Module Render :: Class RenderData

Class RenderData

The RenderData object

This object gives access to Scene rendering contexts in Blender.

Method Summary
int (if prototype is empty)	`aspectRatioX(ratio)` Get/set the horizontal aspect ratio.
int (if prototype is empty)	`aspectRatioY(ratio)` Get/set the vertical aspect ratio.
int (if prototype is empty)	`currentFrame(frame)` Get/set the current frame.
int (if prototype is empty)	`edgeAntiShift(intensity)` With the unified renderer, reduce intensity on boundaries.
int (if prototype is empty)	`edgeIntensity(intensity)` Get/set edge intensity for toon shading.
	`enableBackbuf(toggle)` Enable/disable the backbuf image.
	`enableBorderRender(toggle)` Enable/disable small cut-out rendering.
	`enableCropping(toggle)` Enable/disable exclusion of border rendering from total image.
	`enableEnvironmentMap(toggle)` Enable/disable environment map rendering.
	`enableExtensions(toggle)` Enable/disable windows extensions for output files.
	`enableFieldRendering(toggle)` Enable/disable field rendering
	`enableFieldTimeDisable(toggle)` Enable/disable time difference in field calculations.
	`enableGameFrameBars()` Enable show the entire viewport in the display window, using bar horizontally or vertically.
	`enableGameFrameExpose()` Enable show the entire viewport in the display window, viewing more horizontally or vertically.
	`enableGameFrameStretch()` Enable stretch or squeeze the viewport to fill the display window.
	`enableGammaCorrection(toggle)` Enable/disable gamma correction.
	`enableGaussFilter(toggle)` Enable/disable Gauss sampling filter for anti-aliasing.
	`enableGrayscale()` Images are saved with black and white (grayscale) data.
	`enableKey()` Enable alpha and color values remain unchanged.
	`enableMotionBlur(toggle)` Enable/disable MBlur.
	`enableOddFieldFirst(toggle)` Enable/disable Odd field first rendering (Default: Even field).
	`enableOversampling(toggle)` Enable/disable oversampling (anti-aliasing).
	`enablePanorama(toggle)` Enable/disable panorama rendering (output width is multiplied by Xparts).
	`enablePremultiply()` Enable premultiply alpha.
	`enableRadiosityRender(toggle)` Enable/disable radiosity rendering.
	`enableRayTracing(toggle)` Enable/disable ray tracing.
	`enableRenderDaemon(toggle)` Enable/disable Scene daemon.
	`enableRGBAColor()` Images are saved with RGB and Alpha data (if supported).
	`enableRGBColor()` Images are saved with RGB (color) data.
	`enableSequencer(toggle)` Enable/disable Do Sequence.
	`enableSGICosmo(toggle)` Enable/disable attempt to save SGI movies using Cosmo hardware SGI must be defined on your machine.
	`enableShadow(toggle)` Enable/disable shadow calculation.
	`enableSky()` Enable render background with sky.
	`enableToonShading(toggle)` Enable/disable Edge rendering.
	`enableUnifiedRenderer(toggle)` Use the unified renderer.
	`enableYafrayGICache(toggle)` Enable/disable cache irradiance samples (faster).
	`enableYafrayGIGradient(toggle)` Enable/disable try to smooth lighting using a gradient.
	`enableYafrayGIPhotons(toggle)` Enable/disable use of global photons to help in GI.
	`enableYafrayGITunePhotons(toggle)` Enable/disable show the photon map directly in the render for tuning.
