Home       Trees       Indices       Help   
Blender
Module Render :: Class RenderData

Class RenderData

source code

The RenderData object

This object gives access to Scene rendering contexts in Blender.

Instance Methods
int (if prototype is empty)
currentFrame(frame=None)
Get/set the current frame.		 source code
 
render()
Render the scene.		 source code
 
bake()
Bake selected objects in the scene.		 source code
 
renderAnim()
Render a series of frames to an output directory.		 source code
 
saveRenderedImage(filename, zbuffer=0)
Saves the image rendered using RenderData.render() to the filename and path given in the variable 'filename'.		 source code
 
play()
play animation of rendered images/avi (searches Pics: field).		 source code
string
getTimeCode()
Get the current frame as a string in HH:MM:SS:FF format		 source code
 
setRenderPath(path)
Set the path to where the renderer will write to.		 source code
string
getRenderPath()
Get the path to where the renderer will write to.		 source code
string
getFrameFilename(frame)
Get the filename used for the remdered image.		 source code
 
setBackbufPath(path)
Set the path to a background image and load it.		 source code
string
getBackbufPath()
Get the path to the background image.		 source code
 
enableBackbuf(toggle)
Enable/disable the backbuf image.		 source code
 
setFtypePath(path)
Set the path to Ftype file.		 source code
string
getFtypePath()
Get the path to the Ftype file		 source code
 
enableExtensions(toggle)
Enable/disable windows extensions for output files.		 source code
 
enableSequencer(toggle)
Enable/disable Do Sequence.		 source code
 
enableRenderDaemon(toggle)
Enable/disable Scene daemon.		 source code
 
enableToonShading(toggle)
Enable/disable Edge rendering.		 source code
int (if prototype is empty)
edgeIntensity(intensity=None)
Get/set edge intensity for toon shading.		 source code
 
setEdgeColor(red, green, blue)
Set the edge color for toon shading.		 source code
string
getEdgeColor()
Get the edge color for toon shading.		 source code
int (if prototype is empty)
edgeAntiShift(intensity=None)
With the unified renderer, reduce intensity on boundaries.		 source code
 
enableOversampling(toggle)
Enable/disable oversampling (anti-aliasing).		 source code
 
setOversamplingLevel(level)
Set the level of over-sampling (anti-aliasing).		 source code
 
enableMotionBlur(toggle)
Enable/disable MBlur.		 source code
float (if prototype is empty)
motionBlurLevel(level=None)
Get/set the length of shutter time for motion blur.		 source code
int (if prototype is empty)
partsX(parts=None)
Get/set the number of parts to divide the render in the X direction.		 source code
int (if prototype is empty)
partsY(parts=None)
Get/set the number of parts to divide the render in the Y direction.		 source code
 
enableSky()
Enable render background with sky.		 source code
 
enablePremultiply()
Enable premultiply alpha.		 source code
 
enableKey()
Enable alpha and color values remain unchanged.		 source code
 
enableShadow(toggle)
Enable/disable shadow calculation.		 source code
 
enableEnvironmentMap(toggle)
Enable/disable environment map rendering.		 source code
 
enableRayTracing(toggle)
Enable/disable ray tracing.		 source code
 
enableRadiosityRender(toggle)
Enable/disable radiosity rendering.		 source code
 
enablePanorama(toggle)
Enable/disable panorama rendering (output width is multiplied by Xparts).		 source code
 
setRenderWinSize(size)
Set the size of the render window.		 source code
int
getRenderWinSize()
Get the size of the render window.		 source code
 
enableFieldRendering(toggle)
Enable/disable field rendering		 source code
 
enableOddFieldFirst(toggle)
Enable/disable Odd field first rendering (Default: Even field).		 source code
 
enableFieldTimeDisable(toggle)
Enable/disable time difference in field calculations.		 source code
 
enableGaussFilter(toggle)
Enable/disable Gauss sampling filter for anti-aliasing.		 source code
 
