cl::Event Class Reference

Class interface for cl_event. More...

#include <cl.hpp>

Inheritance diagram for cl::Event:

Public Member Functions
	~Event ()
	Destructor.
	Event ()
	Default constructor - initializes to NULL.
	Event (const Event &event)
	Copy constructor.
	Event (const cl_event &event)
	Constructor from cl_event - takes ownership.
Event &	operator= (const Event &rhs)
	Assignment operator from cl_event - takes ownership.
Event &	operator= (const cl_event &rhs)
	Assignment operator from cl_event.
template<typename T >
cl_int	getInfo (cl_event_info name, T *param) const
	Wrapper for clGetEventInfo().
template<cl_int name>
detail::param_traits< detail::cl_event_info, name >::param_type	getInfo (cl_int *err=NULL) const
	Wrapper for clGetEventInfo() that returns by value.
template<typename T >
cl_int	getProfilingInfo (cl_profiling_info name, T *param) const
	Wrapper for clGetEventProfilingInfo().
template<cl_int name>
detail::param_traits< detail::cl_profiling_info, name >::param_type	getProfilingInfo (cl_int *err=NULL) const
	Wrapper for clGetEventProfilingInfo() that returns by value.
cl_int	wait () const
	Blocks the calling thread until this event completes.
Public Member Functions inherited from cl::detail::Wrapper< cl_event >
	Wrapper (const cl_type &obj)
	Wrapper (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (const cl_type &rhs)
cl_type	operator() () const
cl_type &	operator() ()

Static Public Member Functions
static cl_int	waitForEvents (const VECTOR_CLASS< Event > &events)
	Blocks the calling thread until every event specified is complete.

Additional Inherited Members
Public Types inherited from cl::detail::Wrapper< cl_event >
typedef cl_event	cl_type
Protected Member Functions inherited from cl::detail::Wrapper< cl_event >
cl_int	retain () const
cl_int	release () const
Protected Attributes inherited from cl::detail::Wrapper< cl_event >
cl_type	object_

Detailed Description

Class interface for cl_event.

Note

Copies of these objects are shallow, meaning that the copy will refer to the same underlying cl_event as the original. For details, see clRetainEvent() and clReleaseEvent().

See also

cl_event

Constructor & Destructor Documentation

~Event()

cl::Event::~Event ( )

inline

Destructor.

This calls clReleaseEvent() on the value held by this instance.

Event() [1/2]

cl::Event::Event ( const Event &  event )

inline

Copy constructor.

This calls clRetainEvent() on the parameter's cl_event.

Event() [2/2]

cl::Event::Event ( const cl_event &  event )

inline

Constructor from cl_event - takes ownership.

This effectively transfers ownership of a refcount on the cl_event into the new Event object.

Member Function Documentation

operator=() [1/2]

Event & cl::Event::operator= ( const cl_event &  rhs )

inline

Assignment operator from cl_event.

This calls clRetainEvent() on the parameter and clReleaseEvent() on the previous value held by this instance.

operator=() [2/2]

Event & cl::Event::operator= ( const Event &  rhs )

inline

Assignment operator from cl_event - takes ownership.

This effectively transfers ownership of a refcount on the rhs and calls clReleaseEvent() on the value previously held by this instance.

wait()

cl_int cl::Event::wait ( ) const

inline

Blocks the calling thread until this event completes.

Wraps clWaitForEvents().

Referenced by cl::copy(), and cl::copy().

waitForEvents()

static cl_int cl::Event::waitForEvents ( const VECTOR_CLASS< Event > &  events )

inlinestatic

Blocks the calling thread until every event specified is complete.

Wraps clWaitForEvents().