• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
5  <head>
6    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
7    <style xmlns="" type="text/css">
8    /* This style sets a margin around the entire page */
9        html, body {
10            margin: 10px;
11        }
12
13        p {
14            font: normal 16px verdana, sans-serif;
15            margin: 0;
16            padding-bottom:12px;
17        }
18
19        h1 {
20            font: bold 25px verdana, sans-serif;
21            margin-top: 0;
22            margin-bottom: 3px;
23            padding-top: 0;
24            padding-bottom: 0;
25        }
26
27        h2 {
28            font: bold 19px verdana, sans-serif;
29            margin-top: 28px;
30            margin-bottom: 3px;
31            padding-top: 0;
32            padding-bottom: 0;
33        }
34
35        h3 {
36            font: bold 19px verdana, sans-serif !important;
37            margin-top: 28px;
38            margin-bottom: 3px;
39            padding-top: 0;
40            padding-bottom: 0;
41        }
42
43        li {
44            font: normal 16px verdana, sans-serif;
45            margin-top: 0;
46            margin-bottom: 18px;
47            padding-top: 0;
48            padding-bottom: 0;
49        }
50
51        .pdparam {
52            font: italic 16px verdana, sans-serif;
53        }
54
55                .term {
56                        font: italic 16px verdana, sans-serif;
57                        font-weight: normal;
58                }
59
60                .type {
61                        font: normal 16px verdana, sans-serif !important;
62                }
63
64                .parameter {
65                        font-style: italic;
66                        }
67
68        a:link, a:visited {
69            color: blue;
70            text-decoration: none;
71            font: normal 16px;
72        }
73
74        a:hover {
75            background-color: #FFFF99;
76            font: normal 16px;
77        }
78
79        div.funcsynopsis {
80            text-align: left;
81            background-color: #e6e6e6;
82            font: normal 16px verdana, sans-serif;
83                        padding-top: 10px;
84                        padding-bottom: 10px;
85        }
86
87        div.funcsynopsis table {
88            border-collapse: separate;
89            font: normal 16px verdana, sans-serif;
90        }
91
92        div.funcsynopsis td {
93            background-color: #e6e6e6;
94            border: 0 solid #000;
95            padding: 1px;
96            font: normal 16px verdana, sans-serif;
97        }
98
99        div.refsect1 {
100            font-family: verdana, sans-serif;
101            font-size: 16px;
102        }
103
104        code.constant {
105            font: normal 16px courier new, monospace !important;
106        }
107
108                span.errorname {
109            font: normal 16px verdana, sans-serif !important;
110        }
111
112        code.function {
113            font: bold 16px verdana, sans-serif !important;
114        }
115
116        b.fsfunc {
117            font: bold 16px verdana, sans-serif !important;
118        }
119
120        code.varname {
121            font: italic 16px verdana, sans-serif;
122        }
123
124        code.replaceable {
125            font: italic 16px courier new, monospace;
126        }
127
128        code.funcdef {
129            font: normal 16px verdana, sans-serif !important;
130        }
131
132        .citerefentry {
133            font: normal 16px verdana, sans-serif !important;
134        }
135
136        .parameter {
137            font-style: italic;
138        }
139
140        code.fsfunc {
141            font: normal 16px verdana, sans-serif !important;
142        }
143
144        /* PARAMETER: This style controls spacing between the terms in Parameter section */
145        dt {
146            margin-top: 15px;
147        }
148
149        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
150        div.refsect1 table {
151            width: 100%;
152                        margin-top: 10px;
153            background-color: #FFF;
154                        border-collapse: collapse;
155                        border-color: #000;
156            border-width: 1px;
157                        font: normal 16px verdana, sans-serif;
158        }
159
160        div.refsect1 th {
161                        border-collapse: collapse;
162                        border-color: #000;
163            border-width: 1px;
164            font: bold 16px verdana, sans-serif;
165        }
166
167        div.refsect1 td {
168            background-color: #FFF;
169            padding: 5px;
170            vertical-align: text-top;
171                        border-collapse: collapse;
172                        border-color: #000;
173            border-width: 1px;
174            font: normal 16px verdana, sans-serif;
175        }
176
177                  div.refsect1 p{
178            font: normal 16px verdana, sans-serif;
179            margin-top: 8px;
180            margin-bottom: 8px;
181            padding-top: 0;
182            padding-bottom: 0;
183        }
184
185
186        /* EXAMPLE: These styles apply only to the Example section */
187        div.refsect2 {
188            font: normal 16px courier new, monospace !important;
189        }
190
191        div.refsect2 table {
192            margin-top: 0;
193            background-color: #e6e6e6;
194            width: 100%;
195            border: 0 solid #000;
196            padding: 2px;
197            font: normal 16px courier new, monospace !important;
198        }
199
200        div.refsect2 td {
201            background-color: #e6e6e6;
202            font: normal 16px courier new, monospace !important;
203                        white-space:pre;
204        }
205
206        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
207        div.refsect3 {
208            font: normal 11px verdana, sans-serif;
209            margin-top: 50px;
210            margin-bottom: 20px;
211            padding-top: 0;
212            padding-bottom: 0;
213        }
214
215</style>
216    <title>eglSurfaceAttrib</title>
217    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
218  </head>
219  <body>
220    <div class="refentry">
221      <a id="eglSurfaceAttrib"></a>
222      <div class="titlepage"></div>
223      <div xmlns="" class="refnamediv">
224        <h1>eglSurfaceAttrib</h1>
225        <p>
226            set an <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> surface attribute
227        </p>
228      </div>
229      <div class="refsynopsisdiv">
230        <h2>C Specification</h2>
231        <div class="funcsynopsis">
232          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
233            <tr valign="bottom">
234              <td>
235                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglSurfaceAttrib</strong>(</code>
236                <td>EGLDisplay  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td>
237              </td>
238            </tr>
239            <tr valign="top">
240              <td> </td>
241              <td>EGLSurface  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">surface</var>, </td>
242            </tr>
243            <tr valign="top">
244              <td> </td>
245              <td>EGLint  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attribute</var>, </td>
246            </tr>
247            <tr valign="top">
248              <td> </td>
249              <td>EGLint  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">value</var><code>)</code></td>
250            </tr>
251          </table>
252        </div>
253      </div>
254      <div class="refsect1">
255        <a id="parameters"></a>
256        <h2>Parameters</h2>
257        <div class="variablelist">
258          <dl class="variablelist">
259            <dt>
260              <span class="term">
261                <em class="parameter">
262                  <code>display</code>
263                </em>
264              </span>
265            </dt>
266            <dd>
267              <p>
268                        Specifies the EGL display connection.
269                    </p>
270            </dd>
271            <dt>
272              <span class="term">
273                <em class="parameter">
274                  <code>surface</code>
275                </em>
276              </span>
277            </dt>
278            <dd>
279              <p>
280                        Specifies the EGL surface.
281                    </p>
282            </dd>
283            <dt>
284              <span class="term">
285                <em class="parameter">
286                  <code>attribute</code>
287                </em>
288              </span>
289            </dt>
290            <dd>
291              <p>
292                        Specifies the EGL surface attribute to set.
293                    </p>
294            </dd>
295            <dt>
296              <span class="term">
297                <em class="parameter">
298                  <code>value</code>
299                </em>
300              </span>
301            </dt>
302            <dd>
303              <p>
304                        Specifies the attributes required value.
305                    </p>
306            </dd>
307          </dl>
308        </div>
309      </div>
310      <div class="refsect1">
311        <a id="description"></a>
312        <h2>Description</h2>
313        <p>
314            <code class="function">eglSurfaceAttrib</code> sets the value of
315            <em class="parameter"><code>attribute</code></em> for
316            <em class="parameter"><code>surface</code></em> to
317            <em class="parameter"><code>value</code></em>.
318            <em class="parameter"><code>attribute</code></em> can be one of the
319            following:
320        </p>
321        <div class="variablelist">
322          <dl class="variablelist">
323            <dt>
324              <span class="term">
325                <code class="constant">EGL_MIPMAP_LEVEL</code>
326              </span>
327            </dt>
328            <dd>
329              <p>
330                    For mipmap textures, the
331                    <code class="constant">EGL_MIPMAP_LEVEL</code> attribute
332                    indicates which level of the mipmap should be
333                    rendered. If the value of this attribute is outside
334                    the range of supported mipmap levels, the closest
335                    valid mipmap level is selected for rendering. The
336                    default value is <code class="constant">0</code>.
337                </p>
338            </dd>
339            <dt>
340              <span class="term">
341                <code class="constant">EGL_MULTISAMPLE_RESOLVE</code>
342              </span>
343            </dt>
344            <dd>
345              <p>
346                    Specifies the filter to use when resolving the
347                    multisample buffer (this may occur when swapping or
348                    copying the surface, or when changing the client API
349                    context bound to the surface). A
350                    <em class="parameter"><code>value</code></em> of
351                    <code class="constant">EGL_MULTISAMPLE_RESOLVE_DEFAULT</code>
352                    chooses the default implementation-defined filtering
353                    method, while
354                    <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX</code>
355                    chooses a one-pixel wide box filter placing equal
356                    weighting on all multisample values.
357                </p>
358              <p>
359                    The initial value of
360                    <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> is
361                    <code class="constant">EGL_MULTISAMPLE_RESOLVE_DEFAULT</code>.
362                </p>
363            </dd>
364            <dt>
365              <span class="term">
366                <code class="constant">EGL_SWAP_BEHAVIOR</code>
367              </span>
368            </dt>
369            <dd>
370              <p>
371                    Specifies the effect on the color buffer of posting
372                    a surface with
373                    <a class="citerefentry" href="eglSwapBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a>.
374                    A <em class="parameter"><code>value</code></em> of
375                    <code class="constant">EGL_BUFFER_PRESERVED</code> indicates
376                    that color buffer contents are unaffected, while
377                    <code class="constant">EGL_BUFFER_DESTROYED</code> indicates
378                    that color buffer contents may be destroyed or
379                    changed by the operation.
380                </p>
381              <p>
382                    The initial value of
383                    <code class="constant">EGL_SWAP_BEHAVIOR</code> is chosen by
384                    the implementation.
385                </p>
386            </dd>
387          </dl>
388        </div>
389      </div>
390      <div class="refsect1">
391        <a id="notes"></a>
392        <h2>Notes</h2>
393        <p>
394            Attribute <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> is
395            supported only if the EGL version is 1.4 or greater.
396        </p>
397        <p>
398            Attribute <code class="constant">EGL_SWAP_BEHAVIOR</code> is
399            supported only if the EGL version is 1.2 or greater.
400        </p>
401        <p>
402            If the value of pbuffer attribute
403            <code class="constant">EGL_TEXTURE_FORMAT</code> is
404            <code class="constant">EGL_NO_TEXTURE</code>, the value of attribute
405            <code class="constant">EGL_TEXTURE_TARGET</code> is
406            <code class="constant">EGL_NO_TEXTURE</code>, or
407            <em class="parameter"><code>surface</code></em> is not a pbuffer, then
408            attribute <code class="constant">EGL_MIPMAP_LEVEL</code> may be set,
409            but has no effect.
410        </p>
411      </div>
412      <div class="refsect1">
413        <a id="errors"></a>
414        <h2>Errors</h2>
415        <p>
416            <code class="constant">EGL_FALSE</code> is returned on failure,
417            <code class="constant">EGL_TRUE</code> otherwise.
418        </p>
419        <p>
420            <code class="constant">EGL_BAD_DISPLAY</code> is generated if
421            <em class="parameter"><code>display</code></em> is not an EGL display connection.
422        </p>
423        <p>
424            <code class="constant">EGL_BAD_MATCH</code> is generated if
425            <em class="parameter"><code>attribute</code></em> is
426            <code class="constant">EGL_MULTISAMPLE_RESOLVE</code>,
427            <em class="parameter"><code>value</code></em> is
428            <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX</code>, and the
429            <code class="constant">EGL_SURFACE_TYPE</code> attribute of the
430            <span class="type">EGLConfig</span> used to create
431            <em class="parameter"><code>surface</code></em> does not contain
432            <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX_BIT</code>.
433        </p>
434        <p>
435            <code class="constant">EGL_BAD_MATCH</code> is generated if
436            <em class="parameter"><code>attribute</code></em> is
437            <code class="constant">EGL_SWAP_BEHAVIOR</code>,
438            <em class="parameter"><code>value</code></em> is
439            <code class="constant">EGL_BUFFER_PRESERVED</code>, and the
440            <code class="constant">EGL_SURFACE_TYPE</code> attribute of the
441            <span class="type">EGLConfig</span> used to create
442            <em class="parameter"><code>surface</code></em> does not contain
443            <code class="constant">EGL_SWAP_BEHAVIOR_PRESERVED_BIT</code>.
444        </p>
445        <p>
446            <code class="constant">EGL_NOT_INITIALIZED</code> is generated if
447            <em class="parameter"><code>display</code></em> has not been initialized.
448        </p>
449        <p>
450            <code class="constant">EGL_BAD_SURFACE</code> is generated if
451            <em class="parameter"><code>surface</code></em> is not an EGL surface.
452        </p>
453        <p>
454            <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if
455            <em class="parameter"><code>attribute</code></em> is not a valid surface attribute.
456        </p>
457      </div>
458      <div class="refsect1">
459        <a id="seealso"></a>
460        <h2>See Also</h2>
461        <p>
462            <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>,
463            <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>,
464            <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>,
465            <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a>
466        </p>
467      </div>
468      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>
469Copyright © 2003-2014 The Khronos Group Inc.
470Permission is hereby granted, free of charge, to any person obtaining a
471copy of this software and/or associated documentation files (the
472"Materials"), to deal in the Materials without restriction, including
473without limitation the rights to use, copy, modify, merge, publish,
474distribute, sublicense, and/or sell copies of the Materials, and to
475permit persons to whom the Materials are furnished to do so, subject to
476the condition that this copyright notice and permission notice shall be included
477in all copies or substantial portions of the Materials.
478</div>
479    </div>
480  </body>
481</html>
482