HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
| 2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
| 3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
| 4 | <refentry id="glGetObjectLabel">\r | |
| 5 | <refmeta>\r | |
| 6 | <refmetainfo>\r | |
| 7 | <copyright>\r | |
| 8 | <year>2012</year>\r | |
| 9 | <holder>Khronos Group</holder>\r | |
| 10 | </copyright>\r | |
| 11 | </refmetainfo>\r | |
| 12 | <refentrytitle>glGetObjectLabel</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>glGetObjectLabel</refname>\r | |
| 17 | <refpurpose>retrieve the label of a named object identified within a namespace</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>C Specification</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>void <function>glGetObjectLabel</function></funcdef>\r | |
| 23 | <paramdef>GLenum <parameter>identifier</parameter></paramdef>\r | |
| 24 | <paramdef>GLuint <parameter>name</parameter></paramdef>\r | |
| 25 | <paramdef>GLsizei <parameter>bifSize</parameter></paramdef>\r | |
| 26 | <paramdef>GLsizei * <parameter>length</parameter></paramdef>\r | |
| 27 | <paramdef>char * <parameter>label</parameter></paramdef>\r | |
| 28 | </funcprototype>\r | |
| 29 | </funcsynopsis>\r | |
| 30 | </refsynopsisdiv>\r | |
| 31 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 32 | <variablelist>\r | |
| 33 | <varlistentry>\r | |
| 34 | <term><parameter>identifier</parameter></term>\r | |
| 35 | <listitem>\r | |
| 36 | <para>\r | |
| 37 | The namespace from which the name of the object is allocated.\r | |
| 38 | </para>\r | |
| 39 | </listitem>\r | |
| 40 | </varlistentry>\r | |
| 41 | <varlistentry>\r | |
| 42 | <term><parameter>name</parameter></term>\r | |
| 43 | <listitem>\r | |
| 44 | <para>\r | |
| 45 | The name of the object whose label to retrieve.\r | |
| 46 | </para>\r | |
| 47 | </listitem>\r | |
| 48 | </varlistentry>\r | |
| 49 | <varlistentry>\r | |
| 50 | <term><parameter>bufSize</parameter></term>\r | |
| 51 | <listitem>\r | |
| 52 | <para>\r | |
| 53 | The length of the buffer whose address is in <parameter>label</parameter>.\r | |
| 54 | </para>\r | |
| 55 | </listitem>\r | |
| 56 | </varlistentry>\r | |
| 57 | <varlistentry>\r | |
| 58 | <term><parameter>length</parameter></term>\r | |
| 59 | <listitem>\r | |
| 60 | <para>\r | |
| 61 | The address of a variable to receive the length of the object label.\r | |
| 62 | </para>\r | |
| 63 | </listitem>\r | |
| 64 | </varlistentry>\r | |
| 65 | <varlistentry>\r | |
| 66 | <term><parameter>label</parameter></term>\r | |
| 67 | <listitem>\r | |
| 68 | <para>\r | |
| 69 | The address of a string that will receive the object label.\r | |
| 70 | </para>\r | |
| 71 | </listitem>\r | |
| 72 | </varlistentry>\r | |
| 73 | </variablelist>\r | |
| 74 | </refsect1>\r | |
| 75 | <refsect1 id="description"><title>Description</title>\r | |
| 76 | <para>\r | |
| 77 | <function>glGetObjectLabel</function> retrieves the label of the object identified by\r | |
| 78 | <parameter>name</parameter> within the namespace given by <parameter>identifier</parameter>.\r | |
| 79 | <parameter>identifier</parameter> must be one of <constant>GL_BUFFER</constant>, <constant>GL_SHADER</constant>,\r | |
| 80 | <constant>GL_PROGRAM</constant>, <constant>GL_VERTEX_ARRAY</constant>, <constant>GL_QUERY</constant>,\r | |
| 81 | <constant>GL_PROGRAM_PIPELINE</constant>, <constant>GL_TRANSFORM_FEEDBACK</constant>, <constant>GL_SAMPLER</constant>,\r | |
| 82 | <constant>GL_TEXTURE</constant>, <constant>GL_RENDERBUFFER</constant>, <constant>GL_FRAMEBUFFER</constant>,\r | |
| 83 | to indicate the namespace containing the names of buffers, shaders, programs, vertex array objects, query objects,\r | |
| 84 | program pipelines, transform feedback objects, samplers, textures, renderbuffers and frame\r | |
| 85 | buffers, respectively.\r | |
| 86 | </para>\r | |
| 87 | <para>\r | |
| 88 | <parameter>label</parameter> is the address of a string that will be used to store the object label.\r | |
| 89 | <parameter>bufSize</parameter> specifies the number of characters in the array identified by <parameter>label</parameter>.\r | |
| 90 | <parameter>length</parameter> contains the address of a variable which will receive the the number of characters in the object label.\r | |
| 91 | If <parameter>length</parameter> is NULL, then it is ignored and no data is written. Likewise, if <parameter>label</parameter>\r | |
| 92 | is NULL, or if <parameter>bufSize</parameter> is zero then no data is written to <parameter>label</parameter>.\r | |
| 93 | </para>\r | |
| 94 | </refsect1>\r | |
| 95 | <refsect1 id="errors"><title>Errors</title>\r | |
| 96 | <para>\r | |
| 97 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>identifier</parameter>\r | |
| 98 | is not one of the accepted object types.\r | |
| 99 | </para>\r | |
| 100 | <para>\r | |
| 101 | <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>name</parameter>\r | |
| 102 | is not the name of an existing object of the type specified by <parameter>identifier</parameter>.\r | |
| 103 | </para>\r | |
| 104 | <para>\r | |
| 105 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>bufSize</parameter> is\r | |
| 106 | zero.\r | |
| 107 | </para>\r | |
| 108 | <para>\r | |
| 109 | If not NULL, <parameter>length</parameter> and <parameter>label</parameter> should be addresses\r | |
| 110 | to which the client has write access, otherwise undefined behavior, including process termination\r | |
| 111 | may occur.\r | |
| 112 | </para>\r | |
| 113 | </refsect1>\r | |
| 114 | <refsect1 id="associatedgets"><title>Associated Gets</title>\r | |
| 115 | <para>\r | |
| 116 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_LABEL_LENGTH</constant>.\r | |
| 117 | </para>\r | |
| 118 | </refsect1>\r | |
| 119 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 120 | <para>\r | |
| 121 | <citerefentry><refentrytitle>glPushDebugGroup</refentrytitle></citerefentry>,\r | |
| 122 | <citerefentry><refentrytitle>glPopDebugGroup</refentrytitle></citerefentry>,\r | |
| 123 | <citerefentry><refentrytitle>glObjectLabel</refentrytitle></citerefentry>,\r | |
| 124 | <citerefentry><refentrytitle>glGetObjectPtrLabel</refentrytitle></citerefentry>.\r | |
| 125 | </para>\r | |
| 126 | </refsect1>\r | |
| 127 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 128 | <para>\r | |
| 129 | Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r | |
| 130 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 131 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 132 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 133 | </para>\r | |
| 134 | </refsect1>\r | |
| 135 | </refentry>\r |