diff options
Diffstat (limited to 'glew/auto/EGL-Registry/sdk/docs/man/docbook4')
36 files changed, 6380 insertions, 0 deletions
diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglBindAPI.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglBindAPI.xml new file mode 100644 index 0000000..3dc1b20 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglBindAPI.xml @@ -0,0 +1,130 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglBindAPI"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglBindAPI</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglBindAPI</refname> + <refpurpose>Set the current rendering API</refpurpose> + </refnamediv> + <refsynopsisdiv><title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglBindAPI</function></funcdef> + <paramdef>EGLenum <parameter>api</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>api</parameter></term> + <listitem> + <para> + Specifies the client API to bind, one of + <constant>EGL_OPENGL_API</constant>, + <constant>EGL_OPENGL_ES_API</constant>, or + <constant>EGL_OPENVG_API</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglBindAPI</function> defines the current + rendering API for EGL in the thread it is called from. The + current rendering API is one of the client rendering APIs + supported by the EGL implementation, and affects the + behavior of other EGL commands including + <function>eglCreateContext</function>, + <function>eglGetCurrentContext</function>, + <function>eglGetCurrentDisplay</function>, + <function>eglGetCurrentSurface</function>, + <function>eglMakeCurrent</function>, + <function>eglWaitClient</function>, and + <function>eglWaitNative</function>. + </para> + <para> + If <parameter>api</parameter> is + <constant>EGL_OPENGL_API</constant>, the current rendering + API is set to the OpenGL API. + </para> + <para> + If <parameter>api</parameter> is + <constant>EGL_OPENGL_ES_API</constant>, the current + rendering API is set to the OpenGL ES API. + </para> + <para> + If <parameter>api</parameter> is + <constant>EGL_OPENVG_API</constant>, the current rendering + API is set to the OpenVG API. + </para> + <para> + If an error occurs, the current rendering API is unchanged. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + <function>eglBindAPI</function> and the corresponding + <constant>EGL_OPENGL_ES_API</constant> and + <constant>EGL_OPENVG_API</constant> + <parameter>api</parameter> parameters are supported only if + the EGL version is 1.2 or greater. The + <constant>EGL_OPENGL_API</constant> parameter is supported + only if the EGL version is 1.4 or greater. + </para> + <para> + The initial value of the current rendering API is + <constant>EGL_OPENGL_ES_API</constant> unless OpenGL ES is + not supported by an implementation, in which case the + initial value is <constant>EGL_NONE</constant> (however, + <constant>EGL_NONE</constant> is not a valid + <parameter>api</parameter> parameter to + <function>eglBindAPI</function>). + </para> + <para> + The current rendering API can be queried by calling + <function>eglQueryAPI</function>. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned on failure. + </para> + <para> + <constant>EGL_BAD_PARAMETER</constant> is generated if + <parameter>api</parameter> is not one of the accepted + tokens, or if the specified client API is not supported by + the EGL implementation. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentDisplay</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglQueryAPI</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitClient</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglBindTexImage.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglBindTexImage.xml new file mode 100644 index 0000000..70d05c7 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglBindTexImage.xml @@ -0,0 +1,181 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglBindTexImage"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglBindTexImage</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglBindTexImage</refname> + <refpurpose> + Defines a two-dimensional texture image + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglBindTexImage</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLSurface <parameter>surface</parameter></paramdef> + <paramdef>EGLint <parameter>buffer</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the EGL display connection.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>surface</parameter></term> + <listitem> + <para> + Specifies the EGL surface. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>buffer</parameter></term> + <listitem><para>Specifies the texture image data.</para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + The texture image consists of the image data in <parameter>buffer</parameter> for the specified surface, and need not be copied. + </para> + <para> + The texture target, the texture format and the size of the texture components are derived from + attributes of the specified surface, which must be a pbuffer supporting one of the + <constant>EGL_BIND_TO_TEXTURE_RGB</constant> or <constant>EGL_BIND_TO_TEXTURE_RGBA</constant> attributes. + </para> + <para> + The pbuffer attribute <constant>EGL_TEXTURE_FORMAT</constant> determines the base internal format + of the texture. + </para> + <para> + The texture target is derived from the <constant>EGL_TEXTURE_TARGET</constant> attribute of surface. + If the attribute value is <constant>EGL_TEXTURE_2D</constant>, then <parameter>buffer</parameter> defines a texture for + the two-dimensional texture object which is bound to the current context (hereafter + referred to as the current texture object). + </para> + <para> + If <parameter>display</parameter> and <parameter>surface</parameter> are the display and surface for the calling thread's current + context, <function>eglBindTexImage</function> performs an implicit <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>. + For other surfaces, <function>eglBindTexImage</function> waits for all effects from previously issued OpenGL ES commands + drawing to the surface to complete before defining the texture image, as + though <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry> were called on the last context to which that surface were bound. + </para> + <para> + After <function>eglBindTexImage</function> is called, the specified surface is no longer available + for reading or writing. Any read operation, such as <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry> or + <citerefentry><refentrytitle>eglCopyBuffers</refentrytitle></citerefentry>, which reads values from any of the surface's color buffers or ancillary + buffers will produce indeterminate results. In addition, draw operations that are + done to the surface before its color buffer is released from the texture produce indeterminate + results. Specifically, if the surface is current to a context and thread + then rendering commands will be processed and the context state will be updated, + but the surface may or may not be written. + </para> + <para> + Texture mipmap levels are automatically generated when all of the following + conditions are met while calling <function>eglBindTexImage</function>: + </para> + <itemizedlist> + <listitem> + <para> + The <constant>EGL_MIPMAP_TEXTURE</constant> attribute of the pbuffer being bound is + <constant>EGL_TRUE</constant>. + </para> + </listitem> + <listitem> + <para> + The OpenGL ES texture parameter <constant>GL_GENERATE_MIPMAP</constant> is <constant>GL_TRUE</constant> for + the currently bound texture. + </para> + </listitem> + <listitem> + <para> + The value of the <constant>EGL_MIPMAP_LEVEL</constant> attribute of the pbuffer being bound is + equal to the value of the texture parameter <constant>GL_TEXTURE_BASE_LEVEL</constant>. + In this case, additional mipmap levels are generated as described in section 3.8 + of the OpenGL ES 1.1 Specification. + </para> + </listitem> + </itemizedlist> + <para> + In this case, additional mipmap levels are generated as described in section 3.8 + of the OpenGL ES 1.1 Specification. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + <citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry> has no effect if it is + called on a bound surface. + </para> + <para> + Any existing images associated with the different mipmap levels of the texture object + are freed (it is as if <citerefentry><refentrytitle>glTexImage</refentrytitle></citerefentry> + was called with an image of zero width). + </para> + <para> + The color buffer is bound to a texture object. If the texture object is + shared between contexts, then the color buffer is also shared. If a texture object is + deleted before <citerefentry><refentrytitle>eglReleaseTexImage</refentrytitle></citerefentry> is called, then the color buffer is released and + the surface is made available for reading and writing. + </para> + <para> + It is not an error to call <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry> or + <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry> to replace an + image of a texture object that has a color buffer bound to it. However, these calls + will cause the color buffer to be released back to the surface and new memory will + be allocated for the texture. Note that the color buffer is released even if the image + that is being defined is a mipmap level that was not defined by the color buffer. + </para> + <para> + <function>eglBindTexImage</function> is ignored if there is no current rendering context. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_BAD_ACCESS</constant> is generated if + <parameter>buffer</parameter> is already bound to a texture. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if the + surface attribute <constant>EGL_TEXTURE_FORMAT</constant> is + set to <constant>EGL_NO_TEXTURE</constant>. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + <parameter>buffer</parameter> is not a valid buffer + (currently only <constant>EGL_BACK_BUFFER</constant> may be + specified). + </para> + <para> + <constant>EGL_BAD_SURFACE</constant> is generated if + <parameter>surface</parameter> is not an EGL surface, or is + not a pbuffer surface supporting texture binding. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglReleaseTexImage</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglChooseConfig.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglChooseConfig.xml new file mode 100644 index 0000000..09fd3d7 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglChooseConfig.xml @@ -0,0 +1,929 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglChooseConfig"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglChooseConfig</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglChooseConfig</refname> + <refpurpose> + return a list of EGL frame buffer configurations that match specified attributes + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglChooseConfig</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLint const * <parameter>attrib_list</parameter></paramdef> + <paramdef>EGLConfig * <parameter>configs</parameter></paramdef> + <paramdef>EGLint <parameter>config_size</parameter></paramdef> + <paramdef>EGLint * <parameter>num_config</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the EGL display connection.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrib_list</parameter></term> + <listitem><para>Specifies attributes required to match by configs.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>configs</parameter></term> + <listitem><para>Returns an array of frame buffer configurations.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>config_size</parameter></term> + <listitem><para>Specifies the size of the array of frame buffer configurations.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>num_config</parameter></term> + <listitem><para>Returns the number of frame buffer configurations returned.</para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglChooseConfig</function> returns in + <parameter>configs</parameter> a list of all + <acronym>EGL</acronym> frame buffer configurations that + match the attributes specified in + <parameter>attrib_list</parameter>. The returned + <type>EGLConfig</type>s can be used in any + <acronym>EGL</acronym> function that requires an + <acronym>EGL</acronym> frame buffer configuration. + </para> + <para> + If <parameter>configs</parameter> is not + <constant>NULL</constant>, up to + <parameter>config_size</parameter> configs will be returned + in the array pointed to by <parameter>configs</parameter>. + The number of configs actually returned will be returned in + *<parameter>num_config</parameter>. + </para> + <para> + If <parameter>configs</parameter> is + <constant>NULL</constant>, no configs will be returned in + <parameter>configs</parameter>. Instead, the total number of + configs matching <parameter>attrib_list</parameter> will be + returned in *<parameter>num_config</parameter>. In this case + <parameter>config_size</parameter> is ignored. This form of + <function>eglChooseConfig</function> is used to determine + the number of matching frame buffer configurations, followed + by allocating an array of <type>EGLConfig</type> to pass + into another call to <function>eglChooseConfig</function> + with all other parameters unchanged. + </para> + <para> + All attributes in <parameter>attrib_list</parameter>, + including boolean attributes, are immediately followed by + the corresponding desired value. The list is terminated with + <constant>EGL_NONE</constant>. If an attribute is not + specified in <parameter>attrib_list</parameter> then the + default value (see below) is used (and the attribute is said + to be specified implicitly). For example, if + <constant>EGL_DEPTH_SIZE</constant> is not specified then it + is assumed to be zero. For some attributes, the default is + <constant>EGL_DONT_CARE</constant> meaning that any value is + OK for this attribute, so the attribute will not be checked. + </para> + <para> + Attributes are matched in an attribute-specific manner. Some + of the attributes, such as <constant>EGL_LEVEL</constant>, + must match the specified value exactly. Others, such as, + <constant>EGL_RED_SIZE</constant> must meet or exceed the + specified minimum values. If more than one EGL frame buffer + configuration matching all attributes is found, then a list + of configurations, sorted according to the ``best'' match + criteria, is returned. The match criteria for each attribute + and the exact sorting order is defined below. + </para> + <para> + For the bitmask attributes + <constant>EGL_CONFORMANT</constant>, + <constant>EGL_RENDERABLE_TYPE</constant>, and + <constant>EGL_SURFACE_TYPE</constant>, only the nonzero bits + of the mask are considered when matching. Any bits that are + zero in the specified bitmask attribute value may be either + zero or one in the resulting config's attribute value. + </para> + <para> + Attributes which may appear in + <parameter>attrib_list</parameter>, and their descriptions + and allowed values, are: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_ALPHA_MASK_SIZE</constant></term> + <listitem><para> + Must be followed by a nonnegative integer that + indicates the desired alpha mask buffer size, in + bits. The smallest alpha mask buffers of at least + the specified size are preferred. The default value + is zero. + </para> + <para> + The alpha mask buffer is used only by OpenGL and + OpenGL ES client APIs. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_ALPHA_SIZE</constant></term> + <listitem><para> + Must be followed by a nonnegative integer that + indicates the desired size of the alpha component of + the color buffer, in bits. If this value is zero, + color buffers with the smallest alpha component size + are preferred. Otherwise, color buffers with the + largest alpha component of at least the specified + size are preferred. The default value is zero. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BIND_TO_TEXTURE_RGB</constant></term> + <listitem><para> + Must be followed by + <constant>EGL_DONT_CARE</constant>, + <constant>EGL_TRUE</constant>, or + <constant>EGL_FALSE</constant>. + If <constant>EGL_TRUE</constant> is specified, then + only frame buffer configurations that support + binding of color buffers to an OpenGL ES RGB texture + will be considered. Currently only frame buffer + configurations that support pbuffers allow this. The + default value is <constant>EGL_DONT_CARE</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BIND_TO_TEXTURE_RGBA</constant></term> + <listitem><para> + Must be followed by one of + <constant>EGL_DONT_CARE</constant>, + <constant>EGL_TRUE</constant>, or + <constant>EGL_FALSE</constant>. + If <constant>EGL_TRUE</constant> is specified, then + only frame buffer configurations that support + binding of color buffers to an OpenGL ES RGBA + texture will be considered. Currently only frame + buffer configurations that support pbuffers allow + this. The default value is + <constant>EGL_DONT_CARE</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BLUE_SIZE</constant></term> + <listitem><para> + Must be followed by a nonnegative integer that + indicates the desired size of the blue component of + the color buffer, in bits. If this value is zero, + color buffers with the smallest blue component size + are preferred. Otherwise, color buffers with the + largest blue component of at least the specified + size are preferred. The default value is zero. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BUFFER_SIZE</constant></term> + <listitem><para> + Must be followed by a nonnegative integer that + indicates the desired color buffer size, in bits. + The smallest color buffers of at least the specified + size are preferred. The default value is zero. + </para> + <para> + The color buffer size is the sum of + <constant>EGL_RED_SIZE</constant>, + <constant>EGL_GREEN_SIZE</constant>, + <constant>EGL_BLUE_SIZE</constant>, and + <constant>EGL_ALPHA_SIZE</constant>, and does not + include any padding bits which may be present in the + pixel format. It is usually preferable to specify + desired sizes for these color components + individually. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_COLOR_BUFFER_TYPE</constant></term> + <listitem> + <para> + Must be followed by one of + <constant>EGL_RGB_BUFFER</constant> or + <constant>EGL_LUMINANCE_BUFFER</constant>. + </para> + <para> + <constant>EGL_RGB_BUFFER</constant> indicates + an RGB color buffer; in this case, + attributes <constant>EGL_RED_SIZE</constant>, + <constant>EGL_GREEN_SIZE</constant> and + <constant>EGL_BLUE_SIZE</constant> must be non-zero, and + <constant>EGL_LUMINANCE_SIZE</constant> must be zero. + </para> + <para> + <constant>EGL_LUMINANCE_BUFFER</constant> indicates a luminance color + buffer. In this case <constant>EGL_RED_SIZE</constant>, + <constant>EGL_GREEN_SIZE</constant>, + <constant>EGL_BLUE_SIZE</constant> must be zero, and + <constant>EGL_LUMINANCE_SIZE</constant> must be non-zero. + </para> + <para> + For both RGB and luminance color buffers, + <constant>EGL_ALPHA_SIZE</constant> may be zero or + non-zero. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONFIG_CAVEAT</constant></term> + <listitem> + <para> + Must be followed by + <constant>EGL_DONT_CARE</constant>, + <constant>EGL_NONE</constant>, + <constant>EGL_SLOW_CONFIG</constant>, or + <constant>EGL_NON_CONFORMANT_CONFIG</constant>. + </para> + <para> + If <constant>EGL_DONT_CARE</constant> is specified, + then configs are not matched for this attribute. The + default value is <constant>EGL_DONT_CARE</constant>. + </para> + <para> + If <constant>EGL_NONE</constant> is specified, then + configs are matched for this attribute, but only + configs with no caveats (neither + <constant>EGL_SLOW_CONFIG</constant> or + <constant>EGL_NON_CONFORMANT_CONFIG</constant>) will + be considered. + </para> + <para> + If <constant>EGL_SLOW_CONFIG</constant> is + specified, then only slow configs configurations + will be considered. The meaning of``slow'' is + implementation-dependent, but typically indicates a + non-hardware-accelerated (software) implementation. + </para> + <para> + If <constant>EGL_NON_CONFORMANT_CONFIG</constant> is + specified, then only configs supporting + non-conformant OpenGL ES contexts will be + considered. + </para> + <para> + If the EGL version is 1.3 or later, caveat + <constant>EGL_NON_CONFORMANT_CONFIG</constant> is + obsolete, since the same information can be + specified via the + <constant>EGL_CONFORMANT</constant> attribute on a + per-client-API basis, not just for OpenGL ES. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONFIG_ID</constant></term> + <listitem> + <para> + Must be followed by a valid integer ID that + indicates the desired EGL frame buffer + configuration. When a + <constant>EGL_CONFIG_ID</constant> is specified, all + other attributes are ignored. The default value is + <constant>EGL_DONT_CARE</constant>. + </para> + <para> + The meaning of config IDs is + implementation-dependent. They are used only to + uniquely identify different frame buffer + configurations. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONFORMANT</constant></term> + <listitem> + <para> + Must be followed by a bitmask indicating which types + of client API contexts created with respect to the + frame buffer configuration config must pass the + required conformance tests for that API. Mask bits + include: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_OPENGL_BIT</constant></term> + <listitem><para> + Config supports creating OpenGL contexts. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_OPENGL_ES_BIT</constant></term> + <listitem><para> + Config supports creating OpenGL ES 1.0 + and/or 1.1 contexts. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_OPENGL_ES2_BIT</constant></term> + <listitem><para> + Config supports creating OpenGL ES 2.0 contexts. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_OPENVG_BIT</constant></term> + <listitem><para> + Config supports creating OpenVG contexts. + </para></listitem> + </varlistentry> + </variablelist> + <para> + For example, if the bitmask is set to + <constant>EGL_OPENGL_ES_BIT</constant>, only frame + buffer configurations that support creating + conformant OpenGL ES contexts will match. The + default value is zero. + </para> + <para> + Most EGLConfigs should be conformant for all + supported client APIs, and it is rarely desirable to + select a nonconformant config. Conformance + requirements limit the number of non-conformant + configs that an implementation can define. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_DEPTH_SIZE</constant></term> + <listitem> + <para> + Must be followed by a nonnegative integer that + indicates the desired depth buffer size, in bits. + The smallest depth buffers of at least the specified + size is preferred. If the desired size is zero, + frame buffer configurations with no depth buffer are + preferred. The default value is zero. + </para> + <para> + The depth buffer is used only by OpenGL and OpenGL + ES client APIs. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_GREEN_SIZE</constant></term> + <listitem><para> + Must be followed by a nonnegative integer that + indicates the desired size of the green component of + the color buffer, in bits. If this value is zero, + color buffers with the smallest green component size + are preferred. Otherwise, color buffers with the + largest green component of at least the specified + size are preferred. The default value is zero. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_LEVEL</constant></term> + <listitem><para> + Must be followed by an integer buffer level + specification. This specification is honored + exactly. Buffer level zero corresponds to the + default frame buffer of the display. Buffer level + one is the first overlay frame buffer, level two the + second overlay frame buffer, and so on. Negative + buffer levels correspond to underlay frame buffers. + The default value is zero. + </para> + <para> + Most imlementations do not support overlay or + underlay planes (buffer levels other than zero). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_LUMINANCE_SIZE</constant></term> + <listitem> + <para> + Must be followed by a nonnegative integer that + indicates the desired size of the luminance + component of the color buffer, in bits. If this + value is zero, color buffers with the smallest + luminance component size are preferred. Otherwise, + color buffers with the largest luminance component + of at least the specified size are preferred. The + default value is zero. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MATCH_NATIVE_PIXMAP</constant></term> + <listitem> + <para> + Must be followed by the handle of a valid native + pixmap, cast to <type>EGLint</type>, or + <constant>EGL_NONE</constant>. If the value is not + <constant>EGL_NONE</constant>, only configs which + support creating pixmap surfaces with this pixmap + using + <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry> + will match this attribute. If the value is + <constant>EGL_NONE</constant>, then configs are not + matched for this attribute. The default value is + <constant>EGL_NONE</constant>. + </para> + <para> + <constant>EGL_MATCH_NATIVE_PIXMAP</constant> was + introduced due to the difficulty of determining an + <type>EGLConfig</type> compatibile with a native + pixmap using only color component sizes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_NATIVE_RENDERABLE</constant></term> + <listitem><para> + Must be followed by + <constant>EGL_DONT_CARE</constant>, + <constant>EGL_TRUE</constant>, or + <constant>EGL_FALSE</constant>. + If <constant>EGL_TRUE</constant> is specified, then + only frame buffer configurations that allow native + rendering into the surface will be considered. The + default value is <constant>EGL_DONT_CARE</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MAX_SWAP_INTERVAL</constant></term> + <listitem><para> + Must be followed by a integer that indicates the + maximum value that can be passed to + <citerefentry><refentrytitle>eglSwapInterval</refentrytitle></citerefentry>. + The default value is + <constant>EGL_DONT_CARE</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MIN_SWAP_INTERVAL</constant></term> + <listitem><para> + Must be followed by a integer that indicates the + minimum value that can be passed to eglSwapInterval. + The default value is <constant>EGL_DONT_CARE</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_RED_SIZE</constant></term> + <listitem><para> + Must be followed by a nonnegative integer that + indicates the desired size of the red component of + the color buffer, in bits. If this value is zero, + color buffers with the smallest red component size + are preferred. Otherwise, color buffers with the + largest red component of at least the specified size + are preferred. The default value is zero. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SAMPLE_BUFFERS</constant></term> + <listitem><para> + Must be followed by the minimum acceptable number of + multisample buffers. Configurations with the + smallest number of multisample buffers that meet or + exceed this minimum number are preferred. Currently + operation with more than one multisample buffer is + undefined, so only values of zero or one will + produce a match. The default value is zero. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SAMPLES</constant></term> + <listitem><para> + Must be followed by the minimum number of + samples required in multisample buffers. + Configurations with the smallest number of + samples that meet or exceed the specified + minimum number are preferred. Note that it is + possible for color samples in the multisample + buffer to have fewer bits than colors in the + main color buffers. However, multisampled + colors maintain at least as much color + resolution in aggregate as the main color + buffers. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_STENCIL_SIZE</constant></term> + <listitem> + <para> + Must be followed by a nonnegative integer that + indicates the desired stencil buffer size, in bits. + The smallest stencil buffers of at least the + specified size are preferred. If the desired size is + zero, frame buffer configurations with no stencil + buffer are preferred. The default value is zero. + </para> + <para> + The stencil buffer is used only by OpenGL and + OpenGL ES client APIs. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_RENDERABLE_TYPE</constant></term> + <listitem> + <para> + Must be followed by a bitmask indicating which types + of client API contexts the frame buffer + configuration must support creating with + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>). + Mask bits are the same as for attribute + <constant>EGL_CONFORMANT</constant>. The default + value is <constant>EGL_OPENGL_ES_BIT</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SURFACE_TYPE</constant></term> + <listitem> + <para> + Must be followed by a bitmask indicating which EGL + surface types and capabilities the frame buffer + configuration must support. Mask bits include: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_MULTISAMPLE_RESOLVE_BOX_BIT</constant></term> + <listitem><para> + Config allows specifying box filtered + multisample resolve behavior with + <citerefentry><refentrytitle>eglSurfaceAttrib</refentrytitle></citerefentry>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_PBUFFER_BIT</constant></term> + <listitem><para> + Config supports creating pixel buffer surfaces. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_PIXMAP_BIT</constant></term> + <listitem><para> + Config supports creating pixmap surfaces. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SWAP_BEHAVIOR_PRESERVED_BIT</constant></term> + <listitem><para> + Config allows setting swap behavior for + color buffers with + <citerefentry><refentrytitle>eglSurfaceAttrib</refentrytitle></citerefentry>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_VG_ALPHA_FORMAT_PRE_BIT</constant></term> + <listitem><para> + Config allows specifying OpenVG rendering + with premultiplied alpha values at surface + creation time (see + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>, + and + <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>). + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_VG_COLORSPACE_LINEAR_BIT</constant></term> + <listitem><para> + Config allows specifying OpenVG rendering in + a linear colorspace at surface creation time + (see + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>, + and + <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>). + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_WINDOW_BIT</constant></term> + <listitem><para> + Config supports creating window surfaces. + </para></listitem> + </varlistentry> + </variablelist> + <para> + For example, if the bitmask is set to + <inlineequation> + <mml:math> + <mml:mi><constant>EGL_WINDOW_BIT</constant></mml:mi> + <mml:mo>|</mml:mo> + <mml:mi><constant>EGL_PIXMAP_BIT</constant></mml:mi> + </mml:math> + </inlineequation>, + only frame buffer configurations that support both + windows and pixmaps will be considered. The default + value is <constant>EGL_WINDOW_BIT</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TRANSPARENT_TYPE</constant></term> + <listitem><para> + Must be followed by one of + <constant>EGL_NONE</constant> or + <constant>EGL_TRANSPARENT_RGB</constant>. If + <constant>EGL_NONE</constant> is specified, then + only opaque frame buffer configurations will be + considered. If + <constant>EGL_TRANSPARENT_RGB</constant> is + specified, then only transparent frame buffer + configurations will be considered. The default value + is <constant>EGL_NONE</constant>. + </para> + <para> + Most implementations support only opaque frame + buffer configurations. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TRANSPARENT_RED_VALUE</constant></term> + <listitem><para> + Must be followed by an integer value indicating the + transparent red value. The value must be between + zero and the maximum color buffer value for red. + Only frame buffer configurations that use the + specified transparent red value will be considered. + The default value is + <constant>EGL_DONT_CARE</constant>. + </para> + <para> + This attribute is ignored unless + <constant>EGL_TRANSPARENT_TYPE</constant> is included in + <parameter>attrib_list</parameter> and specified as + <constant>EGL_TRANSPARENT_RGB</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TRANSPARENT_GREEN_VALUE</constant></term> + <listitem><para> + Must be followed by an integer value indicating the + transparent green value. The value must be between + zero and the maximum color buffer value for green. + Only frame buffer configurations that use the + specified transparent green value will be + considered. The default value is + <constant>EGL_DONT_CARE</constant>. + </para> + <para> + This attribute is ignored unless + <constant>EGL_TRANSPARENT_TYPE</constant> is included in + <parameter>attrib_list</parameter> and specified as + <constant>EGL_TRANSPARENT_RGB</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TRANSPARENT_BLUE_VALUE</constant></term> + <listitem><para> + Must be followed by an integer value indicating the + transparent blue value. The value must be between + zero and the maximum color buffer value for blue. + Only frame buffer configurations that use the + specified transparent blue value will be considered. + The default value is + <constant>EGL_DONT_CARE</constant>. + </para> + <para> + This attribute is ignored unless + <constant>EGL_TRANSPARENT_TYPE</constant> is included in + <parameter>attrib_list</parameter> and specified as + <constant>EGL_TRANSPARENT_RGB</constant>. + </para></listitem> + </varlistentry> + </variablelist> + <para> + When more than one EGL frame buffer configuration matches + the specified attributes, a list of matching configurations + is returned. The list is sorted according to the following + precedence rules, which are applied in ascending order + (i.e., configurations that are considered equal by a lower + numbered rule are sorted by the higher numbered rule): + </para> + <orderedlist> + <listitem><para> + Special: by <constant>EGL_CONFIG_CAVEAT</constant>, + where the precedence is <constant>EGL_NONE</constant>, + <constant>EGL_SLOW_CONFIG</constant>, and + <constant>EGL_NON_CONFORMANT_CONFIG</constant>. + </para></listitem> + <listitem><para> + Special: by <constant>EGL_COLOR_BUFFER_TYPE</constant>, + where the precedence is + <constant>EGL_RGB_BUFFER</constant>, + <constant>EGL_LUMINANCE_BUFFER</constant>. + </para></listitem> + <listitem> + <para> + Special: by larger total number of color bits (for an + RGB color buffer, this is the sum of + <constant>EGL_RED_SIZE</constant>, + <constant>EGL_GREEN_SIZE</constant>, + <constant>EGL_BLUE_SIZE</constant>, and + <constant>EGL_ALPHA_SIZE</constant>; for a luminance + color buffer, the sum of + <constant>EGL_LUMINANCE_SIZE</constant> and + <constant>EGL_ALPHA_SIZE</constant>). If the requested + number of bits in <parameter>attrib_list</parameter> is + <constant>0</constant> or + <constant>EGL_DONT_CARE</constant> for a particular + color component, then the number of bits for that + component is not considered. + </para> + <para> + This sort rule places configs with deeper color buffers + before configs with shallower color buffers, which may + be counterintuitive. + </para> + </listitem> + <listitem><para> + Smaller <constant>EGL_BUFFER_SIZE</constant>. + </para></listitem> + <listitem><para> + Smaller <constant>EGL_SAMPLE_BUFFERS</constant>. + </para></listitem> + <listitem><para> + Smaller <constant>EGL_SAMPLES</constant>. + </para></listitem> + <listitem><para> + Smaller <constant>EGL_DEPTH_SIZE</constant>. + </para></listitem> + <listitem><para> + Smaller <constant>EGL_STENCIL_SIZE</constant>. + </para></listitem> + <listitem><para> + Smaller <constant>EGL_ALPHA_MASK_SIZE</constant>. + </para></listitem> + <listitem><para> + Special: <constant>EGL_NATIVE_VISUAL_TYPE</constant> + (the actual sort order is implementation-defined, + depending on the meaning of native visual types). + </para></listitem> + <listitem><para> + Smaller <constant>EGL_CONFIG_ID</constant> (this is + always the last sorting rule, and guarantees a unique + ordering). + </para></listitem> + </orderedlist> + <para> + <type>EGLConfigs</type> are not sorted with respect to the + attributes <constant>EGL_BIND_TO_TEXTURE_RGB</constant>, + <constant>EGL_BIND_TO_TEXTURE_RGBA</constant>, + <constant>EGL_CONFORMANT</constant>, + <constant>EGL_LEVEL</constant>, + <constant>EGL_NATIVE_RENDERABLE</constant>, + <constant>EGL_MAX_SWAP_INTERVAL</constant>, + <constant>EGL_MIN_SWAP_INTERVAL</constant>, + <constant>EGL_RENDERABLE_TYPE</constant>, + <constant>EGL_SURFACE_TYPE</constant>, + <constant>EGL_TRANSPARENT_TYPE</constant>, + <constant>EGL_TRANSPARENT_RED_VALUE</constant>, + <constant>EGL_TRANSPARENT_GREEN_VALUE</constant>, and + <constant>EGL_TRANSPARENT_BLUE_VALUE</constant>. + </para> + </refsect1> + <refsect1 id="examples"><title>Examples</title> + <para> + The following example specifies a frame buffer configuration + in the normal frame buffer (not an overlay or underlay). The + returned frame buffer configuration supports a color buffer + with at least 4 bits each of red, green and blue, and + possibly no alpha bits. The code shown in the example may or + may not have a depth buffer, or a stencil buffer. + </para> + <programlisting>EGLint const attrib_list[] = { + EGL_RED_SIZE, 4, + EGL_GREEN_SIZE, 4, + EGL_BLUE_SIZE, 4, + EGL_NONE +};</programlisting> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + <constant>EGL_RENDERABLE_TYPE</constant> bit + <constant>EGL_OPENGL_BIT</constant>, and + <constant>EGL_SURFACE_TYPE</constant> bits + <constant>EGL_MULTISAMPLE_RESOLVE_BOX_BIT</constant> and + <constant>EGL_SWAP_BEHAVIOR_PRESERVED_BIT</constant> are + supported only if the EGL version is 1.4 or greater. + </para> + <para> + <constant>EGL_CONFORMANT</constant>, + <constant>EGL_MATCH_NATIVE_PIXMAP</constant>, + <constant>EGL_RENDERABLE_TYPE</constant> bit + <constant>EGL_OPENGL_ES2_BIT</constant>, and + <constant>EGL_SURFACE_TYPE</constant> bits + <constant>EGL_VG_ALPHA_FORMAT_PRE_BIT</constant> and + <constant>EGL_VG_COLORSPACE_LINEAR_BIT</constant> are + supported only if the EGL version is 1.3 or greater. + </para> + <para> + <constant>EGL_ALPHA_MASK_SIZE</constant>, + <constant>EGL_COLOR_BUFFER_TYPE</constant>, + <constant>EGL_LUMINANCE_SIZE</constant>, + <constant>EGL_RENDERABLE_TYPE</constant>, and + <constant>EGL_RENDERABLE_TYPE</constant> bits + <constant>EGL_OPENGL_ES_BIT</constant> and + <constant>EGL_OPENVG_BIT</constant> are supported only if + the EGL version is 1.2 or greater. + </para> + <para> + If OpenGL or OpenGL ES rendering is supported for a + luminance color buffer, it is treated as RGB rendering with + the value of <constant>GL_RED_BITS</constant> equal to + <constant>EGL_LUMINANCE_SIZE</constant> and the values of + <constant>GL_GREEN_BITS</constant> and + <constant>GL_BLUE_BITS</constant> equal to zero. The red + component of fragments is written to the luminance channel + of the color buffer while the green and blue components are + discarded. + </para> + <para> + <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry> + and + <citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry> + can be used to implement selection algorithms other than the + generic one implemented by + <function>eglChooseConfig</function>. Call + <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry> + to retrieve all the frame buffer configurations, or + alternatively, all the frame buffer configurations with a + particular set of attributes. Next call + <citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry> + to retrieve additional attributes for the frame buffer + configurations and then select between them. + </para> + <para> + EGL implementors are strongly discouraged, but not + proscribed, from changing the selection algorithm used by + <function>eglChooseConfig</function>. Therefore, selections + may change from release to release of the client-side + library. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned on failure, + <constant>EGL_TRUE</constant> otherwise. + <parameter>configs</parameter> and + <parameter>num_config</parameter> are not modified when + <constant>EGL_FALSE</constant> is returned. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_BAD_ATTRIBUTE</constant> is generated if + <parameter>attribute_list</parameter> contains an invalid frame buffer + configuration attribute or an + attribute value that is unrecognized or out of range. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_PARAMETER</constant> is generated if + <parameter>num_config</parameter> is <constant>NULL</constant>. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglSurfaceAttrib</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglSwapInterval</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCopyBuffers.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCopyBuffers.xml new file mode 100644 index 0000000..e493378 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCopyBuffers.xml @@ -0,0 +1,129 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglCopyBuffers"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglCopyBuffers</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglCopyBuffers</refname> + <refpurpose> + copy <acronym>EGL</acronym> surface color buffer to a native pixmap + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglCopyBuffers</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLSurface <parameter>surface</parameter></paramdef> + <paramdef>NativePixmapType <parameter>native_pixmap</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem> + <para> + Specifies the EGL display connection. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>surface</parameter></term> + <listitem> + <para> + Specifies the EGL surface whose color buffer is to be copied. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>native_pixmap</parameter></term> + <listitem> + <para> + Specifies the native pixmap as target of the copy. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglCopyBuffers</function> copies the color buffer of + <parameter>surface</parameter> to <parameter>native_pixmap</parameter>. + </para> + <para> + <function>eglCopyBuffers</function> performs an implicit + <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry> + before it returns. Subsequent + GL commands may be issued immediately after calling + <function>eglCopyBuffers</function>, + but are not executed until copying of the color buffer is completed. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + The color buffer of <parameter>surface</parameter> is left unchanged + after calling <function>eglCopyBuffers</function>. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned if swapping of the + surface buffers fails, <constant>EGL_TRUE</constant> otherwise. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_SURFACE</constant> is generated if + <parameter>surface</parameter> is not an EGL drawing surface. + </para> + <para> + <constant>EGL_BAD_NATIVE_PIXMAP</constant> is generated if + the implementation does not support native pixmaps. + </para> + <para> + <constant>EGL_BAD_NATIVE_PIXMAP</constant> may be generated if + <parameter>native_pixmap</parameter> is not a valid native pixmap. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + the format of <parameter>native_pixmap</parameter> is not compatible + with the color buffer of <parameter>surface</parameter>. + </para> + <para> + <constant>EGL_CONTEXT_LOST</constant> is generated if a power management + event has occurred. The application must destroy all contexts and + reinitialise OpenGL ES state and objects to continue rendering. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreateContext.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreateContext.xml new file mode 100644 index 0000000..3a05314 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreateContext.xml @@ -0,0 +1,220 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglCreateContext"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglCreateContext</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglCreateContext</refname> + <refpurpose> + create a new <acronym>EGL</acronym> rendering context + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLContext <function>eglCreateContext</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLConfig <parameter>config</parameter></paramdef> + <paramdef>EGLContext <parameter>share_context</parameter></paramdef> + <paramdef>EGLint const * <parameter>attrib_list</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para> + Specifies the + <acronym>EGL</acronym> + display connection. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>config</parameter></term> + <listitem><para>Specifies the EGL frame buffer configuration that + defines the frame buffer resource available to the rendering context. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>share_context</parameter></term> + <listitem><para> + Specifies another + <acronym>EGL</acronym> + rendering context with which to share data, as + defined by the client API corresponding to the + contexts. Data is also shared with all other + contexts with which + <parameter>share_context</parameter> shares data. + <constant>EGL_NO_CONTEXT</constant> indicates that + no sharing is to take place. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrib_list</parameter></term> + <listitem><para> + Specifies attributes and attribute values for the + context being created. Only the attribute + <constant>EGL_CONTEXT_CLIENT_VERSION</constant> may + be specified. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglCreateContext</function> creates an EGL + rendering context for the current rendering API (as set with + <function>eglBindAPI</function>) and returns a handle to the + context. The context can then be used to render into an EGL + drawing surface. If <function>eglCreateContext</function> + fails to create a rendering context, + <constant>EGL_NO_CONTEXT</constant> is returned. + </para> + <para> + If <parameter>share_context</parameter> is not + <constant>EGL_NO_CONTEXT</constant>, then all shareable data + in the context (as defined by the client API specification + for the current rendering API) are shared by context + <parameter>share_context</parameter>, all other contexts + <parameter>share_context</parameter> already shares with, + and the newly created context. An arbitrary number of + rendering contexts can share data. However, all rendering + contexts that share data must themselves exist in the same + address space. Two rendering contexts share an address space + if both are owned by a single process. + </para> + <para> + <parameter>attrib_list</parameter> specifies a list of + attributes for the context. The list has the same structure + as described for <function>eglChooseConfig</function>. The + attributes and attribute values which may be specified are + as follows: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_CONTEXT_CLIENT_VERSION</constant></term> + <listitem><para> + Must be followed by an integer that determines which + version of an OpenGL ES context to create. A value + of 1 specifies creation of an OpenGL ES 1.x context. + An attribute value of 2 specifies creation of an + OpenGL ES 2.x context. The default value is 1. This + attribute can only be specified when creating a + OpenGL ES context (e.g. when the current rendering + API is <constant>EGL_OPENGL_ES_API</constant>). + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + The current rendering API is only respected if the EGL + version is 1.2 or greater. Otherwise, an OpenGL ES context + will always be created. + </para> + <para> + The <constant>EGL_CONTEXT_CLIENT_VERSION</constant> + attribute is only supported if the EGL version is 1.3 or + greater. + </para> + <para> + A <firstterm>process</firstterm> is a single execution environment, + implemented in a single address space, consisting of one or more threads. + </para> + <para> + A <firstterm>thread</firstterm> is one of a set of subprocesses that + share a single address space, but maintain separate program counters, + stack spaces, and other related global data. + A thread is the only member of its subprocess group is equivalent to a + process. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_NO_CONTEXT</constant> is returned if creation of + the context fails. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if the + current rendering API is <constant>EGL_NONE</constant> (this + can only arise in an EGL implementation which does not + support OpenGL ES, prior to the first call to + <function>eglBindAPI</function>). + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if the + server context state for + <parameter>share_context</parameter> exists in an address + space which cannot be shared with the newly created context, + if <parameter>share_context</parameter> was created on a + different display than the one referenced by + <parameter>config</parameter>, or if the contexts are + otherwise incompatible. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_CONFIG</constant> is generated if + <parameter>config</parameter> is not an EGL frame buffer + configuration, or does not support the current rendering + API. This includes requesting creation of an OpenGL ES 1.x + context when the <constant>EGL_RENDERABLE_TYPE</constant> + attribute of <parameter>config</parameter> does not contain + <constant>EGL_OPENGL_ES_BIT</constant>, or creation of an + OpenGL ES 2.x context when the attribute does not contain + <constant>EGL_OPENGL_ES2_BIT</constant>. + </para> + <para> + <constant>EGL_BAD_CONTEXT</constant> is generated if + <parameter>share_context</parameter> is not an EGL rendering + context of the same client API type as the newly created + context and is not <constant>EGL_NO_CONTEXT</constant>. + </para> + <para> + <constant>EGL_BAD_ATTRIBUTE</constant> is generated if + <parameter>attrib_list</parameter> contains an invalid + context attribute or if an attribute is not recognized or + out of range. Note that attribute + <constant>EGL_CONTEXT_CLIENT_VERSION</constant> is + only valid when the current rendering API is + <constant>EGL_OPENGL_ES_API</constant>. + </para> + <para> + <constant>EGL_BAD_ALLOC</constant> is generated if there are not + enough resources to allocate the new context. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglDestroyContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreatePbufferFromClientBuffer.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreatePbufferFromClientBuffer.xml new file mode 100644 index 0000000..bb311f3 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreatePbufferFromClientBuffer.xml @@ -0,0 +1,389 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglCreatePbufferFromClientBuffer"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglCreatePbufferFromClientBuffer</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglCreatePbufferFromClientBuffer</refname> + <refpurpose> + create a new <acronym>EGL</acronym> pixel buffer surface + bound to an OpenVG image + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLSurface <function>eglCreatePbufferFromClientBuffer</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLenum <parameter>buftype</parameter></paramdef> + <paramdef>EGLClientBuffer <parameter>buffer</parameter></paramdef> + <paramdef>EGLConfig <parameter>config</parameter></paramdef> + <paramdef>EGLint const * <parameter>attrib_list</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the EGL display connection.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>buftype</parameter></term> + <listitem> + <para> + Specifies the type of client API buffer to be bound. + Must be <constant>EGL_OPENVG_IMAGE</constant>, + corresponding to an OpenVG <type>VGImage</type> + buffer. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>buffer</parameter></term> + <listitem> + <para> + Specifies the OpenVG <type>VGImage</type> handle of + the buffer to be bound. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>config</parameter></term> + <listitem><para> + Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrib_list</parameter></term> + <listitem><para> + Specifies pixel buffer surface attributes. + May be <constant>NULL</constant> or empty + (first attribute is <constant>EGL_NONE</constant>). + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglCreatePbufferFromClientBuffer</function> creates an + off-screen pixel buffer surface and returns its handle. If + <function>eglCreatePbufferFromClientBuffer</function> fails to create + a pixel buffer surface, <constant>EGL_NO_SURFACE</constant> + is returned. + </para> + <para> + The new pixel buffer surface is similar to a pixel buffer + created with + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>, + but storage for the color buffer is provided by a client API + buffer. Other buffer required by + <parameter>config</parameter>, such as depth, stencil, and + alpha mask, are allocated by EGL. + </para> + <para> + <parameter>buftype</parameter> must be + <constant>EGL_OPENVG_IMAGE</constant>, corresponding to an + OpenVG <type>VGImage</type> buffer. + <parameter>buffer</parameter> must be a valid + <type>VGImage</type> handle in the current OpenVG context, + cast into the type <type>EGLClientBuffer</type>. + </para> + <para> + The height, width,, OpenVG alpha format, and OpenVG + colorspace (surface attributes + <constant>EGL_HEIGHT</constant>, + <constant>EGL_WIDTH</constant>, + <constant>EGL_VG_ALPHA_FORMAT</constant>, and + <constant>EGL_VG_COLORSPACE</constant>, respectively) of the + resulting surface are determined by the size and format of + <parameter>buffer</parameter>. + </para> + <para> + Surface attributes are specified as a list of + attribute-value pairs, terminated with + <constant>EGL_NONE</constant>. Accepted attributes are: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_MIPMAP_TEXTURE</constant></term> + <listitem> + <para> + Specifies whether storage for mipmaps should be + allocated. Space for mipmaps will be set aside if + the attribute value is <constant>EGL_TRUE</constant> + and <constant>EGL_TEXTURE_FORMAT</constant> is not + <constant>EGL_NO_TEXTURE</constant>. The default + value is <constant>EGL_FALSE</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TEXTURE_FORMAT</constant></term> + <listitem> + <para> + Specifies the format of the texture that will be + created when a pbuffer is bound to a texture map. + Possible values are + <constant>EGL_NO_TEXTURE</constant>, + <constant>EGL_TEXTURE_RGB</constant>, and + <constant>EGL_TEXTURE_RGBA</constant>. The default + value is <constant>EGL_NO_TEXTURE</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TEXTURE_TARGET</constant></term> + <listitem> + <para> + Specifies the target for the texture that will be + created when the pbuffer is created with a texture + format of <constant>EGL_TEXTURE_RGB</constant> or + <constant>EGL_TEXTURE_RGBA</constant>. Possible + values are <constant>EGL_NO_TEXTURE</constant>, or + <constant>EGL_TEXTURE_2D</constant>. The default + value is <constant>EGL_NO_TEXTURE</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Any EGL rendering context that was created with respect to + <parameter>config</parameter> can be used to render into the + surface. Use + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + to attach an EGL rendering context to the surface. + </para> + <para> + Use + <citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry> + to retrieve the dimensions of the allocated pixel buffer + surface or the ID of <parameter>config</parameter>. + </para> + <para> + Use <citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry> + to destroy the surface. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + <function>eglCreatePbufferFromClientBuffer</function> is + supported only if the EGL version is 1.2 or greater, and if + the EGL implementation supports the OpenVG client API. + </para> + <para> + Currently + <function>eglCreatePbufferFromClientBuffer</function> only + supports binding OpenVG <type>VGImage</type> buffers to + pixel buffers. While other client API resources could be + supported in the future, mechanisms such as OpenGL ES + framebuffer objects, and the family of EGL and client API + extensions for defining and using <type>EGLImageKHR</type> + images, are a more flexible and general framework to satisfy + most of the same needs. + </para> + <para> + If the value of <parameter>config</parameter> attribute + <constant>EGL_TEXTURE_FORMAT</constant> is not + <constant>EGL_NO_TEXTURE</constant>, then the pbuffer width + and height specify the size of the level zero texture image + </para> + <para> + If <constant>EGL_LARGEST_PBUFFER</constant> is specified and + if the pbuffer will be used as a texture (i.e. the value of + <constant>EGL_TEXTURE_TARGET</constant> is + <constant>EGL_TEXTURE_2D</constant>, and the value of + <constant>EGL_TEXTURE FORMAT</constant> is + <constant>EGL_TEXTURE_RGB</constant> or + <constant>EGL_TEXTURE_RGBA</constant>), then the aspect + ratio will be preserved and the new width and height will be + valid sizes for the texture target (e.g. if the underlying + OpenGL ES implementation does not support non-power-of-two + textures, both the width and height will be a power of 2). + </para> + <para> + The contents of the depth and stencil buffers may not be + preserved when rendering a texture to the pbuffer and + switching which image of the texture is rendered to (e.g., + switching from rendering one mipmap level to rendering + another). + </para> + <para> + Binding client API buffers to EGL pbuffers create the + possibility of race conditions, and of buffers being deleted + through one API while still in use in another API. To avoid + these problems, a number of constraints apply to bound + client API buffers: + <orderedlist> + <listitem> + <para> + Bound buffers may be used exclusively by either EGL, + or the client API that originally created them. For + example, if a <type>VGImage</type> is bound to a + pbuffer, and that pbuffer is bound to any client API + rendering context, then the <type>VGImage</type> may + not be used as the explicit source or destination of + any OpenVG operation. Errors resulting from such use + are described in client API specifications. + Similarly, while a <type>VGImage</type> is in use by + OpenVG, the pbuffer it is bound to may not be made + current to any client API context using + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>. + </para> + </listitem> + <listitem> + <para> + Binding a buffer creates an additional reference to + it, and implementations must respect outstanding + references when destroying objects. For example, if + a <type>VGImage</type> is bound to a pbuffer, + destroying the image with + <function>vgDestroyImage</function> will not free + the underlying buffer, because it is still in use by + EGL. However, following + <function>vgDestroyImage</function> the buffer may + only be referred to via the EGL pbuffer handle, + since the OpenVG handle to that buffer no longer + exists. Similarly, destroying the pbuffer with + <function>eglDestroySurface</function> will not free + the underlying buffer, because it is still in use by + OpenVG . However, following + <function>eglDestroySurface</function> the buffer + may only be referred to via the OpenVG + <type>VGImage</type> handle, since the EGL pbuffer + handle no longer exists. + </para> + </listitem> + </orderedlist> + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_NO_SURFACE</constant> is returned if creation of + the context fails. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_CONFIG</constant> is generated if + <parameter>config</parameter> is not an EGL frame buffer configuration. + </para> + <para> + <constant>EGL_BAD_PARAMETER</constant> is generated if + <parameter>buftype</parameter> is not + <constant>EGL_OPENVG_IMAGE</constant>, or if + <parameter>buffer</parameter> is not a valid handle to a + <type>VGImage</type> object in the currently bound OpenVG + context. + </para> + <para> + <constant>EGL_BAD_ACCESS</constant> is generated if there is + no current OpenVG context, or if + <parameter>buffer</parameter> is already bound to another + pixel buffer or in use by OpenVG as discussed in the Notes + section above. + </para> + <para> + <constant>EGL_BAD_ALLOC</constant> is generated if there are not + enough resources to allocate the new surface. + </para> + <para> + <constant>EGL_BAD_ATTRIBUTE</constant> is generated if + <parameter>attrib_list</parameter> contains an invalid pixel + buffer attribute or if an attribute value is not recognized + or out of range. + </para> + <para> + <constant>EGL_BAD_ATTRIBUTE</constant> is generated if + <parameter>attrib_list</parameter> contains any of the + attributes <constant>EGL_MIPMAP_TEXTURE</constant>, + <constant>EGL_TEXTURE_FORMAT</constant>, or + <constant>EGL_TEXTURE_TARGET</constant>, and + <parameter>config</parameter> does not support OpenGL ES + rendering (e.g. the EGL version is 1.2 or later, and the + <constant>EGL_RENDERABLE_TYPE</constant> attribute of + <parameter>config</parameter> does not include at least one + of <constant>EGL_OPENGL_ES_BIT</constant> or + <constant>EGL_OPENGL_ES2_BIT</constant>). + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + <parameter>config</parameter> does not support rendering to pixel buffers + (the <constant>EGL_SURFACE_TYPE</constant> attribute does not contain + <constant>EGL_PBUFFER_BIT</constant>). + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if the + buffers contained in <parameter>buffer</parameter> do not + match the bit depths for those buffers specified by + <parameter>config</parameter>. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if the + <constant>EGL_TEXTURE_FORMAT</constant> attribute is not + <constant>EGL_NO_TEXTURE</constant>, and + <constant>EGL_WIDTH</constant> and/or + <constant>EGL_HEIGHT</constant> specify an invalid size + (e.g., the texture size is not a power of 2, and the + underlying OpenGL ES implementation does not support + non-power-of-two textures). + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + the <constant>EGL_TEXTURE_FORMAT</constant> attribute is + <constant>EGL_NO_TEXTURE</constant>, and + <constant>EGL_TEXTURE_TARGET</constant> is something other + than <constant>EGL_NO_TEXTURE</constant>; or, + <constant>EGL_TEXTURE_FORMAT</constant> is something other + than <constant>EGL_NO_TEXTURE</constant>, and + <constant>EGL_TEXTURE_TARGET</constant> is + <constant>EGL_NO_TEXTURE</constant>. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if the + implementation has additional constraints on which types of + client API buffers may be bound to pixel buffer surfaces. + For example, it is possible that the OpenVG implementation + might not support a <type>VGImage</type> being bound to a + pixel buffer which will be used as a mipmapped OpenGL ES + texture (e.g. whose <constant>EGL_MIPMAP_TEXTURE</constant> + attribute is <constant>TRUE</constant>). Any such + constraints should be documented by the implementation + release notes. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreatePbufferSurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreatePbufferSurface.xml new file mode 100644 index 0000000..fbe9211 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreatePbufferSurface.xml @@ -0,0 +1,333 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglCreatePbufferSurface"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglCreatePbufferSurface</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglCreatePbufferSurface</refname> + <refpurpose> + create a new <acronym>EGL</acronym> pixel buffer surface + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLSurface <function>eglCreatePbufferSurface</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLConfig <parameter>config</parameter></paramdef> + <paramdef>EGLint const * <parameter>attrib_list</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the EGL display connection.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>config</parameter></term> + <listitem><para> + Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrib_list</parameter></term> + <listitem><para> + Specifies pixel buffer surface attributes. + May be <constant>NULL</constant> or empty + (first attribute is <constant>EGL_NONE</constant>). + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglCreatePbufferSurface</function> creates an + off-screen pixel buffer surface and returns its handle. If + <function>eglCreatePbufferSurface</function> fails to create + a pixel buffer surface, <constant>EGL_NO_SURFACE</constant> + is returned. + </para> + <para> + Surface attributes are specified as a list of + attribute-value pairs, terminated with + <constant>EGL_NONE</constant>. Accepted attributes + are: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_HEIGHT</constant></term> + <listitem> + <para> + Specifies the required height of the pixel buffer + surface. The default value is + <constant>0</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_LARGEST_PBUFFER</constant></term> + <listitem> + <para> + Requests the largest available pixel buffer surface + when the allocation would otherwise fail. Use + <citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry> + to retrieve the dimensions of the allocated pixel + buffer. The default value is + <constant>EGL_FALSE</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MIPMAP_TEXTURE</constant></term> + <listitem> + <para> + Specifies whether storage for mipmaps should be + allocated. Space for mipmaps will be set aside if + the attribute value is <constant>EGL_TRUE</constant> + and <constant>EGL_TEXTURE_FORMAT</constant> is not + <constant>EGL_NO_TEXTURE</constant>. The default + value is <constant>EGL_FALSE</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TEXTURE_FORMAT</constant></term> + <listitem> + <para> + Specifies the format of the texture that will be + created when a pbuffer is bound to a texture map. + Possible values are + <constant>EGL_NO_TEXTURE</constant>, + <constant>EGL_TEXTURE_RGB</constant>, and + <constant>EGL_TEXTURE_RGBA</constant>. The default + value is <constant>EGL_NO_TEXTURE</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TEXTURE_TARGET</constant></term> + <listitem> + <para> + Specifies the target for the texture that will be + created when the pbuffer is created with a texture + format of <constant>EGL_TEXTURE_RGB</constant> or + <constant>EGL_TEXTURE_RGBA</constant>. Possible + values are <constant>EGL_NO_TEXTURE</constant>, or + <constant>EGL_TEXTURE_2D</constant>. The default + value is <constant>EGL_NO_TEXTURE</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_VG_ALPHA_FORMAT</constant></term> + <listitem> + <para> + Specifies how alpha values are interpreted by OpenVG + when rendering to the surface. If its value is + <constant>EGL_VG_ALPHA_FORMAT_NONPRE</constant>, + then alpha values are not premultipled. If its value + is <constant>EGL_VG_ALPHA_FORMAT_PRE</constant>, + then alpha values are premultiplied. The default + value of <constant>EGL_VG_ALPHA_FORMAT</constant> is + <constant>EGL_VG_ALPHA_FORMAT_NONPRE</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_VG_COLORSPACE</constant></term> + <listitem> + <para> + Specifies the color space used by OpenVG when + rendering to the surface. If its value is + <constant>EGL_VG_COLORSPACE_sRGB</constant>, then a + non-linear, perceptually uniform color space is + assumed, with a corresponding + <type>VGImageFormat</type> of form + <constant>VG_s*</constant>. If its value is + <constant>EGL_VG_COLORSPACE_LINEAR</constant>, then + a linear color space is assumed, with a + corresponding <type>VGImageFormat</type> of form + <constant>VG_l*</constant>. The default value of + <constant>EGL_VG_COLORSPACE</constant> is + <constant>EGL_VG_COLORSPACE_sRGB</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_WIDTH</constant></term> + <listitem> + <para> + Specifies the required width of the pixel buffer + surface. The default value is + <constant>0</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Any EGL rendering context that was created with respect to + <parameter>config</parameter> can be used to render into the + surface. Use + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + to attach an EGL rendering context to the surface. + </para> + <para> + Use + <citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry> + to retrieve the dimensions of the allocated pixel buffer + surface or the ID of <parameter>config</parameter>. + </para> + <para> + Use <citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry> + to destroy the surface. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + Attributes + <constant>EGL_RENDERABLE_TYPE</constant>, + <constant>EGL_VG_ALPHA_FORMAT</constant>, and + <constant>EGL_VG_COLORSPACE</constant>, and the + corresponding attribute values, are supported only if the + EGL version is 1.2 or greater. + </para> + <para> + If the value of <parameter>config</parameter> attribute + <constant>EGL_TEXTURE_FORMAT</constant> is not + <constant>EGL_NO_TEXTURE</constant>, then the pbuffer width + and height specify the size of the level zero texture image + </para> + <para> + If <constant>EGL_LARGEST_PBUFFER</constant> is specified and + if the pbuffer will be used as a texture (i.e. the value of + <constant>EGL_TEXTURE_TARGET</constant> is + <constant>EGL_TEXTURE_2D</constant>, and the value of + <constant>EGL_TEXTURE FORMAT</constant> is + <constant>EGL_TEXTURE_RGB</constant> or + <constant>EGL_TEXTURE_RGBA</constant>), then the aspect + ratio will be preserved and the new width and height will be + valid sizes for the texture target (e.g. if the underlying + OpenGL ES implementation does not support non-power-of-two + textures, both the width and height will be a power of 2). + </para> + <para> + The contents of the depth and stencil buffers may not be + preserved when rendering a texture to the pbuffer and + switching which image of the texture is rendered to (e.g., + switching from rendering one mipmap level to rendering + another). + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_NO_SURFACE</constant> is returned if creation of + the context fails. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_CONFIG</constant> is generated if + <parameter>config</parameter> is not an EGL frame buffer configuration. + </para> + <para> + <constant>EGL_BAD_ATTRIBUTE</constant> is generated if + <parameter>attrib_list</parameter> contains an invalid pixel + buffer attribute or if an attribute value is not recognized + or out of range. + </para> + <para> + <constant>EGL_BAD_ATTRIBUTE</constant> is generated if + <parameter>attrib_list</parameter> contains any of the + attributes <constant>EGL_MIPMAP_TEXTURE</constant>, + <constant>EGL_TEXTURE_FORMAT</constant>, or + <constant>EGL_TEXTURE_TARGET</constant>, and + <parameter>config</parameter> does not support OpenGL ES + rendering (e.g. the EGL version is 1.2 or later, and the + <constant>EGL_RENDERABLE_TYPE</constant> attribute of + <parameter>config</parameter> does not include at least one + of <constant>EGL_OPENGL_ES_BIT</constant> or + <constant>EGL_OPENGL_ES2_BIT</constant>). + </para> + <para> + <constant>EGL_BAD_ALLOC</constant> is generated if there are not + enough resources to allocate the new surface. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + <parameter>config</parameter> does not support rendering to pixel buffers + (the <constant>EGL_SURFACE_TYPE</constant> attribute does not contain + <constant>EGL_PBUFFER_BIT</constant>). + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if the + <constant>EGL_TEXTURE_FORMAT</constant> attribute is not + <constant>EGL_NO_TEXTURE</constant>, and + <constant>EGL_WIDTH</constant> and/or + <constant>EGL_HEIGHT</constant> specify an invalid size + (e.g., the texture size is not a power of 2, and the + underlying OpenGL ES implementation does not support + non-power-of-two textures). + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + the <constant>EGL_TEXTURE_FORMAT</constant> attribute is + <constant>EGL_NO_TEXTURE</constant>, and + <constant>EGL_TEXTURE_TARGET</constant> is something other + than <constant>EGL_NO_TEXTURE</constant>; or, + <constant>EGL_TEXTURE_FORMAT</constant> is something other + than <constant>EGL_NO_TEXTURE</constant>, and + <constant>EGL_TEXTURE_TARGET</constant> is + <constant>EGL_NO_TEXTURE</constant>. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + <parameter>config</parameter> does not support the specified + OpenVG alpha format attribute (the value of + <constant>EGL_VG_ALPHA_FORMAT</constant> is + <constant>EGL_VG_ALPHA_FORMAT_PRE</constant> and the + <constant>EGL_VG_ALPHA_FORMAT_PRE_BIT</constant> is not set + in the <constant>EGL_SURFACE_TYPE</constant> attribute of + <parameter>config</parameter>) or colorspace attribute (the + value of <constant>EGL_VG_COLORSPACE</constant> is + <constant>EGL_VG_COLORSPACE_LINEAR</constant> and the + <constant>EGL_VG_COLORSPACE_LINEAR_IT</constant> is not set + in the <constant>EGL_SURFACE_TYPE</constant> attribute of + <parameter>config</parameter>). + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreatePixmapSurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreatePixmapSurface.xml new file mode 100644 index 0000000..15f72ec --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreatePixmapSurface.xml @@ -0,0 +1,227 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglCreatePixmapSurface"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglCreatePixmapSurface</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglCreatePixmapSurface</refname> + <refpurpose> + create a new <acronym>EGL</acronym> pixmap surface + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLSurface <function>eglCreatePixmapSurface</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLConfig <parameter>config</parameter></paramdef> + <paramdef>NativePixmapType <parameter>native_pixmap</parameter></paramdef> + <paramdef>EGLint const * <parameter>attrib_list</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the EGL display connection.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>config</parameter></term> + <listitem><para> + Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>native_pixmap</parameter></term> + <listitem><para>Specifies the native pixmap.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrib_list</parameter></term> + <listitem><para> + Specifies pixmap surface attributes. + May be <constant>NULL</constant> or empty + (first attribute is <constant>EGL_NONE</constant>). + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglCreatePixmapSurface</function> creates an + off-screen <acronym>EGL</acronym> pixmap surface and returns + its handle. If <function>eglCreatePixmapSurface</function> + fails to create a pixmap surface, + <constant>EGL_NO_SURFACE</constant> is returned. + </para> + <para> + Surface attributes are specified as a list of + attribute-value pairs, terminated with + <constant>EGL_NONE</constant>. Accepted attributes + are: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_VG_ALPHA_FORMAT</constant></term> + <listitem> + <para> + Specifies how alpha values are interpreted by OpenVG + when rendering to the surface. If its value is + <constant>EGL_VG_ALPHA_FORMAT_NONPRE</constant>, + then alpha values are not premultipled. If its value + is <constant>EGL_VG_ALPHA_FORMAT_PRE</constant>, + then alpha values are premultiplied. The default + value of <constant>EGL_VG_ALPHA_FORMAT</constant> is + <constant>EGL_VG_ALPHA_FORMAT_NONPRE</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_VG_COLORSPACE</constant></term> + <listitem> + <para> + Specifies the color space used by OpenVG when + rendering to the surface. If its value is + <constant>EGL_VG_COLORSPACE_sRGB</constant>, then a + non-linear, perceptually uniform color space is + assumed, with a corresponding + <type>VGImageFormat</type> of form + <constant>VG_s*</constant>. If its value is + <constant>EGL_VG_COLORSPACE_LINEAR</constant>, then + a linear color space is assumed, with a + corresponding <type>VGImageFormat</type> of form + <constant>VG_l*</constant>. The default value of + <constant>EGL_VG_COLORSPACE</constant> is + <constant>EGL_VG_COLORSPACE_sRGB</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Any EGL rendering context that was created with respect to + <parameter>config</parameter> can be used to render into the + surface. Use + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + to attach an EGL rendering context to the surface. + </para> + <para> + Use + <citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry> + to retrieve the ID of <parameter>config</parameter>. + </para> + <para> + Use <citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry> + to destroy the surface. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + The <constant>EGL_MATCH_NATIVE_PIXMAP</constant> attribute + of + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry> + can be used to select a frame buffer configuration matching + a specified native pixmap. + </para> + <para> + Attributes + <constant>EGL_VG_ALPHA_FORMAT</constant> and + <constant>EGL_VG_COLORSPACE</constant>, and the + corresponding attribute values, are supported only if the + EGL version is 1.2 or greater. + </para> + <!-- Might want to mention aliasing of EGL_VG_* -> EGL_* that occurred in EGL 1.3 --> + <para> + The <constant>EGL_VG_ALPHA_FORMAT</constant> and + <constant>EGL_VG_COLORSPACE</constant> attributes are used + only by OpenVG. EGL itself, and other client APIs such as + OpenGL and OpenGL ES , do not distinguish multiple + colorspace models. Refer to section 11.2 of the OpenVG 1.0 + specification for more information. The native window + system's use and interpretation of alpha values is outside + the scope of EGL, although the preferred behavior is for the + window system to ignore the value of + <constant>EGL_VG_ALPHA_FORMAT</constant>. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_NO_SURFACE</constant> is returned if creation of + the context fails. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_CONFIG</constant> is generated if + <parameter>config</parameter> is not an EGL config. + </para> + <para> + <constant>EGL_BAD_NATIVE_PIXMAP</constant> may be generated if + <parameter>native_pixmap</parameter> is not a valid native pixmap. + </para> + <para> + <constant>EGL_BAD_ATTRIBUTE</constant> is generated if + <parameter>attrib_list</parameter> contains an invalid pixmap attribute + or if an attribute value is not recognized or out of range. + </para> + <para> + <constant>EGL_BAD_ALLOC</constant> is generated if there are not + enough resources to allocate the new surface. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if the attributes of + <parameter>native_pixmap</parameter> do not correspond to + <parameter>config</parameter> or if + <parameter>config</parameter> does not support rendering to pixmaps + (the <constant>EGL_SURFACE_TYPE</constant> attribute does not contain + <constant>EGL_PIXMAP_BIT</constant>). + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + <parameter>config</parameter> does not support the specified + OpenVG alpha format attribute (the value of + <constant>EGL_VG_ALPHA_FORMAT</constant> is + <constant>EGL_VG_ALPHA_FORMAT_PRE</constant> and the + <constant>EGL_VG_ALPHA_FORMAT_PRE_BIT</constant> is not set + in the <constant>EGL_SURFACE_TYPE</constant> attribute of + <parameter>config</parameter>) or colorspace attribute (the + value of <constant>EGL_VG_COLORSPACE</constant> is + <constant>EGL_VG_COLORSPACE_LINEAR</constant> and the + <constant>EGL_VG_COLORSPACE_LINEAR_IT</constant> is not set + in the <constant>EGL_SURFACE_TYPE</constant> attribute of + <parameter>config</parameter>). + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreateWindowSurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreateWindowSurface.xml new file mode 100644 index 0000000..942cc73 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglCreateWindowSurface.xml @@ -0,0 +1,244 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglCreateWindowSurface"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglCreateWindowSurface</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglCreateWindowSurface</refname> + <refpurpose> + create a new <acronym>EGL</acronym> window surface + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLSurface <function>eglCreateWindowSurface</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLConfig <parameter>config</parameter></paramdef> + <paramdef>NativeWindowType <parameter>native_window</parameter></paramdef> + <paramdef>EGLint const * <parameter>attrib_list</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the EGL display connection.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>config</parameter></term> + <listitem> + <para>Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>native_window</parameter></term> + <listitem><para>Specifies the native window.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrib_list</parameter></term> + <listitem><para> + Specifies window surface attributes. + May be <constant>NULL</constant> or empty + (first attribute is <constant>EGL_NONE</constant>). + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglCreateWindowSurface</function> creates an EGL + window surface and returns its handle. If + <function>eglCreateWindowSurface</function> fails to create + a window surface, <constant>EGL_NO_SURFACE</constant> is + returned. + </para> + <para> + Surface attributes are specified as a list of + attribute-value pairs, terminated with + <constant>EGL_NONE</constant>. Accepted attributes + are: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_RENDER_BUFFER</constant></term> + <listitem> + <para> + Specifies which buffer should be used for client API + rendering to the window. If its value is + <constant>EGL_SINGLE_BUFFER</constant>, then client + APIs should render directly into the visible window. + If its value is + <constant>EGL_BACK_BUFFER</constant>, then client + APIs should render into the back buffer. The default + value of <constant>EGL_RENDER_BUFFER</constant> is + <constant>EGL_BACK_BUFFER</constant>. + </para> + <para> + Client APIs may not be able to respect the requested + rendering buffer. To determine the actual buffer + being rendered to by a context, call + <citerefentry><refentrytitle>eglQueryContext</refentrytitle></citerefentry>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_VG_ALPHA_FORMAT</constant></term> + <listitem> + <para> + Specifies how alpha values are interpreted by OpenVG + when rendering to the surface. If its value is + <constant>EGL_VG_ALPHA_FORMAT_NONPRE</constant>, + then alpha values are not premultipled. If its value + is <constant>EGL_VG_ALPHA_FORMAT_PRE</constant>, + then alpha values are premultiplied. The default + value of <constant>EGL_VG_ALPHA_FORMAT</constant> is + <constant>EGL_VG_ALPHA_FORMAT_NONPRE</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_VG_COLORSPACE</constant></term> + <listitem> + <para> + Specifies the color space used by OpenVG when + rendering to the surface. If its value is + <constant>EGL_VG_COLORSPACE_sRGB</constant>, then a + non-linear, perceptually uniform color space is + assumed, with a corresponding + <type>VGImageFormat</type> of form + <constant>VG_s*</constant>. If its value is + <constant>EGL_VG_COLORSPACE_LINEAR</constant>, then + a linear color space is assumed, with a + corresponding <type>VGImageFormat</type> of form + <constant>VG_l*</constant>. The default value of + <constant>EGL_VG_COLORSPACE</constant> is + <constant>EGL_VG_COLORSPACE_sRGB</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Any EGL rendering context that was created with respect to + <parameter>config</parameter> can be used to render into the + surface. Use + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + to attach an EGL rendering context to the surface. + </para> + <para> + Use + <citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry> + to retrieve the ID of <parameter>config</parameter>. + </para> + <para> + Use + <citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry> + to destroy the surface. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + Attributes <constant>EGL_RENDER_BUFFER</constant>, + <constant>EGL_VG_ALPHA_FORMAT</constant>, and + <constant>EGL_VG_COLORSPACE</constant>, and the + corresponding attribute values, are supported only if the + EGL version is 1.2 or greater. + </para> + <!-- Might want to mention aliasing of EGL_VG_* -> EGL_* that occurred in EGL 1.3 --> + <para> + The <constant>EGL_VG_ALPHA_FORMAT</constant> and + <constant>EGL_VG_COLORSPACE</constant> attributes are used + only by OpenVG. EGL itself, and other client APIs such as + OpenGL and OpenGL ES , do not distinguish multiple + colorspace models. Refer to section 11.2 of the OpenVG 1.0 + specification for more information. The native window + system's use and interpretation of alpha values is outside + the scope of EGL, although the preferred behavior is for the + window system to ignore the value of + <constant>EGL_VG_ALPHA_FORMAT</constant> when compositing + window surfaces. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_NO_SURFACE</constant> is returned if creation of + the context fails. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_CONFIG</constant> is generated if + <parameter>config</parameter> is not an EGL frame buffer configuration. + </para> + <para> + <constant>EGL_BAD_NATIVE_WINDOW</constant> may be generated if + <parameter>native_window</parameter> is not a valid native window. + </para> + <para> + <constant>EGL_BAD_ATTRIBUTE</constant> is generated if + <parameter>attrib_list</parameter> contains an invalid window attribute + or if an attribute value is not recognized or is out of range. + </para> + <para> + <constant>EGL_BAD_ALLOC</constant> is generated if there are not + enough resources to allocate the new surface. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if the attributes of + <parameter>native_window</parameter> do not correspond to + <parameter>config</parameter> or if + <parameter>config</parameter> does not support rendering to windows + (the <constant>EGL_SURFACE_TYPE</constant> attribute does not contain + <constant>EGL_WINDOW_BIT</constant>). + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + <parameter>config</parameter> does not support the specified + OpenVG alpha format attribute (the value of + <constant>EGL_VG_ALPHA_FORMAT</constant> is + <constant>EGL_VG_ALPHA_FORMAT_PRE</constant> and the + <constant>EGL_VG_ALPHA_FORMAT_PRE_BIT</constant> is not set + in the <constant>EGL_SURFACE_TYPE</constant> attribute of + <parameter>config</parameter>) or colorspace attribute (the + value of <constant>EGL_VG_COLORSPACE</constant> is + <constant>EGL_VG_COLORSPACE_LINEAR</constant> and the + <constant>EGL_VG_COLORSPACE_LINEAR_IT</constant> is not set + in the <constant>EGL_SURFACE_TYPE</constant> attribute of + <parameter>config</parameter>). + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglDestroyContext.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglDestroyContext.xml new file mode 100644 index 0000000..0edbf42 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglDestroyContext.xml @@ -0,0 +1,84 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglDestroyContext"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglDestroyContext</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglDestroyContext</refname> + <refpurpose> + destroy an <acronym>EGL</acronym> rendering context + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglDestroyContext</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLContext <parameter>context</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the EGL display connection.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>context</parameter></term> + <listitem><para>Specifies the EGL rendering context to be destroyed. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + If the EGL rendering context <parameter>context</parameter> is not + current to any thread, + <function>eglDestroyContext</function> destroys it immediately. + Otherwise, <parameter>context</parameter> is destroyed when it becomes + not current to any thread. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned if destruction of + the context fails, <constant>EGL_TRUE</constant> otherwise. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_CONTEXT</constant> is generated if + <parameter>context</parameter> is not an EGL rendering context. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglDestroySurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglDestroySurface.xml new file mode 100644 index 0000000..9693990 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglDestroySurface.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglDestroySurface"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglDestroySurface</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglDestroySurface</refname> + <refpurpose> + destroy an <acronym>EGL</acronym> surface + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglDestroySurface</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLSurface <parameter>surface</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the EGL display connection.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>surface</parameter></term> + <listitem><para>Specifies the EGL surface to be destroyed. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + If the EGL surface <parameter>surface</parameter> is not current to any + thread, <function>eglDestroySurface</function> destroys it immediately. + Otherwise, <parameter>surface</parameter> is destroyed when it becomes + not current to any thread. + Furthermore, resources associated with a pbuffer surface are not released until + all color buffers of that pbuffer bound to a texture object have been released. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned if destruction of + the surface fails, <constant>EGL_TRUE</constant> otherwise. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_SURFACE</constant> is generated if + <parameter>surface</parameter> is not an EGL surface. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetConfigAttrib.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetConfigAttrib.xml new file mode 100644 index 0000000..25bccac --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetConfigAttrib.xml @@ -0,0 +1,326 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglGetConfigAttrib"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglGetConfigAttrib</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglGetConfigAttrib</refname> + <refpurpose> + return information about an <acronym>EGL</acronym> frame buffer + configuration + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglGetConfigAttrib</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLConfig <parameter>config</parameter></paramdef> + <paramdef>EGLint <parameter>attribute</parameter></paramdef> + <paramdef>EGLint * <parameter>value</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the EGL display connection.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>config</parameter></term> + <listitem><para>Specifies the EGL frame buffer configuration to be + queried. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>attribute</parameter></term> + <listitem><para>Specifies the EGL rendering context attribute to be + returned.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem><para>Returns the requested value.</para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglGetConfigAttrib</function> returns in + <parameter>value</parameter> the value of + <parameter>attribute</parameter> for + <parameter>config</parameter> + (config attributes are described in more detail in the + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry> + reference page). + <parameter>attribute</parameter> can be one of the following: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_ALPHA_SIZE</constant></term> + <listitem><para>Returns the number of bits of alpha stored in the + color buffer. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_ALPHA_MASK_SIZE</constant></term> + <listitem><para> + Returns the number of bits in the alpha mask buffer. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BIND_TO_TEXTURE_RGB</constant></term> + <listitem><para>Returns <constant>EGL_TRUE</constant> if color buffers can be + bound to an RGB texture, + <constant>EGL_FALSE</constant> otherwise. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BIND_TO_TEXTURE_RGBA</constant></term> + <listitem><para>Returns <constant>EGL_TRUE</constant> if color buffers can be + bound to an RGBA texture, + <constant>EGL_FALSE</constant> otherwise. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BLUE_SIZE</constant></term> + <listitem><para>Returns the number of bits of blue stored in the + color buffer. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BUFFER_SIZE</constant></term> + <listitem><para>Returns the depth of the color buffer. + It is the sum of + <constant>EGL_RED_SIZE</constant>, + <constant>EGL_GREEN_SIZE</constant>, + <constant>EGL_BLUE_SIZE</constant>, and + <constant>EGL_ALPHA_SIZE</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_COLOR_BUFFER_TYPE</constant></term> + <listitem><para> + Returns the color buffer type. Possible types are + <constant>EGL_RGB_BUFFER</constant> and + <constant>EGL_LUMINANCE_BUFFER</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONFIG_CAVEAT</constant></term> + <listitem><para>Returns the caveats for the frame buffer configuration. + Possible caveat values are + <constant>EGL_NONE</constant>, + <constant>EGL_SLOW_CONFIG</constant>, and + <constant>EGL_NON_CONFORMANT</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONFIG_ID</constant></term> + <listitem><para>Returns the ID of the frame buffer configuration. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONFORMANT</constant></term> + <listitem><para> + Returns a bitmask indicating which client API contexts + created with respect to this config are conformant. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_DEPTH_SIZE</constant></term> + <listitem><para>Returns the number of bits in the depth buffer. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_GREEN_SIZE</constant></term> + <listitem><para>Returns the number of bits of green stored in the + color buffer. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_LEVEL</constant></term> + <listitem><para>Returns the frame buffer level. + Level zero is the default frame buffer. + Positive levels correspond to frame buffers that overlay the default + buffer and negative levels correspond to frame buffers that underlay + the default buffer. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_LUMINANCE_SIZE</constant></term> + <listitem> + <para> + Returns the number of bits of luminance stored in the luminance buffer. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MAX_PBUFFER_WIDTH</constant></term> + <listitem><para>Returns the maximum width of a pixel buffer surface in pixels. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MAX_PBUFFER_HEIGHT</constant></term> + <listitem><para>Returns the maximum height of a pixel buffer surface in pixels. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MAX_PBUFFER_PIXELS</constant></term> + <listitem><para>Returns the maximum size of a pixel buffer surface in pixels. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MAX_SWAP_INTERVAL</constant></term> + <listitem><para>Returns the maximum value that can be passed to eglSwapInterval. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MIN_SWAP_INTERVAL</constant></term> + <listitem><para>Returns the minimum value that can be passed to eglSwapInterval. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_NATIVE_RENDERABLE</constant></term> + <listitem><para>Returns <constant>EGL_TRUE</constant> if native rendering + APIs can render into the surface, + <constant>EGL_FALSE</constant> otherwise. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_NATIVE_VISUAL_ID</constant></term> + <listitem><para>Returns the ID of the associated native visual. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_NATIVE_VISUAL_TYPE</constant></term> + <listitem><para>Returns the type of the associated native visual. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_RED_SIZE</constant></term> + <listitem><para>Returns the number of bits of red stored in the + color buffer. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_RENDERABLE_TYPE</constant></term> + <listitem> + <para> + Returns a bitmask indicating the types of supported + client API contexts. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SAMPLE_BUFFERS</constant></term> + <listitem><para>Returns the number of multisample buffers. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SAMPLES</constant></term> + <listitem><para>Returns the number of samples per pixel.</para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_STENCIL_SIZE</constant></term> + <listitem><para>Returns the number of bits in the stencil buffer. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SURFACE_TYPE</constant></term> + <listitem><para> + Returns a bitmask indicating the types of supported EGL + surfaces. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TRANSPARENT_TYPE</constant></term> + <listitem><para>Returns the type of supported transparency. + Possible transparency values are: + <constant>EGL_NONE</constant>, and + <constant>EGL_TRANSPARENT_RGB</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TRANSPARENT_RED_VALUE</constant></term> + <listitem><para>Returns the transparent red value.</para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TRANSPARENT_GREEN_VALUE</constant></term> + <listitem><para>Returns the transparent green value.</para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TRANSPARENT_BLUE_VALUE</constant></term> + <listitem><para>Returns the transparent blue value.</para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + <constant>EGL_CONFORMANT</constant> is supported only if the + EGL version is 1.3 or greater. + </para> + <para> + <constant>EGL_ALPHA_MASK_SIZE</constant>, + <constant>EGL_COLOR_BUFFER_TYPE</constant>, + <constant>EGL_LUMINANCE_SIZE</constant>, and + <constant>EGL_RENDERABLE_TYPE</constant> are supported only + if the EGL version is 1.2 or greater. + </para> + <para> + While <constant>EGL_MATCH_NATIVE_PIXMAP</constant> can be + specified in the attribute list passed to + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>, + it is not an attribute of the resulting config and cannot be + queried using <function>eglGetConfigAttrib</function>. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned on failure, + <constant>EGL_TRUE</constant> otherwise. + <parameter>value</parameter> is not modified when + <constant>EGL_FALSE</constant> is returned. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_CONFIG</constant> is generated if + <parameter>config</parameter> is not an EGL frame buffer configuration. + </para> + <para> + <constant>EGL_BAD_ATTRIBUTE</constant> is generated if + <parameter>attribute</parameter> is not a valid frame buffer + configuration attribute. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetConfigs.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetConfigs.xml new file mode 100644 index 0000000..4333862 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetConfigs.xml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglGetConfigs"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglGetConfigs</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglGetConfigs</refname> + <refpurpose> + return a list of all <acronym>EGL</acronym> frame buffer configurations + for a display + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglGetConfigs</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLConfig * <parameter>configs</parameter></paramdef> + <paramdef>EGLint <parameter>config_size</parameter></paramdef> + <paramdef>EGLint * <parameter>num_config</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the EGL display connection.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>configs</parameter></term> + <listitem><para>Returns a list of configs.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>config_size</parameter></term> + <listitem><para>Specifies the size of the list of configs. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>num_config</parameter></term> + <listitem><para>Returns the number of configs returned. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglGetConfigs</function> returns a list of all + EGL frame buffer configurations that are available for the specified + display. + The items in the list can be used in any EGL function that requires + an EGL frame buffer configuration. + </para> + <para> + <parameter>configs</parameter> does not return values, if it is specified + as + <constant>NULL</constant>. This is useful for querying just the + number of all frame buffer configurations. + </para> + <para> + Use + <citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry> + to retrieve individual attribute values of a frame buffer configuration. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned on failure, + <constant>EGL_TRUE</constant> otherwise. + <parameter>configs</parameter> and <parameter>num_config</parameter> + are not modified when + <constant>EGL_FALSE</constant> is returned. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_PARAMETER</constant> is generated if + <parameter>num_config</parameter> is <constant>NULL</constant>. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetCurrentContext.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetCurrentContext.xml new file mode 100644 index 0000000..6b6bc21 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetCurrentContext.xml @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglGetCurrentContext"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglGetCurrentContext</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglGetCurrentContext</refname> + <refpurpose> + return the current <acronym>EGL</acronym> rendering context + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLContext <function>eglGetCurrentContext</function></funcdef> + <void/> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglGetCurrentContext</function> returns the current + <acronym>EGL</acronym> rendering context, as specified by + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>. + If no context is current, <constant>EGL_NO_CONTEXT</constant> is returned. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetCurrentDisplay.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetCurrentDisplay.xml new file mode 100644 index 0000000..64bfa75 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetCurrentDisplay.xml @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglGetCurrentDisplay"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglGetCurrentDisplay</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglGetCurrentDisplay</refname> + <refpurpose> + return the display for the current <acronym>EGL</acronym> rendering context + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLDisplay <function>eglGetCurrentDisplay</function></funcdef> + <void/> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglGetCurrentDisplay</function> returns the current + <acronym>EGL</acronym> display connection for the current + <acronym>EGL</acronym> rendering context, as specified by + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>. + If no context is current, <constant>EGL_NO_DISPLAY</constant> is returned. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetCurrentSurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetCurrentSurface.xml new file mode 100644 index 0000000..075da4e --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetCurrentSurface.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglGetCurrentSurface"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglGetCurrentSurface</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglGetCurrentSurface</refname> + <refpurpose> + return the read or draw surface for the current <acronym>EGL</acronym> rendering context + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLSurface <function>eglGetCurrentSurface</function></funcdef> + <paramdef>EGLint <parameter>readdraw</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>readdraw</parameter></term> + <listitem> + <para> + Specifies whether the <acronym>EGL</acronym> read or draw surface + is to be returned. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglGetCurrentSurface</function> returns the read or draw + surface attached to the current + <acronym>EGL</acronym> rendering context, as specified by + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>. + If no context is current, <constant>EGL_NO_SURFACE</constant> is returned. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetDisplay.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetDisplay.xml new file mode 100644 index 0000000..01efe4f --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetDisplay.xml @@ -0,0 +1,75 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglGetDisplay"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglGetDisplay</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglGetDisplay</refname> + <refpurpose> + return an <acronym>EGL</acronym> display connection + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLDisplay <function>eglGetDisplay</function></funcdef> + <paramdef>NativeDisplayType <parameter>native_display</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>native_display</parameter></term> + <listitem> + <para> + Specifies the display to connect to. + <constant>EGL_DEFAULT_DISPLAY</constant> indicates the default display. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglGetDisplay</function> obtains the + <acronym>EGL</acronym> display connection for the native + display <parameter>native_display</parameter>. + </para> + <para> + If <parameter>display_id</parameter> is + <constant>EGL_DEFAULT_DISPLAY</constant>, a default display connection is returned. + </para> + <para> + If no display connection matching <parameter>native_display</parameter> is + available, <constant>EGL_NO_DISPLAY</constant> is returned. No + error is generated. + </para> + <para> + Use <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry> + to initialize the display connection. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetError.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetError.xml new file mode 100644 index 0000000..86658a7 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetError.xml @@ -0,0 +1,145 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglGetError"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglGetError</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglGetError</refname> + <refpurpose> + return error information + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLint <function>eglGetError</function></funcdef> + <void/> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglGetError</function> returns the error of the last + called <acronym>EGL</acronym> function in the current thread. + Initially, the error is set to <constant>EGL_SUCCESS</constant>. + </para> + <para> + The following errors are currently defined: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_SUCCESS</constant></term> + <listitem><para>The last function succeeded without error. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_NOT_INITIALIZED</constant></term> + <listitem><para>EGL is not initialized, or could not be initialized, + for the specified EGL display connection. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BAD_ACCESS</constant></term> + <listitem><para>EGL cannot access a requested resource + (for example a context is bound in another thread). + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BAD_ALLOC</constant></term> + <listitem><para>EGL failed to allocate resources for the requested + operation.</para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BAD_ATTRIBUTE</constant></term> + <listitem><para>An unrecognized attribute or attribute value was + passed in the attribute list. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BAD_CONTEXT</constant></term> + <listitem><para>An <type>EGLContext</type> argument does not name a + valid EGL rendering context. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BAD_CONFIG</constant></term> + <listitem><para> + An <type>EGLConfig</type> argument does not name a valid + EGL frame buffer configuration. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BAD_CURRENT_SURFACE</constant></term> + <listitem><para>The current surface of the calling thread is a window, + pixel buffer or pixmap that is no longer valid. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BAD_DISPLAY</constant></term> + <listitem><para>An <type>EGLDisplay</type> argument does not name a + valid EGL display connection. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BAD_SURFACE</constant></term> + <listitem><para>An <type>EGLSurface</type> argument does not name a + valid surface (window, pixel buffer or pixmap) configured for + GL rendering. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BAD_MATCH</constant></term> + <listitem><para>Arguments are inconsistent (for example, a valid + context requires buffers not supplied by a valid surface). + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BAD_PARAMETER</constant></term> + <listitem><para>One or more argument values are invalid.</para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BAD_NATIVE_PIXMAP</constant></term> + <listitem><para> + A <type>NativePixmapType</type> argument does not refer to + a valid native pixmap. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_BAD_NATIVE_WINDOW</constant></term> + <listitem><para>A <type>NativeWindowType</type> argument does not refer + to a valid native window. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONTEXT_LOST</constant></term> + <listitem><para> + A power management event has occurred. The application must destroy all + contexts and reinitialise OpenGL ES state and objects to continue rendering. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + A call to <function>eglGetError</function> sets the error to + <constant>EGL_SUCCESS</constant>. + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetProcAddress.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetProcAddress.xml new file mode 100644 index 0000000..aac0bbd --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglGetProcAddress.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglGetProcAddress"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglGetProcAddress</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglGetProcAddress</refname> + <refpurpose> + return a <acronym>GL</acronym> or an <acronym>EGL</acronym> + extension function + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>void (* <function>eglGetProcAddress</function>)()</funcdef> + <paramdef>char const * <parameter>procname</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>procname</parameter></term> + <listitem> + <para> + Specifies the name of the function to return. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglGetProcAddress</function> returns the address of + the extension function named by <parameter>procname</parameter>. + <parameter>procname</parameter> + must be a null-terminated string. The pointer returned + should be cast to a function pointer type matching the extension + function's definition in that extension specification. A return value + of <constant>NULL</constant> indicates that the specific + function does not exist for the <acronym>EGL</acronym> implementation. + </para> + <para> + A non-<constant>NULL</constant> return value does not guarantee + that an extension function is actually supported at runtime. The client + must also query + <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry>(<constant>GL_EXTENSIONS</constant>) or + <citerefentry><refentrytitle>eglQueryString</refentrytitle></citerefentry>(<parameter>display</parameter>, + <constant>EGL_EXTENSIONS</constant>) to determine if an + extension is supported by a particular context or display. + </para> + <para> + Function pointers returned by + <function>eglGetProcAddress</function> are independent of the + display and the currently bound context and may be used by any context + which supports the extension. + </para> + <para> + <function>eglGetProcAddress</function> may be queried for all + <acronym>GL</acronym> and <acronym>EGL</acronym> extension functions. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglQueryString</refentrytitle></citerefentry> </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglInitialize.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglInitialize.xml new file mode 100644 index 0000000..854c172 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglInitialize.xml @@ -0,0 +1,109 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglInitialize"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglInitialize</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglInitialize</refname> + <refpurpose> + initialize an <acronym>EGL</acronym> display connection + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglInitialize</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLint * <parameter>major</parameter></paramdef> + <paramdef>EGLint * <parameter>minor</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem> + <para> + Specifies the EGL display connection to initialize. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>major</parameter></term> + <listitem> + <para> + Returns the major version number of the EGL implementation. + May be <constant>NULL</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>minor</parameter></term> + <listitem> + <para> + Returns the minor version number of the EGL implementation. + May be <constant>NULL</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglInitialize</function> initialized the EGL display + connection obtained with + <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>. + Initializing an already initialized EGL display connection has no + effect besides returning the version numbers. + </para> + <para> + <parameter>major</parameter> and <parameter>minor</parameter> + do not return values if they are specified as <constant>NULL</constant>. + </para> + <para> + Use <citerefentry><refentrytitle>eglTerminate</refentrytitle></citerefentry> + to release resources associated with an EGL display connection. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned if + <function>eglInitialize</function> fails, + <constant>EGL_TRUE</constant> otherwise. + <parameter>major</parameter> and <parameter>minor</parameter> are not + modified when <constant>EGL_FALSE</constant> is returned. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> cannot be initialized. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglTerminate</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglIntro.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglIntro.xml new file mode 100644 index 0000000..d972451 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglIntro.xml @@ -0,0 +1,264 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglIntro"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglIntro</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglIntro</refname> + <refpurpose> + introduction to managing client API rendering through the + <acronym>EGL</acronym> API. + </refpurpose> + </refnamediv> + <refsect1 id="overview"><title>Overview</title> + <para> + The <firstterm>Khronos Native Platform Graphics + Interface</firstterm> (EGL) provides a means for rendering + using a <firstterm>client API</firstterm> such as OpenGL ES + (a 3D renderer for embedded systems), OpenGL (a functional + superset of OpenGL ES for desktop systems), and OpenVG (a 2D + vector graphics renderer) together with a native window + system, such as Microsoft Windows or the X Window System. + </para> + <para> + Depending on its implementation EGL might be more or less + tightly integrated into the native window system. Most EGL + functions require an EGL display connection, which can be + obtained by calling + <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry> + and passing in a native display handle or + <constant>EGL_DEFAULT_DISPLAY</constant>. To initialize and + query what EGL version is supported on the display + connection, call + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>. + </para> + <para> + Native window systems supporting EGL make a subset of their + visuals (which may also referred to as pixel formats, frame + buffer configurations, or other similar terms) available for + client API rendering. Windows and pixmaps created with these + visuals may also be rendered into using the native window + system API. + </para> + <para> + An EGL <firstterm>surface</firstterm> extends a native + window or pixmap with additional <firstterm>auxillary + buffers</firstterm>. These buffers include a color buffer, a + depth buffer, a stencil buffer, and an alpha mask buffer. + Some or all of the buffers listed are included in each EGL + frame buffer configuration. + </para> + <para> + EGL supports rendering into three types of surfaces: + windows, pixmaps and pixel buffers (pbuffers). EGL window + and pixmap surfaces are associated with corresponding + resources of the native window system. EGL pixel buffers are + EGL only resources, and do not accept rendering through the + native window system. + </para> + <para> + To render using a client API into an EGL surface, you must + determine the appropriate EGL frame buffer configuration, + which supports the rendering features the application + requires. + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry> + returns an <type>EGLConfig</type> matching the required + attributes, if any. A complete list of EGL frame buffer + configurations can be obtained by calling + <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry>. + Attributes of a particular EGL frame buffer configuration + can be queried by calling + <citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry>. + </para> + <para> + For EGL window and pixmap surfaces, a suitable native window + or pixmap with a matching native visual must be created + first. For a given EGL frame buffer configuration, the + native visual type and ID can be retrieved with a call to + <citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry>. + For pixel buffers, no underlying native resource is + required. + </para> + <para> + To create an EGL window surface from a native window, call + <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>. + To create an EGL pixmap surface from a native pixmap, call + <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>. + To create a pixel buffer (pbuffer) surface (which has no + associated native buffer), call + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry> + To create a pixel buffer (pbuffer) surface whose color + buffer is provided by an OpenVG <type>VGImage</type>, call + <citerefentry><refentrytitle>eglCreatePbufferFromClientBuffer</refentrytitle></citerefentry>. + Use + <citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry> + to release previously allocated resources. + </para> + <para> + An EGL rendering context is required to bind client API + rendering to an EGL surface. An EGL surface and an EGL + rendering context must have compatible EGL frame buffer + configurations. To create an EGL rendering context, call + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>. + The type of client API context created (OpenGL ES, OpenVG, + etc.) can be changed by first calling + <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>. + </para> + <para> + An EGL rendering context may be bound to one or two EGL + surfaces by calling + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>. + This context/surface(s) association specifies the + <firstterm>current context</firstterm> and + <firstterm>current surface</firstterm>, and is used by all + client API rendering commands for the bound context until + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + is called with different arguments. + </para> + <para> + Both native and client API commands may be used to operate + on certain surfaces, however, the two command streams are + not synchronized. Synchronization can be explicitly + specified using by calling + <citerefentry><refentrytitle>eglWaitCLient</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry>, + and possibly by calling other native window system commands. + </para> + </refsect1> + <refsect1 id="examples"><title>Examples</title> + <para> + Below is a minimal example of creating an RGBA-format window that + allows rendering with OpenGL ES. + The window is cleared to yellow when the program runs. For simplicity, + the program does not check for any errors. + </para> +<programlisting> +#include <stdlib.h> +#include <unistd.h> +#include <EGL/egl.h> +#include <GLES/gl.h> +typedef ... NativeWindowType; +extern NativeWindowType createNativeWindow(void); +static EGLint const attribute_list[] = { + EGL_RED_SIZE, 1, + EGL_GREEN_SIZE, 1, + EGL_BLUE_SIZE, 1, + EGL_NONE +}; +int main(int argc, char ** argv) +{ + EGLDisplay display; + EGLConfig config; + EGLContext context; + EGLSurface surface; + NativeWindowType native_window; + EGLint num_config; + + /* get an EGL display connection */ + display = eglGetDisplay(EGL_DEFAULT_DISPLAY); + + /* initialize the EGL display connection */ + eglInitialize(display, NULL, NULL); + + /* get an appropriate EGL frame buffer configuration */ + eglChooseConfig(display, attribute_list, &config, 1, &num_config); + + /* create an EGL rendering context */ + context = eglCreateContext(display, config, EGL_NO_CONTEXT, NULL); + + /* create a native window */ + native_window = createNativeWindow(); + + /* create an EGL window surface */ + surface = eglCreateWindowSurface(display, config, native_window, NULL); + + /* connect the context to the surface */ + eglMakeCurrent(display, surface, surface, context); + + /* clear the color buffer */ + glClearColor(1.0, 1.0, 0.0, 1.0); + glClear(GL_COLOR_BUFFER_BIT); + glFlush(); + + eglSwapBuffers(display, surface); + + sleep(10); + return EXIT_SUCCESS; +} +</programlisting> + </refsect1> + <refsect1 id="usingeglextensions"><title>Using EGL Extensions</title> + <para> + All supported EGL extensions will have a corresponding definition in + <filename>egl.h</filename> and a token in the extensions string returned + by + <citerefentry><refentrytitle>eglQueryString</refentrytitle></citerefentry>. + </para> + </refsect1> + <refsect1 id="futureeglversions"><title>Future EGL Versions</title> + <para> + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry> + and + <citerefentry><refentrytitle>eglQueryString</refentrytitle></citerefentry> + can be used to determine at run-time what version of EGL is available. + To check the EGL version at compile-time, test whether + <constant>EGL_VERSION_<replaceable>x</replaceable>_<replaceable>y</replaceable></constant> + is defined, where <replaceable>x</replaceable> and + <replaceable>y</replaceable> are the major and minor version + numbers. + </para> + </refsect1> + <refsect1 id="files"><title>Files</title> + <variablelist> + <varlistentry> + <term><filename>GLES/egl.h</filename></term> + <listitem><para> + EGL header file + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> +<!-- + <citerefentry><refentrytitle>glIntro</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>, +--> + <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePbufferFromClientBuffer</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglDestroyContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglQueryString</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglTerminate</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitGL</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglMakeCurrent.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglMakeCurrent.xml new file mode 100644 index 0000000..b237907 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglMakeCurrent.xml @@ -0,0 +1,203 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglMakeCurrent"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglMakeCurrent</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglMakeCurrent</refname> + <refpurpose> + attach an EGL rendering context to EGL surfaces + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglMakeCurrent</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLSurface <parameter>draw</parameter></paramdef> + <paramdef>EGLSurface <parameter>read</parameter></paramdef> + <paramdef>EGLContext <parameter>context</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem> + <para>Specifies the <acronym>EGL</acronym> display connection.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>draw</parameter></term> + <listitem> + <para>Specifies the <acronym>EGL</acronym> draw surface.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>read</parameter></term> + <listitem> + <para>Specifies the <acronym>EGL</acronym> read surface.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>context</parameter></term> + <listitem> + <para>Specifies the <acronym>EGL</acronym> rendering context + to be attached to the surfaces. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglMakeCurrent</function> binds <parameter>context</parameter> + to the current rendering thread and to the <parameter>draw</parameter> + and <parameter>read</parameter> surfaces. <parameter>draw</parameter> + is used for all GL operations except for any pixel data read back + (<citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>, and + <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>), + which is taken from the frame buffer values of + <parameter>read</parameter>. + </para> + <para> + If the calling thread has already a current rendering context, that + context is flushed and marked as no longer current. + </para> + <para> + The first time that <parameter>context</parameter> is made current, + the viewport and scissor dimensions are set to the size of the + <parameter>draw</parameter> surface. The viewport and + scissor are not modified when <parameter>context</parameter> is + subsequently made current. + </para> + <para> + To release the current context without assigning a new one, call + <function>eglMakeCurrent</function> with <parameter>draw</parameter> + and <parameter>read</parameter> set to + <constant>EGL_NO_SURFACE</constant> and <parameter>context</parameter> + set to <constant>EGL_NO_CONTEXT</constant>. + </para> + <para> + Use + <citerefentry><refentrytitle>eglGetCurrentContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentDisplay</refentrytitle></citerefentry>, and + <citerefentry><refentrytitle>eglGetCurrentSurface</refentrytitle></citerefentry> + to query the current rendering context and associated display connection and surfaces. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned on failure, + <constant>EGL_TRUE</constant> otherwise. If <constant>EGL_FALSE</constant> + is returned, the previously current rendering context and + surfaces (if any) remain unchanged. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_SURFACE</constant> is generated if + <parameter>draw</parameter> or <parameter>read</parameter> is not an + EGL surface. + </para> + <para> + <constant>EGL_BAD_CONTEXT</constant> is generated if + <parameter>context</parameter> is not an EGL rendering context. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + <parameter>draw</parameter> or + <parameter>read</parameter> + are not compatible with + <parameter>context</parameter>, or if + <parameter>context</parameter> is set to + <constant>EGL_NO_CONTEXT</constant> and + <parameter>draw</parameter> or + <parameter>read</parameter> + are not set to + <constant>EGL_NO_SURFACE</constant>, or if + <parameter>draw</parameter> or + <parameter>read</parameter> are set to + <constant>EGL_NO_SURFACE</constant> and + <parameter>context</parameter> is not set to + <constant>EGL_NO_CONTEXT</constant>. + </para> + <para> + <constant>EGL_BAD_ACCESS</constant> is generated if + <parameter>context</parameter> + is current to some other thread. + </para> + <para> + <constant>EGL_BAD_NATIVE_PIXMAP</constant> may be generated if + a native pixmap underlying either + <parameter>draw</parameter> or + <parameter>read</parameter> + is no longer valid. + </para> + <para> + <constant>EGL_BAD_NATIVE_WINDOW</constant> may be generated if + a native window underlying either + <parameter>draw</parameter> or + <parameter>read</parameter> + is no longer valid. + </para> + <para> + <constant>EGL_BAD_CURRENT_SURFACE</constant> is generated if + the previous context has unflushed commands and the previous surface + is no longer valid. + </para> + <para> + <constant>EGL_BAD_ALLOC</constant> may be generated if + allocation of ancillary buffers for <parameter>draw</parameter> or + <parameter>read</parameter> were delayed until + <function>eglMakeCurrent</function> is called, and there are not + enough resources to allocate them. + </para> + <para> + <constant>EGL_CONTEXT_LOST</constant> is generated if a power management + event has occurred. The application must destroy all contexts and + reinitialise OpenGL ES state and objects to continue rendering. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentDisplay</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglQueryAPI.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglQueryAPI.xml new file mode 100644 index 0000000..359f64c --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglQueryAPI.xml @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglQueryAPI"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglQueryAPI</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglQueryAPI</refname> + <refpurpose>Query the current rendering API</refpurpose> + </refnamediv> + <refsynopsisdiv><title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLenum <function>eglQueryAPI</function></funcdef> + <void/> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglQueryAPI</function> returns the value of the + current rendering API for EGL in the thread it is called + from. The current rendering API is set by + <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>, + and affects the behavior of other EGL commands. + </para> + <para> + The value returned will be one of the valid + <parameter>api</parameter> parameters to + <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>, or + <constant>EGL_NONE</constant>. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + <function>eglQueryAPI</function> is supported only if the + EGL version is 1.2 or greater. + </para> + <para> + The initial value of the current rendering API is + <constant>EGL_OPENGL_ES_API</constant> unless OpenGL ES is + not supported by an implementation, in which case the + initial value is <constant>EGL_NONE</constant> (however, + <constant>EGL_NONE</constant> is not a valid + <parameter>api</parameter> parameter to + <function>eglQueryAPI</function>). + </para> + <para> + The current rendering API can be changed by calling + <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + None. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentDisplay</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitClient</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglQueryContext.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglQueryContext.xml new file mode 100644 index 0000000..7137ad2 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglQueryContext.xml @@ -0,0 +1,193 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglQueryContext"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglQueryContext</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglQueryContext</refname> + <refpurpose> + return <acronym>EGL</acronym> rendering context information + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglQueryContext</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLContext <parameter>context</parameter></paramdef> + <paramdef>EGLint <parameter>attribute</parameter></paramdef> + <paramdef>EGLint * <parameter>value</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem> + <para> + Specifies the EGL display connection. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>context</parameter></term> + <listitem> + <para> + Specifies the EGL rendering context to query. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attribute</parameter></term> + <listitem> + <para> + Specifies the EGL rendering context attribute to be returned. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + Returns the requested value. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglQueryContext</function> returns in + <parameter>value</parameter> the value of + <parameter>attribute</parameter> for <parameter>context</parameter>. + <parameter>attribute</parameter> can be one of the following: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_CONFIG_ID</constant></term> + <listitem><para> + Returns the ID of the EGL frame buffer configuration + with respect to which the context was created. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONTEXT_CLIENT_TYPE</constant></term> + <listitem><para> + Returns the type of client API which the context + supports (one of + <constant>EGL_OPENGL_API</constant>, + <constant>EGL_OPENGL_ES_API</constant>, or + <constant>EGL_OPENVG_API</constant>). + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONTEXT_CLIENT_VERSION</constant></term> + <listitem><para> + Returns the version of the client API which the + context supports, as specified at context creation + time. The resulting value is only meaningful for an + OpenGL ES context. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_RENDER_BUFFER</constant></term> + <listitem> + <para> + Returns the buffer which client API rendering + via the context will use. The value returned + depends on properties of both the context, and + the surface to which the context is bound: + </para> + <itemizedlist> + <listitem><para> + If the context is bound to a pixmap surface, + then <constant>EGL_SINGLE_BUFFER</constant> will + be returned. + </para></listitem> + <listitem><para> + If the context is bound to a pbuffer surface, + then <constant>EGL_BACK_BUFFER</constant> will + be returned. + </para></listitem> + <listitem><para> + If the context is bound to a window surface, + then either <constant>EGL_BACK_BUFFER</constant> + or <constant>EGL_SINGLE_BUFFER</constant> may be + returned. The value returned depends on both the + buffer requested by the setting of the + <constant>EGL_RENDER_BUFFER</constant> property + of the surface (which may be queried by calling + <function>eglQuerySurface</function>), and on + the client API (not all client APIs support + single-buffer rendering to window surfaces). + </para></listitem> + <listitem><para> + If the context is not bound to a surface, such + as an OpenGL ES context bound to a framebuffer + object, then <constant>EGL_NONE</constant> will + be returned. + </para></listitem> + </itemizedlist> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + Attributes <constant>EGL_CONTEXT_CLIENT_TYPE</constant> and + <constant>EGL_RENDER_BUFFER</constant> are supported only if + the EGL version is 1.2 or greater. + </para> + <para> + Attribute <constant>EGL_CONTEXT_CLIENT_VERSION</constant> is + supported only if the EGL version is 1.3 or greater. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned on failure, + <constant>EGL_TRUE</constant> otherwise. + <parameter>value</parameter> is not modified when + <constant>EGL_FALSE</constant> is returned. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_CONTEXT</constant> is generated if + <parameter>context</parameter> is not an EGL rendering context. + </para> + <para> + <constant>EGL_BAD_ATTRIBUTE</constant> is generated if + <parameter>attribute</parameter> is not a valid context attribute. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglQueryString.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglQueryString.xml new file mode 100644 index 0000000..0799e18 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglQueryString.xml @@ -0,0 +1,142 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglQueryString"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglQueryString</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglQueryString</refname> + <refpurpose> + return a string describing an <acronym>EGL</acronym> display connection + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>char const * <function>eglQueryString</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLint <parameter>name</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem> + <para> + Specifies the EGL display connection. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + Specifies a symbolic constant, one of + <constant>EGL_CLIENT_APIS</constant>, + <constant>EGL_VENDOR</constant>, + <constant>EGL_VERSION</constant>, or + <constant>EGL_EXTENSIONS</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglQueryString</function> returns a pointer to a + static string describing an EGL display connection. + <parameter>name</parameter> can be one of the following: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_CLIENT_APIS</constant></term> + <listitem><para> + Returns a string describing which client rendering + APIs are supported. The string contains a + space-separate list of API names. The list must + include at least one of <code>OpenGL</code>, + <code>OpenGL_ES</code>, or <code>OpenVG</code>. + These strings correspond respectively to values + <constant>EGL_OPENGL_API</constant>, + <constant>EGL_OPENGL_ES_API</constant>, and + <constant>EGL_OPENVG_API</constant> of the + <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>, + <parameter>api</parameter> argument. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_VENDOR</constant></term> + <listitem><para> + Returns the company responsible for this EGL implementation. This + name does not change from release to release. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_VERSION</constant></term> + <listitem><para> + Returns a version or release number. + The <constant>EGL_VERSION</constant> string is laid out as + follows:</para> + <para> + <replaceable>major_version</replaceable>.<replaceable>minor_version</replaceable> + space + <replaceable>vendor_specific_info</replaceable> + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_EXTENSIONS</constant></term> + <listitem><para> + Returns a space separated list of supported extensions to EGL. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + <constant>EGL_CLIENT_APIS</constant> is supported only if + the EGL version is 1.2 or greater. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>NULL</constant> is returned on failure. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_PARAMETER</constant> is generated if + <parameter>name</parameter> is not an accepted value. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglQuerySurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglQuerySurface.xml new file mode 100644 index 0000000..1053cd2 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglQuerySurface.xml @@ -0,0 +1,288 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglQuerySurface"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglQuerySurface</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglQuerySurface</refname> + <refpurpose> + return <acronym>EGL</acronym> surface information + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglQuerySurface</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLSurface <parameter>surface</parameter></paramdef> + <paramdef>EGLint <parameter>attribute</parameter></paramdef> + <paramdef>EGLint * <parameter>value</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem> + <para> + Specifies the EGL display connection. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>surface</parameter></term> + <listitem> + <para> + Specifies the EGL surface to query. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attribute</parameter></term> + <listitem> + <para> + Specifies the EGL surface attribute to be returned. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + Returns the requested value. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglQuerySurface</function> returns in + <parameter>value</parameter> the value of + <parameter>attribute</parameter> for <parameter>surface</parameter>. + <parameter>attribute</parameter> can be one of the following: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_CONFIG_ID</constant></term> + <listitem><para> + Returns the ID of the EGL frame buffer configuration + with respect to which the surface was created. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_HEIGHT</constant></term> + <listitem><para> + Returns the height of the surface in pixels. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_HORIZONTAL_RESOLUTION</constant></term> + <listitem><para> + Returns the horizontal dot pitch of the display on + which a window surface is visible. The value + returned is equal to the actual dot pitch, in + pixels/meter, multiplied by the constant value + <constant>EGL_DISPLAY_SCALING</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_LARGEST_PBUFFER</constant></term> + <listitem><para> + Returns the same attribute value specified when the + surface was created with + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>. + For a window or pixmap surface, + <parameter>value</parameter> is not modified. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MIPMAP_LEVEL</constant></term> + <listitem><para> + Returns which level of the mipmap to render to, if + texture has mipmaps. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MIPMAP_TEXTURE</constant></term> + <listitem><para> + Returns <constant>EGL_TRUE</constant> if texture has + mipmaps, <constant>EGL_FALSE</constant> otherwise. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MULTISAMPLE_RESOLVE</constant></term> + <listitem> + <para> + Returns the filter used when resolving the + multisample buffer. The filter may be either + <constant>EGL_MULTISAMPLE_RESOLVE_DEFAULT</constant> + or <constant>EGL_MULTISAMPLE_RESOLVE_BOX</constant>, + as described for + <citerefentry><refentrytitle>eglSurfaceAttrib</refentrytitle></citerefentry>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_PIXEL_ASPECT_RATIO</constant></term> + <listitem><para> + Returns the aspect ratio of an individual pixel (the + ratio of a pixel's width to its height). The value + returned is equal to the actual aspect ratio + multiplied by the constant value + <constant>EGL_DISPLAY_SCALING</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_RENDER_BUFFER</constant></term> + <listitem><para> + Returns the buffer which client API rendering is + requested to use. For a window surface, this is the + same attribute value specified when the surface was + created. For a pbuffer surface, it is always + <constant>EGL_BACK_BUFFER</constant>. For a pixmap + surface, it is always + <constant>EGL_SINGLE_BUFFER</constant>. To determine + the actual buffer being rendered to by a context, + call + <citerefentry><refentrytitle>eglQueryContext</refentrytitle></citerefentry>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SWAP_BEHAVIOR</constant></term> + <listitem><para> + Returns the effect on the color buffer when posting + a surface with + <citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry>. + Swap behavior may be either + <constant>EGL_BUFFER_PRESERVED</constant> or + <constant>EGL_BUFFER_DESTROYED</constant>, as + described for + <citerefentry><refentrytitle>eglSurfaceAttrib</refentrytitle></citerefentry>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TEXTURE_FORMAT</constant></term> + <listitem><para> + Returns format of texture. Possible values are + <constant>EGL_NO_TEXTURE</constant>, + <constant>EGL_TEXTURE_RGB</constant>, and + <constant>EGL_TEXTURE_RGBA</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_TEXTURE_TARGET</constant></term> + <listitem><para> + Returns type of texture. Possible values are + <constant>EGL_NO_TEXTURE</constant>, or + <constant>EGL_TEXTURE_2D</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_VERTICAL_RESOLUTION</constant></term> + <listitem><para> + Returns the vertical dot pitch of the display on + which a window surface is visible. The value + returned is equal to the actual dot pitch, in + pixels/meter, multiplied by the constant value + <constant>EGL_DISPLAY_SCALING</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_WIDTH</constant></term> + <listitem><para> + Returns the width of the surface in pixels. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + Attribute <constant>EGL_MULTISAMPLE_RESOLVE</constant> is + supported only if the EGL version is 1.4 or greater. + </para> + <para> + Attributes <constant>EGL_DISPLAY_SCALING</constant>. + <constant>EGL_HORIZONTAL_RESOLUTION</constant>, + <constant>EGL_PIXEL_ASPECT_RATIO</constant>, + <constant>EGL_RENDER_BUFFER</constant>, + <constant>EGL_SWAP_BEHAVIOR</constant>, and + <constant>EGL_VERTICAL_RESOLUTION</constant> are supported + only if the EGL version is 1.2 or greater. + </para> + <para> + Querying attributes <constant>EGL_TEXTURE_FORMAT</constant>, + <constant>EGL_TEXTURE_TARGET</constant>, + <constant>EGL_MIPMAP_TEXTURE</constant>, or + <constant>EGL_MIPMAP_LEVEL</constant> for a non-pbuffer + surface is not an error, but <parameter>value</parameter> is + not modified. + </para> + <para> + <constant>EGL_DISPLAY_SCALING</constant> is the constant + value 10000. Floating-point values such as resolution and + pixel aspect ratio are scaled by this value before being + returned as integers so that sufficient precision to be + meaningful will be retained in the returned value. + </para> + <para> + For an offscreen (pbuffer or pixmap) surface, or a surface + whose pixel dot pitch or aspect ratio are unknown, querying + <constant>EGL_HORIZONTAL_RESOLUTION</constant>, + <constant>EGL_PIXEL_ASPECT_RATIO</constant>, or + <constant>EGL_VERTICAL_RESOLUTION</constant> will return the + constant value <constant>EGL_UNKNOWN</constant> (-1). + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned on failure, + <constant>EGL_TRUE</constant> otherwise. + <parameter>value</parameter> is not modified when + <constant>EGL_FALSE</constant> is returned. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_SURFACE</constant> is generated if + <parameter>surface</parameter> is not an EGL surface. + </para> + <para> + <constant>EGL_BAD_ATTRIBUTE</constant> is generated if + <parameter>attribute</parameter> is not a valid surface attribute. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglSurfaceAttrib</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglReleaseTexImage.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglReleaseTexImage.xml new file mode 100644 index 0000000..408fbf5 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglReleaseTexImage.xml @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglReleaseTexImage"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglReleaseTexImage</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglReleaseTexImage</refname> + <refpurpose> + Releases a color buffer that is being used as a texture + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglReleaseTexImage</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLSurface <parameter>surface</parameter></paramdef> + <paramdef>EGLint <parameter>buffer</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem><para>Specifies the EGL display connection.</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>surface</parameter></term> + <listitem> + <para> + Specifies the EGL surface. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>buffer</parameter></term> + <listitem><para>Specifies the texture image data.</para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + The specified color buffer is released back to the surface. The surface is made + available for reading and writing when it no longer has any color buffers bound as + textures. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + If the specified color buffer is no longer bound to a texture (e.g., because the + texture object was deleted) then eglReleaseTexImage has no effect. No error is + generated. + </para> + <para> + The contents of the color buffer are undefined when it is first released. In particular, + there is no guarantee that the texture image is still present. However, the contents of + other color buffers are unaffected by this call. Also, the contents of the depth and stencil buffers + are not affected by <citerefentry><refentrytitle>eglBindTexImage</refentrytitle></citerefentry> + and <function>eglReleaseTexImage</function>. + </para> + <para> + After a color buffer is released from a texture (either explicitly by calling + <function>eglReleaseTexImage</function> or implicitly by calling a routine such as + <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>), + all texture images that were defined by the color buffer become <constant>NULL</constant> + (it is as if <citerefentry><refentrytitle>glTexImage</refentrytitle></citerefentry> was called with an image of zero width). + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if the + surface attribute <constant>EGL_TEXTURE_FORMAT</constant> is + set to <constant>EGL_NO_TEXTURE</constant>. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + <parameter>buffer</parameter> is not a valid buffer + (currently only <constant>EGL_BACK_BUFFER</constant> may be + specified). + </para> + <para> + <constant>EGL_BAD_SURFACE</constant> is generated if + <parameter>surface</parameter> is not an EGL surface, or is + not a bound pbuffer surface. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglBindTexImage</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglReleaseThread.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglReleaseThread.xml new file mode 100644 index 0000000..c37f903 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglReleaseThread.xml @@ -0,0 +1,134 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglReleaseThread"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglReleaseThread</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglReleaseThread</refname> + <refpurpose>Release EGL per-thread state</refpurpose> + </refnamediv> + <refsynopsisdiv><title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglReleaseThread</function></funcdef> + <void/> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglReleaseThread</function> returns the EGL to its + state at thread initialization, releasing all per-thread + state including the error status returned by + <command>eglGetError</command>, the currently bound + rendering API defined by <command>eglBindAPI</command>, and + the current contexts for each supported client API. The + overhead of maintaining this state may be objectionable in + applications which create and destroy many threads, but only + call EGL or client APIs in a few of those threads at any + given time. + </para> + <para> + <constant>EGL_TRUE</constant> is returned on success, and the + following actions are taken: + </para> + <itemizedlist> + <listitem> + <para> + For each client API supported by EGL, if there is a + currently bound context, that context is released. + This is equivalent to calling + <function>eglMakeCurrent</function> with ctx set to + <constant>EGL_NO_CONTEXT</constant> and both draw + and read set to <constant>EGL_NO_SURFACE</constant> + (see section 3.7.3). + </para> + </listitem> + <listitem> + <para> + The current rendering API is reset to its value at + thread initialization (see + <command>eglBindAPI</command>). + </para> + </listitem> + <listitem> + <para> + Any additional implementation-dependent per-thread + state maintained by EGL is marked for deletion as + soon as possible. + </para> + </listitem> + </itemizedlist> + <para> + <function>eglReleaseThread</function> may be called in any + thread at any time, and may be called more than once in a + single thread. The initialization status of EGL (see section + 3.2) is not affected by releasing the thread; only + per-thread state is affected. + </para> + <para> + Resources explicitly allocated by calls to EGL, such as + contexts, surfaces, and configuration lists, are not + affected by <function>eglReleaseThread</function>. Such + resources belong not to the thread, but to the EGL + implementation as a whole. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + <function>eglReleaseThread</function> is supported only if the + EGL version is 1.2 or greater. + </para> + <para> + Applications may call other EGL routines from a thread + following <function>eglReleaseThread</function>, but any + such call may reallocate the EGL state previously released. + In particular, calling <function>eglGetError</function> + immediately following a successful call to + <function>eglReleaseThread</function> will return + <constant>EGL_SUCCESS</constant>, but will also result in + reallocating per-thread state. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned on failure, + <constant>EGL_TRUE</constant> otherwise. There are no + defined conditions under which failure will occur. Even if + EGL is not initialized on any EGLDisplay, + <function>eglReleaseThread</function> should succeed. + </para> + <para> + However, platform-dependent failures may be signaled through + the value returned from <function>eglGetError</function>. + Unless the platform-dependent behavior is known, a failed + call to <function>eglReleaseThread</function> should be + assumed to leave the current rendering API, and the + currently bound contexts for each supported client API, in + an unknown state. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetError</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglSurfaceAttrib.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglSurfaceAttrib.xml new file mode 100644 index 0000000..0487c6b --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglSurfaceAttrib.xml @@ -0,0 +1,216 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglSurfaceAttrib"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglSurfaceAttrib</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglSurfaceAttrib</refname> + <refpurpose> + set an <acronym>EGL</acronym> surface attribute + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglSurfaceAttrib</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLSurface <parameter>surface</parameter></paramdef> + <paramdef>EGLint <parameter>attribute</parameter></paramdef> + <paramdef>EGLint <parameter>value</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem> + <para> + Specifies the EGL display connection. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>surface</parameter></term> + <listitem> + <para> + Specifies the EGL surface. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attribute</parameter></term> + <listitem> + <para> + Specifies the EGL surface attribute to set. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + Specifies the attributes required value. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglSurfaceAttrib</function> sets the value of + <parameter>attribute</parameter> for + <parameter>surface</parameter> to + <parameter>value</parameter>. + <parameter>attribute</parameter> can be one of the + following: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_MIPMAP_LEVEL</constant></term> + <listitem><para> + For mipmap textures, the + <constant>EGL_MIPMAP_LEVEL</constant> attribute + indicates which level of the mipmap should be + rendered. If the value of this attribute is outside + the range of supported mipmap levels, the closest + valid mipmap level is selected for rendering. The + default value is <constant>0</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_MULTISAMPLE_RESOLVE</constant></term> + <listitem> + <para> + Specifies the filter to use when resolving the + multisample buffer (this may occur when swapping or + copying the surface, or when changing the client API + context bound to the surface). A + <parameter>value</parameter> of + <constant>EGL_MULTISAMPLE_RESOLVE_DEFAULT</constant> + chooses the default implementation-defined filtering + method, while + <constant>EGL_MULTISAMPLE_RESOLVE_BOX</constant> + chooses a one-pixel wide box filter placing equal + weighting on all multisample values. + </para> + <para> + The initial value of + <constant>EGL_MULTISAMPLE_RESOLVE</constant> is + <constant>EGL_MULTISAMPLE_RESOLVE_DEFAULT</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SWAP_BEHAVIOR</constant></term> + <listitem> + <para> + Specifies the effect on the color buffer of posting + a surface with + <citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry>. + A <parameter>value</parameter> of + <constant>EGL_BUFFER_PRESERVED</constant> indicates + that color buffer contents are unaffected, while + <constant>EGL_BUFFER_DESTROYED</constant> indicates + that color buffer contents may be destroyed or + changed by the operation. + </para> + <para> + The initial value of + <constant>EGL_SWAP_BEHAVIOR</constant> is chosen by + the implementation. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + Attribute <constant>EGL_MULTISAMPLE_RESOLVE</constant> is + supported only if the EGL version is 1.4 or greater. + </para> + <para> + Attribute <constant>EGL_SWAP_BEHAVIOR</constant> is + supported only if the EGL version is 1.2 or greater. + </para> + <para> + If the value of pbuffer attribute + <constant>EGL_TEXTURE_FORMAT</constant> is + <constant>EGL_NO_TEXTURE</constant>, the value of attribute + <constant>EGL_TEXTURE_TARGET</constant> is + <constant>EGL_NO_TEXTURE</constant>, or + <parameter>surface</parameter> is not a pbuffer, then + attribute <constant>EGL_MIPMAP_LEVEL</constant> may be set, + but has no effect. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned on failure, + <constant>EGL_TRUE</constant> otherwise. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + <parameter>attribute</parameter> is + <constant>EGL_MULTISAMPLE_RESOLVE</constant>, + <parameter>value</parameter> is + <constant>EGL_MULTISAMPLE_RESOLVE_BOX</constant>, and the + <constant>EGL_SURFACE_TYPE</constant> attribute of the + <type>EGLConfig</type> used to create + <parameter>surface</parameter> does not contain + <constant>EGL_MULTISAMPLE_RESOLVE_BOX_BIT</constant>. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if + <parameter>attribute</parameter> is + <constant>EGL_SWAP_BEHAVIOR</constant>, + <parameter>value</parameter> is + <constant>EGL_BUFFER_PRESERVED</constant>, and the + <constant>EGL_SURFACE_TYPE</constant> attribute of the + <type>EGLConfig</type> used to create + <parameter>surface</parameter> does not contain + <constant>EGL_SWAP_BEHAVIOR_PRESERVED_BIT</constant>. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_SURFACE</constant> is generated if + <parameter>surface</parameter> is not an EGL surface. + </para> + <para> + <constant>EGL_BAD_ATTRIBUTE</constant> is generated if + <parameter>attribute</parameter> is not a valid surface attribute. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglSwapBuffers.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglSwapBuffers.xml new file mode 100644 index 0000000..6e1ad73 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglSwapBuffers.xml @@ -0,0 +1,144 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglSwapBuffers"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglSwapBuffers</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglSwapBuffers</refname> + <refpurpose> + post <acronym>EGL</acronym> surface color buffer to a native window + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglSwapBuffers</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLSurface <parameter>surface</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem> + <para> + Specifies the EGL display connection. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>surface</parameter></term> + <listitem> + <para> + Specifies the EGL drawing surface whose buffers are to be swapped. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + If <parameter>surface</parameter> is a window surface, + <function>eglSwapBuffers</function> posts its color buffer + to the associated native window. + </para> + <para> + The contents of ancillary buffers are always undefined after + calling <function>eglSwapBuffers</function>. The contents of + the color buffer are left unchanged if the value of the + <constant>EGL_SWAP_BEHAVIOR</constant> attribute of + <parameter>surface</parameter> is + <constant>EGL_BUFFER_PRESERVED</constant>, and are undefined + if the value is <constant>EGL_BUFFER_DESTROYED</constant>. + The value of <constant>EGL_SWAP_BEHAVIOR</constant> can be + set for some surfaces using + <citerefentry><refentrytitle>eglSurfaceAttrib</refentrytitle></citerefentry>. + </para> + <para> + <function>eglSwapBuffers</function> performs an implicit + flush operation on the context (<function>glFlush</function> + for an OpenGL ES or OpenGL context, + <function>vgFlush</function> for an OpenVG context) bound to + <parameter>surface</parameter> before swapping. Subsequent + client API commands may be issued on that context + immediately after calling + <function>eglSwapBuffers</function>, but are not executed + until the buffer exchange is completed. + </para> + <para> + If <parameter>surface</parameter> is a pixel buffer or a pixmap, + <function>eglSwapBuffers</function> + has no effect, and no error is generated. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + Attribute <constant>EGL_SWAP_BEHAVIOR</constant> is + supported only if the EGL version is 1.2 or greater. In + earlier versions, behavior is as though the attribute + exists, and always has the value + <constant>EGL_BUFFER_DESTROYED</constant>. + </para> + <para> + The EGL 1.4 specification was updated to acknowledge that + ancillary buffers are not necessarily preserved after a + swap, and that the <constant>EGL_SWAP_BEHAVIOR</constant> + attribute applies only to the color buffer. This change in + the specification acknowledged the behavior of many shipping + implementations, and is not intended to result in behavior + changes in any existing implementation. Applications which + require preservation of ancillary buffers across a swap + should be aware that not all implementations can preserve + them, and that EGL 1.4 has no way to query whether or not + they are preserved. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned if swapping of the + surface buffers fails, <constant>EGL_TRUE</constant> otherwise. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> has not been initialized. + </para> + <para> + <constant>EGL_BAD_SURFACE</constant> is generated if + <parameter>surface</parameter> is not an EGL drawing surface. + </para> + <para> + <constant>EGL_CONTEXT_LOST</constant> is generated if a power management + event has occurred. The application must destroy all contexts and + reinitialise OpenGL ES state and objects to continue rendering. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCopyBuffers</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglSwapInterval.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglSwapInterval.xml new file mode 100644 index 0000000..4ec5aba --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglSwapInterval.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglSwapInterval"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglSwapInterval</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglSwapInterval</refname> + <refpurpose> + specifies the minimum number of video frame periods + per buffer swap for the window associated with the current context. + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglSwapInterval</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLint <parameter>interval</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem> + <para> + Specifies the EGL display connection. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>interval</parameter></term> + <listitem> + <para> + Specifies the minimum number of video frames that are displayed before + a buffer swap will occur. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + The interval takes effect when <citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry> is + first called subsequent to the <function>eglSwapInterval</function> call. + </para> + <para> + The <parameter>interval</parameter> specified by the function applies to the draw surface + bound to the context that is current on the calling thread. + </para> + <para> + If <parameter>interval</parameter> is set to a value of <constant>0</constant>, buffer swaps are not synchronized to a + video frame, and the swap happens as soon as the render is complete. interval + is silently clamped to minimum and maximum implementation dependent + valuesbefore being stored; these values are defined by <type>EGLConfig</type> attributes + <constant>EGL_MIN_SWAP_INTERVAL</constant> and <constant>EGL_MAX_SWAP_INTERVAL</constant> respectively. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + The swap interval has no effect on <citerefentry><refentrytitle>eglCopyBuffers</refentrytitle></citerefentry>. + </para> + <para> + The default swap interval is 1. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned on failure, <constant>EGL_TRUE</constant> otherwise. + </para> + <para> + <constant>EGL_BAD_CONTEXT</constant> is generated if there is no current context + on the calling thread. + </para> + <para> + <constant>EGL_BAD_SURFACE</constant> is generated if there is no surface + bound to the current context. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglTerminate.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglTerminate.xml new file mode 100644 index 0000000..966b8c8 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglTerminate.xml @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglTerminate"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglTerminate</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglTerminate</refname> + <refpurpose> + terminate an <acronym>EGL</acronym> display connection + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglTerminate</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>display</parameter></term> + <listitem> + <para> + Specifies the EGL display connection to terminate. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + <function>eglTerminate</function> releases resources associated with + an EGL display connection. Termination marks all EGL resources associated + with the EGL display connection for deletion. If contexts or surfaces + associated with <parameter>display</parameter> is current to any thread, + they are not released until they are no longer current as a result of + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>. + </para> + <para> + Terminating an already terminated EGL display connection has no effect. + A terminated display may be re-initialized by calling + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry> + again. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned if + <function>eglTerminate</function> fails, + <constant>EGL_TRUE</constant> otherwise. + </para> + <para> + <constant>EGL_BAD_DISPLAY</constant> is generated if + <parameter>display</parameter> is not an EGL display connection. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglWaitClient.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglWaitClient.xml new file mode 100644 index 0000000..0ec3714 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglWaitClient.xml @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglWaitClient"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglWaitClient</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglWaitClient</refname> + <refpurpose> + Complete client API execution prior to subsequent native + rendering calls + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglWaitClient</function></funcdef> + <void/> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="description"><title>Description</title> + <para> + All rendering calls for the currently bound context, for the + current rendering API, made prior to + <function>eglWaitClient</function> are guaranteed to be + executed before native rendering calls made after + <function>eglWaitClient</function>. The same result can be + achieved using client API-specific commands such as + <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry> + or + <citerefentry><refentrytitle>vgFinish</refentrytitle></citerefentry>. + </para> + <para> + <function>eglWaitClient</function> is ignored if there is no + current EGL rendering context for the current rendering API. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned if + <function>eglWaitClient</function> fails, + <constant>EGL_TRUE</constant> otherwise. + </para> + <para> + If there is no current context for the current rendering + API, the function has no effect but still returns + <constant>EGL_TRUE</constant>. + </para> + <para> + <constant>EGL_BAD_CURRENT_SURFACE</constant> is generated if + the surface associated with the current context has a native + window or pixmap, and that window or pixmap is no longer + valid. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + <function>eglWaitClient</function> is supported only if the + EGL version is 1.2 or greater. + </para> + <para> + <function>eglWaitClient</function> is a generalized version + of <function>eglWaitGL</function>, supporting multiple + client APIs. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitGL</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>vgFinish</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglWaitGL.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglWaitGL.xml new file mode 100644 index 0000000..3da6f96 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglWaitGL.xml @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglWaitGL"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglWaitGL</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglWaitGL</refname> + <refpurpose> + Complete GL execution prior to subsequent native rendering + calls + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglWaitGL</function></funcdef> + <void/> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="description"><title>Description</title> + <para> + All OpenGL ES rendering calls for the currently bound OpenGL + ES context made prior to <function>eglWaitGL</function> are + guaranteed to be executed before native rendering calls made + after <function>eglWaitGL</function>. The same result can be + achieved using + <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>. + </para> + <para> + <function>eglWaitGL</function> is ignored if there is no + current EGL rendering context for OpenGL ES. + </para> + </refsect1> + <refsect1 id="notes"><title>Notes</title> + <para> + <function>eglWaitClient</function> is supported only if the + EGL version is 1.2 or greater. + </para> + <para> + <function>eglWaitClient</function> is a generalized version + of <function>eglWaitGL</function>, supporting multiple + client APIs. For backwards compatibility, + <function>eglWaitGL</function> continues to be supported and + is equivalent to the series of commands + </para> + <programlisting> + EGLenum api = <function>eglQueryAPI</function>(); + <function>eglBindAPI</function>(<constant>EGL_OPENGL_ES_API</constant>); + <function>eglWaitClient</function>(); + <function>eglBindAPI</function>(api); + </programlisting> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_FALSE</constant> is returned if + <function>eglWaitGL</function> fails, + <constant>EGL_TRUE</constant> otherwise. + </para> + <para> + <constant>EGL_BAD_CURRENT_SURFACE</constant> is generated if + the surface associated with the current context has a native + window or pixmap, and that window or pixmap is no longer + valid. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitClient</refentrytitle></citerefentry> + <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglWaitNative.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglWaitNative.xml new file mode 100644 index 0000000..0a44340 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/eglWaitNative.xml @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" + "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> +<refentry xml:base="" id="eglWaitNative"> + <refentryinfo> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </refentryinfo> + <refmeta> + <refentrytitle>eglWaitNative</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglWaitNative</refname> + <refpurpose> + complete native execution prior to subsequent GL rendering calls + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglWaitNative</function></funcdef> + <paramdef>EGLint <parameter>engine</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>engine</parameter></term> + <listitem> + <para> + Specifies a particular marking engine to be waited on. + Must be <constant>EGL_CORE_NATIVE_ENGINE</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id="description"><title>Description</title> + <para> + Native rendering calls made prior to <function>eglWaitNative</function> + are guaranteed to be executed before GL rendering calls made after + <function>eglWaitNative</function>. + </para> + <para> + <function>eglWaitNative</function> + is ignored if there is no current + <acronym>EGL</acronym> + rendering context. + </para> + </refsect1> + <refsect1 id="errors"><title>Errors</title> + <para> + <constant>EGL_BAD_PARAMETER</constant> is generated if + <parameter>engine</parameter> is not a recognized marking engine. + </para> + <para> + <constant>EGL_BAD_CURRENT_SURFACE</constant> + is generated if the surface associated with the current context has a + native window or pixmap, and that window or pixmap is no longer valid. + </para> + </refsect1> + <refsect1 id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitClient</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitGL</refentrytitle></citerefentry> + </para> + </refsect1> + <refsect3 id="Copyright"><title></title> + <!-- Content included from copyright.inc.xsl --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg" /> + </imageobject> + <para /> + </refsect3> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/docbook4/reference.xml b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/reference.xml new file mode 100644 index 0000000..0aa0603 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/docbook4/reference.xml @@ -0,0 +1,174 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "DTD/docbook/docbookx.dtd"> +<!-- + Copyright 2003-2010 Khronos Group. + This material may be distributed subject to the terms and conditions set forth in + the Open Publication License, v 1.0, 8 June 1999. + http://opencontent.org/openpub/ +--> +<book xmlns:xi="http://www.w3.org/2001/XInclude"> + <title> + EGL Reference Manual + </title> + <subtitle> + Version 1.4 + </subtitle> + <bookinfo> + <author> + <firstname>Claude</firstname> + <surname>Knaus</surname> + </author> + <author> + <firstname>Jon</firstname> + <surname>Leech</surname> + </author> + <date>October 2010</date> + <releaseinfo>Draft Version 20101012</releaseinfo> + <subjectset> + <subject>EGL</subject> + </subjectset> + <keywordset> + <keyword>EGL</keyword> + <keyword>man</keyword> + <keyword>reference</keyword> + </keywordset> + <xi:include href="legal-notice.xml"/> + </bookinfo> + <toc> + <title>Contents</title> + <!-- generated by LaTeX --> + </toc> + <chapter> + <title>Preface</title> + <sect1> + <title>Style Conventions</title> + <para> + The following style conventions apply to this document: + </para> + <variablelist> + <varlistentry> + <term><function>Bold</function></term> + <listitem><para>Command and function names</para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>Italics</parameter></term> + <listitem>Variables and parameters</listitem> + </varlistentry> + <varlistentry> + <term>Regular</term> + <listitem><para>Ordinary text</para></listitem> + </varlistentry> + <varlistentry> + <term><constant>Monospace</constant></term> + <listitem><para>Constants and source code</para></listitem> + </varlistentry> + </variablelist> + </sect1> + </chapter> + <chapter> + <title>Summary of Commands and Routines</title> + <sect1> + <title>EGL Functions</title> + <para>Manage or query display connections:</para> + <simplelist type="vert"> + <member><citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglQueryString</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglTerminate</refentrytitle></citerefentry></member> + </simplelist> + <para>Request EGL and client API extension functions:</para> + <simplelist type="vert"> + <member><citerefentry><refentrytitle>eglGetProcAddress</refentrytitle></citerefentry></member> + </simplelist> + <para>Query errors:</para> + <simplelist type="vert"> + <member><citerefentry><refentrytitle>eglGetError</refentrytitle></citerefentry></member> + </simplelist> + <para>Request or query frame buffer configurations:</para> + <simplelist type="vert"> + <member><citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry></member> + </simplelist> + <para>Manage or query the current rendering API:</para> + <simplelist type="vert"> + <member><citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglQueryAPI</refentrytitle></citerefentry></member> + </simplelist> + <para>Manage or query EGL rendering contexts:</para> + <simplelist type="vert"> + <member><citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglDestroyContext</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglQueryContext</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglGetCurrentContext</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglGetCurrentSurface</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglGetCurrentDisplay</refentrytitle></citerefentry></member> + </simplelist> + <para>Manage or query EGL surfaces:</para> + <simplelist type="vert"> + <member><citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglDestroySurface</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglSurfaceAttrib</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglQuerySurface</refentrytitle></citerefentry></member> + </simplelist> + <para>Synchronize execution:</para> + <simplelist type="vert"> + <member><citerefentry><refentrytitle>eglSwapInterval</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglWaitClient</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglWaitGL</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry></member> + </simplelist> + <para>Post and copy buffers:</para> + <simplelist type="vert"> + <member><citerefentry><refentrytitle>eglCopyBuffers</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry></member> + </simplelist> + <para>Bind pixel buffer surfaces to OpenGL ES textures:</para> + <simplelist type="vert"> + <member><citerefentry><refentrytitle>eglBindTexImage</refentrytitle></citerefentry></member> + <member><citerefentry><refentrytitle>eglReleaseTexImage</refentrytitle></citerefentry></member> + </simplelist> + </sect1> + </chapter> + <chapter> + <title>EGL Reference Pages</title> + <xi:include href="eglBindAPI.xml"/> + <xi:include href="eglBindTexImage.xml"/> + <xi:include href="eglChooseConfig.xml"/> + <xi:include href="eglCopyBuffers.xml"/> + <xi:include href="eglCreateContext.xml"/> + <xi:include href="eglCreatePbufferSurface.xml"/> + <xi:include href="eglCreatePixmapSurface.xml"/> + <xi:include href="eglCreateWindowSurface.xml"/> + <xi:include href="eglDestroyContext.xml"/> + <xi:include href="eglDestroySurface.xml"/> + <xi:include href="eglGetConfigAttrib.xml"/> + <xi:include href="eglGetConfigs.xml"/> + <xi:include href="eglGetCurrentContext.xml"/> + <xi:include href="eglGetCurrentDisplay.xml"/> + <xi:include href="eglGetCurrentSurface.xml"/> + <xi:include href="eglGetDisplay.xml"/> + <xi:include href="eglGetError.xml"/> + <xi:include href="eglGetProcAddress.xml"/> + <xi:include href="eglInitialize.xml"/> + <xi:include href="eglIntro.xml"/> + <xi:include href="eglMakeCurrent.xml"/> + <xi:include href="eglQueryAPI.xml"/> + <xi:include href="eglQueryContext.xml"/> + <xi:include href="eglQueryString.xml"/> + <xi:include href="eglQuerySurface.xml"/> + <xi:include href="eglReleaseTexImage.xml"/> + <xi:include href="eglReleaseThread.xml"/> + <xi:include href="eglSurfaceAttrib.xml"/> + <xi:include href="eglSwapBuffers.xml"/> + <xi:include href="eglSwapInterval.xml"/> + <xi:include href="eglTerminate.xml"/> + <xi:include href="eglWaitClient.xml"/> + <xi:include href="eglWaitGL.xml"/> + <xi:include href="eglWaitNative.xml"/> + </chapter> + <xi:include href="license-full.xml"/> +</book> |