Module vrMovieExport

Functions

createMovie(movie, filename, width, height, fps, startFrame, stopFrame, ssf, alpha, alphaRed, alphaGreen, alphaBlue, overwrite, alpha_premultiply, step, tonemap_hdr)
Method to create a movie.

createSnapshot(filename, width, height, ssf, alpha, alphaRed, alphaGreen, alphaBlue, dpi, overwrite, showImage, alpha_premultiply, tonemap_hdr)
Method to create a snapshot.

createSnapshotFast(filename)
Create a fast snapshot with the provided file name.

createSnapshotFastInit(width, height, ssf)
Initializes the fast snapshot method setting the image resolution to width times height.

createSnapshotFastTerminate()
Terminates the creation of a fast snapshot.

createSnapshotStream()

unsigned int

getDepthMode()
Returns the depth mode used to write the depth pass.

Vec2f

getDepthRange()
Get the range for mapping depth values.

bool.

getExportExrHalf()
Return if EXR is exported in 16 bit float format.

bool.

getExportMultiLayer()
Return if EXR/PSD is exported as layers for render passes.

bool.

getExportTiffHDR()
Return if TIFF/PSD is exported in HDR format.

getLastRenderTime()
Returns the duration in seconds of the last image render.

Vec2f

getOcclusionRange()
Gets the range used for the ambient occlusion calculation in the Occlusion render pass.

imageStream()
Redirects image write operations of function into a string which is returned.

imageStreamBase64()
Redirects image write operations of function into a string which is returned

renderAnimation(animation, filename, width, height, fps, startFrame, stopFrame, ssf, alpha, alphaRed, alphaGreen, alphaBlue, overwrite, alpha_premultiply, tonemap_hdr)
This method writes an animation as a movie in the specified resolution and supersampling and alpha channel.

renderStepAnimation(animation, filename, width, height, fps, startFrame, stopFrame, ssf, alpha, alphaRed, alphaGreen, alphaBlue, overwrite, alpha_premultiply, step)
This method writes an animation as a movie in the specified resolution and supersampling and alpha channel.

resetActiveSnapshotMovieRenderPasses()
Resets the active renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands.

setActiveSnapshotMovieRenderPasses(beauty_pass, diffuse_ibl_pass, diffuse_light_pass, glossy_ibl_pass, glossy_light_pass, specular_reflection_pass, specular_light_pass, translucency_pass, incandescence_pass, diffuse_indirect_pass, glossy_indirect_pass, occlusion_pass, normal_pass, depth_pass, material_id_pass)
Sets the active renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands.

setAuxiliaryChannelsRenderPasses(occlusion_pass, normal_pass, depth_pass, material_id_pass, mask_pass, position_pass, view_vector_pass, crypto_object_pass, crypto_object_pass)
Sets the active combined channels renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands.

setCombinedChannelsRenderPasses(beauty_pass, diffuse_ibl_pass, diffuse_light_pass, glossy_ibl_pass, glossy_light_pass, specular_reflection_pass, translucency_pass, incandescence_pass, diffuse_indirect_pass, glossy_indirect_pass, transparency_pass, background_pass, volume_pass)
Sets the active combined channels renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands.

setDepthMode(depthMode)
Sets the depth mode for writing the depth pass.

setDepthRange(min, max)
Sets the range the depth is mapped to.

setExportExrHalf(on)
Enables/Disables export of EXR format in 16 bit float.

setExportMultiLayer(on)
Enables/Disables export of EXR/PSD as layers for render passes.

setExportTiffHDR(on)
Enables/Disables export of TIFF/PSD in HDR format.

setIlluminationChannelsRenderPasses(diffuse_ibl_pass, glossy_ibl_pass, translucency_ibl_pass, diffuse_light_pass, glossy_light_pass, translucency_light_pass, diffuse_indirect_pass, glossy_indirect_pass, specular_indirect_pass, translucency_indirect_pass)
Sets the active illumination channels renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands.

