Name

kOfxImageClipPropFieldExtraction — Controls how a plugin fetched fielded imagery from a clip.

Synopsis

#include "/ofxImageEffect.h"
#define kOfxImageClipPropFieldExtraction "OfxImageClipPropFieldExtraction"

Type

kOfxImageClipPropFieldExtraction is of type string, and has only a single dimension.

Property Set

This is a property that belongs to the a clip descriptor (read/write).

Default

The default value is kOfxImageFieldDoubled.

Valid Values

This must be one of

  • kOfxImageFieldBoth - fetch a full frame interlaced image
  • kOfxImageFieldSingle - fetch a single field, making a half height image
  • kOfxImageFieldDoubled - fetch a single field, but doubling each line and so making a full height image

Description

Controls how a plugin fetched fielded imagery from a clip.

This controls how a plug-in wishes to fetch images from a fielded clip, so it can tune it behaviour when it renders fielded footage.

Note that if it fetches kOfxImageFieldSingle and the host stores images natively as both fields interlaced, it can return a single image by doubling rowbytes and tweaking the starting address of the image data. This saves on a buffer copy.