upstream-man-pages/man4/xhtml/glGenSamplers.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>glGenSamplers - 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="glGenSamplers"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGenSamplers — generate sampler object names</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">glGenSamplers</b>(</code></td><td>GLsizei  </td><td><var class="pdparam">n</var>, </td></tr><tr><td> </td><td>GLuint * </td><td><var class="pdparam">samplers</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>n</code></em></span></dt><dd><p>
   5                     Specifies the number of sampler object names to generate.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>samplers</code></em></span></dt><dd><p>
   7                     Specifies an array in which the generated sampler object names are stored.
   8                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   9             <code class="function">glGenSamplers</code> returns <em class="parameter"><code>n</code></em> sampler object names in <em class="parameter"><code>samplers</code></em>.
  10             There is no guarantee that the names form a contiguous set of integers; however, it is guaranteed that none of the returned names
  11             was in use immediately before the call to <code class="function">glGenSamplers</code>.
  12         </p><p>
  13             Sampler object names returned by a call to <code class="function">glGenSamplers</code> are not returned by subsequent calls, unless
  14             they are first deleted with <a href="glDeleteSamplers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteSamplers</span></span></a>.
  15         </p><p>
  16             The names returned in <em class="parameter"><code>samplers</code></em> are marked as used, for the purposes of <code class="function">glGenSamplers</code> only,
  17             but they acquire state and type only when they are first bound.
  18         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  19             <code class="function">glGenSamplers</code> is available only if the GL version is 3.3 or higher.
  20         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  21             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>n</code></em> is negative.
  22         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  23             <a href="glBindSampler.xml"><span class="citerefentry"><span class="refentrytitle">glBindSampler</span></span></a>,
  24             <a href="glIsSampler.xml"><span class="citerefentry"><span class="refentrytitle">glIsSampler</span></span></a>,
  25             <a href="glDeleteSamplers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteSamplers</span></span></a>
  26         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  27             Copyright <span class="trademark"></span>© 2010 Khronos Group.
  28             This material may be distributed subject to the terms and conditions set forth in
  29             the Open Publication License, v 1.0, 8 June 1999.
  30             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  31         </p></div></div></body></html>