cl::Event Class Reference

Class interface for cl_event. More...

`#include <cl.hpp>`

Inheritance diagram for cl::Event:
[legend]
Collaboration diagram for cl::Event:
[legend]

## Public Member Functions

| Event ()
| Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS | Event (const cl_event &event)
| Constructor from cl_event - takes ownership. More...
Event & | operator= (const cl_event &rhs)
| Assignment operator from cl_event - takes ownership. More...
template<typename T >
cl_int | getInfo (cl_event_info name, T *param) const
| Wrapper for clGetEventInfo(). More...
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. More...
template<typename T >
cl_int | getProfilingInfo (cl_profiling_info name, T *param) const
| Wrapper for clGetEventProfilingInfo(). More...
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. More...
cl_int | wait () const
| Blocks the calling thread until this event completes. More...
| Event ()
| Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS | Event (const cl_event &event)
| Constructor from cl_event - takes ownership. More...
Event & | operator= (const cl_event &rhs)
| Assignment operator from cl_event - takes ownership. More...
template<typename T >
cl_int | getInfo (cl_event_info name, T *param) const
| Wrapper for clGetEventInfo(). More...
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. More...
template<typename T >
cl_int | getProfilingInfo (cl_profiling_info name, T *param) const
| Wrapper for clGetEventProfilingInfo(). More...
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. More...
cl_int | wait () const
| Blocks the calling thread until this event completes. More...
Public Member Functions inherited from cl::detail::Wrapper< cl_event >
| Wrapper ()
| Wrapper (const cl_type &obj)
| Wrapper (const Wrapper< cl_type > &rhs)
| Wrapper ()
| Wrapper (const cl_type &obj)
| Wrapper (const Wrapper< cl_type > &rhs)
| ~Wrapper ()
| ~Wrapper ()
Wrapper< cl_type > & | operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > & | operator= (const 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() ()
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. More...
static cl_int | waitForEvents (const VECTOR_CLASS< Event > &events)
| Blocks the calling thread until every event specified is complete. More...

## Additional Inherited Members

Public Types inherited from cl::detail::Wrapper< cl_event >
typedef cl_event | cl_type
typedef cl_event | cl_type
Protected Member Functions inherited from cl::detail::Wrapper< cl_event >
cl_int | retain () const
cl_int | retain () const
cl_int | release () 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

Definition at line 2714 of file cl.hpp.

## Constructor & Destructor Documentation

## Event() [1/4]

cl::Event::Event | ( |  | ) |

inline

Default constructor - initializes to NULL.

Definition at line 2718 of file cl.hpp.

## Event() [2/4]

__CL_EXPLICIT_CONSTRUCTORS 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.

Definition at line 2725 of file cl.hpp.

## Event() [3/4]

cl::Event::Event | ( |  | ) |

inline

Default constructor - initializes to NULL.

Definition at line 2718 of file cl.hpp.

## Event() [4/4]

__CL_EXPLICIT_CONSTRUCTORS 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.

Definition at line 2725 of file cl.hpp.

## Member Function Documentation

## getInfo() [1/4]

template<typename T >

cl_int cl::Event::getInfo | ( | cl_event_info | name,
|  | T * | param
| ) |  | const

inline

Wrapper for clGetEventInfo().

Definition at line 2740 of file cl.hpp.

## getInfo() [2/4]

template<typename T >

cl_int cl::Event::getInfo | ( | cl_event_info | name,
|  | T * | param
| ) |  | const

inline

Wrapper for clGetEventInfo().

Definition at line 2740 of file cl.hpp.

## getInfo() [3/4]

template<cl_int name>

detail::param_traits<detail::cl_event_info, name>::param_type cl::Event::getInfo | ( | cl_int * | err = `NULL` | ) | const

inline

Wrapper for clGetEventInfo() that returns by value.

Definition at line 2750 of file cl.hpp.

## getInfo() [4/4]

template<cl_int name>

detail::param_traits<detail::cl_event_info, name>::param_type cl::Event::getInfo | ( | cl_int * | err = `NULL` | ) | const

inline

Wrapper for clGetEventInfo() that returns by value.

Definition at line 2750 of file cl.hpp.

## getProfilingInfo() [1/4]

template<cl_int name>

detail::param_traits<detail::cl_profiling_info, name>::param_type cl::Event::getProfilingInfo | ( | cl_int * | err = `NULL` | ) | const

inline

Wrapper for clGetEventProfilingInfo() that returns by value.

Definition at line 2773 of file cl.hpp.

## getProfilingInfo() [2/4]

template<cl_int name>

detail::param_traits<detail::cl_profiling_info, name>::param_type cl::Event::getProfilingInfo | ( | cl_int * | err = `NULL` | ) | const

inline

Wrapper for clGetEventProfilingInfo() that returns by value.

Definition at line 2773 of file cl.hpp.

## getProfilingInfo() [3/4]

template<typename T >

cl_int cl::Event::getProfilingInfo | ( | cl_profiling_info | name,
|  | T * | param
| ) |  | const

inline

Wrapper for clGetEventProfilingInfo().

Definition at line 2763 of file cl.hpp.

## getProfilingInfo() [4/4]

template<typename T >

cl_int cl::Event::getProfilingInfo | ( | cl_profiling_info | name,
|  | T * | param
| ) |  | const

inline

Wrapper for clGetEventProfilingInfo().

Definition at line 2763 of file cl.hpp.

## operator=() [1/2]

Event& cl::Event::operator= | ( | const cl_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.

Definition at line 2732 of file cl.hpp.

## operator=() [2/2]

Event& cl::Event::operator= | ( | const cl_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.

Definition at line 2732 of file cl.hpp.

## wait() [1/2]

cl_int cl::Event::wait | ( |  | ) | const

inline

Blocks the calling thread until this event completes.

Wraps clWaitForEvents().

Definition at line 2788 of file cl.hpp.

## wait() [2/2]

cl_int cl::Event::wait | ( |  | ) | const

inline

Blocks the calling thread until this event completes.

Wraps clWaitForEvents().

Definition at line 2788 of file cl.hpp.

## waitForEvents() [1/2]

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

inline static

Blocks the calling thread until every event specified is complete.

Wraps clWaitForEvents().

Definition at line 2820 of file cl.hpp.

## waitForEvents() [2/2]

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

inline static

Blocks the calling thread until every event specified is complete.

Wraps clWaitForEvents().

Definition at line 2820 of file cl.hpp.

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

- /build/asl-1Fw6fH/asl-0.1.7/debian/tmp/usr/include/ASL/acl/cl.hpp