enableBorderRender(toggle)
Enable/disable small cut-out rendering.		 source code
 
setBorder(left, bottom, right, top)
Set a border for rendering from cameras in the scene.		 source code
 
enableGammaCorrection(toggle)
Enable/disable gamma correction.		 source code
float (if prototype is empty)
gaussFilterSize(size=None)
Get/sets the Gauss filter size.		 source code
int (if prototype is empty)
startFrame(frame=None)
Get/set the starting frame for sequence rendering.		 source code
int (if prototype is empty)
endFrame(frame=None)
Get/set the ending frame for sequence rendering.		 source code
int (if prototype is empty)
imageSizeX(size=None)
Get/set the image width in pixels.		 source code
int (if prototype is empty)
imageSizeY(size=None)
Get/set the image height in pixels.		 source code
int (if prototype is empty)
aspectRatioX(ratio=None)
Get/set the horizontal aspect ratio.		 source code
int (if prototype is empty)
aspectRatioY(ratio=None)
Get/set the vertical aspect ratio.		 source code
 
setRenderer(type)
Get/set which renderer to render the output.		 source code
 
enableCropping(toggle)
Enable/disable exclusion of border rendering from total image.		 source code
 
setImageType(type)
Set the type of image to output from the render.		 source code
int (if prototype is empty)
quality(qual=None)
Get/set quality get/setting for JPEG images, AVI JPEG and SGI movies.		 source code
int (if prototype is empty)
framesPerSec(qual=None)
Get/set frames per second.		 source code
 
enableGrayscale()
Images are saved with black and white (grayscale) data.		 source code
 
enableRGBColor()
Images are saved with RGB (color) data.		 source code
 
enableRGBAColor()
Images are saved with RGB and Alpha data (if supported).		 source code
 
sizePreset(type)
Set the renderer to one of a few presets.		 source code
 
enableUnifiedRenderer(toggle)
Use the unified renderer.		 source code
 
setYafrayGIQuality(type)
Set yafray global Illumination quality.		 source code
enum constant
getYafrayGIQuality()
Get yafray global Illumination quality.		 source code
 
setYafrayGIMethod(type)
Set yafray global Illumination method.		 source code
enum constant -
getYafrayGIMethod()
Get yafray global Illumination method.		 source code
float (if prototype is empty)
yafrayGIPower(power=None)
Get/set GI lighting intensity scale.		 source code
float (if prototype is empty)
yafrayGIIndirPower(power=None)
Get/set GI indirect lighting intensity scale.		 source code
int (if prototype is empty)
yafrayGIDepth(depth=None)
Get/set number of bounces of the indirect light.		 source code
int (if prototype is empty)
yafrayGICDepth(depth=None)
Get/set number of bounces inside objects (for caustics).		 source code
 
enableYafrayGICache(toggle)
Enable/disable cache irradiance samples (faster).		 source code
 
enableYafrayGIPhotons(toggle)
Enable/disable use of global photons to help in GI.		 source code
int (if prototype is empty)
yafrayGIPhotonCount(count=None)
Get/set number of photons to shoot.		 source code
float (if prototype is empty)
yafrayGIPhotonRadius(radius=None)
Get/set radius to search for photons to mix (blur).		 source code
int (if prototype is empty)
yafrayGIPhotonMixCount(count=None)
Get/set number of photons to keep inside radius.		 source code
 
enableYafrayGITunePhotons(toggle)
Enable/disable show the photon map directly in the render for tuning.		 source code
float (if prototype is empty)
yafrayGIShadowQuality(qual=None)
Get/set the shadow quality, keep it under 0.95.		 source code
int (if prototype is empty)
yafrayGIPixelsPerSample(pixels=None)
Get/set maximum number of pixels without samples, the lower the better and slower.		 source code
 
