GLAPI/glGetSync: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
← Older edit
m Bot: Adjusting API page category.
m Bot: Adding better formatting.
 
(4 intermediate revisions by the same user not shown)
Line 9: Line 9:
== Function Definition ==
== Function Definition ==


   void '''glGetSynciv'''(GLsync ''sync'', GLenum ''pname'', GLsizei ''bufSize'', GLsizei *''length'', GLint *''values'');
   void '''glGetSynciv'''(GLsync {{param|sync}}, GLenum {{param|pname}}, GLsizei {{param|bufSize}}, GLsizei *{{param|length}}, GLint *{{param|values}});


; sync
; sync
: Specifies the sync object whose properties to query.
: Specifies the sync object whose properties to query.
; pname
; pname
: Specifies the parameter whose value to retrieve from the sync object specified in ''sync''.
: Specifies the parameter whose value to retrieve from the sync object specified in {{param|sync}}.
; bufSize
; bufSize
: Specifies the size of the buffer whose address is given in ''values''.
: Specifies the size of the buffer whose address is given in {{param|values}}.
; length
; length
: Specifies the address of an variable to receive the number of integers placed in ''values''.
: Specifies the address of an variable to receive the number of integers placed in {{param|values}}.
; values
; values
: Specifies the address of an array to receive the values of the queried parameter.
: Specifies the address of an array to receive the values of the queried parameter.
Line 24: Line 24:
== Description ==
== Description ==


'''glGetSynciv''' retrieves properties of a sync object. ''sync'' specifies the name of the sync object whose properties to retrieve.
'''glGetSynciv''' retrieves properties of a sync object. {{param|sync}} specifies the name of the sync object whose properties to retrieve.


On success, '''glGetSynciv''' replaces up to ''bufSize'' integers in ''values'' with the corresponding property values of the object being queried. The actual number of integers replaced is returned in the variable whose address is specified in ''length''. If ''length'' is {{code|NULL}}, no length is returned.
On success, '''glGetSynciv''' replaces up to {{param|bufSize}} integers in {{param|values}} with the corresponding property values of the object being queried. The actual number of integers replaced is returned in the variable whose address is specified in {{param|length}}. If {{param|length}} is {{code|NULL}}, no length is returned.


If ''pname'' is {{code|GL_OBJECT_TYPE}}, a single value representing the specific type of the sync object is placed in ''values''. The only type supported is {{code|GL_SYNC_FENCE}}.
If {{param|pname}} is {{enum|GL_OBJECT_TYPE}}, a single value representing the specific type of the sync object is placed in {{param|values}}. The only type supported is {{enum|GL_SYNC_FENCE}}.


If ''pname'' is {{code|GL_SYNC_STATUS}}, a single value representing the status of the sync object ({{code|GL_SIGNALED}} or {{code|GL_UNSIGNALED}}) is placed in ''values''.
If {{param|pname}} is {{enum|GL_SYNC_STATUS}}, a single value representing the status of the sync object ({{enum|GL_SIGNALED}} or {{enum|GL_UNSIGNALED}}) is placed in {{param|values}}.


If ''pname'' is {{code|GL_SYNC_CONDITION}}, a single value representing the condition of the sync object is placed in ''values''. The only condition supported is {{code|GL_SYNC_GPU_COMMANDS_COMPLETE}}.
If {{param|pname}} is {{enum|GL_SYNC_CONDITION}}, a single value representing the condition of the sync object is placed in {{param|values}}. The only condition supported is {{enum|GL_SYNC_GPU_COMMANDS_COMPLETE}}.


If ''pname'' is {{code|GL_SYNC_FLAGS}}, a single value representing the flags with which the sync object was created is placed in ''values''. No flags are currently supported('''Note:''' ''flags'' is expected to be used in future extensions to the sync objects.).
If {{param|pname}} is {{enum|GL_SYNC_FLAGS}}, a single value representing the flags with which the sync object was created is placed in {{param|values}}. No flags are currently supported('''Note:''' {{param|flags}} is expected to be used in future extensions to the sync objects.).


If an error occurs, nothing will be written to ''values'' or ''length''.
If an error occurs, nothing will be written to {{param|values}} or {{param|length}}.


== Errors ==
== Errors ==


{{code|GL_INVALID_VALUE}} is generated if ''sync'' is not the name of a sync object.
{{enum|GL_INVALID_VALUE}} is generated if {{param|sync}} is not the name of a sync object.


{{code|GL_INVALID_ENUM}} is generated if ''pname'' is not one of the accepted tokens.
{{enum|GL_INVALID_ENUM}} is generated if {{param|pname}} is not one of the accepted tokens.


== See Also ==
== See Also ==


[[GLAPI/glFenceSync|glFenceSync]], [[GLAPI/glWaitSync|glWaitSync]], [[GLAPI/glClientWaitSync|glClientWaitSync]]
{{apifunc|glFenceSync}}, {{apifunc|glWaitSync}}, {{apifunc|glClientWaitSync}}


== Copyright ==
== Copyright ==
Line 52: Line 52:
Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. [http://opencontent.org/openpub/ http://opencontent.org/openpub/].
Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. [http://opencontent.org/openpub/ http://opencontent.org/openpub/].


[[Category:API Reference 4|GetSync]]
[[Category:Core API Reference|GetSync]]
[[Category:GL 4 API Synchronization|GetSync]]
[[Category:Core API Ref Synchronization|GetSync]]
[[Category:Sync Object API State Functions|GetSync]]

Latest revision as of 10:01, 15 August 2013

glGetSynciv
Core in version 4.6
Core since version 3.2
Core ARB extension ARB_sync

glGetSynciv: query the properties of a sync object

Function Definition

 void glGetSynciv(GLsync sync​, GLenum pname​, GLsizei bufSize​, GLsizei *length​, GLint *values​);
sync
Specifies the sync object whose properties to query.
pname
Specifies the parameter whose value to retrieve from the sync object specified in sync​.
bufSize
Specifies the size of the buffer whose address is given in values​.
length
Specifies the address of an variable to receive the number of integers placed in values​.
values
Specifies the address of an array to receive the values of the queried parameter.

Description

glGetSynciv retrieves properties of a sync object. sync​ specifies the name of the sync object whose properties to retrieve.

On success, glGetSynciv replaces up to bufSize​ integers in values​ with the corresponding property values of the object being queried. The actual number of integers replaced is returned in the variable whose address is specified in length​. If length​ is NULL, no length is returned.

If pname​ is GL_OBJECT_TYPE, a single value representing the specific type of the sync object is placed in values​. The only type supported is GL_SYNC_FENCE.

If pname​ is GL_SYNC_STATUS, a single value representing the status of the sync object (GL_SIGNALED or GL_UNSIGNALED) is placed in values​.

If pname​ is GL_SYNC_CONDITION, a single value representing the condition of the sync object is placed in values​. The only condition supported is GL_SYNC_GPU_COMMANDS_COMPLETE.

If pname​ is GL_SYNC_FLAGS, a single value representing the flags with which the sync object was created is placed in values​. No flags are currently supported(Note: flags​ is expected to be used in future extensions to the sync objects.).

If an error occurs, nothing will be written to values​ or length​.

Errors

GL_INVALID_VALUE is generated if sync​ is not the name of a sync object.

GL_INVALID_ENUM is generated if pname​ is not one of the accepted tokens.

See Also

glFenceSync, glWaitSync, glClientWaitSync

Copyright

Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

Retrieved from "https://wikis.khronos.org/opengl/index.php?title=GLAPI/glGetSync&oldid=11047"