• 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>eglCreatePixmapSurface</title>
217    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
218  </head>
219  <body>
220    <div class="refentry">
221      <a id="eglCreatePixmapSurface"></a>
222      <div class="titlepage"></div>
223      <div xmlns="" class="refnamediv">
224        <h1>eglCreatePixmapSurface</h1>
225        <p>
226            create a new <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> pixmap surface
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">EGLSurface <strong class="fsfunc">eglCreatePixmapSurface</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>EGLConfig  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">config</var>, </td>
242            </tr>
243            <tr valign="top">
244              <td> </td>
245              <td>NativePixmapType  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">native_pixmap</var>, </td>
246            </tr>
247            <tr valign="top">
248              <td> </td>
249              <td>EGLint const *  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attrib_list</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>Specifies the EGL display connection.</p>
268            </dd>
269            <dt>
270              <span class="term">
271                <em class="parameter">
272                  <code>config</code>
273                </em>
274              </span>
275            </dt>
276            <dd>
277              <p>
278                    Specifies the EGL frame buffer configuration that defines the
279                    frame buffer resource available to the surface.</p>
280            </dd>
281            <dt>
282              <span class="term">
283                <em class="parameter">
284                  <code>native_pixmap</code>
285                </em>
286              </span>
287            </dt>
288            <dd>
289              <p>Specifies the native pixmap.</p>
290            </dd>
291            <dt>
292              <span class="term">
293                <em class="parameter">
294                  <code>attrib_list</code>
295                </em>
296              </span>
297            </dt>
298            <dd>
299              <p>
300                    Specifies pixmap surface attributes.
301                    May be <code class="constant">NULL</code> or empty
302                    (first attribute is <code class="constant">EGL_NONE</code>).
303                </p>
304            </dd>
305          </dl>
306        </div>
307      </div>
308      <div class="refsect1">
309        <a id="description"></a>
310        <h2>Description</h2>
311        <p>
312            <code class="function">eglCreatePixmapSurface</code> creates an
313            off-screen <acronym class="acronym">EGL</acronym> pixmap surface and returns
314            its handle. If <code class="function">eglCreatePixmapSurface</code>
315            fails to create a pixmap surface,
316            <code class="constant">EGL_NO_SURFACE</code> is returned.
317        </p>
318        <p>
319            Surface attributes are specified as a list of
320            attribute-value pairs, terminated with
321            <code class="constant">EGL_NONE</code>. Accepted attributes
322            are:
323        </p>
324        <div class="variablelist">
325          <dl class="variablelist">
326            <dt>
327              <span class="term">
328                <code class="constant">EGL_VG_ALPHA_FORMAT</code>
329              </span>
330            </dt>
331            <dd>
332              <p>
333                    Specifies how alpha values are interpreted by OpenVG
334                    when rendering to the surface. If its value is
335                    <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>,
336                    then alpha values are not premultipled. If its value
337                    is <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code>,
338                    then alpha values are premultiplied. The default
339                    value of <code class="constant">EGL_VG_ALPHA_FORMAT</code> is
340                    <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>.
341                </p>
342            </dd>
343            <dt>
344              <span class="term">
345                <code class="constant">EGL_VG_COLORSPACE</code>
346              </span>
347            </dt>
348            <dd>
349              <p>
350                    Specifies the color space used by OpenVG when
351                    rendering to the surface. If its value is
352                    <code class="constant">EGL_VG_COLORSPACE_sRGB</code>, then a
353                    non-linear, perceptually uniform color space is
354                    assumed, with a corresponding
355                    <span class="type">VGImageFormat</span> of form
356                    <code class="constant">VG_s*</code>. If its value is
357                    <code class="constant">EGL_VG_COLORSPACE_LINEAR</code>, then
358                    a linear color space is assumed, with a
359                    corresponding <span class="type">VGImageFormat</span> of form
360                    <code class="constant">VG_l*</code>. The default value of
361                    <code class="constant">EGL_VG_COLORSPACE</code> is
362                    <code class="constant">EGL_VG_COLORSPACE_sRGB</code>.
363                </p>
364            </dd>
365          </dl>
366        </div>
367        <p>
368            Any EGL rendering context that was created with respect to
369            <em class="parameter"><code>config</code></em> can be used to render into the
370            surface. Use
371            <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>
372            to attach an EGL rendering context to the surface.
373        </p>
374        <p>
375            Use
376            <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a>
377            to retrieve the ID of <em class="parameter"><code>config</code></em>.
378        </p>
379        <p>
380            Use <a class="citerefentry" href="eglDestroySurface.html"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>
381            to destroy the surface.
382        </p>
383      </div>
384      <div class="refsect1">
385        <a id="notes"></a>
386        <h2>Notes</h2>
387        <p>
388            The <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code> attribute
389            of
390            <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>
391            can be used to select a frame buffer configuration matching
392            a specified native pixmap.
393        </p>
394        <p>
395            Attributes
396            <code class="constant">EGL_VG_ALPHA_FORMAT</code> and
397            <code class="constant">EGL_VG_COLORSPACE</code>, and the
398            corresponding attribute values, are supported only if the
399            EGL version is 1.2 or greater.
400        </p>
401        <p>
402            The <code class="constant">EGL_VG_ALPHA_FORMAT</code> and
403            <code class="constant">EGL_VG_COLORSPACE</code> attributes are used
404            only by OpenVG. EGL itself, and other client APIs such as
405            OpenGL and OpenGL ES , do not distinguish multiple
406            colorspace models. Refer to section 11.2 of the OpenVG 1.0
407            specification for more information. The native window
408            system's use and interpretation of alpha values is outside
409            the scope of EGL, although the preferred behavior is for the
410            window system to ignore the value of
411            <code class="constant">EGL_VG_ALPHA_FORMAT</code>.
412        </p>
413      </div>
414      <div class="refsect1">
415        <a id="errors"></a>
416        <h2>Errors</h2>
417        <p>
418            <code class="constant">EGL_NO_SURFACE</code> is returned if creation of
419            the context fails.
420        </p>
421        <p>
422            <code class="constant">EGL_BAD_DISPLAY</code> is generated if
423            <em class="parameter"><code>display</code></em> is not an EGL display connection.
424        </p>
425        <p>
426            <code class="constant">EGL_NOT_INITIALIZED</code> is generated if
427            <em class="parameter"><code>display</code></em> has not been initialized.
428        </p>
429        <p>
430            <code class="constant">EGL_BAD_CONFIG</code> is generated if
431            <em class="parameter"><code>config</code></em> is not an EGL config.
432        </p>
433        <p>
434            <code class="constant">EGL_BAD_NATIVE_PIXMAP</code> may be generated if
435            <em class="parameter"><code>native_pixmap</code></em> is not a valid native pixmap.
436        </p>
437        <p>
438            <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if
439            <em class="parameter"><code>attrib_list</code></em> contains an invalid pixmap attribute
440            or if an attribute value is not recognized or out of range.
441        </p>
442        <p>
443            <code class="constant">EGL_BAD_ALLOC</code> is generated if there are not
444            enough resources to allocate the new surface.
445        </p>
446        <p>
447            <code class="constant">EGL_BAD_MATCH</code> is generated if the attributes of
448            <em class="parameter"><code>native_pixmap</code></em> do not correspond to
449            <em class="parameter"><code>config</code></em> or if
450            <em class="parameter"><code>config</code></em> does not support rendering to pixmaps
451            (the <code class="constant">EGL_SURFACE_TYPE</code> attribute does not contain
452            <code class="constant">EGL_PIXMAP_BIT</code>).
453        </p>
454        <p>
455            <code class="constant">EGL_BAD_MATCH</code> is generated if
456            <em class="parameter"><code>config</code></em> does not support the specified
457            OpenVG alpha format attribute (the value of
458            <code class="constant">EGL_VG_ALPHA_FORMAT</code> is
459            <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code> and the
460            <code class="constant">EGL_VG_ALPHA_FORMAT_PRE_BIT</code> is not set
461            in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of
462            <em class="parameter"><code>config</code></em>) or colorspace attribute (the
463            value of <code class="constant">EGL_VG_COLORSPACE</code> is
464            <code class="constant">EGL_VG_COLORSPACE_LINEAR</code> and the
465            <code class="constant">EGL_VG_COLORSPACE_LINEAR_IT</code> is not set
466            in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of
467            <em class="parameter"><code>config</code></em>).
468        </p>
469      </div>
470      <div class="refsect1">
471        <a id="seealso"></a>
472        <h2>See Also</h2>
473        <p>
474            <a class="citerefentry" href="eglDestroySurface.html"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>,
475            <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>,
476            <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>,
477            <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>,
478            <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a>
479        </p>
480      </div>
481      <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>
482Copyright © 2003-2014 The Khronos Group Inc.
483Permission is hereby granted, free of charge, to any person obtaining a
484copy of this software and/or associated documentation files (the
485"Materials"), to deal in the Materials without restriction, including
486without limitation the rights to use, copy, modify, merge, publish,
487distribute, sublicense, and/or sell copies of the Materials, and to
488permit persons to whom the Materials are furnished to do so, subject to
489the condition that this copyright notice and permission notice shall be included
490in all copies or substantial portions of the Materials.
491</div>
492    </div>
493  </body>
494</html>
495