Skip to content

Commit 1737d41

Browse files
committed
update kOfxImageEffectPropNoSpatialAwareness docs
Signed-off-by: Greg Cotten <[email protected]>
1 parent 08606e1 commit 1737d41

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

include/ofxImageEffect.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1175,15 +1175,16 @@ Also note that some hosts do implement kOfxImageEffectPropRenderScale - these tw
11751175
#define kOfxImageEffectPropRenderQualityDraft "OfxImageEffectPropRenderQualityDraft"
11761176

11771177
/** @brief Indicates that the plugin can render without spatial awareness, either inherently or by
1178-
disabling certain parameters at render time. If the plugin descriptor has this prop set to "true", the
1179-
plugin is expected to disable spatial effects when the host sets this prop to "true" in the render call arguments.
1178+
disabling certain parameters at render time.
1179+
1180+
If the plugin descriptor has this property set to "true", the plugin is expected to disable spatial effects when the host sets this property to "true" in the arguments passed to kOfxImageEffectActionBeginSequenceRender and kOfxImageEffectActionRender.
11801181
11811182
- Type - string X 1
11821183
- Property Set - plugin descriptor (read/write), render calls - host (read-only)
11831184
- Default - "false"
11841185
- Valid Values - This must be one of
1185-
- "false" - the plugin cannot render without spatial awareness and the host will bypass it for renders that require no spatial awareness.
1186-
- "true" - the plugin can render without spatial awareness, and the host will indicate this type of render by setting kOfxImageEffectPropNoSpatialAwareness to "true" in the render call.
1186+
- "false" - the plugin cannot render without spatial awareness and the host should bypass it for renders that require no spatial awareness.
1187+
- "true" - the plugin can render without spatial awareness. The host will indicate this type of render by setting kOfxImageEffectPropNoSpatialAwareness to "true" in the arguments passed to kOfxImageEffectActionBeginSequenceRender and kOfxImageEffectActionRender.
11871188
*/
11881189
#define kOfxImageEffectPropNoSpatialAwareness "OfxImageEffectPropNoSpatialAwareness"
11891190

0 commit comments

Comments
 (0)