• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <title xmlns:xlink="http://www.w3.org/1999/xlink">eglCreatePixmapSurface - EGL Reference Pages</title>
5    <link rel="stylesheet" type="text/css" href="khronos-man.css"/>
6    <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/>
7  </head>
8  <body>
9    <header/>
10    <div class="refentry" id="eglCreatePixmapSurface">
11      <div class="titlepage"/>
12      <div class="refnamediv">
13        <h2>Name</h2>
14        <p>eglCreatePixmapSurface —
15            create a new <abbr class="acronym">EGL</abbr> offscreen surface
16        </p>
17      </div>
18      <div class="refsynopsisdiv">
19        <h2>C Specification</h2>
20        <div class="funcsynopsis">
21          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
22            <tr>
23              <td>
24                <code class="funcdef">EGLSurface <strong class="fsfunc">eglCreatePixmapSurface</strong>(</code>
25              </td>
26              <td>EGLDisplay <var class="pdparam">display</var>, </td>
27            </tr>
28            <tr>
29              <td> </td>
30              <td>EGLConfig <var class="pdparam">config</var>, </td>
31            </tr>
32            <tr>
33              <td> </td>
34              <td>NativePixmapType <var class="pdparam">native_pixmap</var>, </td>
35            </tr>
36            <tr>
37              <td> </td>
38              <td>EGLint const * <var class="pdparam">attrib_list</var><code>)</code>;</td>
39            </tr>
40          </table>
41          <div class="funcprototype-spacer"> </div>
42        </div>
43      </div>
44      <div class="refsect1" id="parameters">
45        <h2>Parameters</h2>
46        <div class="variablelist">
47          <dl class="variablelist">
48            <dt>
49              <span class="term">
50                <em class="parameter">
51                  <code>display</code>
52                </em>
53              </span>
54            </dt>
55            <dd>
56              <p>Specifies the EGL display connection.</p>
57            </dd>
58            <dt>
59              <span class="term">
60                <em class="parameter">
61                  <code>config</code>
62                </em>
63              </span>
64            </dt>
65            <dd>
66              <p>
67                    Specifies the EGL frame buffer configuration that defines the
68                    frame buffer resource available to the surface.</p>
69            </dd>
70            <dt>
71              <span class="term">
72                <em class="parameter">
73                  <code>native_pixmap</code>
74                </em>
75              </span>
76            </dt>
77            <dd>
78              <p>Specifies the native pixmap.</p>
79            </dd>
80            <dt>
81              <span class="term">
82                <em class="parameter">
83                  <code>attrib_list</code>
84                </em>
85              </span>
86            </dt>
87            <dd>
88              <p>
89                    Specifies pixmap surface attributes.
90                    May be <code class="constant">NULL</code> or empty
91                    (first attribute is <code class="constant">EGL_NONE</code>).
92                </p>
93            </dd>
94          </dl>
95        </div>
96      </div>
97      <div class="refsect1" id="description">
98        <h2>Description</h2>
99        <p>
100            <code class="function">eglCreatePixmapSurface</code> creates an off-screen
101            EGL pixmap surface and returns a handle to it. The behavior of
102            <code class="function">eglCreatePixmapSurface</code> is identical to that
103            of
104            <a class="citerefentry" href="eglCreatePlatformPixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePlatformPixmapSurface</span></span></a>
105            except that the set of platforms to which
106            <em class="parameter"><code>display</code></em> is permitted to belong, as well
107            as the actual type of <em class="parameter"><code>native_pixmap</code></em>, are
108            implementation specific.
109        </p>
110      </div>
111      <div class="refsect1" id="errors">
112        <h2>Errors</h2>
113        <p>
114            See errors for
115            <a class="citerefentry" href="eglCreatePlatformPixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePlatformPixmapSurface</span></span></a>.
116        </p>
117      </div>
118      <div class="refsect1" id="seealso">
119        <h2>See Also</h2>
120        <p>
121            <a class="citerefentry" href="eglCreatePlatformPixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePlatformPixmapSurface</span></span></a>,
122            <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>,
123            <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>,
124            <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>,
125            <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>,
126            <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a>
127        </p>
128      </div>
129      <p>
130    </p>
131      <div class="refsect3" id="copyright">
132        <img src="KhronosLogo.jpg"/>
133        <p>
134            Copyright © 2003-2014 The Khronos Group Inc.
135            Permission is hereby granted, free of charge, to any person obtaining a
136            copy of this software and/or associated documentation files (the
137            "Materials"), to deal in the Materials without restriction, including
138            without limitation the rights to use, copy, modify, merge, publish,
139            distribute, sublicense, and/or sell copies of the Materials, and to
140            permit persons to whom the Materials are furnished to do so, subject to
141            the condition that this copyright notice and permission notice shall be included
142            in all copies or substantial portions of the Materials.
143        </p>
144      </div>
145      <p>
146</p>
147    </div>
148    <footer/>
149  </body>
150</html>
151