enableYafrayGIGradient(toggle)
Enable/disable try to smooth lighting using a gradient.		 source code
float (if prototype is empty)
yafrayGIRefinement(refine=None)
Get/set threshold to refine shadows EXPERIMENTAL.		 source code
float (if prototype is empty)
yafrayRayBias(bias=None)
Get/set shadow ray bias to avoid self shadowing.		 source code
int (if prototype is empty)
yafrayRayDepth(depth=None)
Get/set maximum render ray depth from the camera.		 source code
float (if prototype is empty)
yafrayGamma(gamma=None)
Get/set gamma correction, 1 is off.		 source code
float (if prototype is empty)
yafrayExposure(expose=None)
Get/set exposure adjustment, 0 is off.		 source code
 
enableGameFrameStretch()
Enable stretch or squeeze the viewport to fill the display window.		 source code
 
enableGameFrameExpose()
Enable show the entire viewport in the display window, viewing more horizontally or vertically.		 source code
 
enableGameFrameBars()
Enable show the entire viewport in the display window, using bar horizontally or vertically.		 source code
 
setGameFrameColor(red, green, blue)
Set the red, green, blue component of the bars.		 source code
string
getGameFrameColor()
Set the red, green, blue component of the bars.		 source code
float (if prototype is empty)
gammaLevel(level=None)
Get/set the gamma value for blending oversampled images (1.0 = no correction).		 source code
float (if prototype is empty)
postProcessAdd(add=None)
Get/set post processing add.		 source code
float (if prototype is empty)
postProcessMultiply(mult=None)
Get/set post processing multiply.		 source code
float (if prototype is empty)
postProcessGamma(gamma=None)
Get/set post processing gamma.		 source code
int (if prototype is empty)
SGIMaxsize(size=None)
Get/set maximum size per frame to save in an SGI movie.		 source code
 
enableSGICosmo(toggle)
Enable/disable attempt to save SGI movies using Cosmo hardware SGI must be defined on your machine.		 source code
int (if prototype is empty)
oldMapValue(value=None)
Get/set specify old map value in frames.		 source code
int (if prototype is empty)
newMapValue(value=None)
Get/set specify new map value in frames.		 source code
Instance Variables
int OSALevel
Oversampling (anti-aliasing) level.
int activeLayer
The active render layer.
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).
float bakeBias
The distance in blender units to bias faces further away from the object.
bool bakeClear
When enabled, baking clears the image first.
float bakeDist
The distance in blender units to use when bakeToActive is enabled and geomtry does not overlap.
int bakeMargin
The pixel distance to extend baked pixels past the boundry (reduces bleeding when mipmapping)
int bakeMode
The method used when baking, see BakeModes.
int bakeNormalSpace
The method used when baking, see BakeNormalSpaceModes.
bool bakeNormalize
Normalize AO and displacement to the range of the distance value.
bool bakeToActive
When enabled, selected objects are baked onto the active object.
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.
int eFrame
Ending frame for rendering.
list of 3 RGB floats edgeColor
RGB color triplet for edges in Toon shading (unified renderer).
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.
  fps