int (if prototype is empty)	`endFrame(frame)` Get/set the ending frame for sequence rendering.
int (if prototype is empty)	`framesPerSec(qual)` Get/set frames per second.
float (if prototype is empty)	`gammaLevel(level)` Get/set the gamma value for blending oversampled images (1.0 = no correction).
float (if prototype is empty)	`gaussFilterSize(size)` Get/sets the Gauss filter size.
string	`getBackbufPath()` Get the path to the background image.
string	`getEdgeColor()` Get the edge color for toon shading.
string	`getFtypePath()` Get the path to the Ftype file
string	`getGameFrameColor()` Set the red, green, blue component of the bars.
string	`getRenderPath()` Get the path to where the renderer will write to.
int	`getRenderWinSize()` Get the size of the render window.
string	`getTimeCode()` Get the current frame as a string in HH:MM:SS:FF format
int (if prototype is empty)	`imageSizeX(size)` Get/set the image width in pixels.
int (if prototype is empty)	`imageSizeY(size)` Get/set the image height in pixels.
float (if prototype is empty)	`motionBlurLevel(level)` Get/set the length of shutter time for motion blur.
int (if prototype is empty)	`newMapValue(value)` Get/set specify new map value in frames.
int (if prototype is empty)	`oldMapValue(value)` Get/set specify old map value in frames.
int (if prototype is empty)	`partsX(parts)` Get/set the number of parts to divide the render in the X direction.
int (if prototype is empty)	`partsY(parts)` Get/set the number of parts to divide the render in the Y direction.
	`play()` play animation of rendered images/avi (searches Pics: field).
float (if prototype is empty)	`postProcessAdd(add)` Get/set post processing add.
float (if prototype is empty)	`postProcessGamma(gamma)` Get/set post processing gamma.
float (if prototype is empty)	`postProcessMultiply(mult)` Get/set post processing multiply.
int (if prototype is empty)	`quality(qual)` Get/set quality get/setting for JPEG images, AVI JPEG and SGI movies.
	`render()` Render the scene.
	`renderAnim()` Render a series of frames to an output directory.
	`saveRenderedImage(filename, zbuffer)` Saves the image rendered using RenderData.render() to the filename and path given in the variable 'filename'.
	`setBackbufPath(path)` Set the path to a background image and load it.
	`setBorder(left, bottom, right, top)` Set a border for rendering from cameras in the scene.
	`setEdgeColor(red, green, blue)` Set the edge color for toon shading.
	`setFtypePath(path)` Set the path to Ftype file.
	`setGameFrameColor(red, green, blue)` Set the red, green, blue component of the bars.
	`setImageType(type)` Set the type of image to output from the render.
	`setOversamplingLevel(level)` Set the edge color for toon shading.
	`setRenderer(type)` Get/set which renderer to render the output.
	`setRenderPath(path)` Set the path to where the renderer will write to.
	`setRenderWinSize(size)` Set the size of the render window.
	`setYafrayGIMethod(type)` Set yafray global Illumination method.
	`setYafrayGIQuality(type)` Set yafray global Illumination quality.
int (if prototype is empty)	`SGIMaxsize(size)` Get/set maximum size per frame to save in an SGI movie.
	`sizePreset(type)` Set the renderer to one of a few presets.
int (if prototype is empty)	`startFrame(frame)` Get/set the starting frame for sequence rendering.
float (if prototype is empty)	`yafrayExposure(expose)` Get/set exposure adjustment, 0 is off.
float (if prototype is empty)	`yafrayGamma(gamma)` Get/set gamma correction, 1 is off.
int (if prototype is empty)	`yafrayGICDepth(depth)` Get/set number of bounces inside objects (for caustics).
int (if prototype is empty)	`yafrayGIDepth(depth)` Get/set number of bounces of the indirect light.
float (if prototype is empty)	`yafrayGIIndirPower(power)` Get/set GI indirect lighting intensity scale.
int (if prototype is empty)	`yafrayGIPhotonCount(count)` Get/set number of photons to shoot.
int (if prototype is empty)	`yafrayGIPhotonMixCount(count)` Get/set number of photons to keep inside radius.
float (if prototype is empty)	`yafrayGIPhotonRadius(radius)` Get/set radius to search for photons to mix (blur).
int (if prototype is empty)	`yafrayGIPixelsPerSample(pixels)` Get/set maximum number of pixels without samples, the lower the better and slower.
float (if prototype is empty)	`yafrayGIPower(power)` Get/set GI lighting intensity scale.
float (if prototype is empty)	`yafrayGIRefinement(refine)` Get/set threshold to refine shadows EXPERIMENTAL.
float (if prototype is empty)	`yafrayGIShadowQuality(qual)` Get/set the shadow quality, keep it under 0.95.
int (if prototype is empty)	`yafrayProcessorCount(count)` Get/set number of processors to use.
float (if prototype is empty)	`yafrayRayBias(bias)` Get/set shadow ray bias to avoid self shadowing.
int (if prototype is empty)	`yafrayRayDepth(depth)` Get/set maximum render ray depth from the camera.

