Public Types | Public Member Functions | Static Public Member Functions | List of all members
CLEvaluator Class Reference

`#include <clEvaluator.h>`

## Public Types
typedef bool | Instantiatable

## Public Member Functions
| CLEvaluator (cl_context context, cl_command_queue queue)
| Constructor. More...
| ~CLEvaluator ()
| Desctructor. More...
template<typename SRC_BUFFER , typename DST_BUFFER , typename STENCIL_TABLE >
bool | EvalStencils (SRC_BUFFER *srcBuffer, BufferDescriptor const &srcDesc, DST_BUFFER *dstBuffer, BufferDescriptor const &dstDesc, STENCIL_TABLE const *stencilTable, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL) const
template<typename SRC_BUFFER , typename DST_BUFFER , typename STENCIL_TABLE >
bool | EvalStencils (SRC_BUFFER *srcBuffer, BufferDescriptor const &srcDesc, DST_BUFFER *dstBuffer, BufferDescriptor const &dstDesc, DST_BUFFER *duBuffer, BufferDescriptor const &duDesc, DST_BUFFER *dvBuffer, BufferDescriptor const &dvDesc, STENCIL_TABLE const *stencilTable, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL) const
bool | EvalStencils (cl_mem src, BufferDescriptor const &srcDesc, cl_mem dst, BufferDescriptor const &dstDesc, cl_mem sizes, cl_mem offsets, cl_mem indices, cl_mem weights, int start, int end, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL) const
bool | EvalStencils (cl_mem src, BufferDescriptor const &srcDesc, cl_mem dst, BufferDescriptor const &dstDesc, cl_mem du, BufferDescriptor const &duDesc, cl_mem dv, BufferDescriptor const &dvDesc, cl_mem sizes, cl_mem offsets, cl_mem indices, cl_mem weights, cl_mem duWeights, cl_mem dvWeights, int start, int end, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL) const
template<typename SRC_BUFFER , typename DST_BUFFER , typename PATCHCOORD_BUFFER , typename PATCH_TABLE >
bool | EvalPatches (SRC_BUFFER *srcBuffer, BufferDescriptor const &srcDesc, DST_BUFFER *dstBuffer, BufferDescriptor const &dstDesc, int numPatchCoords, PATCHCOORD_BUFFER *patchCoords, PATCH_TABLE *patchTable, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL) const
| Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way. More...
template<typename SRC_BUFFER , typename DST_BUFFER , typename PATCHCOORD_BUFFER , typename PATCH_TABLE >
bool | EvalPatches (SRC_BUFFER *srcBuffer, BufferDescriptor const &srcDesc, DST_BUFFER *dstBuffer, BufferDescriptor const &dstDesc, DST_BUFFER *duBuffer, BufferDescriptor const &duDesc, DST_BUFFER *dvBuffer, BufferDescriptor const &dvDesc, int numPatchCoords, PATCHCOORD_BUFFER *patchCoords, PATCH_TABLE *patchTable, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL) const
| Generic limit eval function with derivatives. This function has a same signature as other device kernels have so that it can be called in the same way. More...
bool | EvalPatches (cl_mem src, BufferDescriptor const &srcDesc, cl_mem dst, BufferDescriptor const &dstDesc, cl_mem du, BufferDescriptor const &duDesc, cl_mem dv, BufferDescriptor const &dvDesc, int numPatchCoords, cl_mem patchCoordsBuffer, cl_mem patchArrayBuffer, cl_mem patchIndexBuffer, cl_mem patchParamsBuffer, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL) const
template<typename SRC_BUFFER , typename DST_BUFFER , typename PATCHCOORD_BUFFER , typename PATCH_TABLE >
bool | EvalPatchesVarying (SRC_BUFFER *srcBuffer, BufferDescriptor const &srcDesc, DST_BUFFER *dstBuffer, BufferDescriptor const &dstDesc, int numPatchCoords, PATCHCOORD_BUFFER *patchCoords, PATCH_TABLE *patchTable, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL) const
| Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way. More...
template<typename SRC_BUFFER , typename DST_BUFFER , typename PATCHCOORD_BUFFER , typename PATCH_TABLE >
bool | EvalPatchesFaceVarying (SRC_BUFFER *srcBuffer, BufferDescriptor const &srcDesc, DST_BUFFER *dstBuffer, BufferDescriptor const &dstDesc, int numPatchCoords, PATCHCOORD_BUFFER *patchCoords, PATCH_TABLE *patchTable, int fvarChannel=0, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL) const
| Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way. More...
bool | Compile (BufferDescriptor const &srcDesc, BufferDescriptor const &dstDesc, BufferDescriptor const &duDesc, BufferDescriptor const &dvDesc)

