The Begin Sequence Render Action

The Begin Sequence Render Action
Prev	Chapter 13. Actions Passed to An Image Effect	Next

	#include "ofxImageEffect.h"
	#define kOfxImageEffectActionBeginSequenceRender   "OfxImageEffectActionBeginSequenceRender"

Arguments

handle handle to the instance, cast to an OfxImageEffectHandle ,
inArgs has the following properties...
- kOfxImageEffectPropFrameRange - the range of frames (inclusive) that will be renderred,
- kOfxImageEffectPropFrameStep - what is the step between frames, generally set to 1 (for full frame renders) or 0.5 (for fielded renders),
- kOfxPropIsInteractive - is this a single frame render due to user interaction in a GUI, or a proper full sequence render.
- kOfxImageEffectPropRenderScale - the scale factor to apply to images for this call
- kOfxImageEffectPropSequentialRenderStatus - whether the effect is currently being rendered in strict frame order on a single instance
- kOfxImageEffectPropInteractiveRenderStatus - if the render is in response to a user modifying the effect in an interactive session
outArgs is redundant and is set to NULL.

Description

This action is passed to an image effect before it renders a range of frames. It is there to allow an effect to set things up for a long sequence of frames. Note that this is still called, even if only a single frame is being rendered in an interactive environment.

Preconditions

kOfxActionCreateInstance has been called on the instance

Postconditions

kOfxImageEffectActionRender action will be called at least once on the instance
kOfxImageEffectActionEndSequenceRender action will be called on the instance

Return Values

kOfxStatOK, the action was trapped and handled cleanly by the effect,
kOfxStatReplyDefault, the action was not trapped, but all is well anyway,
kOfxStatErrMemory, in which case the action may be called again after a memory purge,
kOfxStatFailed, something wrong, but no error code appropriate, plugin to post message,
kOfxStatErrFatal

Prev	Up	Next
The Render Action	Home	The End Sequence Render Action