1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglSurfaceAttrib">
<info>
<copyright>
<year>2003-2014</year>
<holder>The Khronos Group Inc.</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>eglSurfaceAttrib</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>eglSurfaceAttrib</refname>
<refpurpose>
set an <acronym>EGL</acronym> surface attribute
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>EGLBoolean <function>eglSurfaceAttrib</function></funcdef>
<paramdef>EGLDisplay <parameter>display</parameter></paramdef>
<paramdef>EGLSurface <parameter>surface</parameter></paramdef>
<paramdef>EGLint <parameter>attribute</parameter></paramdef>
<paramdef>EGLint <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>display</parameter></term>
<listitem>
<para>
Specifies the EGL display connection.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>surface</parameter></term>
<listitem>
<para>
Specifies the EGL surface.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>attribute</parameter></term>
<listitem>
<para>
Specifies the EGL surface attribute to set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
Specifies the attributes required value.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description"><title>Description</title>
<para>
<function>eglSurfaceAttrib</function> sets the value of
<parameter>attribute</parameter> for
<parameter>surface</parameter> to
<parameter>value</parameter>.
<parameter>attribute</parameter> can be one of the
following:
</para>
<variablelist>
<varlistentry>
<term><constant>EGL_MIPMAP_LEVEL</constant></term>
<listitem><para>
For mipmap textures, the
<constant>EGL_MIPMAP_LEVEL</constant> attribute
indicates which level of the mipmap should be
rendered. If the value of this attribute is outside
the range of supported mipmap levels, the closest
valid mipmap level is selected for rendering. The
default value is <constant>0</constant>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>EGL_MULTISAMPLE_RESOLVE</constant></term>
<listitem>
<para>
Specifies the filter to use when resolving the
multisample buffer (this may occur when swapping or
copying the surface, or when changing the client API
context bound to the surface). A
<parameter>value</parameter> of
<constant>EGL_MULTISAMPLE_RESOLVE_DEFAULT</constant>
chooses the default implementation-defined filtering
method, while
<constant>EGL_MULTISAMPLE_RESOLVE_BOX</constant>
chooses a one-pixel wide box filter placing equal
weighting on all multisample values.
</para>
<para>
The initial value of
<constant>EGL_MULTISAMPLE_RESOLVE</constant> is
<constant>EGL_MULTISAMPLE_RESOLVE_DEFAULT</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>EGL_SWAP_BEHAVIOR</constant></term>
<listitem>
<para>
Specifies the effect on the color buffer of posting
a surface with
<citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry>.
A <parameter>value</parameter> of
<constant>EGL_BUFFER_PRESERVED</constant> indicates
that color buffer contents are unaffected, while
<constant>EGL_BUFFER_DESTROYED</constant> indicates
that color buffer contents may be destroyed or
changed by the operation.
</para>
<para>
The initial value of
<constant>EGL_SWAP_BEHAVIOR</constant> is chosen by
the implementation.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="notes"><title>Notes</title>
<para>
Attribute <constant>EGL_MULTISAMPLE_RESOLVE</constant> is
supported only if the EGL version is 1.4 or greater.
</para>
<para>
Attribute <constant>EGL_SWAP_BEHAVIOR</constant> is
supported only if the EGL version is 1.2 or greater.
</para>
<para>
If the value of pbuffer attribute
<constant>EGL_TEXTURE_FORMAT</constant> is
<constant>EGL_NO_TEXTURE</constant>, the value of attribute
<constant>EGL_TEXTURE_TARGET</constant> is
<constant>EGL_NO_TEXTURE</constant>, or
<parameter>surface</parameter> is not a pbuffer, then
attribute <constant>EGL_MIPMAP_LEVEL</constant> may be set,
but has no effect.
</para>
</refsect1>
<refsect1 xml:id="errors"><title>Errors</title>
<para>
<constant>EGL_FALSE</constant> is returned on failure,
<constant>EGL_TRUE</constant> otherwise.
</para>
<para>
<constant>EGL_BAD_DISPLAY</constant> is generated if
<parameter>display</parameter> is not an EGL display connection.
</para>
<para>
<constant>EGL_BAD_MATCH</constant> is generated if
<parameter>attribute</parameter> is
<constant>EGL_MULTISAMPLE_RESOLVE</constant>,
<parameter>value</parameter> is
<constant>EGL_MULTISAMPLE_RESOLVE_BOX</constant>, and the
<constant>EGL_SURFACE_TYPE</constant> attribute of the
<type>EGLConfig</type> used to create
<parameter>surface</parameter> does not contain
<constant>EGL_MULTISAMPLE_RESOLVE_BOX_BIT</constant>.
</para>
<para>
<constant>EGL_BAD_MATCH</constant> is generated if
<parameter>attribute</parameter> is
<constant>EGL_SWAP_BEHAVIOR</constant>,
<parameter>value</parameter> is
<constant>EGL_BUFFER_PRESERVED</constant>, and the
<constant>EGL_SURFACE_TYPE</constant> attribute of the
<type>EGLConfig</type> used to create
<parameter>surface</parameter> does not contain
<constant>EGL_SWAP_BEHAVIOR_PRESERVED_BIT</constant>.
</para>
<para>
<constant>EGL_NOT_INITIALIZED</constant> is generated if
<parameter>display</parameter> has not been initialized.
</para>
<para>
<constant>EGL_BAD_SURFACE</constant> is generated if
<parameter>surface</parameter> is not an EGL surface.
</para>
<para>
<constant>EGL_BAD_ATTRIBUTE</constant> is generated if
<parameter>attribute</parameter> is not a valid surface attribute.
</para>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry>
</para>
</refsect1>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
</refentry>
|