## Static Public Member Functions
template<typename DEVICE_CONTEXT >
static CLEvaluator * | Create (BufferDescriptor const &srcDesc, BufferDescriptor const &dstDesc, BufferDescriptor const &duDesc, BufferDescriptor const &dvDesc, DEVICE_CONTEXT deviceContext)
| Generic creator template. More...
static CLEvaluator * | Create (BufferDescriptor const &srcDesc, BufferDescriptor const &dstDesc, BufferDescriptor const &duDesc, BufferDescriptor const &dvDesc, cl_context clContext, cl_command_queue clCommandQueue)
template<typename SRC_BUFFER , typename DST_BUFFER , typename STENCIL_TABLE , typename DEVICE_CONTEXT >
static bool | EvalStencils (SRC_BUFFER *srcBuffer, BufferDescriptor const &srcDesc, DST_BUFFER *dstBuffer, BufferDescriptor const &dstDesc, STENCIL_TABLE const *stencilTable, CLEvaluator const *instance, DEVICE_CONTEXT deviceContext, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL)
| Generic static compute function. This function has a same signature as other device kernels have so that it can be called transparently from OsdMesh template interface. More...
template<typename SRC_BUFFER , typename DST_BUFFER , typename STENCIL_TABLE , typename DEVICE_CONTEXT >
static bool | EvalStencils (SRC_BUFFER *srcBuffer, BufferDescriptor const &srcDesc, DST_BUFFER *dstBuffer, BufferDescriptor const &dstDesc, DST_BUFFER *duBuffer, BufferDescriptor const &duDesc, DST_BUFFER *dvBuffer, BufferDescriptor const &dvDesc, STENCIL_TABLE const *stencilTable, CLEvaluator const *instance, DEVICE_CONTEXT deviceContext, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL)
| Generic static compute function. This function has a same signature as other device kernels have so that it can be called transparently from OsdMesh template interface. More...
template<typename SRC_BUFFER , typename DST_BUFFER , typename PATCHCOORD_BUFFER , typename PATCH_TABLE , typename DEVICE_CONTEXT >
static bool | EvalPatches (SRC_BUFFER *srcBuffer, BufferDescriptor const &srcDesc, DST_BUFFER *dstBuffer, BufferDescriptor const &dstDesc, int numPatchCoords, PATCHCOORD_BUFFER *patchCoords, PATCH_TABLE *patchTable, CLEvaluator const *instance, DEVICE_CONTEXT deviceContext, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL)
| Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way. More...
template<typename SRC_BUFFER , typename DST_BUFFER , typename PATCHCOORD_BUFFER , typename PATCH_TABLE , typename DEVICE_CONTEXT >
static bool | EvalPatches (SRC_BUFFER *srcBuffer, BufferDescriptor const &srcDesc, DST_BUFFER *dstBuffer, BufferDescriptor const &dstDesc, DST_BUFFER *duBuffer, BufferDescriptor const &duDesc, DST_BUFFER *dvBuffer, BufferDescriptor const &dvDesc, int numPatchCoords, PATCHCOORD_BUFFER *patchCoords, PATCH_TABLE *patchTable, CLEvaluator const *instance, DEVICE_CONTEXT deviceContext, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL)
| Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way. More...
template<typename SRC_BUFFER , typename DST_BUFFER , typename PATCHCOORD_BUFFER , typename PATCH_TABLE , typename DEVICE_CONTEXT >
static bool | EvalPatchesVarying (SRC_BUFFER *srcBuffer, BufferDescriptor const &srcDesc, DST_BUFFER *dstBuffer, BufferDescriptor const &dstDesc, int numPatchCoords, PATCHCOORD_BUFFER *patchCoords, PATCH_TABLE *patchTable, CLEvaluator const *instance, DEVICE_CONTEXT deviceContext, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL)
| Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way. More...
template<typename SRC_BUFFER , typename DST_BUFFER , typename PATCHCOORD_BUFFER , typename PATCH_TABLE , typename DEVICE_CONTEXT >
static bool | EvalPatchesFaceVarying (SRC_BUFFER *srcBuffer, BufferDescriptor const &srcDesc, DST_BUFFER *dstBuffer, BufferDescriptor const &dstDesc, int numPatchCoords, PATCHCOORD_BUFFER *patchCoords, PATCH_TABLE *patchTable, int fvarChannel, CLEvaluator const *instance, DEVICE_CONTEXT deviceContext, unsigned int numStartEvents=0, const cl_event *startEvents=NULL, cl_event *endEvent=NULL)
| Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way. More...
template<typename DEVICE_CONTEXT >
static void | Synchronize (DEVICE_CONTEXT deviceContext)
| Wait the OpenCL kernels finish. More...
static void | Synchronize (cl_command_queue queue)

