oglplus::Sync Class Reference

Encapsulates sync object and fence functionality. More...

#include </home/chochlik/devel/oglplus/include/oglplus/sync.hpp>

Classes
struct	Property
	Types related to Sync. More...

Public Member Functions
	Sync (SyncCondition condition=SyncCondition::GPUCommandsComplete)
	Creates a new sync object for the specified condition. More...
	Sync (Sync &&temp)
	Sync objects are moveable.
bool	Signaled (void) const
	Returns true if this Sync object is in signaled status. More...
SyncType	Type (void) const
	Returns the type of this Sync object. More...
SyncCondition	Condition (void) const
	Returns the condition of this Sync object. More...
SyncStatus	Status (void) const
	Returns the status of this Sync object. More...
SyncWaitResult	ClientWait (GLuint64 timeout) const
	Wait for the condition to be satisfied. More...
void	Wait (GLuint64 timeout=GL_TIMEOUT_IGNORED) const
	Wait for the condition to be satisfied. More...

Detailed Description

Encapsulates sync object and fence functionality.

Requires OpenGL 3.2 or the GL_ARB_sync extension.

Constructor & Destructor Documentation

oglplus::Sync::Sync

(

SyncCondition

condition = SyncCondition::GPUCommandsComplete

)

Creates a new sync object for the specified condition.

Sync objects are non-copyable

Related OpenGL symbols:

glFenceSync

Member Function Documentation

SyncWaitResult oglplus::Sync::ClientWait

(

GLuint64

timeout

)

const

Wait for the condition to be satisfied.

Related OpenGL symbols:

glClientWaitSync

SyncCondition oglplus::Sync::Condition

(

void

)

const

Returns the condition of this Sync object.

Related OpenGL symbols:

glGetSync GL_SYNC_CONDITION

bool oglplus::Sync::Signaled

(

void

)

const

Returns true if this Sync object is in signaled status.

Related OpenGL symbols:

glGetSync GL_SYNC_STATUS GL_SIGNALED

SyncStatus oglplus::Sync::Status

(

void

)

const

Returns the status of this Sync object.

Related OpenGL symbols:

glGetSync GL_SYNC_STATUS

SyncType oglplus::Sync::Type

(

void

)

const

Returns the type of this Sync object.

Related OpenGL symbols:

glGetSync GL_OBJECT_TYPE

void oglplus::Sync::Wait

(

GLuint64

timeout = GL_TIMEOUT_IGNORED

)

const

Wait for the condition to be satisfied.

Related OpenGL symbols:

glWaitSync

---

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

• /home/chochlik/devel/oglplus/include/oglplus/sync.hpp