Instance Variable Summary
int	`alphaMode`: Setting for sky/background.
int	`aspectX`: Horizontal aspect ratio.
int	`aspectY`: Vertical aspect ratio.
boolean	`backbuf`: Backbuffer image enabled.
string	`backbufPath`: Path to a background image (setting loads image).
list of 4 floats.	`border`: The border for border rendering.
boolean	`borderRender`: Small cut-out rendering enabled.
int	`cFrame`: The current frame for rendering.
boolean	`compositeFree`: Free nodes that are not used while composite.
boolean	`compositor`: 'Do Compositor' enabled.
boolean	`crop`: Crop image during border renders.
int	`displayMode`: Render output in separate window or 3D view.
list of 3 RGB floats	`edgeColor`: RGB color triplet for edges in Toon shading (unified renderer).
int	`eFrame`: Ending frame for rendering.
boolean	`environmentMap`: Environment map rendering enabled.
boolean	`extensions`: Add extensions to output (when rendering animations).
boolean	`fieldRendering`: Field rendering enabled.
int	`fieldTimeDisable`: Time difference in field calculations disabled.
int	`fps`: Frames per second.
boolean	`freeImages`: 'Do Compositor' enabled.
string	`ftypePath`: The path to Ftype file.
int	`gameFrame`: Game framing type.
list of RGB 3 floats	`gameFrameColor`: RGB color triplet for bars.
boolean	`gammaCorrection`: Gamma correction enabled.
float	`gaussFilter`: Gauss filter size.
int	`imagePlanes`: Image depth in bits.
int	`imageType`: File format for saving images.
int	`mapNew`: New mapping value (in frames).
int	`mapOld`: Number of frames the Map Old will last Values are clamped to the range [1,900].
float	`mblurFactor`: Motion blur factor.
bitfield	`mode`: Mode bitfield.
boolean	`motionBlur`: Motion blur enabled.
boolean	`oddFieldFirst`: Odd field first rendering enabled.
int	`OSALevel`: Oversampling (anti-aliasing) level.
boolean	`oversampling`: Oversampling (anti-aliasing) enabled.
boolean	`panorama`: Panorama rendering enabled.
boolean	`radiosityRender`: Radiosity rendering enabled.
boolean	`rayTracing`: Ray tracing enabled.
int	`renderer`: Rendering engine choice.
string	`renderPath`: The path to output the rendered images.
int	`renderwinSize`: Size of the rendering window.
boolean	`saveBuffers`: Save render buffers to disk while rendering, saves memory.
bitfield	`sceneMode`: Scene mode bitfield.
boolean	`sequencer`: Enables sequencer output rendering.
BPy_Scene or None	`set`: The scene linked as a set to this scene.
int	`sFrame`: Starting frame for rendering.
boolean	`shadow`: Shadow calculation enabled.
boolean	`singleLayer`: Only render the active layer.
int	`sizeX`: Image width (in pixels).
int	`sizeY`: Image height (in pixels).
int	`threads`: Number of threads to render, clamed [1-8]
string	`timeCode`: Get the current frame in HH:MM:SS:FF format.
boolean	`toonShading`: Toon edge shading enabled.
boolean	`unified`: Unified Renderer enabled.
int	`xParts`: Number of horizontal parts for image render.
int	`yParts`: Number of vertical parts for image render.

Method Details

aspectRatioX(ratio=None)

Get/set the horizontal aspect ratio.

Parameters:: ratio - must be between 1 - 200
(type=int (optional))

Returns:: Current horizontal aspect ratio for the scene.
(type=int (if prototype is empty))

aspectRatioY(ratio=None)

Get/set the vertical aspect ratio.

Parameters:: ratio - must be between 1 - 200
(type=int (optional))

Returns:: Current vertical aspect ratio for the scene.
(type=int (if prototype is empty))

currentFrame(frame=None)

Get/set the current frame.

Parameters:: frame - must be between 1 - 30000
(type=int (optional))

Returns:: Current frame for the scene.
(type=int (if prototype is empty))

edgeAntiShift(intensity=None)

With the unified renderer, reduce intensity on boundaries.

Parameters:: intensity - must be between 0 - 255
(type=int (optional))