setImageProcessingRenderPasses(fog_pass, lens_flare_pass, backplate_pass, frontplate_pass)
Sets the active image processing renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands.

setMaterialChannelsRenderPasses(diffuse_material_pass, glossy_material_pass, specular_material_pass, translucency_material_pass, translucency_material_pass, transparency_material_pass)
Sets the active material channels renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands.

setOcclusionRange(min, max)
Sets the range used for the ambient occlusion calculation in the Occlusion render pass.

setSnapshotEmbedMetaData(embedRenderSettings, embedCameraSettings, embedNodeVisibilities, embedSwitchNodeStates, embedSwitchMaterialStates)
Sets which meta data to store within the output image.

setSnapshotICCProfile(profileID)
Sets the ICC Profile to store with the output image.

setSnapshotNoShowImage(state)
If state is set to true the rendered image is shown.

setSnapshotQuality(quality)
Sets the quality of the image to be exported.

Function Details

createMovie(movie, filename, width, height, fps, startFrame, stopFrame, ssf, alpha, alphaRed, alphaGreen, alphaBlue, overwrite, alpha_premultiply, step, tonemap_hdr)

Method to create a movie. Four sets of parameters are valid:

createMovie(filename,width,height,fps,startFrame,stopFrame,ssf,alpha,alphaRed,alphaGreen,alphaBlue,overwrite)

This method writes the movie in the specified resolution and supersampling and alpha channel and dpi. The movie starts with startFrame, ends with stopFrame and runs with fps frames per second. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. alphaRed, alphaGreen and alphaBlue define the red, green and blue component of the background color. If overwrite is set to true an already existing file will be overwritten without an extra dialog. (This command is only available in VRED Professional.)

createMovie(filename,width,height,fps,startFrame,stopFrame,ssf,alpha,alphaRed,alphaGreen,alphaBlue,overwrite,alpha_premultiply)

This method writes the movie in the specified resolution and supersampling and alpha channel and dpi. The movie starts with startFrame, ends with stopFrame and runs with fps frames per second. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. alphaRed, alphaGreen and alphaBlue define the red, green and blue component of the background color. If overwrite is set to true an already existing file will be overwritten without an extra dialog. alpha_premultiply sets pre-multiplication of the alpha value on or off. (This command is only available in VRED Professional.)

createMovie(filename,width,height,fps,startFrame,stopFrame,ssf,alpha,alphaRed,alphaGreen,alphaBlue,overwrite,alpha_premultiply,step)

This method writes the movie in the specified resolution and supersampling and alpha channel and dpi. The movie starts with startFrame, ends with stopFrame and runs with fps frames per second. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. alphaRed, alphaGreen and alphaBlue define the red, green and blue component of the background color. If overwrite is set to true an already existing file will be overwritten without an extra dialog. alpha_premultiply sets pre-multiplication of the alpha value on or off. steps sets the number of frames to advance. (This command is only available in VRED Professional.)

createMovie(movie, filename,width,height,fps,startFrame,stopFrame,ssf,alpha,alphaRed,alphaGreen,alphaBlue,alpha_premultiply,step,export_type)

This method writes the movie with name movie, in the specified resolution and supersampling and alpha channel and dpi. The movie starts with startFrame, ends with stopFrame and runs with fps frames per second. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. alphaRed, alphaGreen and alphaBlue define the red, green and blue component of the background color. If overwrite is set to true an already existing file will be overwritten without an extra dialog. alpha_premultiply sets pre-multiplication of the alpha value on or off. steps sets the number of frames to advance.export type is 0 if images are to be generated and 1 if exporting to AVI. (This command is only available in VRED Professional.)

createMovie(filename,width,height,fps,startFrame,stopFrame,ssf,alpha,alphaRed,alphaGreen,alphaBlue,overwrite,alpha_premultiply,step,tonemap_hdr)

