The Get Region of Definition Action

The Get Region of Definition Action
Prev	Chapter 13. Actions Passed to An Image Effect	Next

	#include "ofxImageEffect.h"
	#define kOfxImageEffectActionGetRegionOfDefinition        "OfxImageEffectActionGetRegionOfDefinition"

Arguments

handle handle to the instance, cast to an OfxImageEffectHandle ,
inArgs has the following properties...
- kOfxPropTime the effect time for which a region of definition is being requested,
- kOfxImageEffectPropRenderScale the render scale that should be used in any calculations in this action,
outArgs has the following property which the plug-in may set...
- kOfxImageEffectPropRegionOfDefinition , the calculated region of definition, initially set by the host to the default RoD (see below), in Canonical Coordinates.

Description

The region of definition for an image effect is the rectangular section of the 2D image plane that it is capable of filling, given the state of its input clips and parameters. This action is used to calculate the RoD for a plugin instance at a given frame. For more details on regions of definition see Image Effect Architectures .

Note that hosts that have constant sized imagery need not call this action, only hosts that allow image sizes to vary need call this.

Return Values

kOfxStatOK, , the action was trapped and the RoD was set in the outArgs property set
kOfxStatReplyDefault, the action was not trapped and the host should use the default values
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

If the effect did not trap this, it means the host should use the default RoD instead, which depends on the context. This is...

generator context - defaults to the project window,
filter and paint contexts - defaults to the RoD of the 'Source' input clip at the given time,
transition context - defaults to the union of the RoDs of the 'SourceFrom' and 'SourceTo' input clips at the given time,
general context - defaults to the union of the RoDs of all the non optional input clips and the 'Source' input clip (if it exists and it is connected) at the given time, if none exist, then it is the project window
retimer context - defaults to the union of the RoD of the 'Source' input clip at the frame directly preceding the value of the 'SourceTime' double parameter and the frame directly after it

Prev	Up	Next
The Describe In Context Action	Home	The Get Regions Of Interest Action