• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "DTD/docbook/docbookx.dtd">
3<!--
4  Copyright 2003-2010 Khronos Group.
5  This material may be distributed subject to the terms and conditions set forth in
6  the Open Publication License, v 1.0, 8 June 1999.
7  http://opencontent.org/openpub/
8-->
9<book xmlns:xi="http://www.w3.org/2001/XInclude">
10  <title>
11    EGL Reference Manual
12  </title>
13  <subtitle>
14    Version 1.5
15  </subtitle>
16  <bookinfo>
17    <author>
18      <firstname>Claude</firstname>
19      <surname>Knaus</surname>
20    </author>
21    <author>
22      <firstname>Jon</firstname>
23      <surname>Leech</surname>
24    </author>
25    <date>October 2010</date>
26    <releaseinfo>Draft Version 20101012</releaseinfo>
27    <subjectset>
28      <subject>EGL</subject>
29    </subjectset>
30    <keywordset>
31      <keyword>EGL</keyword>
32      <keyword>man</keyword>
33      <keyword>reference</keyword>
34    </keywordset>
35    <xi:include href="legal-notice.xml"/>
36  </bookinfo>
37  <toc>
38    <title>Contents</title>
39    <!-- generated by LaTeX -->
40  </toc>
41  <chapter>
42    <title>Preface</title>
43    <sect1>
44      <title>Style Conventions</title>
45      <para>
46        The following style conventions apply to this document:
47      </para>
48      <variablelist>
49        <varlistentry>
50          <term><function>Bold</function></term>
51          <listitem><para>Command and function names</para></listitem>
52        </varlistentry>
53        <varlistentry>
54          <term><parameter>Italics</parameter></term>
55          <listitem>Variables and parameters</listitem>
56        </varlistentry>
57        <varlistentry>
58          <term>Regular</term>
59          <listitem><para>Ordinary text</para></listitem>
60        </varlistentry>
61        <varlistentry>
62          <term><constant>Monospace</constant></term>
63          <listitem><para>Constants and source code</para></listitem>
64        </varlistentry>
65      </variablelist>
66    </sect1>
67  </chapter>
68  <chapter>
69    <title>Summary of Commands and Routines</title>
70    <sect1>
71      <title>EGL Functions</title>
72      <para>Manage or query display connections:</para>
73      <simplelist type="vert">
74        <member><citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry></member>
75        <member><citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry></member>
76        <member><citerefentry><refentrytitle>eglQueryString</refentrytitle></citerefentry></member>
77        <member><citerefentry><refentrytitle>eglTerminate</refentrytitle></citerefentry></member>
78      </simplelist>
79      <para>Request EGL and client API extension functions:</para>
80      <simplelist type="vert">
81        <member><citerefentry><refentrytitle>eglGetProcAddress</refentrytitle></citerefentry></member>
82      </simplelist>
83      <para>Query errors:</para>
84      <simplelist type="vert">
85        <member><citerefentry><refentrytitle>eglGetError</refentrytitle></citerefentry></member>
86      </simplelist>
87      <para>Request or query frame buffer configurations:</para>
88      <simplelist type="vert">
89        <member><citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry></member>
90        <member><citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry></member>
91        <member><citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry></member>
92      </simplelist>
93      <para>Manage or query the current rendering API:</para>
94      <simplelist type="vert">
95        <member><citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry></member>
96        <member><citerefentry><refentrytitle>eglQueryAPI</refentrytitle></citerefentry></member>
97      </simplelist>
98      <para>Manage or query EGL rendering contexts:</para>
99      <simplelist type="vert">
100        <member><citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry></member>
101        <member><citerefentry><refentrytitle>eglDestroyContext</refentrytitle></citerefentry></member>
102        <member><citerefentry><refentrytitle>eglQueryContext</refentrytitle></citerefentry></member>
103        <member><citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry></member>
104        <member><citerefentry><refentrytitle>eglGetCurrentContext</refentrytitle></citerefentry></member>
105        <member><citerefentry><refentrytitle>eglGetCurrentSurface</refentrytitle></citerefentry></member>
106        <member><citerefentry><refentrytitle>eglGetCurrentDisplay</refentrytitle></citerefentry></member>
107      </simplelist>
108      <para>Manage or query EGL surfaces:</para>
109      <simplelist type="vert">
110        <member><citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry></member>
111        <member><citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry></member>
112        <member><citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry></member>
113        <member><citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry></member>
114        <member><citerefentry><refentrytitle>eglSurfaceAttrib</refentrytitle></citerefentry></member>
115        <member><citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry></member>
116      </simplelist>
117      <para>Synchronize execution:</para>
118      <simplelist type="vert">
119        <member><citerefentry><refentrytitle>eglSwapInterval</refentrytitle></citerefentry></member>
120        <member><citerefentry><refentrytitle>eglWaitClient</refentrytitle></citerefentry></member>
121        <member><citerefentry><refentrytitle>eglWaitGL</refentrytitle></citerefentry></member>
122        <member><citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry></member>
123      </simplelist>
124      <para>Post and copy buffers:</para>
125      <simplelist type="vert">
126        <member><citerefentry><refentrytitle>eglCopyBuffers</refentrytitle></citerefentry></member>
127        <member><citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry></member>
128      </simplelist>
129      <para>Bind pixel buffer surfaces to OpenGL ES textures:</para>
130      <simplelist type="vert">
131        <member><citerefentry><refentrytitle>eglBindTexImage</refentrytitle></citerefentry></member>
132        <member><citerefentry><refentrytitle>eglReleaseTexImage</refentrytitle></citerefentry></member>
133      </simplelist>
134    </sect1>
135  </chapter>
136  <chapter>
137    <title>EGL Reference Pages</title>
138    <xi:include href="eglBindAPI.xml"/>
139    <xi:include href="eglBindTexImage.xml"/>
140    <xi:include href="eglChooseConfig.xml"/>
141    <xi:include href="eglClientWaitSync.xml"/>
142    <xi:include href="eglCopyBuffers.xml"/>
143    <xi:include href="eglCreateContext.xml"/>
144    <xi:include href="eglCreateImage.xml"/>
145    <xi:include href="eglCreatePbufferSurface.xml"/>
146    <xi:include href="eglCreatePixmapSurface.xml"/>
147    <xi:include href="eglCreateSync.xml"/>
148    <xi:include href="eglCreateWindowSurface.xml"/>
149    <xi:include href="eglDestroyContext.xml"/>
150    <xi:include href="eglDestroyImage.xml"/>
151    <xi:include href="eglDestroySurface.xml"/>
152    <xi:include href="eglDestroySync.xml"/>
153    <xi:include href="eglGetConfigAttrib.xml"/>
154    <xi:include href="eglGetConfigs.xml"/>
155    <xi:include href="eglGetCurrentContext.xml"/>
156    <xi:include href="eglGetCurrentDisplay.xml"/>
157    <xi:include href="eglGetCurrentSurface.xml"/>
158    <xi:include href="eglGetDisplay.xml"/>
159    <xi:include href="eglGetError.xml"/>
160    <xi:include href="eglGetPlatformDisplay.xml"/>
161    <xi:include href="eglGetProcAddress.xml"/>
162    <xi:include href="eglGetSyncAttrib.xml"/>
163    <xi:include href="eglInitialize.xml"/>
164    <xi:include href="eglIntro.xml"/>
165    <xi:include href="eglMakeCurrent.xml"/>
166    <xi:include href="eglQueryAPI.xml"/>
167    <xi:include href="eglQueryContext.xml"/>
168    <xi:include href="eglQueryString.xml"/>
169    <xi:include href="eglQuerySurface.xml"/>
170    <xi:include href="eglReleaseTexImage.xml"/>
171    <xi:include href="eglReleaseThread.xml"/>
172    <xi:include href="eglSurfaceAttrib.xml"/>
173    <xi:include href="eglSwapBuffers.xml"/>
174    <xi:include href="eglSwapInterval.xml"/>
175    <xi:include href="eglTerminate.xml"/>
176    <xi:include href="eglWaitClient.xml"/>
177    <xi:include href="eglWaitGL.xml"/>
178    <xi:include href="eglWaitNative.xml"/>
179    <xi:include href="eglWaitSync.xml"/>
180  </chapter>
181  <xi:include href="license-full.xml"/>
182</book>
183