Returns:: Current edge antishift for the scene.
(type=int (if prototype is empty))

edgeIntensity(intensity=None)

Get/set edge intensity for toon shading.

Parameters:: intensity - must be between 0 - 255
(type=int (optional))

Returns:: Current edge intensity for the scene.
(type=int (if prototype is empty))

enableBackbuf(toggle)

Enable/disable the backbuf image.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableBorderRender(toggle)

Enable/disable small cut-out rendering.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableCropping(toggle)

Enable/disable exclusion of border rendering from total image.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableEnvironmentMap(toggle)

Enable/disable environment map rendering.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableExtensions(toggle)

Enable/disable windows extensions for output files.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableFieldRendering(toggle)

Enable/disable field rendering

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableFieldTimeDisable(toggle)

Enable/disable time difference in field calculations.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableGameFrameBars()

Enable show the entire viewport in the display window, using bar horizontally or vertically.

enableGameFrameExpose()

Enable show the entire viewport in the display window, viewing more horizontally or vertically.

enableGameFrameStretch()

Enable stretch or squeeze the viewport to fill the display window.

enableGammaCorrection(toggle)

Enable/disable gamma correction.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableGaussFilter(toggle)

Enable/disable Gauss sampling filter for anti-aliasing.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableGrayscale()

Images are saved with black and white (grayscale) data.

enableKey()

Enable alpha and color values remain unchanged.

enableMotionBlur(toggle)

Enable/disable MBlur.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableOddFieldFirst(toggle)

Enable/disable Odd field first rendering (Default: Even field).

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableOversampling(toggle)

Enable/disable oversampling (anti-aliasing).

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enablePanorama(toggle)

Enable/disable panorama rendering (output width is multiplied by Xparts).

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enablePremultiply()

Enable premultiply alpha.

enableRadiosityRender(toggle)

Enable/disable radiosity rendering.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableRayTracing(toggle)

Enable/disable ray tracing.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableRenderDaemon(toggle)

Enable/disable Scene daemon.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableRGBAColor()

Images are saved with RGB and Alpha data (if supported).

enableRGBColor()

Images are saved with RGB (color) data.

enableSequencer(toggle)

Enable/disable Do Sequence.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableSGICosmo(toggle)

Enable/disable attempt to save SGI movies using Cosmo hardware SGI must be defined on your machine.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableShadow(toggle)

Enable/disable shadow calculation.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableSky()

Enable render background with sky.

enableToonShading(toggle)

Enable/disable Edge rendering.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableUnifiedRenderer(toggle)

Use the unified renderer.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableYafrayGICache(toggle)

Enable/disable cache irradiance samples (faster). YafrayMethod must be GIFULL.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableYafrayGIGradient(toggle)

Enable/disable try to smooth lighting using a gradient. YafrayMethod must be GIFULL and Cache enabled.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableYafrayGIPhotons(toggle)

Enable/disable use of global photons to help in GI. YafrayMethod must be GIFULL.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

enableYafrayGITunePhotons(toggle)

Enable/disable show the photon map directly in the render for tuning. YafrayMethod must be GIFULL and Photons enabled.

Parameters:: toggle - pass 1 for on / 0 for off
(type=int)

endFrame(frame=None)

Get/set the ending frame for sequence rendering.

Parameters:: frame - must be between 1 - 18000
(type=int (optional))

Returns:: Current ending frame for the scene.
(type=int (if prototype is empty))

framesPerSec(qual=None)

Get/set frames per second.

Parameters:: qual - must be between 1 - 120
(type=int (optional))

Returns:: Current frames per second for the scene.
(type=int (if prototype is empty))

gammaLevel(level=None)

Get/set the gamma value for blending oversampled images (1.0 = no correction). Unified renderer must be enabled.

Parameters:: level - must be between 0.2 - 5.0
(type=float (optional))

Returns:: Current gamma value for the scene.
(type=float (if prototype is empty))

gaussFilterSize(size=None)

Get/sets the Gauss filter size.

Parameters:: size - must be between 0.5 - 1.5
(type=float (optional))

Returns:: Current gauss filter size for the scene.
(type=float (if prototype is empty))

getBackbufPath()