This method writes the movie in the specified resolution and supersampling and alpha channel and dpi. The movie starts with startFrame, ends with stopFrame and runs with fps frames per second. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. alphaRed, alphaGreen and alphaBlue define the red, green and blue component of the background color. If overwrite is set to true an already existing file will be overwritten without an extra dialog. alpha_premultiply sets pre-multiplication of the alpha value on or off. steps sets the number of frames to advance. tonemap_hdr applies tonemapping when you render to hdr format. (This command is only available in VRED Professional.)

Parameters:

movie - The name of the movie.
filename (string) - The name of the file.
width (integer) - Width.
height (integer) - Height.
fps (integer) - Frames per second.
startFrame (integer) - The first frame to start the movie.
stopFrame (integer) - The last frame.
ssf (integer) - Supersampling factor.
alpha (bool) - Alpha channel: On/Off.
alphaRed (float) - The red component of the background color.
alphaGreen (float) - The green component of the background color.
alphaBlue (float) - The blue component of the background color.
overwrite (bool) - Overwrite existing file: On/Off.
alpha_premultiply (bool) - Premultiply alpha: On/Off.
step (int) - Frame advance step size.
tonemap_hdr (bool) - Tonemap hdr formats: On/Off.
export_type (int)

createSnapshot(filename, width, height, ssf, alpha, alphaRed, alphaGreen, alphaBlue, dpi, overwrite, showImage, alpha_premultiply, tonemap_hdr)

Method to create a snapshot. Actually, there are 11 different methods to create a snapshot.

createSnapshot(width,height) opens up a file dialog and writes the snapshot in the specified resolution with no supersampling. (This command is only available in VRED Professional.)

createSnapshot(width,height,ssf) opens up a file dialog and writes the snapshot in the specified resolution and supersampling factor. (This command is only available in VRED Professional.)

createSnapshot(width,height,ssf,alpha) opens up a file dialog and writes the snapshot in the specified resolution and supersampling. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. (This command is only available in VRED Professional.)

createSnapshot(width,height,ssf,alpha,dpi) opens up a file dialog and writes the snapshot in the specified resolution and supersampling. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. dpi gives the resolution in dots per inch important for image printing.(This command is only available in VRED Professional.)

createSnapshot(filename,width,height) writes the snapshot in the specified resolution with no supersampling. (This command is only available in VRED Professional.)

createSnapshot(filename,width,height,ssf) writes the snapshot in the specified resolution and supersampling factor. (This command is only available in VRED Professional.)

createSnapshot(filename,width,height,ssf,alpha) writes the snapshot in the specified resolution and supersampling and alpha channel. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. (This command is only available in VRED Professional.)

createSnapshot(filename,width,height,ssf,alpha,dpi) writes the snapshot in the specified resolution and supersampling and alpha channel and dpi. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. dpi gives the resolution in dots per inch important for image printing. (This command is only available in VRED Professional.)

createSnapshot(filename,width,height,ssf,alpha,alphaRed,alphaGreen,alphaBlue,dpi,overwrite,showImage) writes the snapshot in the specified resolution and supersampling and alpha channel and dpi. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. alphaRed, alphaGreen and alphaBlue define the red, green and blue component of the background color. dpi gives the resolution in dots per inch important for image printing. If overwrite is set to true an already existing file will be overwritten without an extra dialog. If showImage is set to true the rendered image is shown. (This command is only available in VRED Professional.)

createSnapshot(filename,width,height,ssf,alpha,alphaRed,alphaGreen,alphaBlue,dpi,overwrite,showImage,alpha_premultiply) writes the snapshot in the specified resolution and supersampling and alpha channel and dpi. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. alphaRed, alphaGreen and alphaBlue define the red, green and blue component of the background color. dpi gives the resolution in dots per inch important for image printing. If overwrite is set to true an already existing file will be overwritten without an extra dialog. If showImage is set to true the rendered image is shown. alpha_premultiply sets pre-multiplication of the alpha value on or off. (This command is only available in VRED Professional.)

