Renderer

From SilhouetteFX
Jump to: navigation, search

The RenderDialog can be used to display and edit the RenderInfo of the Session to be rendered, usually to verify settings before rendering with the Renderer. The Render Dialog can not be used from the command-line renderer.

The Renderer executes a rendering loop on a specific Session, using the session's current rendering options.

The Renderer can be subclassed to actions can be taken various points in the rendering process.

>> renderer = Renderer(session)
>> renderer.render()

Attributes

Most attributes are read-only.

Name Description
averageTime the average duration in seconds that a frame takes to render
duration the number of frames to be rendered
elapsedTime time in seconds since rendering was started
lastTime the duration in seconds the last frame took to render
outputNode the Node to be rendered (read/write) - defaults to the Output node
outputPort the Port to be rendered (read/write) - defaults to node's default output port
outputRange the frame range to be rendered, as a tuple (start_frame, end_frame)
remainingTime an estimate in seconds of the time left to finish rendering
session the Session being rendered
writeEnable True if frames should be saved to disk, False to skip saving (useful for testing, read-write)

Methods

These methods are designed to be overridden by subclasses.

Name Description
beginFrame(frame) called before rendering the frame. Return False to cancel the render.
beginRender() called when rendering begins. Return False to cancel the render.
beginStream(stream called before rendering the stream. Return False to cancel the render.
buildPath(frame,
stream=Stream_Left,
type=color|alpha|depth|paint,
alpha=False)
build a path for the specified frame, using the session's render options
endFrame(frame) called after rendering the frame
endRender() called when rendering ends
endStream(stream) called after rendering the stream
error(text) called to report an error message
message(text) called to report status information
processRaster(raster) called to perform post-processing on the Raster
progress(frame) called before each frame to indicate progress. Return False to cancel the render.
render() render the session's output range. Returns False if canceled.
render(frame) render the specified frame. Returns False if canceled.
render(start, end) render the specified range of frames. Returns False if canceled.
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox