C++ API Reference
MGPUEventList Class Reference

Helper class to keep track of CL events. More...

#include <MPxGPUDeformer.h>

Public Member Functions

 MGPUEventList ()
 Constructs a MGPUEventList.
 
 MGPUEventList (const MGPUEventList &)
 Constructs a MGPUEventList. More...
 
 ~MGPUEventList ()
 Destructor.
 
void add (const MAutoCLEvent &event)
 This method adds a new event to the list. More...
 
void add (MOpenCLBuffer &buf)
 This method adds the bufferReadyEvent of a buffer to the list. More...
 
const cl_event * array () const
 This method returns the array of events contained in the MGPUEventList. More...
 
cl_uint size () const
 This method returns the number of events contained in the MGPUEventList. More...
 

Detailed Description

Helper class to keep track of CL events.

MGPUEventList is a simple class to make it easier to manage an event wait list for kernels that are queued up.

Examples:
basicMorphNode/basicMorphNode.cpp, and offsetNode/offsetNode.cpp.

Constructor & Destructor Documentation

MGPUEventList ( const MGPUEventList other)

Constructs a MGPUEventList.

Parameters
[in]otherThe MGPUEventList to copy.

Member Function Documentation

void add ( const MAutoCLEvent event)

This method adds a new event to the list.

Parameters
[in]eventThe event to add
Examples:
basicMorphNode/basicMorphNode.cpp, and offsetNode/offsetNode.cpp.
void add ( MOpenCLBuffer buf)

This method adds the bufferReadyEvent of a buffer to the list.

Parameters
[in]bufThe buffer of which we want to add the bufferReadyEvent
const cl_event * array ( ) const

This method returns the array of events contained in the MGPUEventList.

Returns
the pointer to the array containing the events
Examples:
basicMorphNode/basicMorphNode.cpp, and offsetNode/offsetNode.cpp.
cl_uint size ( ) const

This method returns the number of events contained in the MGPUEventList.

Returns
the number of events
Examples:
basicMorphNode/basicMorphNode.cpp, and offsetNode/offsetNode.cpp.

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