createSnapshot(filename,width,height,ssf,alpha,alphaRed,alphaGreen,alphaBlue,dpi,overwrite,showImage,alpha_premultiply,tonemap_hdr) writes the snapshot in the specified resolution and supersampling and alpha channel and dpi. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. alphaRed, alphaGreen and alphaBlue define the red, green and blue component of the background color. dpi gives the resolution in dots per inch important for image printing. If overwrite is set to true an already existing file will be overwritten without an extra dialog. If showImage is set to true the rendered image is shown. alpha_premultiply sets pre-multiplication of the alpha value on or off. tonemap_hdr applies tonemapping when you render to hdr format. (This command is only available in VRED Professional.)

Parameters:

filename (string) - The name of the file.
width (integer) - Width.
height (integer) - Height.
ssf (integer) - Supersampling factor. 0 disables supersampling, a value larger than 0 enables supersampling.
alpha (bool) - Alpha channel: On/Off.
alphaRed (float) - The red component of the background color.
alphaGreen (float) - The green component of the background color.
alphaBlue (float) - The blue component of the background color.
dpi (float) - The number of dots per inch.
overwrite (bool) - Overwrite existing file: On/Off.
showImage (bool) - Show rendered image: On/Off.
alpha_premultiply (bool) - Premultiply alpha: On/Off.
tonemap_hdr (bool) - Tonemap hdr formats: On/Off.

createSnapshotFast(filename)

Create a fast snapshot with the provided file name.

Parameters:

filename (string) - The name of the file.

createSnapshotFastInit(width, height, ssf)

Initializes the fast snapshot method setting the image resolution to width times height. Optionally, a supersampling factor can be specified.

Parameters:

width (integer) - Width.
height (integer) - Height.
ssf (integer) - Supersampling factor (Optional).

getDepthMode()

Returns the depth mode used to write the depth pass.

Returns: unsigned int: depth mode.

getDepthRange()

Get the range for mapping depth values.

Returns: Vec2f: A vector with min, max values.

getExportExrHalf()

Return if EXR is exported in 16 bit float format.

Returns: bool.: True for 16 fit export, False otherwise.

getExportMultiLayer()

Return if EXR/PSD is exported as layers for render passes.

Returns: bool.: True for layer export, False otherwise.

getExportTiffHDR()

Return if TIFF/PSD is exported in HDR format.

Returns: bool.: True for HDR export, False otherwise.

getOcclusionRange()

Gets the range used for the ambient occlusion calculation in the Occlusion render pass.

Returns: Vec2f: A vector with min, max values.

imageStream()

Redirects image write operations of function into a string which is returned. imageStream makes sense only with pythoneval calls on the webinterface. When a function produces multiple images, there is no way to keep them apart other when searching for image headers.Images will be held in memory during processing

Example: binaryimage = imageStream(lambda: createSnapshot('D:/vred-snapshots/image.png', 100,100,50))

imageStreamBase64()

Redirects image write operations of function into a string which is returned

When a function produces multiple images, there is no way to keep them apart other when searching for image headers.Images will be held in memory during processing

Example: b64image = imageStreamBase64(lambda: createSnapshot('D:/vred-snapshots/image.png', 100,100,50))

renderAnimation(animation, filename, width, height, fps, startFrame, stopFrame, ssf, alpha, alphaRed, alphaGreen, alphaBlue, overwrite, alpha_premultiply, tonemap_hdr)

This method writes an animation as a movie in the specified resolution and supersampling and alpha channel. The movie starts with startFrame, ends with stopFrame and runs with fps frames per second. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. alphaRed, alphaGreen and alphaBlue define the red, green and blue component of the background color. If overwrite is set to true an already existing file will be overwritten without an extra dialog. alpha_premultiply sets pre-multiplication of the alpha value on or off. tonemap_hdr applies tonemapping when you render to hdr format. (This command is only available in VRED Professional.)

