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>glGetMultisamplefv
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.75.2" /></head><body><div class=
"refentry" title=
"glGetMultisamplefv"><a id=
"glGetMultisample"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glGetMultisamplefv — retrieve the location of a sample
</p></div><div class=
"refsynopsisdiv" title=
"C Specification"><h2>C Specification
</h2><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0" class=
"funcprototype-table"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glGetMultisamplefv
</b>(
</code></td><td>GLenum
<var class=
"pdparam">pname
</var>,
</td></tr><tr><td> </td><td>GLuint
<var class=
"pdparam">index
</var>,
</td></tr><tr><td> </td><td>GLfloat *
<var class=
"pdparam">val
</var><code>)
</code>;
</td></tr></table><div class=
"funcprototype-spacer"> </div></div></div><div class=
"refsect1" title=
"Parameters"><a id=
"parameters"></a><h2>Parameters
</h2><div class=
"variablelist"><dl><dt><span class=
"term"><em class=
"parameter"><code>pname
</code></em></span></dt><dd><p>
5 Specifies the sample parameter name.
<em class=
"parameter"><code>pname
</code></em> must be
<code class=
"constant">GL_SAMPLE_POSITION
</code>.
6 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>index
</code></em></span></dt><dd><p>
7 Specifies the index of the sample whose position to query.
8 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>val
</code></em></span></dt><dd><p>
9 Specifies the address of an array to receive the position of the sample.
10 </p></dd></dl></div></div><div class=
"refsect1" title=
"Description"><a id=
"description"></a><h2>Description
</h2><p>
11 <code class=
"function">glGetMultisamplefv
</code> queries the location of a given sample.
<em class=
"parameter"><code>pname
</code></em>
12 specifies the sample parameter to retrieve and must be
<code class=
"constant">GL_SAMPLE_POSITION
</code>.
<em class=
"parameter"><code>index
</code></em>
13 corresponds to the sample for which the location should be returned. The sample location is returned as two floating-point
14 values in
<em class=
"parameter"><code>val[
0]
</code></em> and
<em class=
"parameter"><code>val[
1]
</code></em>, each between
0 and
1, corresponding to the
<em class=
"parameter"><code>x
</code></em>
15 and
<em class=
"parameter"><code>y
</code></em> locations respectively in the GL pixel space of that sample. (
0.5,
0.5) this corresponds to the
16 pixel center.
<em class=
"parameter"><code>index
</code></em> must be between zero and the value of
<code class=
"constant">GL_SAMPLES
</code> -
1.
18 If the multisample mode does not have fixed sample locations, the returned values may only reflect the locations of samples
20 </p></div><div class=
"refsect1" title=
"Errors"><a id=
"errors"></a><h2>Errors
</h2><p>
21 <code class=
"constant">GL_INVALID_ENUM
</code> is generated if
<em class=
"parameter"><code>pname
</code></em> is not one
<code class=
"constant">GL_SAMPLE_POSITION
</code>.
23 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>index
</code></em> is greater than or equal to the value of
24 <code class=
"constant">GL_SAMPLES
</code>.
25 </p></div><div class=
"refsect1" title=
"See Also"><a id=
"seealso"></a><h2>See Also
</h2><p>
26 <a class=
"citerefentry" href=
"glGenFramebuffers.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGenFramebuffers
</span></span></a>,
27 <a class=
"citerefentry" href=
"glBindFramebuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBindFramebuffer
</span></span></a>
28 </p></div><div class=
"refsect1" title=
"Copyright"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
29 Copyright
<span class=
"trademark"></span>©
2010 Khronos Group.
30 This material may be distributed subject to the terms and conditions set forth in
31 the Open Publication License, v
1.0,
8 June
1999.
32 <a class=
"ulink" href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
33 </p></div></div></body></html>