Get the path to the background image.

Returns:: The path to a background image.
(type=string)

getEdgeColor()

Get the edge color for toon shading.

Returns:: A string representing the edge color.
(type=string)

getFtypePath()

Get the path to the Ftype file

Returns:: Path to FtypeImage type.
(type=string)

getGameFrameColor()

Set the red, green, blue component of the bars.

Returns:: A string representing the color component of the bars.
(type=string)

getRenderPath()

Get the path to where the renderer will write to.

Returns:: Returns the directory that is used to playback and store rendered sequences.
(type=string)

getRenderWinSize()

Get the size of the render window.

Returns:: window size; can be 25, 50, 75 or 100 (percent).
(type=int)

getTimeCode()

Get the current frame as a string in HH:MM:SS:FF format

Returns:: current frame as a string in HH:MM:SS:FF format
(type=string)

imageSizeX(size=None)

Get/set the image width in pixels.

Parameters:: size - must be between 4 - 10000
(type=int (optional))

Returns:: Current image width for the scene.
(type=int (if prototype is empty))

imageSizeY(size=None)

Get/set the image height in pixels.

Parameters:: size - must be between 4 - 10000
(type=int (optional))

Returns:: Current image height for the scene.
(type=int (if prototype is empty))

motionBlurLevel(level=None)

Get/set the length of shutter time for motion blur.

Parameters:: level - must be between 0.01 - 5.0
(type=float (optional))

Returns:: Current MBlur for the scene.
(type=float (if prototype is empty))

newMapValue(value=None)

Get/set specify new map value in frames.

Parameters:: value - must be between 1 - 900
(type=int (optional))

Returns:: Current new map value for the scene.
(type=int (if prototype is empty))

oldMapValue(value=None)

Get/set specify old map value in frames.

Parameters:: value - must be between 1 - 900
(type=int (optional))

Returns:: Current old map value for the scene.
(type=int (if prototype is empty))

partsX(parts=None)

Get/set the number of parts to divide the render in the X direction.

Parameters:: parts - must be between 1 - 64
(type=int (optional))

Returns:: Current number of parts in the X for the scene.
(type=int (if prototype is empty))

partsY(parts=None)

Get/set the number of parts to divide the render in the Y direction.

Parameters:: parts - must be between 1 - 64
(type=int (optional))

Returns:: Current number of parts in the Y for the scene.
(type=int (if prototype is empty))

play()

play animation of rendered images/avi (searches Pics: field).

postProcessAdd(add=None)

Get/set post processing add. Unified renderer must be enabled.

Parameters:: add - must be between -1.0 - 1.0
(type=float (optional))

Returns:: Current processing add value for the scene.
(type=float (if prototype is empty))

postProcessGamma(gamma=None)

Get/set post processing gamma. Unified renderer must be enabled.

Parameters:: gamma - must be between 0.2 - 2.0
(type=float (optional))

Returns:: Current processing gamma value for the scene.
(type=float (if prototype is empty))

postProcessMultiply(mult=None)

Get/set post processing multiply. Unified renderer must be enabled.

Parameters:: mult - must be between 0.01 - 4.0
(type=float (optional))

Returns:: Current processing multiply value for the scene.
(type=float (if prototype is empty))

quality(qual=None)

Get/set quality get/setting for JPEG images, AVI JPEG and SGI movies.

Parameters:: qual - must be between 10 - 100
(type=int (optional))

Returns:: Current image quality for the scene.
(type=int (if prototype is empty))

render()

Render the scene.

renderAnim()

Render a series of frames to an output directory.

saveRenderedImage(filename, zbuffer=0)

Saves the image rendered using RenderData.render() to the filename and path given in the variable 'filename'.

Make sure the filename you provide makes a valid path when added to the "render path" (setRenderPath/getRenderPath) to make up the absolute path. If you want to render to a new absolute path just set the renderpath to an empty string and use the absolute path as the filename.

Parameters:: filename - The path+filename for the rendered image.
(type=string); zbuffer - Whether or not to render the zbuffer along with the image.
(type=int)

Requires: You must have an image currently rendered before calling this method

Since: 2.40

setBackbufPath(path)

Set the path to a background image and load it.

Parameters:: path - The path to a background image for loading.
(type=string)

