Group CudaRender

group CudaRender

Version

CUDA rendering was added in version 1.5.

Defines

kOfxImageEffectPropCudaRenderSupported

Indicates whether a host or plug-in can support CUDA render.

• Type - string X 1

• Property Set - plug-in descriptor (read/write), host descriptor (read only)

• Default - “false” for a plug-in

• Valid Values - This must be one of

  • ”false” - the host or plug-in does not support CUDA render

  • ”true” - the host or plug-in can support CUDA render

kOfxImageEffectPropCudaEnabled

Indicates that a plug-in SHOULD use CUDA render in the current action.

If a plug-in and host have both set kOfxImageEffectPropCudaRenderSupported=”true” then the host MAY set this property to indicate that it is passing images as CUDA memory pointers.

• Type - int X 1

• Property Set - inArgs property set of the following actions…

  • kOfxImageEffectActionRender

  • kOfxImageEffectActionBeginSequenceRender

  • kOfxImageEffectActionEndSequenceRender

• Valid Values

  • 0 indicates that the kOfxImagePropData of each image of each clip is a CPU memory pointer.

  • 1 indicates that the kOfxImagePropData of each image of each clip is a CUDA memory pointer.

kOfxImageEffectPropCudaStreamSupported

Indicates whether a host or plug-in can support CUDA streams.

• Type - string X 1

• Property Set - plug-in descriptor (read/write), host descriptor (read only)

• Default - “false” for a plug-in

• Valid Values - This must be one of

  • ”false” - in which case the host or plug-in does not support CUDA streams

  • ”true” - which means a host or plug-in can support CUDA streams

kOfxImageEffectPropCudaStream

The CUDA stream to be used for rendering.

• Type - pointer X 1

• Property Set - inArgs property set of the following actions…

  • kOfxImageEffectActionRender

  • kOfxImageEffectActionBeginSequenceRender

  • kOfxImageEffectActionEndSequenceRender

This property will only be set if the host and plug-in both support CUDA streams.

If set:

• this property contains a pointer to the stream of CUDA render (cudaStream_t). In order to use it, reinterpret_cast<cudaStream_t>(pointer) is needed.

• the plug-in SHOULD ensure that its render action enqueues any asynchronous CUDA operations onto the supplied queue.

• the plug-in SHOULD NOT wait for final asynchronous operations to complete before returning from the render action, and SHOULD NOT call cudaDeviceSynchronize() at any time.

If not set:

• the plug-in SHOULD ensure that any asynchronous operations it enqueues have completed before returning from the render action.