Frames per second.
float fpsBase
Frames per second base: used to generate fractional frames per second values.
boolean freeImages
Texture images are freed after render.
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.
bool halfFloat
When enabled use 16bit floats rather then 32bit for OpenEXR files.
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.
bool noOverwrite
Skip rendering frames when the file exists.
boolean oddFieldFirst
Odd field first rendering enabled.
boolean oversampling
Oversampling (anti-aliasing) enabled.
boolean panorama
Panorama rendering enabled.
bool preview
When enabled, save a preview jpeg with an OpenEXR file
boolean radiosityRender
Radiosity rendering enabled.
boolean rayTracing
Ray tracing enabled.
string renderPath
The path to output the rendered images.
int renderer
Rendering engine choice.
int renderwinSize
Size of the rendering window.
int sFrame
Starting frame for rendering.
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.
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.
bool touch
Create an empty file before rendering it.
boolean unified
Unified Renderer enabled.
int xParts
Number of horizontal parts for image render.
int yParts
Number of vertical parts for image render.
int [0, 64] yafrayAntiAliasingPasses
Number of anti-aliasing passes (0 is no Anti-Aliasing).
float [1.0, 2.0] yafrayAntiAliasingPixelSize
Anti-aliasing pixel filter size.
int [0, 2048] yafrayAntiAliasingSamples
Number of samples per pass.
float [0.05, 1.0] yafrayAntiAliasingThreshold
Anti-aliasing threshold.
boolean yafrayAutoAntiAliasing
Automatic anti-aliasing enabled/disabled.
boolean yafrayClampRGB
Clamp RGB enabled/disabled.
boolean yafrayExportToXML
If true export to an xml file and call yafray instead of plugin.
boolean yafrayGICache
Cache occlusion/irradiance samples (faster).
boolean yafrayGICacheBumpNormals
Enable/disable bumpnormals for cache.
int [1, 50] yafrayGICachePixelsPerSample
Maximum number of pixels without samples, the lower the better and slower.
float [0.001, 1.0] yafrayGICacheRefinement
Threshold to refine shadows EXPERIMENTAL.
float [0.01, 1.0] yafrayGICacheShadowQuality
Shadow quality, keep it under 0.95 :-).
int {NONE (0), SKYDOME (1), GIFULL (2)} yafrayGIMethod
Global Illumination method.
boolean yafrayGIPhotons
Enable/disable use of global photons to help in GI.
int {NONE (0), LOW (1), MEDIUM (2), HIGH (3), HIGHER (4), BEST (5), USEAOSETTINGS (6)} yafrayGIQuality
Global Illumination quality.
boolean yafrayGITunePhotons
If true the photonmap is shown directly in the render for tuning.
bool zbuf
When enabled, save the zbuffer with an OpenEXR file
Method Details

currentFrame(frame=None)

source code 
Get/set the current frame.
Parameters:
  • frame (int (optional)) - must be between 1 - 30000
Returns: int (if prototype is empty)
Current frame for the scene.

saveRenderedImage(filename, zbuffer=0)

source code 

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 (string) - The path+filename for the rendered image.
  • zbuffer (int) - Whether or not to render the zbuffer along with the image.

Since: 2.40

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

Warning: This wont work in background mode. use renderAnim instead.

getTimeCode()

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

setRenderPath(path)

source code 
Set the path to where the renderer will write to.
Parameters:
  • path (string) - A directory for that the renderer searches for both playback and output from the renderAnim function.

getRenderPath()

source code 
Get the path to where the renderer will write to.
Returns: string
Returns the directory that is used to playback and store rendered sequences.

getFrameFilename(frame)

source code 
Get the filename used for the remdered image.
Parameters:
  • frame (int) - the frame to use in the filename, if no argument given, use the current frame.
Returns: string
Returns the filename that blender would render to, taking into account output path, extension and frame number.

setBackbufPath(path)

source code 
Set the path to a background image and load it.
Parameters:
  • path (string) - The path to a background image for loading.

getBackbufPath()

source code 
Get the path to the background image.
Returns: string
The path to a background image.

enableBackbuf(toggle)

source code 
Enable/disable the backbuf image.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

setFtypePath(path)

source code 
Set the path to Ftype file.
Parameters:
  • path (string) - Path to Ftype Image type.

getFtypePath()

source code 
Get the path to the Ftype file
Returns: string
Path to FtypeImage type.

enableExtensions(toggle)

source code 
Enable/disable windows extensions for output files.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

enableSequencer(toggle)

source code 
Enable/disable Do Sequence.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

enableRenderDaemon(toggle)

source code 
Enable/disable Scene daemon.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

enableToonShading(toggle)

source code 
Enable/disable Edge rendering.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

edgeIntensity(intensity=None)

source code 
Get/set edge intensity for toon shading.
Parameters:
  • intensity (int (optional)) - must be between 0 - 255
Returns: int (if prototype is empty)
Current edge intensity for the scene.

setEdgeColor(red, green, blue)