setBorder(left, bottom, right, top)

Set a border for rendering from cameras in the scene. The left,bottom coordinates and right,top coordinates define the size of the border. (0,0,1,1) will set the border to the whole camera. (0,0) lower left and (1,1) upper right.

Parameters:: left - float between 0 and 1
(type=float); bottom - float between 0 and 1
(type=float); right - float between 0 and 1
(type=float); top - float between 0 and 1
(type=float)

setEdgeColor(red, green, blue)

Set the edge color for toon shading.

Parameters:: red - must be between 0 - 1.0
(type=float); green - must be between 0 - 1.0
(type=float); blue - must be between 0 - 1.0
(type=float)

setFtypePath(path)

Set the path to Ftype file.

Parameters:: path - Path to Ftype Image type.
(type=string)

setGameFrameColor(red, green, blue)

Set the red, green, blue component of the bars.

Parameters:: red - must be between 0 - 1.0
(type=float); green - must be between 0 - 1.0
(type=float); blue - must be between 0 - 1.0
(type=float)

setImageType(type)

Set the type of image to output from the render.

Parameters:

type - must be one of 13 constants:

AVIRAW: Uncompressed AVI files. AVI is a commonly used format on Windows platforms
AVIJPEG: AVI movie w/ JPEG images
AVICODEC: AVI using win32 codec
QUICKTIME: Quicktime movie (if enabled)
TARGA: Targa files
RAWTGA: Raw Targa files
PNG: Png files
BMP: Bitmap files
JPEG90: JPEG files
HAMX: Hamx files
IRIS: Iris files
IRIZ: Iris + z-buffer files
FTYPE: Ftype file

(type=enum constant)

setOversamplingLevel(level)

Set the edge color for toon shading.

Parameters:: level - can be either 5, 8, 11, or 16
(type=int)

setRenderer(type)

Get/set which renderer to render the output.

Parameters:

type - must be one of 2 constants:

INTERN: Blender's internal renderer
YAFRAY: Yafray renderer

(type=enum constant)

setRenderPath(path)

Set the path to where the renderer will write to.

Parameters:: path - A directory for that the renderer searches for both playback and output from the renderAnim function.
(type=string)

setRenderWinSize(size)

Set the size of the render window.

Parameters:: size - can be 25, 50, 75 or 100 (percent).
(type=int)

setYafrayGIMethod(type)

Set yafray global Illumination method.

Parameters:

type - must be one of 3 constants:

NONE: Do not use GI illumination
SKYDOME: Use Skydome method
GIFULL: Use Full method

(type=enum constant)

setYafrayGIQuality(type)

Set yafray global Illumination quality.

Parameters:

type - must be one of 6 constants:

NONE
LOW
MEDIUM
HIGH
HIGHER
BEST

(type=enum constant)

SGIMaxsize(size=None)

Get/set maximum size per frame to save in an SGI movie. SGI must be defined on your machine.

Parameters:: size - must be between 0 - 500
(type=int (optional))

Returns:: Current SGI maximum size per frame for the scene.
(type=int (if prototype is empty))

sizePreset(type)

Set the renderer to one of a few presets.

Parameters:

type - must be one of 8 constants:

PAL: The European video standard: 720 x 576 pixels, 54 x 51 aspect.
FULL: For large screens: 1280 x 1024 pixels.
PREVIEW: For preview rendering: 320 x 256 pixels.
PAL169: Wide-screen PAL.
DEFAULT: Like "PAL", but here the render settings are also set.
PANO: Panorama render.
NTSC: For TV playback.
PC: For standard PC graphics: 640 x 480 pixels.

(type=enum constant)

startFrame(frame=None)

Get/set the starting frame for sequence rendering.

Parameters:: frame - must be between 1 - 18000
(type=int (optional))

Returns:: Current starting frame for the scene.
(type=int (if prototype is empty))

yafrayExposure(expose=None)

Get/set exposure adjustment, 0 is off.

Parameters:: expose - must be between 0 - 10.0
(type=float (optional))

Returns:: Current exposure adjustment for the scene.
(type=float (if prototype is empty))

yafrayGamma(gamma=None)

Get/set gamma correction, 1 is off.

Parameters:: gamma - must be between 0.001 - 5.0
(type=float (optional))

