This is the documentation for Enlighten.
class Geo GeoEvent
class Geo::GeoEvent
Event that can be manually triggered.
Functions
| Name | Description |
|---|---|
| ~GeoEvent() | Destructor. |
| GeoEvent() | Constructor. |
| GetHandle() | Returns the event handle. |
| IGeoEvent() | Constructor. |
| Reset() | Reset the event. |
| Signal(bool) | Signal release of other threads. |
| Wait(Geo::u32) | Block current thread until signalled. |
| WaitForMultipleEvents(GeoArray< GeoRefPtr< IGeoEvent >>, u32) | cross platform implementation of WaitForMultipleObjects returns index of event that triggers, or -1 for failure |
Variables
| Name | Description |
|---|---|
| Impl::EventHandle m_Event | The event handle. |
Geo::GeoEvent::~GeoEvent
public: ~GeoEvent()
Destructor.
Geo::GeoEvent::GeoEvent
public: GeoEvent()
Constructor.
Impl::EventHandle Geo::IGeoEvent::GetHandle
public: Impl::EventHandle GetHandle()
Returns the event handle.
Geo::IGeoEvent::IGeoEvent
protected: IGeoEvent()
Constructor.
void Geo::GeoEvent::Reset
public: void Reset()
Reset the event.
void Geo::GeoEvent::Signal
public: void Signal
(
bool reset
)
Signal release of other threads.
void Geo::GeoEvent::Wait
public: void Wait
(
Geo::u32 timeout
)
Block current thread until signalled.
static s32 Geo::IGeoEvent::WaitForMultipleEvents
public: s32 WaitForMultipleEvents
(
GeoArray< GeoRefPtr< IGeoEvent >> events,
u32 waitMilliseconds
)
cross platform implementation of WaitForMultipleObjects returns index of event that triggers, or -1 for failure