• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglCreatePixmapSurface">
2    <info>
3         <copyright>
4             <year>2003-2018</year>
5             <holder>The Khronos Group Inc.</holder>
6         </copyright>
7    </info>
8    <refmeta>
9        <refentrytitle>eglCreatePixmapSurface</refentrytitle>
10        <manvolnum>3G</manvolnum>
11    </refmeta>
12    <refnamediv>
13        <refname>eglCreatePixmapSurface</refname>
14        <refpurpose>
15            create a new <acronym>EGL</acronym> offscreen surface
16        </refpurpose>
17    </refnamediv>
18    <refsynopsisdiv>
19        <title>C Specification</title>
20        <funcsynopsis>
21            <funcprototype>
22                <funcdef>EGLSurface <function>eglCreatePixmapSurface</function></funcdef>
23                <paramdef>EGLDisplay <parameter>display</parameter></paramdef>
24                <paramdef>EGLConfig <parameter>config</parameter></paramdef>
25                <paramdef>NativePixmapType <parameter>native_pixmap</parameter></paramdef>
26                <paramdef>EGLint const * <parameter>attrib_list</parameter></paramdef>
27            </funcprototype>
28        </funcsynopsis>
29    </refsynopsisdiv>
30    <refsect1 xml:id="parameters"><title>Parameters</title>
31        <variablelist>
32            <varlistentry>
33                <term><parameter>display</parameter></term>
34                <listitem><para>Specifies the EGL display connection.</para></listitem>
35            </varlistentry>
36            <varlistentry>
37                <term><parameter>config</parameter></term>
38                <listitem><para>
39                    Specifies the EGL frame buffer configuration that defines the
40                    frame buffer resource available to the surface.</para>
41                </listitem>
42            </varlistentry>
43            <varlistentry>
44                <term><parameter>native_pixmap</parameter></term>
45                <listitem><para>Specifies the native pixmap.</para></listitem>
46            </varlistentry>
47            <varlistentry>
48                <term><parameter>attrib_list</parameter></term>
49                <listitem><para>
50                    Specifies pixmap surface attributes.
51                    May be <constant>NULL</constant> or empty
52                    (first attribute is <constant>EGL_NONE</constant>).
53                </para></listitem>
54            </varlistentry>
55        </variablelist>
56    </refsect1>
57    <refsect1 xml:id="description"><title>Description</title>
58        <para>
59            <function>eglCreatePixmapSurface</function> creates an off-screen
60            EGL pixmap surface and returns a handle to it. The behavior of
61            <function>eglCreatePixmapSurface</function> is identical to that
62            of
63            <citerefentry><refentrytitle>eglCreatePlatformPixmapSurface</refentrytitle></citerefentry>
64            except that the set of platforms to which
65            <parameter>display</parameter> is permitted to belong, as well
66            as the actual type of <parameter>native_pixmap</parameter>, are
67            implementation specific.
68        </para>
69    </refsect1>
70    <refsect1 xml:id="errors"><title>Errors</title>
71        <para>
72            See errors for
73            <citerefentry><refentrytitle>eglCreatePlatformPixmapSurface</refentrytitle></citerefentry>.
74        </para>
75    </refsect1>
76    <refsect1 xml:id="seealso"><title>See Also</title>
77        <para>
78            <citerefentry><refentrytitle>eglCreatePlatformPixmapSurface</refentrytitle></citerefentry>,
79            <citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry>,
80            <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>,
81            <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry>,
82            <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>,
83            <citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry>
84        </para>
85    </refsect1>
86    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
87</refentry>
88