## Detailed Description

Definition at line 92 of file clEvaluator.h.

## Member Typedef Documentation

## § Instantiatable

typedef bool Instantiatable

Definition at line 94 of file clEvaluator.h.

## Constructor & Destructor Documentation

## § CLEvaluator()

CLEvaluator | ( | cl_context | context,
|  | cl_command_queue | queue
| ) |  |

Constructor.

## § ~CLEvaluator()

~CLEvaluator | ( |  | ) |

Desctructor.

## Member Function Documentation

## § Compile()

bool Compile | ( | BufferDescriptor const & | srcDesc,
|  | BufferDescriptor const & | dstDesc,
|  | BufferDescriptor const & | duDesc,
|  | BufferDescriptor const & | dvDesc
| ) |  |

Other methods

Configure OpenCL kernel. Returns false if it fails to compile the kernel.

## § Create() [1/2]

static CLEvaluator* Create | ( | BufferDescriptor const & | srcDesc,
|  | BufferDescriptor const & | dstDesc,
|  | BufferDescriptor const & | duDesc,
|  | BufferDescriptor const & | dvDesc,
|  | DEVICE_CONTEXT | deviceContext
| ) |  |
| inline static

Generic creator template.

Definition at line 103 of file clEvaluator.h.

## § Create() [2/2]

static CLEvaluator* Create | ( | BufferDescriptor const & | srcDesc,
|  | BufferDescriptor const & | dstDesc,
|  | BufferDescriptor const & | duDesc,
|  | BufferDescriptor const & | dvDesc,
|  | cl_context | clContext,
|  | cl_command_queue | clCommandQueue
| ) |  |
| inline static

Definition at line 113 of file clEvaluator.h.

## § EvalPatches() [1/5]