source code 
Set the edge color for toon shading.
Parameters:
  • red (float) - must be between 0 - 1.0
  • green (float) - must be between 0 - 1.0
  • blue (float) - must be between 0 - 1.0

getEdgeColor()

source code 
Get the edge color for toon shading.
Returns: string
A string representing the edge color.

edgeAntiShift(intensity=None)

source code 
With the unified renderer, reduce intensity on boundaries.
Parameters:
  • intensity (int (optional)) - must be between 0 - 255
Returns: int (if prototype is empty)
Current edge antishift for the scene.

enableOversampling(toggle)

source code 
Enable/disable oversampling (anti-aliasing).
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

setOversamplingLevel(level)

source code 
Set the level of over-sampling (anti-aliasing).
Parameters:
  • level (int) - can be either 5, 8, 11, or 16

enableMotionBlur(toggle)

source code 
Enable/disable MBlur.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

motionBlurLevel(level=None)

source code 
Get/set the length of shutter time for motion blur.
Parameters:
  • level (float (optional)) - must be between 0.01 - 5.0
Returns: float (if prototype is empty)
Current MBlur for the scene.

partsX(parts=None)

source code 
Get/set the number of parts to divide the render in the X direction.
Parameters:
  • parts (int (optional)) - must be between 1 - 64
Returns: int (if prototype is empty)
Current number of parts in the X for the scene.

partsY(parts=None)

source code 
Get/set the number of parts to divide the render in the Y direction.
Parameters:
  • parts (int (optional)) - must be between 1 - 64
Returns: int (if prototype is empty)
Current number of parts in the Y for the scene.

enableShadow(toggle)

source code 
Enable/disable shadow calculation.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

enableEnvironmentMap(toggle)

source code 
Enable/disable environment map rendering.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

enableRayTracing(toggle)

source code 
Enable/disable ray tracing.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

enableRadiosityRender(toggle)

source code 
Enable/disable radiosity rendering.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

enablePanorama(toggle)

source code 
Enable/disable panorama rendering (output width is multiplied by Xparts).
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

setRenderWinSize(size)

source code 
Set the size of the render window.
Parameters:
  • size (int) - can be 25, 50, 75 or 100 (percent).

getRenderWinSize()

source code 
Get the size of the render window.
Returns: int
window size; can be 25, 50, 75 or 100 (percent).

enableFieldRendering(toggle)

source code 
Enable/disable field rendering
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

enableOddFieldFirst(toggle)

source code 
Enable/disable Odd field first rendering (Default: Even field).
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

enableFieldTimeDisable(toggle)

source code 
Enable/disable time difference in field calculations.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

enableGaussFilter(toggle)

source code 
Enable/disable Gauss sampling filter for anti-aliasing.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

enableBorderRender(toggle)

source code 
Enable/disable small cut-out rendering.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

setBorder(left, bottom, right, top)

source code 
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) - float between 0 and 1
  • right (float) - float between 0 and 1
  • bottom (float) - float between 0 and 1
  • top (float) - float between 0 and 1

enableGammaCorrection(toggle)

source code 
Enable/disable gamma correction.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

gaussFilterSize(size=None)

source code 
Get/sets the Gauss filter size.
Parameters:
  • size (float (optional)) - must be between 0.5 - 1.5
Returns: float (if prototype is empty)
Current gauss filter size for the scene.

startFrame(frame=None)

source code 
Get/set the starting frame for sequence rendering.
Parameters:
  • frame (int (optional)) - must be between 1 - 18000
Returns: int (if prototype is empty)
Current starting frame for the scene.

endFrame(frame=None)

source code 
Get/set the ending frame for sequence rendering.
Parameters:
  • frame (int (optional)) - must be between 1 - 18000
Returns: int (if prototype is empty)
Current ending frame for the scene.

imageSizeX(size=None)

source code 
Get/set the image width in pixels.
Parameters:
  • size (int (optional)) - must be between 4 - 10000
