The Render Action

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

	#include "ofxImageEffect.h"
	#define kOfxImageEffectActionRender                "OfxImageEffectActionRender"

Arguments

handle handle to the instance, cast to an OfxImageEffectHandle ,
inArgs has the following properties...
- kOfxPropTime - the time at which to test for identity
- kOfxImageEffectPropFieldToRender - the field to test for identity
- kOfxImageEffectPropRenderWindow - the window (in \ref PixelCoordinates) to test for identity under
- kOfxImageEffectPropRenderScale - the scale factor being applied to the images being renderred
- 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
- kOfxImageEffectPropRenderQualityDraft - if the render should be done in draft mode (e.g. for faster scrubbing)
outArgs is redundant and should be set to NULL.

Description

This action is where an effect gets to push pixels and turn its input clips and parameter set into an output image. This is possibly quite complicated and covered in the Rendering Image Effects chapter.

Preconditions

kOfxActionCreateInstance has been called on the instance
kOfxImageEffectActionBeginSequenceRender has been called on the instance

Postconditions

kOfxImageEffectActionEndSequenceRender action will be called on the instance

Return Values

kOfxStatOK, the effect rendered happily
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

Default Action

The render action must be trapped by the plug-in, it cannot return kOfxStatReplyDefault. The pixels needs be pushed I'm afraid.

Prev	Up	Next
The Is Identity Action	Home	The Begin Sequence Render Action