Class user_event

boost::compute::user_event — An user-created event.


// In header: <boost/compute/user_event.hpp>

class user_event : public boost::compute::event {
  // construct/copy/destruct
  explicit user_event(const context &);
  user_event(const user_event &);
  user_event(user_event &&) noexcept;
  user_event & operator=(const user_event &);
  user_event & operator=(user_event &&) noexcept;

  // public member functions
  void set_status(cl_int);


[Warning] Warning

This method is only available if the OpenCL version is 1.1 or later.

See Also:


user_event public construct/copy/destruct

  1. explicit user_event(const context & context);

    Creates a new user-event object.

    See the documentation for clCreateUserEvent() for more information.

  2. user_event(const user_event & other);
    Creates a new user-event from other.
  3. user_event(user_event && other) noexcept;
    Move-constructs a new user event object from other.
  4. user_event & operator=(const user_event & other);
    Copies the user-event from other to *this.
  5. user_event & operator=(user_event && other) noexcept;
    Move-assigns the user event from other to *this.

user_event public member functions

  1. void set_status(cl_int execution_status);

    Sets the execution status for the user-event.

    See the documentation for clSetUserEventStatus() for more information.