Returns: int (if prototype is empty)
Current image width for the scene.

imageSizeY(size=None)

source code 
Get/set the image height in pixels.
Parameters:
  • size (int (optional)) - must be between 4 - 10000
Returns: int (if prototype is empty)
Current image height for the scene.

aspectRatioX(ratio=None)

source code 
Get/set the horizontal aspect ratio.
Parameters:
  • ratio (int (optional)) - must be between 1 - 200
Returns: int (if prototype is empty)
Current horizontal aspect ratio for the scene.

aspectRatioY(ratio=None)

source code 
Get/set the vertical aspect ratio.
Parameters:
  • ratio (int (optional)) - must be between 1 - 200
Returns: int (if prototype is empty)
Current vertical aspect ratio for the scene.

setRenderer(type)

source code 
Get/set which renderer to render the output.
Parameters:
  • type (enum constant) - must be one of 2 constants:
    • INTERN: Blender's internal renderer
    • YAFRAY: Yafray renderer

enableCropping(toggle)

source code 
Enable/disable exclusion of border rendering from total image.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

setImageType(type)

source code 
Set the type of image to output from the render.
Parameters:
  • type (enum constant) - 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

quality(qual=None)

source code 
Get/set quality get/setting for JPEG images, AVI JPEG and SGI movies.
Parameters:
  • qual (int (optional)) - must be between 10 - 100
Returns: int (if prototype is empty)
Current image quality for the scene.

framesPerSec(qual=None)

source code 
Get/set frames per second.
Parameters:
  • qual (int (optional)) - must be between 1 - 120
Returns: int (if prototype is empty)
Current frames per second for the scene.

sizePreset(type)

source code 
Set the renderer to one of a few presets.
Parameters:
  • type (enum constant) - 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.

enableUnifiedRenderer(toggle)

source code 
Use the unified renderer.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

setYafrayGIQuality(type)

source code 
Set yafray global Illumination quality.
Parameters:
  • type (enum constant) - must be one of 6 constants:
    • NONE
    • LOW
    • MEDIUM
    • HIGH
    • HIGHER
    • BEST
    • USEAOSETTINGS

getYafrayGIQuality()

source code 
Get yafray global Illumination quality.
Returns: enum constant
one of 6 constants:
  • NONE
  • LOW
  • MEDIUM
  • HIGH
  • HIGHER
  • BEST
  • USEAOSETTINGS

setYafrayGIMethod(type)

source code 
Set yafray global Illumination method.
Parameters:
  • type (enum constant) - must be one of 3 constants:
    • NONE: Do not use GI illumination
    • SKYDOME: Use Skydome method
    • GIFULL: Use Full method

getYafrayGIMethod()

source code 
Get yafray global Illumination method.
Returns: enum constant -
Current yafray global illumination method:
  • NONE: Do not use GI illumination
  • SKYDOME: Use Skydome method
  • GIFULL: Use Full method

yafrayGIPower(power=None)

source code 
Get/set GI lighting intensity scale. YafrayMethod must be either SKYDOME or GIFULL.
Parameters:
  • power (float (optional)) - must be between 0.01 - 100.0
Returns: float (if prototype is empty)
Current yafray global illumination intensity for the scene.

yafrayGIIndirPower(power=None)

source code 
Get/set GI indirect lighting intensity scale.
Parameters:
  • power (float (optional)) - must be between 0.01 - 100.0
Returns: float (if prototype is empty)
Current yafray indirect illumination intensity for the scene.

yafrayGIDepth(depth=None)

source code 
Get/set number of bounces of the indirect light. YafrayMethod must be GIFULL.
Parameters:
  • depth (int (optional)) - must be between 1 - 8
Returns: int (if prototype is empty)
Current yafray global illumination light bounces for the scene.

yafrayGICDepth(depth=None)

source code 
Get/set number of bounces inside objects (for caustics). YafrayMethod must be GIFULL.
Parameters:
  • depth (int (optional)) - must be between 1 - 8
