OfxImageEffectOpenGLRenderSuiteV1::clipLoadTexture
Prev   OpenGL Render Suite   Next

Name

OfxImageEffectOpenGLRenderSuiteV1::clipLoadTexture — loads an image from an OFX clip as a texture into OpenGL

Synopsis

#include "ofxOpenGLRender.h"
OfxStatus (*clipLoadTexture) ( OfxImageClipHandle clip ,
  OfxTime time ,
  const char * format ,
  const OfxRectD * region ,
  OfxPropertySetHandle * textureHandle ) ;
 

Arguments

  • clip - the clip to load the image from
  • time - effect time to load the image from
  • format - the requested texture format (As in none,byte,word,half,float, etc..) When set to NULL, the host decides the format based on the plug-in's kOfxOpenGLPropPixelDepth setting.
  • region - region of the image to load (optional, set to NULL to get a 'default' region) this is in the CanonicalCoordinates .
  • textureHandle - a property set containing information about the texture

Description

An image is fetched from a clip at the indicated time for the given region and loaded into an OpenGL texture. When a specific format is requested, the host ensures it gives the requested format. When the clip specified is the "Output" clip, the format is ignored and the host must bind the resulting texture as the current color buffer (render target). This may also be done prior to calling the kOfxImageEffectActionRender action. If the m region parameter is set to non-NULL, then it will be clipped to the clip's Region of Definition for the given time. The returned image will be m at m least as big as this region. If the region parameter is not set or is NULL, then the region fetched will be at least the Region of Interest the effect has previously specified, clipped to the clip's Region of Definition. Information about the texture, including the texture index, is returned in the m textureHandle argument. The properties on this handle will be...

With the exception of the OpenGL specifics, these properties are the same as the properties in an image handle returned by clipGetImage in the image effect suite. \pre

  • clip was returned by clipGetHandle
  • Format property in the texture handle

\post

  • texture handle to be disposed of by clipFreeTexture before the action

returns

  • when the clip specified is the "Output" clip, the format is ignored and

the host must bind the resulting texture as the current color buffer (render target). This may also be done prior to calling the render action.

\note

  • this is the OpenGL equivalent of clipGetImage from OfxImageEffectSuiteV1

Returns

  • kOfxStatOK - the image was successfully fetched and returned

in the handle,

not exist in the clip at the indicated time and/or region, the plugin should continue operation, but assume the image was black and transparent.

effect to load the texture. The plugin should abort the GL render and return kOfxStatErrMemory , after which the host can decide to retry the operation with CPU based processing.

Prev   Up   Next
OfxImageEffectOpenGLRenderSuiteV1   Home   OfxImageEffectOpenGLRenderSuiteV1::clipFreeTexture