• 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>eglBindAPI</title>
217    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
218  </head>
219  <body>
220    <div class="refentry">
221      <a id="eglBindAPI"></a>
222      <div class="titlepage"></div>
223      <div xmlns="" class="refnamediv">
224        <h1>eglBindAPI</h1>
225        <p>Set the current rendering API</p>
226      </div>
227      <div class="refsynopsisdiv">
228        <h2>C Specification</h2>
229        <div class="funcsynopsis">
230          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
231            <tr valign="bottom">
232              <td>
233                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglBindAPI</strong>(</code>
234                <td>EGLenum  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">api</var><code>)</code></td>
235              </td>
236            </tr>
237          </table>
238        </div>
239      </div>
240      <div class="refsect1">
241        <a id="parameters"></a>
242        <h2>Parameters</h2>
243        <div class="variablelist">
244          <dl class="variablelist">
245            <dt>
246              <span class="term">
247                <em class="parameter">
248                  <code>api</code>
249                </em>
250              </span>
251            </dt>
252            <dd>
253              <p>
254                    Specifies the client API to bind, one of
255                    <code class="constant">EGL_OPENGL_API</code>,
256                    <code class="constant">EGL_OPENGL_ES_API</code>, or
257                    <code class="constant">EGL_OPENVG_API</code>.
258                </p>
259            </dd>
260          </dl>
261        </div>
262      </div>
263      <div class="refsect1">
264        <a id="description"></a>
265        <h2>Description</h2>
266        <p>
267            <code class="function">eglBindAPI</code> defines the current
268            rendering API for EGL in the thread it is called from. The
269            current rendering API is one of the client rendering APIs
270            supported by the EGL implementation, and affects the
271            behavior of other EGL commands including
272            <code class="function">eglCreateContext</code>,
273            <code class="function">eglGetCurrentContext</code>,
274            <code class="function">eglGetCurrentDisplay</code>,
275            <code class="function">eglGetCurrentSurface</code>,
276            <code class="function">eglMakeCurrent</code>,
277            <code class="function">eglWaitClient</code>, and
278            <code class="function">eglWaitNative</code>.
279        </p>
280        <p>
281            If <em class="parameter"><code>api</code></em> is
282            <code class="constant">EGL_OPENGL_API</code>, the current rendering
283            API is set to the OpenGL API.
284        </p>
285        <p>
286            If <em class="parameter"><code>api</code></em> is
287            <code class="constant">EGL_OPENGL_ES_API</code>, the current
288            rendering API is set to the OpenGL ES API.
289        </p>
290        <p>
291            If <em class="parameter"><code>api</code></em> is
292            <code class="constant">EGL_OPENVG_API</code>, the current rendering
293            API is set to the OpenVG API.
294        </p>
295        <p>
296            If an error occurs, the current rendering API is unchanged.
297        </p>
298      </div>
299      <div class="refsect1">
300        <a id="notes"></a>
301        <h2>Notes</h2>
302        <p>
303            <code class="function">eglBindAPI</code> and the corresponding
304            <code class="constant">EGL_OPENGL_ES_API</code> and
305            <code class="constant">EGL_OPENVG_API</code>
306            <em class="parameter"><code>api</code></em> parameters are supported only if
307            the EGL version is 1.2 or greater. The
308            <code class="constant">EGL_OPENGL_API</code> parameter is supported
309            only if the EGL version is 1.4 or greater.
310        </p>
311        <p>
312            The initial value of the current rendering API is
313            <code class="constant">EGL_OPENGL_ES_API</code> unless OpenGL ES is
314            not supported by an implementation, in which case the
315            initial value is <code class="constant">EGL_NONE</code> (however,
316            <code class="constant">EGL_NONE</code> is not a valid
317            <em class="parameter"><code>api</code></em> parameter to
318            <code class="function">eglBindAPI</code>).
319        </p>
320        <p>
321            The current rendering API can be queried by calling
322            <code class="function">eglQueryAPI</code>.
323        </p>
324      </div>
325      <div class="refsect1">
326        <a id="errors"></a>
327        <h2>Errors</h2>
328        <p>
329            <code class="constant">EGL_FALSE</code> is returned on failure.
330        </p>
331        <p>
332            <code class="constant">EGL_BAD_PARAMETER</code> is generated if
333            <em class="parameter"><code>api</code></em> is not one of the accepted
334            tokens, or if the specified client API is not supported by
335            the EGL implementation.
336        </p>
337      </div>
338      <div class="refsect1">
339        <a id="seealso"></a>
340        <h2>See Also</h2>
341        <p>
342            <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>,
343            <a class="citerefentry" href="eglGetCurrentContext.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentContext</span></span></a>,
344            <a class="citerefentry" href="eglGetCurrentDisplay.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentDisplay</span></span></a>,
345            <a class="citerefentry" href="eglGetCurrentSurface.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentSurface</span></span></a>,
346            <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>,
347            <a class="citerefentry" href="eglQueryAPI.html"><span class="citerefentry"><span class="refentrytitle">eglQueryAPI</span></span></a>,
348            <a class="citerefentry" href="eglWaitClient.html"><span class="citerefentry"><span class="refentrytitle">eglWaitClient</span></span></a>,
349            <a class="citerefentry" href="eglWaitNative.html"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a>
350        </p>
351      </div>
352      <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>
353Copyright © 2003-2014 The Khronos Group Inc.
354Permission is hereby granted, free of charge, to any person obtaining a
355copy of this software and/or associated documentation files (the
356"Materials"), to deal in the Materials without restriction, including
357without limitation the rights to use, copy, modify, merge, publish,
358distribute, sublicense, and/or sell copies of the Materials, and to
359permit persons to whom the Materials are furnished to do so, subject to
360the condition that this copyright notice and permission notice shall be included
361in all copies or substantial portions of the Materials.
362</div>
363    </div>
364  </body>
365</html>
366