Parameters:

animation (string) - The name of the animation.
filename (string) - The name of the file.
width (integer) - Width.
height (integer) - Height.
fps (integer) - Frames per second.
startFrame (integer) - The first frame to start the movie.
stopFrame (integer) - The last frame.
ssf (integer) - Supersampling factor.
alpha (bool) - Alpha channel: On/Off.
alphaRed (float) - The red component of the background color.
alphaGreen (float) - The green component of the background color.
alphaBlue (float) - The blue component of the background color.
overwrite (bool) - Overwrite existing file: On/Off.
alpha_premultiply (bool) - Premultiply alpha: On/Off.
tonemap_hdr (bool) - Tonemap hdr formats: On/Off.

renderStepAnimation(animation, filename, width, height, fps, startFrame, stopFrame, ssf, alpha, alphaRed, alphaGreen, alphaBlue, overwrite, alpha_premultiply, step)

This method writes an animation as a movie in the specified resolution and supersampling and alpha channel. The movie starts with startFrame, ends with stopFrame and runs with fps frames per second. If alpha is set to true the resulting image will have a transparent background including correct alpha values for transparent materials. alphaRed, alphaGreen and alphaBlue define the red, green and blue component of the background color. If overwrite is set to true an already existing file will be overwritten without an extra dialog. alpha_premultiply sets pre-multiplication of the alpha value on or off. steps sets the number of frames to advance. (This command is only available in VRED Professional.)

Parameters:

animation (string) - The name of the animation.
filename (string) - The name of the file.
width (integer) - Width.
height (integer) - Height.
fps (integer) - Frames per second.
startFrame (integer) - The first frame to start the movie.
stopFrame (integer) - The last frame.
ssf (integer) - Supersampling factor.
alpha (bool) - Alpha channel: On/Off.
alphaRed (float) - The red component of the background color.
alphaGreen (float) - The green component of the background color.
alphaBlue (float) - The blue component of the background color.
overwrite (bool) - Overwrite existing file: On/Off.
alpha_premultiply (bool) - Premultiply alpha: On/Off.
step (int) - Frame advance step size.

resetActiveSnapshotMovieRenderPasses()

Resets the active renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands. This command does not change the scene settings.

setActiveSnapshotMovieRenderPasses(beauty_pass, diffuse_ibl_pass, diffuse_light_pass, glossy_ibl_pass, glossy_light_pass, specular_reflection_pass, specular_light_pass, translucency_pass, incandescence_pass, diffuse_indirect_pass, glossy_indirect_pass, occlusion_pass, normal_pass, depth_pass, material_id_pass)

Sets the active renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands. This command does not change the scene settings. The following sets of parameters are valid:

setActiveSnapshotMovieRenderPasses(beauty_pass,diffuse_ibl_pass,diffuse_light_pass,glossy_ibl_pass,glossy_light_pass,specular_reflection_pass,specular_light_pass,translucency_pass,incandescence_pass,diffuse_indirect_pass,glossy_indirect_pass,occlusion_pass,normal_pass,depth_pass,material_id_pass).

Parameters:

beauty_pass (bool) - Turns the beauty pass on or off.
diffuse_ibl_pass (bool) - Turns the diffuse ibl pass on or off.
diffuse_light_pass (bool) - Turns the diffuse light pass on or off.
glossy_ibl_pass (bool) - Turns the glossy ibl pass on or off.
glossy_light_pass (bool) - Turns the glossy light pass on or off.
specular_reflection_pass (bool) - Turns the specular reflection pass on or off.
specular_light_pass (bool) - Turns the specular Light pass on or off. This parameter is deprecated, the specular light pass no longer exists, therefore the parameter will be ignored.
translucency_pass (bool) - Turns the translucency pass on or off.
incandescence_pass (bool) - Turns the incandescence pass on or off.
diffuse_indirect_pass (bool) - Turns the diffuse indirect pass on or off.
glossy_indirect_pass (bool) - Turns the glossy indirect pass on or off.
occlusion_pass (bool) - Turns the occlusion pass on or off.
normal_pass (bool) - Turns the normal pass on or off.
depth_pass (bool) - Turns the depth pass on or off.
material_id_pass (bool) - Turns the material id pass on or off.

