OpenCL C++ Wrapper API 1.1
 All Classes Namespaces Files Functions Variables Typedefs Defines
Public Member Functions | Static Public Member Functions
cl::Event Class Reference

Event interface for cl_event. More...

#include <cl.hpp>

Inheritance diagram for cl::Event:
cl::detail::Wrapper< cl_event >

List of all members.

Public Member Functions

 Event ()
 Event (const Event &event)
 Event (const cl_event &event)
Eventoperator= (const Event &rhs)
Eventoperator= (const cl_event &rhs)
template<typename T >
cl_int getInfo (cl_event_info name, T *param) const
template<cl_int name>
detail::param_traits
< detail::cl_event_info, name >
::param_type 
getInfo (cl_int *err=NULL) const
template<typename T >
cl_int getProfilingInfo (cl_profiling_info name, T *param) const
template<cl_int name>
detail::param_traits
< detail::cl_profiling_info,
name >::param_type 
getProfilingInfo (cl_int *err=NULL) const
cl_int wait () const

Static Public Member Functions

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

Detailed Description

Event interface for cl_event.

Definition at line 1833 of file cl.hpp.


Constructor & Destructor Documentation

cl::Event::Event ( ) [inline]

Definition at line 1836 of file cl.hpp.

: detail::Wrapper<cl_type>() { }
cl::Event::Event ( const Event event) [inline]

Definition at line 1838 of file cl.hpp.

: detail::Wrapper<cl_type>(event) { }
cl::Event::Event ( const cl_event &  event) [inline]

Definition at line 1840 of file cl.hpp.

: detail::Wrapper<cl_type>(event) { }

Member Function Documentation

template<typename T >
cl_int cl::Event::getInfo ( cl_event_info  name,
T *  param 
) const [inline]

Definition at line 1857 of file cl.hpp.

    {
        return detail::errHandler(
            detail::getInfo(&::clGetEventInfo, object_, name, param),
            __GET_EVENT_INFO_ERR);
    }
template<cl_int name>
detail::param_traits<detail::cl_event_info, name>::param_type cl::Event::getInfo ( cl_int *  err = NULL) const [inline]

Definition at line 1866 of file cl.hpp.

    {
        typename detail::param_traits<
            detail::cl_event_info, name>::param_type param;
        cl_int result = getInfo(name, &param);
        if (err != NULL) {
            *err = result;
        }
        return param;
    }
template<typename T >
cl_int cl::Event::getProfilingInfo ( cl_profiling_info  name,
T *  param 
) const [inline]

Definition at line 1878 of file cl.hpp.

    {
        return detail::errHandler(detail::getInfo(
            &::clGetEventProfilingInfo, object_, name, param),
            __GET_EVENT_PROFILE_INFO_ERR);
    }
template<cl_int name>
detail::param_traits<detail::cl_profiling_info, name>::param_type cl::Event::getProfilingInfo ( cl_int *  err = NULL) const [inline]

Definition at line 1887 of file cl.hpp.

    {
        typename detail::param_traits<
            detail::cl_profiling_info, name>::param_type param;
        cl_int result = getProfilingInfo(name, &param);
        if (err != NULL) {
            *err = result;
        }
        return param;
    }
Event& cl::Event::operator= ( const Event rhs) [inline]

Definition at line 1842 of file cl.hpp.

    {
        if (this != &rhs) {
            detail::Wrapper<cl_type>::operator=(rhs);
        }
        return *this;
    }
Event& cl::Event::operator= ( const cl_event &  rhs) [inline]

Reimplemented from cl::detail::Wrapper< cl_event >.

Definition at line 1850 of file cl.hpp.

    {
        detail::Wrapper<cl_type>::operator=(rhs);
        return *this;
    }
cl_int cl::Event::wait ( ) const [inline]

Definition at line 1898 of file cl.hpp.

    {
        return detail::errHandler(
            ::clWaitForEvents(1, &object_),
            __WAIT_FOR_EVENTS_ERR);
    }
static cl_int cl::Event::waitForEvents ( const VECTOR_CLASS< Event > &  events) [inline, static]

Definition at line 1922 of file cl.hpp.

    {
        return detail::errHandler(
            ::clWaitForEvents(
                (cl_uint) events.size(), (cl_event*)&events.front()),
            __WAIT_FOR_EVENTS_ERR);
    }

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Defines