Returns:: Current gamma correction for the scene.
(type=float (if prototype is empty))

yafrayGICDepth(depth=None)

Get/set number of bounces inside objects (for caustics). YafrayMethod must be GIFULL.

Parameters:: depth - must be between 1 - 8
(type=int (optional))

Returns:: Current yafray global illumination inside light bounces for the scene.
(type=int (if prototype is empty))

yafrayGIDepth(depth=None)

Get/set number of bounces of the indirect light. YafrayMethod must be GIFULL.

Parameters:: depth - must be between 1 - 8
(type=int (optional))

Returns:: Current yafray global illumination light bounces for the scene.
(type=int (if prototype is empty))

yafrayGIIndirPower(power=None)

Get/set GI indirect lighting intensity scale.

Parameters:: power - must be between 0.01 - 100.0
(type=float (optional))

Returns:: Current yafray indirect illumination intensity for the scene.
(type=float (if prototype is empty))

yafrayGIPhotonCount(count=None)

Get/set number of photons to shoot. YafrayMethod must be GIFULL and Photons enabled.

Parameters:: count - must be between 0 - 10000000
(type=int (optional))

Returns:: Current number of photons to shoot for the scene.
(type=int (if prototype is empty))

yafrayGIPhotonMixCount(count=None)

Get/set number of photons to keep inside radius. YafrayMethod must be GIFULL and Photons enabled.

Parameters:: count - must be between 0 - 1000
(type=int (optional))

Returns:: Current number of photons to keep inside radius for the scene.
(type=int (if prototype is empty))

yafrayGIPhotonRadius(radius=None)

Get/set radius to search for photons to mix (blur). YafrayMethod must be GIFULL and Photons enabled.

Parameters:: radius - must be between 0.00001 - 100.0
(type=float (optional))

Returns:: Current photon search radius for the scene.
(type=float (if prototype is empty))

yafrayGIPixelsPerSample(pixels=None)

Get/set maximum number of pixels without samples, the lower the better and slower. YafrayMethod must be GIFULL and Cache enabled.

Parameters:: pixels - must be between 1 - 50
(type=int (optional))

Returns:: Current number of pixels without samples for the scene.
(type=int (if prototype is empty))

yafrayGIPower(power=None)

Get/set GI lighting intensity scale. YafrayMethod must be either SKYDOME or GIFULL.

Parameters:: power - must be between 0.01 - 100.0
(type=float (optional))

Returns:: Current yafray global illumination intensity for the scene.
(type=float (if prototype is empty))

yafrayGIRefinement(refine=None)

Get/set threshold to refine shadows EXPERIMENTAL. 1 = no refinement. YafrayMethod must be GIFULL and Cache enabled.

Parameters:: refine - must be between 0.001 - 1.0
(type=float (optional))

Returns:: Current threshold to refine shadows for the scene.
(type=float (if prototype is empty))

yafrayGIShadowQuality(qual=None)

Get/set the shadow quality, keep it under 0.95. YafrayMethod must be GIFULL and Cache enabled.

Parameters:: qual - must be between 0.01 - 1.0
(type=float (optional))

Returns:: Current shadow quality for the scene.
(type=float (if prototype is empty))

yafrayProcessorCount(count=None)

Get/set number of processors to use.

Parameters:: count - must be between 1 - 8
(type=int (optional))

Returns:: Current number of processors for the scene.
(type=int (if prototype is empty))

yafrayRayBias(bias=None)

Get/set shadow ray bias to avoid self shadowing.

Parameters:: bias - must be between 0 - 10.0
(type=float (optional))

Returns:: Current ray bias for the scene.
(type=float (if prototype is empty))

yafrayRayDepth(depth=None)

Get/set maximum render ray depth from the camera.

Parameters:: depth - must be between 1 - 80
(type=int (optional))

Returns:: Current ray depth for the scene.
(type=int (if prototype is empty))

Instance Variable Details

alphaMode

Setting for sky/background. Valid values are 0 (fill background with sky), 1 (multiply alpha in advance), or 2 (alpha and color values remain unchanged).

Type:: int

aspectX

Horizontal aspect ratio. Values are clamped to the range [1,200].

Type:: int

aspectY