Returns: int (if prototype is empty)
Current yafray global illumination inside light bounces for the scene.

enableYafrayGICache(toggle)

source code 
Enable/disable cache irradiance samples (faster). YafrayMethod must be GIFULL.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

enableYafrayGIPhotons(toggle)

source code 
Enable/disable use of global photons to help in GI. YafrayMethod must be GIFULL.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

yafrayGIPhotonCount(count=None)

source code 
Get/set number of photons to shoot. YafrayMethod must be GIFULL and Photons enabled.
Parameters:
  • count (int (optional)) - must be between 0 - 10000000
Returns: int (if prototype is empty)
Current number of photons to shoot for the scene.

yafrayGIPhotonRadius(radius=None)

source code 
Get/set radius to search for photons to mix (blur). YafrayMethod must be GIFULL and Photons enabled.
Parameters:
  • radius (float (optional)) - must be between 0.00001 - 100.0
Returns: float (if prototype is empty)
Current photon search radius for the scene.

yafrayGIPhotonMixCount(count=None)

source code 
Get/set number of photons to keep inside radius. YafrayMethod must be GIFULL and Photons enabled.
Parameters:
  • count (int (optional)) - must be between 0 - 1000
Returns: int (if prototype is empty)
Current number of photons to keep inside radius for the scene.

enableYafrayGITunePhotons(toggle)

source code 
Enable/disable show the photon map directly in the render for tuning. YafrayMethod must be GIFULL and Photons enabled.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

yafrayGIShadowQuality(qual=None)

source code 
Get/set the shadow quality, keep it under 0.95. YafrayMethod must be GIFULL and Cache enabled.
Parameters:
  • qual (float (optional)) - must be between 0.01 - 1.0
Returns: float (if prototype is empty)
Current shadow quality for the scene.

yafrayGIPixelsPerSample(pixels=None)

source code 
Get/set maximum number of pixels without samples, the lower the better and slower. YafrayMethod must be GIFULL and Cache enabled.
Parameters:
  • pixels (int (optional)) - must be between 1 - 50
Returns: int (if prototype is empty)
Current number of pixels without samples for the scene.

enableYafrayGIGradient(toggle)

source code 
Enable/disable try to smooth lighting using a gradient. YafrayMethod must be GIFULL and Cache enabled.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

yafrayGIRefinement(refine=None)

source code 
Get/set threshold to refine shadows EXPERIMENTAL. 1 = no refinement. YafrayMethod must be GIFULL and Cache enabled.
Parameters:
  • refine (float (optional)) - must be between 0.001 - 1.0
Returns: float (if prototype is empty)
Current threshold to refine shadows for the scene.

yafrayRayBias(bias=None)

source code 
Get/set shadow ray bias to avoid self shadowing.
Parameters:
  • bias (float (optional)) - must be between 0 - 10.0
Returns: float (if prototype is empty)
Current ray bias for the scene.

yafrayRayDepth(depth=None)

source code 
Get/set maximum render ray depth from the camera.
Parameters:
  • depth (int (optional)) - must be between 1 - 80
Returns: int (if prototype is empty)
Current ray depth for the scene.

yafrayGamma(gamma=None)

source code 
Get/set gamma correction, 1 is off.
Parameters:
  • gamma (float (optional)) - must be between 0.001 - 5.0
Returns: float (if prototype is empty)
Current gamma correction for the scene.

yafrayExposure(expose=None)

source code 
Get/set exposure adjustment, 0 is off.
Parameters:
  • expose (float (optional)) - must be between 0 - 10.0
Returns: float (if prototype is empty)
Current exposure adjustment for the scene.

setGameFrameColor(red, green, blue)

source code 
Set the red, green, blue component of the bars.
Parameters:
  • red (float) - must be between 0 - 1.0
  • green (float) - must be between 0 - 1.0
  • blue (float) - must be between 0 - 1.0

getGameFrameColor()

source code 
Set the red, green, blue component of the bars.
Returns: string
A string representing the color component of the bars.