setAuxiliaryChannelsRenderPasses(occlusion_pass, normal_pass, depth_pass, material_id_pass, mask_pass, position_pass, view_vector_pass, crypto_object_pass, crypto_object_pass)

Sets the active combined channels renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands. This command does not change the scene settings.

Parameters:

occlusion_pass (bool) - Turns the occlusion pass on or off.
normal_pass (bool) - Turns the normal pass on or off.
depth_pass (bool) - Turns the depth pass on or off.
material_id_pass (bool) - Turns the material id pass on or off.
mask_pass (bool) - Turns the mask pass on or off.
position_pass (bool) - Turns the position pass on or off.
view_vector_pass (bool) - Turns the view vector pass on or off.
crypto_object_pass (bool) - Turns the object cryptomatte pass on or off.
crypto_object_pass (bool) - Turns the material cryptomatte pass on or off.

setCombinedChannelsRenderPasses(beauty_pass, diffuse_ibl_pass, diffuse_light_pass, glossy_ibl_pass, glossy_light_pass, specular_reflection_pass, translucency_pass, incandescence_pass, diffuse_indirect_pass, glossy_indirect_pass, transparency_pass, background_pass, volume_pass)

Sets the active combined channels renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands. This command does not change the scene settings.

Parameters:

beauty_pass (bool) - Turns the beauty pass on or off.
diffuse_ibl_pass (bool) - Turns the diffuse ibl pass on or off.
diffuse_light_pass (bool) - Turns the diffuse light pass on or off.
glossy_ibl_pass (bool) - Turns the glossy ibl pass on or off.
glossy_light_pass (bool) - Turns the glossy light pass on or off.
specular_reflection_pass (bool) - Turns the specular reflection pass on or off.
translucency_pass (bool) - Turns the translucency pass on or off.
incandescence_pass (bool) - Turns the incandescence pass on or off. Note that this is the same pass as the incandescence pass in the separate material channel passes
diffuse_indirect_pass (bool) - Turns the diffuse indirect pass on or off.
glossy_indirect_pass (bool) - Turns the glossy indirect pass on or off.
transparency_pass (bool) - Turns the transparency pass on or off. Note that this is the same pass as the transparency pass in the separate material channel passes.
background_pass (bool) - Turns the background pass on or off. Note that this is the same pass as the background pass in the separate material channel passes
volume_pass (bool) - Turns the volume pass on or off.

setDepthMode(depthMode)

Sets the depth mode for writing the depth pass.

Parameters:

depthMode (unsigned int) - 0 = Standard, 1 = linear depth, 2 = normalized linear depth, 3 = normalized reversed linear depth.

setDepthRange(min, max)

Sets the range the depth is mapped to.

Parameters:

min (float) - minimum depth value that is mapped to zero.
max (float) - maximum depth value that is mapped to one.

setExportExrHalf(on)

Enables/Disables export of EXR format in 16 bit float.

Parameters:

on (bool.) - True for export in 16 bit, False otherwise.

setExportMultiLayer(on)

Enables/Disables export of EXR/PSD as layers for render passes.

Parameters:

on (bool.) - True for export as layers, False otherwise.

setExportTiffHDR(on)

Enables/Disables export of TIFF/PSD in HDR format.

Parameters:

on (bool.) - True for export in HDR, False otherwise.

setIlluminationChannelsRenderPasses(diffuse_ibl_pass, glossy_ibl_pass, translucency_ibl_pass, diffuse_light_pass, glossy_light_pass, translucency_light_pass, diffuse_indirect_pass, glossy_indirect_pass, specular_indirect_pass, translucency_indirect_pass)

