Static Public Member Functions
	toRenderRoom ()
	get to the render room to be able to render

	restartRendering ()
	if the realtime render enabled the command will restart the rendering from scratch

	setCustomRenderSize (int width, int height)
	set the render output width

	setRenderResult (str filename)
	set the render output filename

	renderFrame ()
	render to the output file

	enableRealtimeRendering (bool enable)
	enable or disable the realtime rendering

bool	isRealtimeRenderingEnabled ()
	get the realtime rendering state

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

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

	setEnvironmentLight (float envlight)
	set the brightness of the environment light (spherical environment)

float	getEnvironmentLight ()
	get the brightness of the environment light (spherical environment)

	setDOFDegree (float degree)
	set the depth of field (DOF) degree

float	getDOFDegree ()
	get the depth of field (DOF) degree

int	getLightsCount ()
	get the amount of additional directional lighte

int	addLight ()
	add the additional directional light

	removeLight (int idx)
	remove the additional directional light

	removeAllLights ()
	remove all additional directional lights

	setLightDirection (int idx, vec3 dir)
	set the direction for the additional light

vec3	getLightDirection (int idx)
	get the direction for the additional light

	setLightScattering (int idx, float scattering)
	set the light scattering for the additional light

float	getLightScattering (int idx)
	get the light scattering for the additional light

	setLightColor (int idx, vec3 color=vec3.One)
	set the light color for the additional light

vec3	getLightColor (int idx)
	get the light color for the additional light

	setLightIntensity (int idx, float intensity)
	set the light intensity for the additional light

float	getLightIntensity (int idx)
	get the light intensity for the additional light

	setRaysPerFrame (int count)
	set rays per frame for the rendering

int	getRaysPerFrame ()
	get rays per frame for the rendering

	setAA (bool AA)
	set the anti-aliasing (AA) rendering state

bool	getAA ()
	get the anti-aliasing (AA) rendering state

Member Function Documentation

◆ addLight()

int coat.RenderRoom.addLight ( )

static

add the additional directional light

Returns: the index of the light for all further operations

◆ enableRealtimeRendering()

coat.RenderRoom.enableRealtimeRendering ( bool enable )

static

enable or disable the realtime rendering

Parameters

enable set true to enable

◆ getAA()

bool coat.RenderRoom.getAA ( )

static

get the anti-aliasing (AA) rendering state

Returns: true if enabled

◆ getDOFDegree()

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()

float coat.RenderRoom.getEnvironmentLight ( )

static

get the brightness of the environment light (spherical environment)

Returns: the brightness, usually 1

◆ getExposure()

float coat.RenderRoom.getExposure ( )

static

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

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

◆ getLightColor()

vec3 coat.RenderRoom.getLightColor ( int idx )

static

get the light color for the additional light

Parameters

idx	the index of the light

Returns: the light color (r,g,b)

◆ getLightDirection()

vec3 coat.RenderRoom.getLightDirection ( int idx )

static

get the direction for the additional light

Parameters

idx	the index of the light

Returns: the light direction

◆ getLightIntensity()

float coat.RenderRoom.getLightIntensity ( int idx )

static

get the light intensity for the additional light

Parameters

idx	the index of the light

Returns: the light intensity value

◆ getLightScattering()

float coat.RenderRoom.getLightScattering ( int idx )

static

get the light scattering for the additional light

Parameters

idx	the index of the light

Returns: the light scattering value

◆ getLightsCount()

int coat.RenderRoom.getLightsCount ( )

static

get the amount of additional directional lighte

Returns: the amount

◆ getRaysPerFrame()

int coat.RenderRoom.getRaysPerFrame ( )

static

get rays per frame for the rendering

Returns: the rays per frame count

◆ isRealtimeRenderingEnabled()

bool coat.RenderRoom.isRealtimeRenderingEnabled ( )

static

get the realtime rendering state

Returns: true if enabled

◆ removeAllLights()

coat.RenderRoom.removeAllLights ( )

static

remove all additional directional lights

◆ removeLight()

coat.RenderRoom.removeLight ( int idx )

static

remove the additional directional light

Parameters

idx	the index of the light

◆ renderFrame()

coat.RenderRoom.renderFrame ( )

static

render to the output file

◆ restartRendering()

coat.RenderRoom.restartRendering ( )

static

if the realtime render enabled the command will restart the rendering from scratch

◆ setAA()

coat.RenderRoom.setAA ( bool AA )

static

set the anti-aliasing (AA) rendering state

Parameters

AA	true to enable

◆ setCustomRenderSize()

coat.RenderRoom.setCustomRenderSize	(	int	width,
		int	height )

static

set the render output width

Parameters

width	the width
height	the height

◆ setDOFDegree()

coat.RenderRoom.setDOFDegree ( float degree )

static

set the depth of field (DOF) degree

Parameters

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

◆ setEnvironmentLight()

coat.RenderRoom.setEnvironmentLight ( float envlight )

static

set the brightness of the environment light (spherical environment)

Parameters

envlight the brightness, usually 1

◆ setExposure()

coat.RenderRoom.setExposure ( float exposure )

static

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

Parameters

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

◆ setLightColor()

coat.RenderRoom.setLightColor	(	int	idx,
		vec3	color = vec3.One )

static

set the light color for the additional light

Parameters

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

◆ setLightDirection()

coat.RenderRoom.setLightDirection	(	int	idx,
		vec3	dir )

static

set the direction for the additional light

Parameters

idx	the index of the light
dir	the light direction

◆ setLightIntensity()

coat.RenderRoom.setLightIntensity	(	int	idx,
		float	intensity )

static

set the light intensity for the additional light

Parameters

idx	the index of the light
intensity	the light intensity value

◆ setLightScattering()

coat.RenderRoom.setLightScattering	(	int	idx,
		float	scattering )

static

set the light scattering for the additional light

Parameters

idx	the index of the light
scattering	the light scattering value

◆ setRaysPerFrame()

coat.RenderRoom.setRaysPerFrame ( int count )

static

set rays per frame for the rendering

Parameters

count the rays per frame count

◆ setRenderResult()

coat.RenderRoom.setRenderResult ( str filename )

static

set the render output filename

Parameters

filename the filename

◆ toRenderRoom()

coat.RenderRoom.toRenderRoom ( )

static

get to the render room to be able to render

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

doxy/src/coat.py

Static Public Member Functions

Member Function Documentation

◆ addLight()

◆ enableRealtimeRendering()

◆ getAA()

◆ getDOFDegree()

◆ getEnvironmentLight()

◆ getExposure()

◆ getLightColor()

◆ getLightDirection()

◆ getLightIntensity()

◆ getLightScattering()

◆ getLightsCount()

◆ getRaysPerFrame()

◆ isRealtimeRenderingEnabled()

◆ removeAllLights()

◆ removeLight()

◆ renderFrame()

◆ restartRendering()

◆ setAA()

◆ setCustomRenderSize()

◆ setDOFDegree()

◆ setEnvironmentLight()

◆ setExposure()

◆ setLightColor()

◆ setLightDirection()

◆ setLightIntensity()

◆ setLightScattering()

◆ setRaysPerFrame()

◆ setRenderResult()

◆ toRenderRoom()