Module Render

Module Render

The Blender.Scene.Render submodule.

Scene.Render

This module provides access to Scene Rendering Contexts in Blender.

Example:

 import Blender
 from Blender import *
 from Blender.Scene import Render
 
 scn = Scene.GetCurrent()
 context = scn.getRenderingContext()
 
 Render.EnableDispWin()
 context.extensions = True
 context.renderPath = "//myRenderdir/"
 context.sizePreset(Render.PC)
 context.imageType = Render.AVIRAW
 context.sFrame = 2
 context.eFrame = 10
 context.renderAnim()
 
 context.imageType = Render.TARGA
 context.fps = 15
 context.sFrame = 15
 context.eFrame = 22
 context.renderAnim()
 
 Render.CloseRenderWindow()
 print context.fps
 print context.cFrame

Classes
`RenderData`	This object gives access to Scene rendering contexts in Blender.

Function Summary
	`CloseRenderWindow()` Closes the rendering window.
	`EnableDispView()` Render in the 3d View area.
	`EnableDispWin()` Render in Render window.
	`EnableEdgeAll()` Globally consider transparent faces for edge-rendering with the unified renderer.
	`EnableEdgeShift()` Globally with the unified renderer enabled the outlines of the render are shifted a bit.
	`SetRenderWinPos(locationList)` Set the position of the Render window on the screen.

Variable Summary
readonly dictionary	`FramingModes`: Constant dict used for with `RenderData.gameFrame` attribute.
readonly dictionary	`Modes`: Constant dict used for with `RenderData.mode` bitfield attribute.
readonly dictionary	`SceModes`: Constant dict used for with `RenderData.sceneMode` bitfield attribute.

Function Details

CloseRenderWindow()

Closes the rendering window.

EnableDispView()

Render in the 3d View area. Note this method is deprecated; use the l{displayMode} attribute instead.

EnableDispWin()

Render in Render window. Note this method is deprecated; use the l{displayMode} attribute instead.

EnableEdgeAll()

Globally consider transparent faces for edge-rendering with the unified renderer.

EnableEdgeShift()

Globally with the unified renderer enabled the outlines of the render are shifted a bit.

SetRenderWinPos(locationList)

Set the position of the Render window on the screen. Possible values are:

S = south
N = north
W = west
E = east
C = center
ne = northeast
nw = northwest
se = southeast
sw = southwest

Parameters:: locationList - a list of strings that together define the location of the Render window on the screen.
(type=PyList of strings)

Variable Details

FramingModes

Constant dict used for with RenderData.gameFrame attribute. One of the following modes can be active:

BARS: Show the entire viewport in the display window, using bar horizontally or vertically.
EXTEND: Show the entire viewport in the display window, viewing more horizontally or vertically
SCALE: Stretch or squeeze the viewport to fill the display window.

Type:: readonly dictionary

Modes

Constant dict used for with RenderData.mode bitfield attribute. Values can be ORed together. Individual bits can also be set/cleared with boolean attributes.

OSA: Oversampling (anti-aliasing) enabled
SHADOW: Shadow calculation enabled
GAMMA: Gamma correction enabled
ENVMAP: Environment map rendering enabled
TOONSHADING: Toon edge shading enabled
FIELDRENDER: Field rendering enabled
FIELDTIME: Time difference in field calculations disabled
RADIOSITY: Radiosity rendering enabled
BORDER_RENDER: Small cut-out rendering enabled
PANORAMA: Panorama rendering enabled
CROP: Crop image during border renders
ODDFIELD: Odd field first rendering enabled
MBLUR: Motion blur enabled
UNIFIED: Unified Renderer enabled
RAYTRACING: Ray tracing enabled
THREADS: Render in two threads enabled

Type:: readonly dictionary

SceModes

Constant dict used for with RenderData.sceneMode bitfield attribute. Values can be ORed together. Individual bits can also be set/cleared with boolean attributes.

SEQUENCER: Enables sequencer output rendering.
EXTENSION: Adds extensions to the output when rendering animations.

Type:: readonly dictionary

Generated by Epydoc 2.1 on Thu Jul 13 16:50:06 2006

http://epydoc.sf.net