YAKL
Public Member Functions | List of all members
yakl::Event Struct Reference

Implements the functionality of an event within a stream. The event is not created until the Event::create() function is called. More...

#include <YAKL_streams_events.h>

Public Member Functions

bool completed ()
 Determine if this event has completed. More...
 
void create ()
 Create the event. More...
 
void destroy ()
 Destroy the event. More...
 
void fence ()
 Pause all CPU work until this event has completed. More...
 
bool operator== (Event event) const
 Determine if this event is the same as the passed event. More...
 
void record (Stream stream)
 Record an event in the passed stream. More...
 

Detailed Description

Implements the functionality of an event within a stream. The event is not created until the Event::create() function is called.

Member Function Documentation

◆ completed()

bool yakl::Event::completed ( )
inline

Determine if this event has completed.

◆ create()

void yakl::Event::create ( )
inline

Create the event.

◆ destroy()

void yakl::Event::destroy ( )
inline

Destroy the event.

◆ fence()

void yakl::Event::fence ( )
inline

Pause all CPU work until this event has completed.

◆ operator==()

bool yakl::Event::operator== ( Event  event) const
inline

Determine if this event is the same as the passed event.

◆ record()

void yakl::Event::record ( Stream  stream)
inline

Record an event in the passed stream.


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