gammaLevel(level=None)

source code 
Get/set the gamma value for blending oversampled images (1.0 = no correction). Unified renderer must be enabled.
Parameters:
  • level (float (optional)) - must be between 0.2 - 5.0
Returns: float (if prototype is empty)
Current gamma value for the scene.

postProcessAdd(add=None)

source code 
Get/set post processing add. Unified renderer must be enabled.
Parameters:
  • add (float (optional)) - must be between -1.0 - 1.0
Returns: float (if prototype is empty)
Current processing add value for the scene.

postProcessMultiply(mult=None)

source code 
Get/set post processing multiply. Unified renderer must be enabled.
Parameters:
  • mult (float (optional)) - must be between 0.01 - 4.0
Returns: float (if prototype is empty)
Current processing multiply value for the scene.

postProcessGamma(gamma=None)

source code 
Get/set post processing gamma. Unified renderer must be enabled.
Parameters:
  • gamma (float (optional)) - must be between 0.2 - 2.0
Returns: float (if prototype is empty)
Current processing gamma value for the scene.

SGIMaxsize(size=None)

source code 
Get/set maximum size per frame to save in an SGI movie. SGI must be defined on your machine.
Parameters:
  • size (int (optional)) - must be between 0 - 500
Returns: int (if prototype is empty)
Current SGI maximum size per frame for the scene.

enableSGICosmo(toggle)

source code 
Enable/disable attempt to save SGI movies using Cosmo hardware SGI must be defined on your machine.
Parameters:
  • toggle (int) - pass 1 for on / 0 for off

oldMapValue(value=None)

source code 
Get/set specify old map value in frames.
Parameters:
  • value (int (optional)) - must be between 1 - 900
Returns: int (if prototype is empty)
Current old map value for the scene.

newMapValue(value=None)

source code 
Get/set specify new map value in frames.
Parameters:
  • value (int (optional)) - must be between 1 - 900
Returns: int (if prototype is empty)
Current new map value for the scene.

Instance Variable Details

OSALevel

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

activeLayer

The active render layer. Must be in range[0,num render layers-1]
Type:
int

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

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

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

eFrame

Ending frame for rendering. Values are clamped to the range [1,MAXFRAME].
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

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

fps

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

fpsBase

Frames per second base: used to generate fractional frames per second values. For example, setting fps to 30 and fps_base to 1.001 will approximate the NTSC frame rate of 29.97 fps. Values are clamped to the range [1,120].
Type:
float

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

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

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

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

renderwinSize

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

sFrame

Starting frame for rendering. Values are clamped to the range [1,MAXFRAME].
Type:
int

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

shadow

Shadow calculation enabled. Also see SHADOW in Modes constant dict.
Type:
boolean

sizeX

Image width (in pixels). Values are clamped to the range [4,10000].
Type:
int

sizeY

Image height (in pixels). Values are clamped to the range [4,10000].
Type:
int

timeCode

Get the current frame in HH:MM:SS:FF format. Read-only.
Type:
string

toonShading

Toon edge shading enabled. Also see TOONSHADING in Modes constant dict.
Type:
boolean

unified

Unified Renderer enabled. Also see UNIFIED in Modes constant dict.
Type:
boolean

xParts

Number of horizontal parts for image render. Values are clamped to the range [2,512].
Type:
int

yParts

Number of vertical parts for image render. Values are clamped to the range [2,512].
Type:
int

yafrayGICacheRefinement

Threshold to refine shadows EXPERIMENTAL. 1 = no refinement.
Type:
float [0.001, 1.0]

yafrayGIMethod

Global Illumination method. Valid values are NONE (0), SKYDOME (1) or FULL (2).
Type:
int {NONE (0), SKYDOME (1), GIFULL (2)}

   Home       Trees       Indices       Help   
Blender
Generated by Epydoc 3.0beta1 on Mon May 19 15:32:21 2008 http://epydoc.sourceforge.net