plucky (3) glGetObjectPtrLabel.3G.gz

Provided by: opengl-4-man-doc_1.0~svn33624-3_all bug

NAME
       glGetObjectPtrLabel - retrieve the label of a sync object identified by a pointer


C SPECIFICATION
       void glGetObjectPtrLabel(void * ptr, GLsizei bifSize, GLsizei * length, char * label);


PARAMETERS
       ptr
           The name of the sync object whose label to retrieve.

       bufSize
           The length of the buffer whose address is in label.

       length
           The address of a variable to receive the length of the object label.

       label
           The address of a string that will receive the object label.


DESCRIPTION
       glGetObjectPtrLabel retrieves the label of the sync object identified by ptr.

       label is the address of a string that will be used to store the object label.  bufSize specifies the
       number of characters in the array identified by label.  length contains the address of a variable which
       will receive the the number of characters in the object label. If length is NULL, then it is ignored and
       no data is written. Likewise, if label is NULL, or if bufSize is zero then no data is written to label.


ERRORS
       GL_INVALID_ENUM is generated if identifier is not one of the accepted object types.

       GL_INVALID_VALUE is generated if ptr is not the name of an existing sync object.

       GL_INVALID_VALUE is generated if bufSize is zero.

       If not NULL, length and label should be addresses to which the client has write access, otherwise
       undefined behavior, including process termination may occur.


ASSOCIATED GETS
       glGet() with argument GL_MAX_LABEL_LENGTH.


VERSION SUPPORT
       ┌────────────────────┬───────────────────────────────────────────────────────────────────────┐
       │                    │                OpenGL Version                                         │
       ├────────────────────┼─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┤
       │Function            │ 2.0 │ 2.1 │ 3.0 │ 3.1 │ 3.2 │ 3.3 │ 4.0 │ 4.1 │ 4.2 │ 4.3 │ 4.4 │ 4.5 │
       │/                   │     │     │     │     │     │     │     │     │     │     │     │     │
       │Feature             │     │     │     │     │     │     │     │     │     │     │     │     │
       │Name                │     │     │     │     │     │     │     │     │     │     │     │     │
       ├────────────────────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
       │glGetObjectPtrLabel │  -  │  -  │  -  │  -  │  -  │  -  │  -  │  -  │  -  │  ✔  │  ✔  │  ✔  │
       └────────────────────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘


SEE ALSO
       glPushDebugGroup(), glPopDebugGroup(), glObjectLabel(), glGetObjectLabel().


       Copyright © 2013-2014 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/.


       Copyright © 2013-2014 Khronos Group

[FIXME: source]                                    11/18/2024                            GLGETOBJECTPTRLABEL(3G)