3DCoat Core API
The 3DCoat API documentation.
|
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 | |
|
static |
add the additional directional light
|
static |
enable or disable the realtime rendering
enable | set true to enable |
|
static |
get the anti-aliasing (AA) rendering state
|
static |
get the depth of field (DOF) degree
|
static |
get the brightness of the environment light (spherical environment)
|
static |
get the exposure value for the rendering (in render room)
|
static |
get the light color for the additional light
idx | the index of the light |
|
static |
get the direction for the additional light
idx | the index of the light |
|
static |
get the light intensity for the additional light
idx | the index of the light |
|
static |
get the light scattering for the additional light
idx | the index of the light |
|
static |
get the amount of additional directional lighte
|
static |
get rays per frame for the rendering
|
static |
get the realtime rendering state
|
static |
remove the additional directional light
idx | the index of the light |
|
static |
set the anti-aliasing (AA) rendering state
AA | true to enable |
|
static |
set the render output width
width | the width |
height | the height |
|
static |
set the depth of field (DOF) degree
degree | the degree of DOF, 0 means no DOF, 1 means full DOF |
|
static |
set the brightness of the environment light (spherical environment)
envlight | the brightness, usually 1 |
|
static |
set the exposure value for the rendering (in render room)
exposure | the exposure value, usually 0..1, bigger values allowed as well |
|
static |
set the light color for the additional light
idx | the index of the light |
color | the light color (r,g,b) wintin [0..1] range, if need more intensity, increase the light intensity value |
|
static |
set the direction for the additional light
idx | the index of the light |
dir | the light direction |
|
static |
set the light intensity for the additional light
idx | the index of the light |
intensity | the light intensity value |
|
static |
set the light scattering for the additional light
idx | the index of the light |
scattering | the light scattering value |
|
static |
set rays per frame for the rendering
count | the rays per frame count |
|
static |
set the render output filename
filename | the filename |