static bool EvalPatches | ( | SRC_BUFFER * | srcBuffer,
|  | BufferDescriptor const & | srcDesc,
|  | DST_BUFFER * | dstBuffer,
|  | BufferDescriptor const & | dstDesc,
|  | int | numPatchCoords,
|  | PATCHCOORD_BUFFER * | patchCoords,
|  | PATCH_TABLE * | patchTable,
|  | CLEvaluator const * | instance,
|  | DEVICE_CONTEXT | deviceContext,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  |
| inline static

Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way.

Limit evaluations with PatchTable

Parameters

  srcBuffer | Input primvar buffer. must have BindCLBuffer() method returning a CL buffer object of source data
  srcDesc | vertex buffer descriptor for the input buffer
  dstBuffer | Output primvar buffer must have BindCLBuffer() method returning a CL buffer object of destination data
  dstDesc | vertex buffer descriptor for the output buffer
  numPatchCoords | number of patchCoords.
  patchCoords | array of locations to be evaluated. must have BindCLBuffer() method returning an array of PatchCoord struct.
  patchTable | CLPatchTable or equivalent
  instance | cached compiled instance. Clients are supposed to pre-compile an instance of this class and provide to this function. If it's null the kernel still compute by instantiating on-demand kernel although it may cause a performance problem.
  deviceContext | client providing context class which supports cL_context GetContext() cl_command_queue GetCommandQueue() methods.
  numStartEvents | the number of events in the array pointed to by startEvents.
  startEvents | points to an array of cl_event which will determine when it is safe for the OpenCL device to begin work or NULL if it can begin immediately.
  endEvent | pointer to a cl_event which will recieve a copy of the cl_event which indicates when all work for this call has completed. This cl_event has an incremented reference count and should be released via clReleaseEvent(). NULL if not required.

Definition at line 442 of file clEvaluator.h.

## § EvalPatches() [2/5]

static bool EvalPatches | ( | SRC_BUFFER * | srcBuffer,
|  | BufferDescriptor const & | srcDesc,
|  | DST_BUFFER * | dstBuffer,
|  | BufferDescriptor const & | dstDesc,
|  | DST_BUFFER * | duBuffer,
|  | BufferDescriptor const & | duDesc,
|  | DST_BUFFER * | dvBuffer,
|  | BufferDescriptor const & | dvDesc,
|  | int | numPatchCoords,
|  | PATCHCOORD_BUFFER * | patchCoords,
|  | PATCH_TABLE * | patchTable,
|  | CLEvaluator const * | instance,
|  | DEVICE_CONTEXT | deviceContext,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  |
| inline static

Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way.

Parameters

  srcBuffer | Input primvar buffer. must have BindCLBuffer() method returning a CL buffer object of source data
  srcDesc | vertex buffer descriptor for the input buffer
  dstBuffer | Output primvar buffer must have BindCLBuffer() method returning a CL buffer object of destination data
  dstDesc | vertex buffer descriptor for the output buffer
  duBuffer |
  duDesc |
  dvBuffer |
  dvDesc |
  numPatchCoords | number of patchCoords.
  patchCoords | array of locations to be evaluated. must have BindCLBuffer() method returning an array of PatchCoord struct
  patchTable | CLPatchTable or equivalent
  instance | cached compiled instance. Clients are supposed to pre-compile an instance of this class and provide to this function. If it's null the kernel still compute by instantiating on-demand kernel although it may cause a performance problem.
  deviceContext | client providing context class which supports cL_context GetContext() cl_command_queue GetCommandQueue() methods.
  numStartEvents | the number of events in the array pointed to by startEvents.
  startEvents | points to an array of cl_event which will determine when it is safe for the OpenCL device to begin work or NULL if it can begin immediately.
  endEvent | pointer to a cl_event which will recieve a copy of the cl_event which indicates when all work for this call has completed. This cl_event has an incremented reference count and should be released via clReleaseEvent(). NULL if not required.

Definition at line 539 of file clEvaluator.h.

## § EvalPatches() [3/5]

bool EvalPatches | ( | SRC_BUFFER * | srcBuffer,
|  | BufferDescriptor const & | srcDesc,
|  | DST_BUFFER * | dstBuffer,
|  | BufferDescriptor const & | dstDesc,
|  | int | numPatchCoords,
|  | PATCHCOORD_BUFFER * | patchCoords,
|  | PATCH_TABLE * | patchTable,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  | const
| inline

Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way.

Parameters

  srcBuffer | Input primvar buffer. must have BindCLBuffer() method returning a CL buffer object of source data
  srcDesc | vertex buffer descriptor for the input buffer
  dstBuffer | Output primvar buffer must have BindCLBuffer() method returning a CL buffer object of destination data
  dstDesc | vertex buffer descriptor for the output buffer
  numPatchCoords | number of patchCoords.
  patchCoords | array of locations to be evaluated. must have BindCLBuffer() method returning an array of PatchCoord struct.
  patchTable | CLPatchTable or equivalent
  numStartEvents | the number of events in the array pointed to by startEvents.
  startEvents | points to an array of cl_event which will determine when it is safe for the OpenCL device to begin work or NULL if it can begin immediately.
  endEvent | pointer to a cl_event which will recieve a copy of the cl_event which indicates when all work for this call has completed. This cl_event has an incremented reference count and should be released via clReleaseEvent(). NULL if not required.

Definition at line 619 of file clEvaluator.h.

## § EvalPatches() [4/5]

bool EvalPatches | ( | SRC_BUFFER * | srcBuffer,
|  | BufferDescriptor const & | srcDesc,
|  | DST_BUFFER * | dstBuffer,
|  | BufferDescriptor const & | dstDesc,
|  | DST_BUFFER * | duBuffer,
|  | BufferDescriptor const & | duDesc,
|  | DST_BUFFER * | dvBuffer,
|  | BufferDescriptor const & | dvDesc,
|  | int | numPatchCoords,
|  | PATCHCOORD_BUFFER * | patchCoords,
|  | PATCH_TABLE * | patchTable,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  | const
| inline

Generic limit eval function with derivatives. This function has a same signature as other device kernels have so that it can be called in the same way.

Parameters

  srcBuffer | Input primvar buffer. must have BindCLBuffer() method returning a CL buffer object of source data
  srcDesc | vertex buffer descriptor for the input buffer
  dstBuffer | Output primvar buffer must have BindCLBuffer() method returning a CL buffer object of destination data
  dstDesc | vertex buffer descriptor for the output buffer
  duBuffer | Output U-derivatives buffer must have BindCLBuffer() method returning a CL buffer object of destination data of Du
  duDesc | vertex buffer descriptor for the duBuffer
  dvBuffer | Output V-derivatives buffer must have BindCLBuffer() method returning a CL buffer object of destination data of Dv
  dvDesc | vertex buffer descriptor for the dvBuffer
  numPatchCoords | number of patchCoords.
  patchCoords | array of locations to be evaluated.
  patchTable | CLPatchTable or equivalent
  numStartEvents | the number of events in the array pointed to by startEvents.
  startEvents | points to an array of cl_event which will determine when it is safe for the OpenCL device to begin work or NULL if it can begin immediately.
  endEvent | pointer to a cl_event which will recieve a copy of the cl_event which indicates when all work for this call has completed. This cl_event has an incremented reference count and should be released via clReleaseEvent(). NULL if not required.

Definition at line 690 of file clEvaluator.h.

## § EvalPatches() [5/5]

bool EvalPatches | ( | cl_mem | src,
|  | BufferDescriptor const & | srcDesc,
|  | cl_mem | dst,
|  | BufferDescriptor const & | dstDesc,
|  | cl_mem | du,
|  | BufferDescriptor const & | duDesc,
|  | cl_mem | dv,
|  | BufferDescriptor const & | dvDesc,
|  | int | numPatchCoords,
|  | cl_mem | patchCoordsBuffer,
|  | cl_mem | patchArrayBuffer,
|  | cl_mem | patchIndexBuffer,
|  | cl_mem | patchParamsBuffer,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  | const

## § EvalPatchesFaceVarying() [1/2]

static bool EvalPatchesFaceVarying | ( | SRC_BUFFER * | srcBuffer,
|  | BufferDescriptor const & | srcDesc,
|  | DST_BUFFER * | dstBuffer,
|  | BufferDescriptor const & | dstDesc,
|  | int | numPatchCoords,
|  | PATCHCOORD_BUFFER * | patchCoords,
|  | PATCH_TABLE * | patchTable,
|  | int | fvarChannel,
|  | CLEvaluator const * | instance,
|  | DEVICE_CONTEXT | deviceContext,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  |
| inline static

Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way.

Parameters

  srcBuffer | Input primvar buffer. must have BindCLBuffer() method returning a CL buffer object of source data
  srcDesc | vertex buffer descriptor for the input buffer
  dstBuffer | Output primvar buffer must have BindCLBuffer() method returning a CL buffer object of destination data
  dstDesc | vertex buffer descriptor for the output buffer
  numPatchCoords | number of patchCoords.
  patchCoords | array of locations to be evaluated. must have BindCLBuffer() method returning an array of PatchCoord struct.
  patchTable | CLPatchTable or equivalent
  fvarChannel | face-varying channel
  instance | cached compiled instance. Clients are supposed to pre-compile an instance of this class and provide to this function. If it's null the kernel still compute by instantiating on-demand kernel although it may cause a performance problem.
  deviceContext | client providing context class which supports cL_context GetContext() cl_command_queue GetCommandQueue() methods.
  numStartEvents | the number of events in the array pointed to by startEvents.
  startEvents | points to an array of cl_event which will determine when it is safe for the OpenCL device to begin work or NULL if it can begin immediately.
  endEvent | pointer to a cl_event which will recieve a copy of the cl_event which indicates when all work for this call has completed. This cl_event has an incremented reference count and should be released via clReleaseEvent(). NULL if not required.

Definition at line 932 of file clEvaluator.h.

## § EvalPatchesFaceVarying() [2/2]

bool EvalPatchesFaceVarying | ( | SRC_BUFFER * | srcBuffer,
|  | BufferDescriptor const & | srcDesc,
|  | DST_BUFFER * | dstBuffer,
|  | BufferDescriptor const & | dstDesc,
|  | int | numPatchCoords,
|  | PATCHCOORD_BUFFER * | patchCoords,
|  | PATCH_TABLE * | patchTable,
|  | int | fvarChannel = `0`,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  | const
| inline

Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way.

Parameters

  srcBuffer | Input primvar buffer. must have BindCLBuffer() method returning a CL buffer object of source data
  srcDesc | vertex buffer descriptor for the input buffer
  dstBuffer | Output primvar buffer must have BindCLBuffer() method returning a CL buffer object of destination data
  dstDesc | vertex buffer descriptor for the output buffer
  numPatchCoords | number of patchCoords.
  patchCoords | array of locations to be evaluated. must have BindCLBuffer() method returning an array of PatchCoord struct.
  patchTable | CLPatchTable or equivalent
  fvarChannel | face-varying channel
  numStartEvents | the number of events in the array pointed to by startEvents.
  startEvents | points to an array of cl_event which will determine when it is safe for the OpenCL device to begin work or NULL if it can begin immediately.
  endEvent | pointer to a cl_event which will recieve a copy of the cl_event which indicates when all work for this call has completed. This cl_event has an incremented reference count and should be released via clReleaseEvent(). NULL if not required.

Definition at line 1014 of file clEvaluator.h.

## § EvalPatchesVarying() [1/2]

static bool EvalPatchesVarying | ( | SRC_BUFFER * | srcBuffer,
|  | BufferDescriptor const & | srcDesc,
|  | DST_BUFFER * | dstBuffer,
|  | BufferDescriptor const & | dstDesc,
|  | int | numPatchCoords,
|  | PATCHCOORD_BUFFER * | patchCoords,
|  | PATCH_TABLE * | patchTable,
|  | CLEvaluator const * | instance,
|  | DEVICE_CONTEXT | deviceContext,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  |
| inline static

Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way.

Parameters

  srcBuffer | Input primvar buffer. must have BindCLBuffer() method returning a CL buffer object of source data
  srcDesc | vertex buffer descriptor for the input buffer
  dstBuffer | Output primvar buffer must have BindCLBuffer() method returning a CL buffer object of destination data
  dstDesc | vertex buffer descriptor for the output buffer
  numPatchCoords | number of patchCoords.
  patchCoords | array of locations to be evaluated. must have BindCLBuffer() method returning an array of PatchCoord struct.
  patchTable | CLPatchTable or equivalent
  instance | cached compiled instance. Clients are supposed to pre-compile an instance of this class and provide to this function. If it's null the kernel still compute by instantiating on-demand kernel although it may cause a performance problem.
  deviceContext | client providing context class which supports cL_context GetContext() cl_command_queue GetCommandQueue() methods.
  numStartEvents | the number of events in the array pointed to by startEvents.
  startEvents | points to an array of cl_event which will determine when it is safe for the OpenCL device to begin work or NULL if it can begin immediately.
  endEvent | pointer to a cl_event which will recieve a copy of the cl_event which indicates when all work for this call has completed. This cl_event has an incremented reference count and should be released via clReleaseEvent(). NULL if not required.

Definition at line 778 of file clEvaluator.h.

## § EvalPatchesVarying() [2/2]

bool EvalPatchesVarying | ( | SRC_BUFFER * | srcBuffer,
|  | BufferDescriptor const & | srcDesc,
|  | DST_BUFFER * | dstBuffer,
|  | BufferDescriptor const & | dstDesc,
|  | int | numPatchCoords,
|  | PATCHCOORD_BUFFER * | patchCoords,
|  | PATCH_TABLE * | patchTable,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  | const
| inline

Generic limit eval function. This function has a same signature as other device kernels have so that it can be called in the same way.

Parameters

  srcBuffer | Input primvar buffer. must have BindCLBuffer() method returning a CL buffer object of source data
  srcDesc | vertex buffer descriptor for the input buffer
  dstBuffer | Output primvar buffer must have BindCLBuffer() method returning a CL buffer object of destination data
  dstDesc | vertex buffer descriptor for the output buffer
  numPatchCoords | number of patchCoords.
  patchCoords | array of locations to be evaluated. must have BindCLBuffer() method returning an array of PatchCoord struct.
  patchTable | CLPatchTable or equivalent
  numStartEvents | the number of events in the array pointed to by startEvents.
  startEvents | points to an array of cl_event which will determine when it is safe for the OpenCL device to begin work or NULL if it can begin immediately.
  endEvent | pointer to a cl_event which will recieve a copy of the cl_event which indicates when all work for this call has completed. This cl_event has an incremented reference count and should be released via clReleaseEvent(). NULL if not required.

Definition at line 857 of file clEvaluator.h.

## § EvalStencils() [1/6]

static bool EvalStencils | ( | SRC_BUFFER * | srcBuffer,
|  | BufferDescriptor const & | srcDesc,
|  | DST_BUFFER * | dstBuffer,
|  | BufferDescriptor const & | dstDesc,
|  | STENCIL_TABLE const * | stencilTable,
|  | CLEvaluator const * | instance,
|  | DEVICE_CONTEXT | deviceContext,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  |
| inline static

Generic static compute function. This function has a same signature as other device kernels have so that it can be called transparently from OsdMesh template interface.

Stencil evaluations with StencilTable

Parameters

  srcBuffer | Input primvar buffer. must have BindCLBuffer() method returning the cl_mem object for read
  srcDesc | vertex buffer descriptor for the input buffer
  dstBuffer | Output primvar buffer must have BindCLBuffer() method returning the cl_mem object for results to be written
  dstDesc | vertex buffer descriptor for the output buffer
  stencilTable | stencil table to be applied. The table must have SSBO interfaces.
  instance | cached compiled instance. Clients are supposed to pre-compile an instance of this class and provide to this function. If it's null the kernel still compute by instantiating on-demand kernel although it may cause a performance problem.
  deviceContext | client providing context class which supports cL_context GetContext() cl_command_queue GetCommandQueue() methods.
  numStartEvents | the number of events in the array pointed to by startEvents.
  startEvents | points to an array of cl_event which will determine when it is safe for the OpenCL device to begin work or NULL if it can begin immediately.
  endEvent | pointer to a cl_event which will recieve a copy of the cl_event which indicates when all work for this call has completed. This cl_event has an incremented reference count and should be released via clReleaseEvent(). NULL if not required.

Definition at line 176 of file clEvaluator.h.

## § EvalStencils() [2/6]

static bool EvalStencils | ( | SRC_BUFFER * | srcBuffer,
|  | BufferDescriptor const & | srcDesc,
|  | DST_BUFFER * | dstBuffer,
|  | BufferDescriptor const & | dstDesc,
|  | DST_BUFFER * | duBuffer,
|  | BufferDescriptor const & | duDesc,
|  | DST_BUFFER * | dvBuffer,
|  | BufferDescriptor const & | dvDesc,
|  | STENCIL_TABLE const * | stencilTable,
|  | CLEvaluator const * | instance,
|  | DEVICE_CONTEXT | deviceContext,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  |
| inline static

Generic static compute function. This function has a same signature as other device kernels have so that it can be called transparently from OsdMesh template interface.

Parameters

  srcBuffer | Input primvar buffer. must have BindCLBuffer() method returning the cl_mem object for read
  srcDesc | vertex buffer descriptor for the input buffer
  dstBuffer | Output primvar buffer must have BindCLBuffer() method returning the cl_mem object for results to be written
  dstDesc | vertex buffer descriptor for the output buffer
  duBuffer | Output U-derivative buffer must have BindCLBuffer() method returning the cl_mem object for du results to be written
  duDesc | vertex buffer descriptor for the du output buffer
  dvBuffer | Output V-derivative buffer must have BindCLBuffer() method returning the cl_mem object for dv results to be written
  dvDesc | vertex buffer descriptor for the dv output buffer
  stencilTable | stencil table to be applied. The table must have SSBO interfaces.
  instance | cached compiled instance. Clients are supposed to pre-compile an instance of this class and provide to this function. If it's null the kernel still compute by instantiating on-demand kernel although it may cause a performance problem.
  deviceContext | client providing context class which supports cL_context GetContext() cl_command_queue GetCommandQueue() methods.
  numStartEvents | the number of events in the array pointed to by startEvents.
  startEvents | points to an array of cl_event which will determine when it is safe for the OpenCL device to begin work or NULL if it can begin immediately.
  endEvent | pointer to a cl_event which will recieve a copy of the cl_event which indicates when all work for this call has completed. This cl_event has an incremented reference count and should be released via clReleaseEvent(). NULL if not required.

Definition at line 266 of file clEvaluator.h.

## § EvalStencils() [3/6]

bool EvalStencils | ( | SRC_BUFFER * | srcBuffer,
|  | BufferDescriptor const & | srcDesc,
|  | DST_BUFFER * | dstBuffer,
|  | BufferDescriptor const & | dstDesc,
|  | STENCIL_TABLE const * | stencilTable,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  | const
| inline

Generic compute function. Dispatch the CL compute kernel asynchronously. Returns false if the kernel hasn't been compiled yet.

Definition at line 307 of file clEvaluator.h.

## § EvalStencils() [4/6]

bool EvalStencils | ( | SRC_BUFFER * | srcBuffer,
|  | BufferDescriptor const & | srcDesc,
|  | DST_BUFFER * | dstBuffer,
|  | BufferDescriptor const & | dstDesc,
|  | DST_BUFFER * | duBuffer,
|  | BufferDescriptor const & | duDesc,
|  | DST_BUFFER * | dvBuffer,
|  | BufferDescriptor const & | dvDesc,
|  | STENCIL_TABLE const * | stencilTable,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  | const
| inline

Generic compute function. Dispatch the CL compute kernel asynchronously. Returns false if the kernel hasn't been compiled yet.

Definition at line 329 of file clEvaluator.h.

## § EvalStencils() [5/6]

bool EvalStencils | ( | cl_mem | src,
|  | BufferDescriptor const & | srcDesc,
|  | cl_mem | dst,
|  | BufferDescriptor const & | dstDesc,
|  | cl_mem | sizes,
|  | cl_mem | offsets,
|  | cl_mem | indices,
|  | cl_mem | weights,
|  | int | start,
|  | int | end,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  | const

Dispatch the CL compute kernel asynchronously. returns false if the kernel hasn't been compiled yet.

## § EvalStencils() [6/6]

bool EvalStencils | ( | cl_mem | src,
|  | BufferDescriptor const & | srcDesc,
|  | cl_mem | dst,
|  | BufferDescriptor const & | dstDesc,
|  | cl_mem | du,
|  | BufferDescriptor const & | duDesc,
|  | cl_mem | dv,
|  | BufferDescriptor const & | dvDesc,
|  | cl_mem | sizes,
|  | cl_mem | offsets,
|  | cl_mem | indices,
|  | cl_mem | weights,
|  | cl_mem | duWeights,
|  | cl_mem | dvWeights,
|  | int | start,
|  | int | end,
|  | unsigned int | numStartEvents = `0`,
|  | const cl_event * | startEvents = `NULL`,
|  | cl_event * | endEvent = `NULL`
| ) |  | const

Dispatch the CL compute kernel asynchronously. returns false if the kernel hasn't been compiled yet.

## § Synchronize() [1/2]

static void Synchronize | ( | DEVICE_CONTEXT | deviceContext | ) |
| inline static

Wait the OpenCL kernels finish.

Definition at line 1052 of file clEvaluator.h.

## § Synchronize() [2/2]

static void Synchronize | ( | cl_command_queue | queue | ) |
| static

The documentation for this class was generated from the following file:

- opensubdiv/osd/clEvaluator.h