Sets the active illumination channels renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands. This command does not change the scene settings.

Parameters:

diffuse_ibl_pass (bool) - Turns the diffuse ibl pass on or off.
glossy_ibl_pass (bool) - Turns the glossy ibl pass on or off.
translucency_ibl_pass (bool) - Turns the translucency ibl pass on or off.
diffuse_light_pass (bool) - Turns the diffuse light pass on or off.
glossy_light_pass (bool) - Turns the glossy light pass on or off.
translucency_light_pass (bool) - Turns the translucency light pass on or off.
diffuse_indirect_pass (bool) - Turns the diffuse indirect pass on or off.
glossy_indirect_pass (bool) - Turns the glossy indirect pass on or off.
specular_indirect_pass (bool) - Turns the specular indirect pass on or off.
translucency_indirect_pass (bool) - Turns the translucency indirect pass on or off.

setImageProcessingRenderPasses(fog_pass, lens_flare_pass, backplate_pass, frontplate_pass)

Sets the active image processing renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands. This command does not change the scene settings.

Parameters:

fog_pass (bool) - Turns the fog pass on or off.
lens_flare_pass (bool) - Turns the lens flare pass on or off.
backplate_pass (bool) - Turns the backplate pass on or off.
frontplate_pass (bool) - Turns the frontplate pass on or off.

setMaterialChannelsRenderPasses(diffuse_material_pass, glossy_material_pass, specular_material_pass, translucency_material_pass, translucency_material_pass, transparency_material_pass)

Sets the active material channels renderpasses for rendering a snapshot using the createSnapshot or renderAnimation commands. This command does not change the scene settings.

Parameters:

diffuse_material_pass (bool) - Turns the diffuse material pass on or off.
glossy_material_pass (bool) - Turns the glossy material pass on or off.
specular_material_pass (bool) - Turns the specular material pass on or off.
translucency_material_pass (bool) - Turns the translucency material pass on or off.
translucency_material_pass (bool) - Turns the translucency material pass on or off.
transparency_material_pass (bool) - Turns the transparency pass on or off. Note that this is the same pass as the background pass in the combined material channel passes

setOcclusionRange(min, max)

Sets the range used for the ambient occlusion calculation in the Occlusion render pass.

Parameters:

min (float) - minimum distance of objects to be taken into account.
max (float) - maximum distance of objects to be taken into account.

setSnapshotEmbedMetaData(embedRenderSettings, embedCameraSettings, embedNodeVisibilities, embedSwitchNodeStates, embedSwitchMaterialStates)

Sets which meta data to store within the output image.

Please note: Image formats supporting meta data are png, jpg, tif and exr.

Parameters:

embedRenderSettings (bool) - Sets whether to embed image, animation and raytracing settings.
embedCameraSettings (bool) - Sets whether to embed the settings of the active camera.
embedNodeVisibilities (bool) - Sets whether to embed the visibility state of each node in the scenegraph.
embedSwitchNodeStates (bool) - Sets whether to embed the state of each switch node in the scenegraph.
embedSwitchMaterialStates (bool) - Sets whether to embed the state of each valid switch material in the scene.

setSnapshotICCProfile(profileID)

Sets the ICC Profile to store with the output image.

0 uses the current settings from the render settings module.

1 uses sRGB encoding.

2 uses Adobe RGB 98 encoding.

3 uses the specified Monitor ICC Profile.

4 uses the specified Image ICC Profile.

Parameters:

profileID (int) - The profile id.

setSnapshotNoShowImage(state)

If state is set to true the rendered image is shown.

Parameters:

state (bool) - Show image: On/Off.

setSnapshotQuality(quality)

Sets the quality of the image to be exported. Only useful for file formats that define a compression quality like jpeg or png. -1 is the default value for reasonable compression.

Parameters:

quality (integer signed (32bit)) - The quality of the image.