upstream-doc/man4/xhtml/glGetObjectLabel.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glGetObjectLabel - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glGetObjectLabel"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetObjectLabel — retrieve the label of a named object identified within a namespace</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glGetObjectLabel</b>(</code></td><td>GLenum  </td><td><var class="pdparam">identifier</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">name</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">bifSize</var>, </td></tr><tr><td> </td><td>GLsizei *  </td><td><var class="pdparam">length</var>, </td></tr><tr><td> </td><td>char *  </td><td><var class="pdparam">label</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>identifier</code></em></span></dt><dd><p>
   5                     The namespace from which the name of the object is allocated.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p>
   7                     The name of the object whose label to retrieve.
   8                 </p></dd><dt><span class="term"><em class="parameter"><code>bufSize</code></em></span></dt><dd><p>
   9                     The length of the buffer whose address is in <em class="parameter"><code>label</code></em>.
  10                 </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
  11                     The address of a variable to receive the length of the object label.
  12                 </p></dd><dt><span class="term"><em class="parameter"><code>label</code></em></span></dt><dd><p>
  13                     The address of a string that will receive the object label.
  14                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  15             <code class="function">glGetObjectLabel</code> retrieves the label of the object identified by
  16             <em class="parameter"><code>name</code></em> within the namespace given by <em class="parameter"><code>identifier</code></em>.
  17             <em class="parameter"><code>identifier</code></em> must be one of <code class="constant">GL_BUFFER</code>, <code class="constant">GL_SHADER</code>,
  18             <code class="constant">GL_PROGRAM</code>, <code class="constant">GL_VERTEX_ARRAY</code>, <code class="constant">GL_QUERY</code>,
  19             <code class="constant">GL_PROGRAM_PIPELINE</code>, <code class="constant">GL_TRANSFORM_FEEDBACK</code>, <code class="constant">GL_SAMPLER</code>,
  20             <code class="constant">GL_TEXTURE</code>, <code class="constant">GL_RENDERBUFFER</code>, <code class="constant">GL_FRAMEBUFFER</code>,
  21             to indicate the namespace containing the names of buffers, shaders, programs, vertex array objects, query objects,
  22             program pipelines, transform feedback objects, samplers, textures, renderbuffers and frame
  23             buffers, respectively.
  24         </p><p>
  25             <em class="parameter"><code>label</code></em> is the address of a string that will be used to store the object label.
  26             <em class="parameter"><code>bufSize</code></em> specifies the number of characters in the array identified by <em class="parameter"><code>label</code></em>.
  27             <em class="parameter"><code>length</code></em> contains the address of a variable which will receive the the number of characters in the object label.
  28             If <em class="parameter"><code>length</code></em> is NULL, then it is ignored and no data is written. Likewise, if <em class="parameter"><code>label</code></em>
  29             is NULL, or if <em class="parameter"><code>bufSize</code></em> is zero then no data is written to <em class="parameter"><code>label</code></em>.
  30         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  31             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>identifier</code></em>
  32             is not one of the accepted object types.
  33         </p><p>
  34             <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>name</code></em>
  35             is not the name of an existing object of the type specified by <em class="parameter"><code>identifier</code></em>.
  36         </p><p>
  37             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>bufSize</code></em> is
  38             zero.
  39         </p><p>
  40             If not NULL, <em class="parameter"><code>length</code></em> and <em class="parameter"><code>label</code></em> should be addresses
  41             to which the client has write access, otherwise undefined behavior, including process termination
  42             may occur.
  43         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  44             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_LABEL_LENGTH</code>.
  45         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  46             <a href="glPushDebugGroup.xml"><span class="citerefentry"><span class="refentrytitle">glPushDebugGroup</span></span></a>,
  47             <a href="glPopDebugGroup.xml"><span class="citerefentry"><span class="refentrytitle">glPopDebugGroup</span></span></a>,
  48             <a href="glObjectLabel.xml"><span class="citerefentry"><span class="refentrytitle">glObjectLabel</span></span></a>,
  49             <a href="glGetObjectPtrLabel.xml"><span class="citerefentry"><span class="refentrytitle">glGetObjectPtrLabel</span></span></a>.
  50         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  51             Copyright <span class="trademark"></span>© 2012 Khronos Group.
  52             This material may be distributed subject to the terms and conditions set forth in
  53             the Open Publication License, v 1.0, 8 June 1999.
  54             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  55         </p></div></div></body></html>