Vertical aspect ratio. Values are clamped to the range [1,200].

Type:: int

backbuf

Backbuffer image enabled.

Type:: boolean

backbufPath

Path to a background image (setting loads image).

Type:: string

border

The border for border rendering. The format is [xmin,ymin,xmax,ymax]. Values are clamped to [0.0,1.0].

Type:: list of 4 floats.

borderRender

Small cut-out rendering enabled. Also see BORDER_RENDER in Modes constant dict.

Type:: boolean

cFrame

The current frame for rendering. Values are clamped to the range [1,MAXFRAME].

Type:: int

compositeFree

Free nodes that are not used while composite.

Type:: boolean

compositor

'Do Compositor' enabled.

Type:: boolean

crop

Crop image during border renders. Also see CROP in Modes constant dict.

Type:: boolean

displayMode

Render output in separate window or 3D view. Valid values are 0 (display in image editor view), 1 (display in render window), or 2 (display full screen).

Type:: int

edgeColor

RGB color triplet for edges in Toon shading (unified renderer). Values are clamped in the range [0.0,1.0].

Type:: list of 3 RGB floats

eFrame

Ending frame for rendering. Values are clamped to the range [1,MAXFRAME].

Type:: int

environmentMap

Environment map rendering enabled. Also see ENVMAP in Modes constant dict.

Type:: boolean

extensions

Add extensions to output (when rendering animations). Also see EXTENSION in SceModes constant dict.

Type:: boolean

fieldRendering

Field rendering enabled. Also see FIELDRENDER in Modes constant dict.

Type:: boolean

fieldTimeDisable

Time difference in field calculations disabled.

Type:: int

fps

Frames per second. Values are clamped to the range [1,120].

Type:: int

freeImages

'Do Compositor' enabled.

Type:: boolean

ftypePath

The path to Ftype file.

Type:: string

gameFrame

Game framing type. See FramingModes constant dict.

Type:: int

gameFrameColor

RGB color triplet for bars. Values are clamped in the range [0.0,1.0].

Type:: list of RGB 3 floats

gammaCorrection

Gamma correction enabled. Also see GAMMA in Modes constant dict.

Type:: boolean

gaussFilter

Gauss filter size. Values are clamped to the range [0.5,1.5].

Type:: float

imagePlanes

Image depth in bits. Valid values are 8, 24, or 32.

Type:: int

imageType

File format for saving images. See the module's constants for values.

Type:: int

mapNew

New mapping value (in frames). Values are clamped to the range [1,900].

Type:: int

mapOld

Number of frames the Map Old will last Values are clamped to the range [1,900].

Type:: int

mblurFactor

Motion blur factor. Values are clamped to the range [0.01,5.0].

Type:: float

mode

Mode bitfield. See Modes constant dict for values.

Type:: bitfield

motionBlur

Motion blur enabled. Also see MBLUR in Modes constant dict.

Type:: boolean

oddFieldFirst

Odd field first rendering enabled. Also see ODDFIELD in Modes constant dict.

Type:: boolean

OSALevel

Oversampling (anti-aliasing) level. Valid values are 5, 8, 11, or 16.

Type:: int

oversampling

Oversampling (anti-aliasing) enabled. Also see OSA in Modes constant dict.

Type:: boolean

panorama

Panorama rendering enabled. Also see PANORAMA in Modes constant dict.

Type:: boolean

radiosityRender

Radiosity rendering enabled.

Type:: boolean

rayTracing

Ray tracing enabled. Also see RAYTRACING in Modes constant dict.

Type:: boolean

renderer

Rendering engine choice. Valid values are 0 (internal) or 1 (Yafray).

Type:: int

renderPath

The path to output the rendered images.

Type:: string

renderwinSize

Size of the rendering window. Valid values are 25, 50, 75, or 100.

Type:: int

saveBuffers

Save render buffers to disk while rendering, saves memory.

Type:: boolean

sceneMode

Scene mode bitfield. See SceModes constant dict for values.

Type:: bitfield

sequencer

Enables sequencer output rendering. Also see SEQUENCER in SceModes constant dict.

Type:: boolean

set

The scene linked as a set to this scene. Values are an existing scene or None (setting to None clears the set). The scene argument cannot cause a circular link.

Type:: BPy_Scene or None