Games Task Scheduler (GTS)
A multi-processor scheduling framework for games engines
Macros
OsEventWrapper
Config

Macros

#define GTS_WAIT_FOREVER   #error "Replace with custom definition"
 
#define GTS_EVENT_HANDLE_TYPE   #error "Replace with custom definition"
 
#define GTS_CREATE_EVENT(eventHandle)   #error "Replace with custom definition"
 Creates an OS event object. More...
 
#define GTS_DESTROY_EVENT(eventHandle)   #error "Replace with custom definition"
 Destroys an OS event object. More...
 
#define GTS_WAIT_FOR_EVENT(eventHandle, waitForever)   #error "Replace with custom definition"
 Blocks until an event is signaled. More...
 
#define GTS_SIGNAL_EVENT(eventHandle)   #error "Replace with custom definition"
 Signals an event. More...
 
#define GTS_RESET_EVENT(eventHandle)   #error "Replace with custom definition"
 Resets an event to be unsignaled. More...
 

Detailed Description

User defined wrappers for the OS event API.

Macro Definition Documentation

◆ GTS_CREATE_EVENT

#define GTS_CREATE_EVENT (   eventHandle)    #error "Replace with custom definition"

Creates an OS event object.

Remarks
Signature:
bool createEvent(EventHandle& handle)
Parameters
[out]eventHandleThe returned handle to the event.
Returns
True on success, false on fail.

◆ GTS_DESTROY_EVENT

#define GTS_DESTROY_EVENT (   eventHandle)    #error "Replace with custom definition"

Destroys an OS event object.

Remarks
Signature:
bool destroyEvent(EventHandle& handle)
Parameters
eventHandleThe event to destroy.
Returns
True on success, false on fail.

◆ GTS_RESET_EVENT

#define GTS_RESET_EVENT (   eventHandle)    #error "Replace with custom definition"

Resets an event to be unsignaled.

Remarks
Signature:
bool resetEvent(EventHandle& handle)
Parameters
eventHandleThe to signal.
Returns
True on success, false on fail.

◆ GTS_SIGNAL_EVENT

#define GTS_SIGNAL_EVENT (   eventHandle)    #error "Replace with custom definition"

Signals an event.

Remarks
Signature:
bool signalEvent(EventHandle& handle)
Parameters
eventHandleThe to signal.
Returns
True on success, false on fail.

◆ GTS_WAIT_FOR_EVENT

#define GTS_WAIT_FOR_EVENT (   eventHandle,
  waitForever 
)    #error "Replace with custom definition"

Blocks until an event is signaled.

Remarks
Signature:
bool waitForEvent(EventHandle& handle, bool waitForever)
Parameters
eventHandleThe event to wait for.
waitForeverFlag true to wait until an event is signaled, false to return immediate.
Returns
True if then event was set to unsignaled, false otherwise.