3DCoat Core API
The 3DCoat API documentation.
Loading...
Searching...
No Matches
coat::RenderRoom Class Reference

Static Public Member Functions

static void toRenderRoom ()
 get to the render room to be able to render
 
static void restartRendering ()
 if the realtime render enabled the command will restart the rendering from scratch
 
static void setCustomRenderSize (int width, int height)
 set the render output width
 
static void setRenderResult (const char *filename)
 set the render output filename
 
static void renderFrame ()
 render to the output file
 
static void enableRealtimeRendering (bool enable)
 enable or disable the realtime rendering
 
static bool isRealtimeRenderingEnabled ()
 get the realtime rendering state
 
static void setExposure (float exposure)
 set the exposure value for the rendering (in render room)
 
static float getExposure ()
 get the exposure value for the rendering (in render room)
 
static void setEnvironmentLight (float envlight)
 set the brightness of the environment light (spherical environment)
 
static float getEnvironmentLight ()
 get the brightness of the environment light (spherical environment)
 
static void setDOFDegree (float degree)
 set the depth of field (DOF) degree
 
static float getDOFDegree ()
 get the depth of field (DOF) degree
 
static int getLightsCount ()
 get the amount of additional directional lighte
 
static int addLight ()
 add the additional directional light
 
static void removeLight (int idx)
 remove the additional directional light
 
static void removeAllLights ()
 remove all additional directional lights
 
static void setLightDirection (int idx, const vec3 &dir)
 set the direction for the additional light
 
static vec3 getLightDirection (int idx)
 get the direction for the additional light
 
static void setLightScattering (int idx, float scattering)
 set the light scattering for the additional light
 
static float getLightScattering (int idx)
 get the light scattering for the additional light
 
static void setLightColor (int idx, const vec3 &color=vec3::One)
 set the light color for the additional light
 
static vec3 getLightColor (int idx)
 get the light color for the additional light
 
static void setLightIntensity (int idx, float intensity)
 set the light intensity for the additional light
 
static float getLightIntensity (int idx)
 get the light intensity for the additional light
 
static void setRaysPerFrame (int count)
 set rays per frame for the rendering
 
static int getRaysPerFrame ()
 get rays per frame for the rendering
 
static void setAA (bool AA)
 set the anti-aliasing (AA) rendering state
 
static bool getAA ()
 get the anti-aliasing (AA) rendering state
 

Member Function Documentation

◆ addLight()

static int coat::RenderRoom::addLight ( )
static

add the additional directional light

Returns
the index of the light for all further operations

◆ enableRealtimeRendering()

static void coat::RenderRoom::enableRealtimeRendering ( bool enable)
static

enable or disable the realtime rendering

Parameters
enableset true to enable

◆ getAA()

static bool coat::RenderRoom::getAA ( )
static

get the anti-aliasing (AA) rendering state

Returns
true if enabled

◆ getDOFDegree()

static float coat::RenderRoom::getDOFDegree ( )
static

get the depth of field (DOF) degree

Returns
the degree of DOF, 0 means no DOF, 1 means full DOF

◆ getEnvironmentLight()

static float coat::RenderRoom::getEnvironmentLight ( )
static

get the brightness of the environment light (spherical environment)

Returns
the brightness, usually 1

◆ getExposure()

static float coat::RenderRoom::getExposure ( )
static

get the exposure value for the rendering (in render room)

Returns
the exposure value, around (0..1)

◆ getLightColor()

static vec3 coat::RenderRoom::getLightColor ( int idx)
static

get the light color for the additional light

Parameters
idxthe index of the light
Returns
the light color (r,g,b)

◆ getLightDirection()

static vec3 coat::RenderRoom::getLightDirection ( int idx)
static

get the direction for the additional light

Parameters
idxthe index of the light
Returns
the light direction

◆ getLightIntensity()

static float coat::RenderRoom::getLightIntensity ( int idx)
static

get the light intensity for the additional light

Parameters
idxthe index of the light
Returns
the light intensity value

◆ getLightScattering()

static float coat::RenderRoom::getLightScattering ( int idx)
static

get the light scattering for the additional light

Parameters
idxthe index of the light
Returns
the light scattering value

◆ getLightsCount()

static int coat::RenderRoom::getLightsCount ( )
static

get the amount of additional directional lighte

Returns
the amount

◆ getRaysPerFrame()

static int coat::RenderRoom::getRaysPerFrame ( )
static

get rays per frame for the rendering

Returns
the rays per frame count

◆ isRealtimeRenderingEnabled()

static bool coat::RenderRoom::isRealtimeRenderingEnabled ( )
static

get the realtime rendering state

Returns
true if enabled

◆ removeLight()

static void coat::RenderRoom::removeLight ( int idx)
static

remove the additional directional light

Parameters
idxthe index of the light

◆ setAA()

static void coat::RenderRoom::setAA ( bool AA)
static

set the anti-aliasing (AA) rendering state

Parameters
AAtrue to enable

◆ setCustomRenderSize()

static void coat::RenderRoom::setCustomRenderSize ( int width,
int height )
static

set the render output width

Parameters
widththe width
heightthe height

◆ setDOFDegree()

static void coat::RenderRoom::setDOFDegree ( float degree)
static

set the depth of field (DOF) degree

Parameters
degreethe degree of DOF, 0 means no DOF, 1 means full DOF

◆ setEnvironmentLight()

static void coat::RenderRoom::setEnvironmentLight ( float envlight)
static

set the brightness of the environment light (spherical environment)

Parameters
envlightthe brightness, usually 1

◆ setExposure()

static void coat::RenderRoom::setExposure ( float exposure)
static

set the exposure value for the rendering (in render room)

Parameters
exposurethe exposure value, usually 0..1, bigger values allowed as well

◆ setLightColor()

static void coat::RenderRoom::setLightColor ( int idx,
const vec3 & color = vec3::One )
static

set the light color for the additional light

Parameters
idxthe index of the light
colorthe light color (r,g,b) wintin [0..1] range, if need more intensity, increase the light intensity value

◆ setLightDirection()

static void coat::RenderRoom::setLightDirection ( int idx,
const vec3 & dir )
static

set the direction for the additional light

Parameters
idxthe index of the light
dirthe light direction

◆ setLightIntensity()

static void coat::RenderRoom::setLightIntensity ( int idx,
float intensity )
static

set the light intensity for the additional light

Parameters
idxthe index of the light
intensitythe light intensity value

◆ setLightScattering()

static void coat::RenderRoom::setLightScattering ( int idx,
float scattering )
static

set the light scattering for the additional light

Parameters
idxthe index of the light
scatteringthe light scattering value

◆ setRaysPerFrame()

static void coat::RenderRoom::setRaysPerFrame ( int count)
static

set rays per frame for the rendering

Parameters
countthe rays per frame count

◆ setRenderResult()

static void coat::RenderRoom::setRenderResult ( const char * filename)
static

set the render output filename

Parameters
filenamethe filename

The documentation for this class was generated from the following file: