diff options
| author | sotech117 <michael_foiani@brown.edu> | 2024-04-09 03:14:17 -0400 |
|---|---|---|
| committer | sotech117 <michael_foiani@brown.edu> | 2024-04-09 03:14:17 -0400 |
| commit | 7a8d0d8bc2572707c9d35006f30ea835c86954b0 (patch) | |
| tree | dedb9a65c1698202ad485378b4186b667008abe5 /glew/auto/EGL-Registry/sdk/docs/man | |
| parent | 818324678bd5dca790c57048e5012d2937a4b5e5 (diff) | |
first draft to generate waves
Diffstat (limited to 'glew/auto/EGL-Registry/sdk/docs/man')
209 files changed, 46825 insertions, 0 deletions
diff --git a/glew/auto/EGL-Registry/sdk/docs/man/.htaccess b/glew/auto/EGL-Registry/sdk/docs/man/.htaccess new file mode 100644 index 0000000..578915b --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/.htaccess @@ -0,0 +1,13 @@ +RewriteEngine on + +# Avoid redirect loops +RewriteCond %{ENV:REDIRECT_STATUS} 200 +RewriteRule ^ - [L] + +# Unlike the OpenGL ES and OpenGL reference pages, we're not keeping +# old versions of the EGL man pages around. Just redirect links to +# egl/sdk/docs/man/xhtml/*.html to the new HTML 5 pages in html/*.xhtml. + +RewriteRule ^xhtml/$ https://www.khronos.org/registry/egl/sdk/docs/man/ [L,R=301] +RewriteRule ^xhtml/index.html https://www.khronos.org/registry/egl/sdk/docs/man/ [L,R=301] +RewriteRule ^xhtml/(.*)\.html https://www.khronos.org/registry/egl/sdk/docs/man/html/$1.xhtml [L,R=301] diff --git a/glew/auto/EGL-Registry/sdk/docs/man/NOTES b/glew/auto/EGL-Registry/sdk/docs/man/NOTES new file mode 100644 index 0000000..710ee20 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/NOTES @@ -0,0 +1,59 @@ +egl/ -> EGL Docbook 4.3 + OpenCL stuff +es/ -> ES Docbook 5 + OpenCL stuff + +Only in es/ : + OK> accord.js - Javascript for accordion menus + OK> genheaders.py - unused + OK> makeindex.py - make accordion index frame + OK> opengl-man.css - CSS equivalent to content wrapped in old/styles-css.xsl + OK> start.html - start page + OK> ../index.html - main SDK index + OK> ../top.php - top bar of interface + OK> ../bottom.php - bottom section of interface + OK> style-index.css - CSS for index page + +Only in egl/ : + OK> EGL_300.png - icon + OK> KhronosLogo.jpg - icon + OK> index.html - main SDK index (equivalent to es/../index.php) + OK> Header.html - top bar of interface + OK> headBackground.jpg - background for Header.html + NO> TOC.html - accordion index frame, equivalent to output of makeindex.py + OK> Intro.html - equivalent to start.html + OK> copyright.inc.xsl - inserted by egl-man.xsl into each page + NO> ctop.xsl - no longer used? + NO> styles-css.xsl - equivalent to es/opengl-man.css + NO> maketoc.pl - replaced by es/makeindex.py + +Similar files: + OK> egl/egl-man.xsl - branched from opengl-man.xsl, should be compared to es/opengl-man.xsl + OK> egl/style.css - equivalent to es/style-index.css, includes a couple of other .css files + OK> egl/undohtml.css - identical, appears to reset CSS parameters + OK> egl/present.css - minor tweak to CSS class name, lev1 -> Level1 + OK> egl/bullets*gif - accordion menu navigation bullets + + +---------- + Added from ES: + man/index.php - navigation framework, edited for correct title and top bar height + man/top.php - from ES but mostly replaced by egl/Header.html + man/bottom.php + man/headBackground.jpg - from ES + + accord.js + bullets-{contract,end,expand}.gif - accordion menus + makeindex.py - with edits for EGL instead of ES + present.css - matching output of makeindex.py + Makefile - with edits from egl/Makefile + khronos-man.css - copied from es/opengl-man.css + start.html - with massive edits from egl/Intro.html + style-index.css - equivalent to egl/style.css + khronos-man.xsl - merged from egl/egl-man.xsl and es/opengl-man.xsl. + egl-man.xsl - stuff from old egl/egl-man.xsl not being used + (yet) in khronos-man.xsl. + + Added from EGL: + EGL_300.png + KhronosLogo.jpg + undohtml.css + copyright.inc.xsl diff --git a/glew/auto/EGL-Registry/sdk/docs/man/README b/glew/auto/EGL-Registry/sdk/docs/man/README new file mode 100644 index 0000000..9355121 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/README @@ -0,0 +1 @@ +EGL reference pages, branched from /repos/ogles/branches/1.X/doc/man/xhtml diff --git a/glew/auto/EGL-Registry/sdk/docs/man/bottom.php b/glew/auto/EGL-Registry/sdk/docs/man/bottom.php new file mode 100644 index 0000000..b90da9f --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/bottom.php @@ -0,0 +1,9 @@ +<html> +<head> +<title>EGL Reference Pages</title> +</head> +<frameset cols="280,*"> + <frame frameborder="0" marginwidth="0" marginheight="0" src="html/indexflat.php"> + <frame name="pagedisplay" frameborder="0" marginwidth="20" marginheight="20" src="html/start.html"> +</frameset> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/copyright.xml b/glew/auto/EGL-Registry/sdk/docs/man/copyright.xml new file mode 100644 index 0000000..e71ca98 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/copyright.xml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8"?> +<para xmlns="http://docbook.org/ns/docbook" version="5.0"> + <refsect3 xml:id="copyright"> + <!-- <title>Copyright</title> --> + <imageobject> + <imagedata fileref="KhronosLogo.jpg" format="jpg"/> + </imageobject> + <para> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </para> + </refsect3> +</para> + diff --git a/glew/auto/EGL-Registry/sdk/docs/man/db4-upgrade.xsl b/glew/auto/EGL-Registry/sdk/docs/man/db4-upgrade.xsl new file mode 100644 index 0000000..2d3e1cd --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/db4-upgrade.xsl @@ -0,0 +1,1455 @@ +<?xml version="1.0"?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:exsl="http://exslt.org/common" + xmlns:db = "http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + exclude-result-prefixes="exsl db" + version="1.0"> + +<!-- +# ====================================================================== +# This file is part of DocBook V5.0CR5 +# +# Copyright 2005 Norman Walsh, Sun Microsystems, Inc., and the +# Organization for the Advancement of Structured Information +# Standards (OASIS). +# +# Release: $Id: db4-upgrade.xsl 9828 2013-11-03 21:45:22Z tom_schr $ +# +# Permission to use, copy, modify and distribute this stylesheet +# and its accompanying documentation for any purpose and without fee +# is hereby granted in perpetuity, provided that the above copyright +# notice and this paragraph appear in all copies. The copyright +# holders make no representation about the suitability of the schema +# for any purpose. It is provided "as is" without expressed or implied +# warranty. +# +# Please direct all questions, bug reports, or suggestions for changes +# to the docbook@lists.oasis-open.org mailing list. For more +# information, see http://www.oasis-open.org/docbook/. +# +# ====================================================================== +--> + +<xsl:param name="db5.version" select="'5.0'"/> <!-- DocBook version for the output 5.0 and 5.1 only current values --> +<xsl:param name="db5.version.string" select="$db5.version"/> <!-- Set this if you want a local version number --> +<xsl:param name="keep.numbered.sections" select="'0'"/> <!-- Set to 1 to keep numbered sections, default changes to recursive --> + +<xsl:variable name="version" select="'1.1'"/> <!-- version of this transform --> + +<xsl:output method="xml" encoding="utf-8" indent="no" omit-xml-declaration="yes"/> + +<xsl:preserve-space elements="*"/> +<xsl:param name="rootid"> + <xsl:choose> + <xsl:when test="/*/@id"> + <xsl:value-of select="/*/@id"/> + </xsl:when> + <xsl:otherwise> + <xsl:text>UNKNOWN</xsl:text> + </xsl:otherwise> + </xsl:choose> +</xsl:param> + +<xsl:param name="defaultDate" select="''"/> + +<xsl:template match="/"> + <xsl:variable name="converted"> + <xsl:apply-templates/> + </xsl:variable> + <xsl:comment> + <xsl:text> Converted by db4-upgrade version </xsl:text> + <xsl:value-of select="$version"/> + <xsl:text> </xsl:text> + </xsl:comment> + <xsl:text> </xsl:text> + <xsl:apply-templates select="exsl:node-set($converted)/*" mode="addNS"/> +</xsl:template> + +<!-- Convert numbered sections into recursive sections, unless + $keep.numbered.sections is set to '1' --> +<xsl:template match="sect1|sect2|sect3|sect4|sect5|section" + priority="200"> + <xsl:choose> + <xsl:when test="$keep.numbered.sections = '1'"> + <xsl:element name="{local-name(.)}"> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </xsl:element> + </xsl:when> + <xsl:otherwise> + <section> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </section> + </xsl:otherwise> + </xsl:choose> +</xsl:template> +<!-- This is the template for the elements (book, article, set) that allow + title, subtitle, and titleabbrev before (or in) info, but not after. + If title, subtitle, or titleabbrev exist both inside and outside the + info block, everything is moved inside. Otherwise things are left as is. --> +<xsl:template match="bookinfo|articleinfo|artheader|setinfo" priority="200"> + <xsl:variable name="title.inside.info"> + <xsl:choose> + <xsl:when test="./title or ./subtitle or ./titleabbrev"> + <xsl:text>1</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>0</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="title.outside.info"> + <xsl:choose> + <xsl:when test="preceding-sibling::title or preceding-sibling::subtitle or preceding-sibling::titleabbrev"> + <xsl:text>1</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>0</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <info> + <xsl:if test="$title.inside.info = '1' and $title.outside.info = '1'"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Found title|subtitle|titleabbrev both inside and outside </xsl:text><xsl:value-of select="local-name(.)"/> + <xsl:text>. Moving all inside info element.</xsl:text> + </xsl:with-param> + </xsl:call-template> + <xsl:if test="preceding-sibling::title and not(./title)"> + <xsl:apply-templates select="preceding-sibling::title" mode="copy"/> + </xsl:if> + <xsl:if test="preceding-sibling::subtitle and not(./subtitle)"> + <xsl:apply-templates select="preceding-sibling::subtitle" mode="copy"/> + </xsl:if> + <xsl:if test="preceding-sibling::titleabbrev and not(./titleabbrev)"> + <xsl:apply-templates select="preceding-sibling::titleabbrev" mode="copy"/> + </xsl:if> + </xsl:if> + <xsl:apply-templates/> + </info> +</xsl:template> +<!-- This is the template for the elements (all except book, article, set) that + allow title, subtitle, and titleabbrev after (or in) info, but not before. + If an info element exists, and there is a title, subtitle, or titleabbrev + after the info element, then the element is moved inside the info block. + However, if a duplicate element exists inside the info element, that element + is kept, and the one outside is dropped.--> +<xsl:template match="appendixinfo|blockinfo|bibliographyinfo|glossaryinfo + |indexinfo|setindexinfo|chapterinfo + |sect1info|sect2info|sect3info|sect4info|sect5info|sectioninfo + |refsect1info|refsect2info|refsect3info|refsectioninfo + |referenceinfo|partinfo + |objectinfo|prefaceinfo|refsynopsisdivinfo + |screeninfo|sidebarinfo" + priority="200"> + <xsl:variable name="title.inside.info"> + <xsl:choose> + <xsl:when test="./title or ./subtitle or ./titleabbrev"> + <xsl:text>1</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>0</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <!-- place title/subtitle/titleabbrev inside if any of them are already inside. + otherwise place them before. --> + <xsl:choose> + <xsl:when test="$title.inside.info = '0'"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Keeping one or more title elements before </xsl:text><xsl:value-of select="local-name(.)"/> + </xsl:with-param> + </xsl:call-template> + + <xsl:if test="following-sibling::title and not(./title)"> + <xsl:apply-templates select="following-sibling::title" mode="copy"/> + </xsl:if> + <xsl:if test="following-sibling::subtitle and not(./subtitle)"> + <xsl:apply-templates select="following-sibling::subtitle" mode="copy"/> + </xsl:if> + <xsl:if test="following-sibling::titleabbrev and not(./titleabbrev)"> + <xsl:apply-templates select="following-sibling::titleabbrev" mode="copy"/> + </xsl:if> + <info> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </info> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Moving one or more title elements into </xsl:text><xsl:value-of select="local-name(.)"/> + </xsl:with-param> + </xsl:call-template> + <info> + <xsl:call-template name="copy.attributes"/> + <xsl:if test="following-sibling::title and not(./title)"> + <xsl:apply-templates select="following-sibling::title" mode="copy"/> + </xsl:if> + <xsl:if test="following-sibling::subtitle and not(./subtitle)"> + <xsl:apply-templates select="following-sibling::subtitle" mode="copy"/> + </xsl:if> + <xsl:if test="following-sibling::titleabbrev and not(./titleabbrev)"> + <xsl:apply-templates select="following-sibling::titleabbrev" mode="copy"/> + </xsl:if> + <xsl:apply-templates/> + </info> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="refentryinfo" + priority="200"> + <info> + <xsl:call-template name="copy.attributes"/> + + <xsl:if test="title"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Discarding title from refentryinfo!</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:if> + + <xsl:if test="titleabbrev"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Discarding titleabbrev from refentryinfo!</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:if> + + <xsl:if test="subtitle"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Discarding subtitle from refentryinfo!</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:if> + + <xsl:apply-templates/> + </info> +</xsl:template> + +<xsl:template match="refmiscinfo" + priority="200"> + <refmiscinfo> + <xsl:call-template name="copy.attributes"> + <xsl:with-param name="suppress" select="'class'"/> + </xsl:call-template> + <xsl:if test="@class"> + <xsl:choose> + <xsl:when test="@class = 'source' + or @class = 'version' + or @class = 'manual' + or @class = 'sectdesc' + or @class = 'software'"> + <xsl:attribute name="class"> + <xsl:value-of select="@class"/> + </xsl:attribute> + </xsl:when> + <xsl:otherwise> + <xsl:attribute name="class"> + <xsl:value-of select="'other'"/> + </xsl:attribute> + <xsl:attribute name="otherclass"> + <xsl:value-of select="@class"/> + </xsl:attribute> + </xsl:otherwise> + </xsl:choose> + </xsl:if> + <xsl:apply-templates/> + </refmiscinfo> +</xsl:template> + +<xsl:template match="corpauthor" priority="200"> + <author> + <xsl:call-template name="copy.attributes"/> + <orgname> + <xsl:apply-templates/> + </orgname> + </author> +</xsl:template> + +<xsl:template match="corpname" priority="200"> + <orgname> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </orgname> +</xsl:template> + +<xsl:template match="author[not(personname)]|editor[not(personname)]|othercredit[not(personname)]" priority="200"> + <xsl:copy> + <xsl:call-template name="copy.attributes"/> + <personname> + <xsl:apply-templates select="honorific|firstname|surname|othername|lineage"/> + </personname> + <xsl:apply-templates select="*[not(self::honorific|self::firstname|self::surname + |self::othername|self::lineage)]"/> + </xsl:copy> +</xsl:template> + +<xsl:template match="address|programlisting|screen|funcsynopsisinfo + |classsynopsisinfo" priority="200"> + <xsl:copy> + <xsl:call-template name="copy.attributes"> + <xsl:with-param name="suppress" select="'format'"/> + </xsl:call-template> + <xsl:apply-templates/> + </xsl:copy> +</xsl:template> + +<!-- Suppress attributes with default values (i.e., added implicitly by DTD) --> +<xsl:template match="productname" priority="200"> + <xsl:copy> + <xsl:call-template name="copy.attributes"> + <xsl:with-param name="suppress.default" select="'class=trade'"/> + </xsl:call-template> + <xsl:apply-templates/> + </xsl:copy> +</xsl:template> + +<xsl:template match="orderedlist" priority="200"> + <xsl:copy> + <xsl:call-template name="copy.attributes"> + <xsl:with-param name="suppress.default" select="'inheritnum=ignore continuation=restarts'"/> + </xsl:call-template> + <xsl:apply-templates/> + </xsl:copy> +</xsl:template> + +<xsl:template match="literallayout" priority="200"> + <xsl:copy> + <xsl:call-template name="copy.attributes"> + <xsl:with-param name="suppress" select="'format'"/><!-- Dropped entirely in DB5 --> + <xsl:with-param name="suppress.default" select="'class=normal'"/> + </xsl:call-template> + <xsl:apply-templates/> + </xsl:copy> +</xsl:template> + +<xsl:template match="equation" priority="200"> + <xsl:choose> + <xsl:when test="not(title)"> + <xsl:call-template name="emit-message"> + <xsl:with-param + name="message" + >Convert equation without title to informal equation.</xsl:with-param> + </xsl:call-template> + <informalequation> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </informalequation> + </xsl:when> + <xsl:otherwise> + <xsl:copy> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </xsl:copy> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="imagedata|videodata|audiodata|textdata" priority="200"> + <xsl:copy> + <xsl:call-template name="copy.attributes"> + <xsl:with-param name="suppress" select="'srccredit'"/> + </xsl:call-template> + <xsl:if test="@srccredit"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Check conversion of srccredit </xsl:text> + <xsl:text>(othercredit="srccredit").</xsl:text> + </xsl:with-param> + </xsl:call-template> + <info> + <othercredit class="other" otherclass="srccredit"> + <orgname>???</orgname> + <contrib> + <xsl:value-of select="@srccredit"/> + </contrib> + </othercredit> + </info> + </xsl:if> + </xsl:copy> +</xsl:template> + +<xsl:template match="sgmltag" priority="200"> + <tag> + <xsl:call-template name="copy.attributes"/> + <xsl:if test="@class = 'sgmlcomment'"> + <xsl:attribute name="class">comment</xsl:attribute> + </xsl:if> + <xsl:apply-templates/> + </tag> +</xsl:template> + +<xsl:template match="inlinegraphic[@format='linespecific']" priority="210"> + <textobject> + <textdata> + <xsl:call-template name="copy.attributes"/> + </textdata> + </textobject> +</xsl:template> + +<xsl:template match="inlinegraphic" priority="200"> + <inlinemediaobject> + <imageobject> + <imagedata> + <xsl:call-template name="copy.attributes"/> + </imagedata> + </imageobject> + </inlinemediaobject> +</xsl:template> + +<xsl:template match="graphic[@format='linespecific']" priority="210"> + <mediaobject> + <textobject> + <textdata> + <xsl:call-template name="copy.attributes"/> + </textdata> + </textobject> + </mediaobject> +</xsl:template> + +<xsl:template match="graphic" priority="200"> + <mediaobject> + <imageobject> + <imagedata> + <xsl:call-template name="copy.attributes"/> + </imagedata> + </imageobject> + </mediaobject> +</xsl:template> + +<xsl:template match="pubsnumber" priority="200"> + <biblioid class="pubsnumber"> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </biblioid> +</xsl:template> + +<xsl:template match="invpartnumber" priority="200"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Converting invpartnumber to biblioid otherclass="invpartnumber".</xsl:text> + </xsl:with-param> + </xsl:call-template> + <biblioid class="other" otherclass="invpartnumber"> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </biblioid> +</xsl:template> + +<xsl:template match="contractsponsor" priority="200"> + <xsl:variable name="contractnum" + select="preceding-sibling::contractnum|following-sibling::contractnum"/> + + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Converting contractsponsor to othercredit="contractsponsor".</xsl:text> + </xsl:with-param> + </xsl:call-template> + + <othercredit class="other" otherclass="contractsponsor"> + <orgname> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </orgname> + <xsl:for-each select="$contractnum"> + <contrib role="contractnum"> + <xsl:apply-templates select="node()"/> + </contrib> + </xsl:for-each> + </othercredit> +</xsl:template> + +<xsl:template match="contractnum" priority="200"> + <xsl:if test="not(preceding-sibling::contractsponsor + |following-sibling::contractsponsor) + and not(preceding-sibling::contractnum)"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Converting contractnum to othercredit="contractnum".</xsl:text> + </xsl:with-param> + </xsl:call-template> + + <othercredit class="other" otherclass="contractnum"> + <orgname>???</orgname> + <xsl:for-each select="self::contractnum + |preceding-sibling::contractnum + |following-sibling::contractnum"> + <contrib> + <xsl:apply-templates select="node()"/> + </contrib> + </xsl:for-each> + </othercredit> + </xsl:if> +</xsl:template> + +<xsl:template match="isbn|issn" priority="200"> + <biblioid class="{local-name(.)}"> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </biblioid> +</xsl:template> + +<xsl:template match="biblioid[count(*) = 1 + and ulink + and normalize-space(text()) = '']" priority="200"> + <biblioid xlink:href="{ulink/@url}"> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates select="ulink/node()"/> + </biblioid> +</xsl:template> + +<xsl:template match="authorblurb" priority="200"> + <personblurb> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </personblurb> +</xsl:template> + +<xsl:template match="collabname" priority="200"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Check conversion of collabname </xsl:text> + <xsl:text>(orgname role="collabname").</xsl:text> + </xsl:with-param> + </xsl:call-template> + <orgname role="collabname"> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </orgname> +</xsl:template> + +<xsl:template match="modespec" priority="200"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Discarding modespec (</xsl:text> + <xsl:value-of select="."/> + <xsl:text>).</xsl:text> + </xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template match="mediaobjectco" priority="200"> + <mediaobject> + <xsl:copy-of select="@*"/> + <xsl:apply-templates/> + </mediaobject> +</xsl:template> + +<xsl:template match="remark"> + <!-- get rid of any embedded markup if the version is 5.0. If it's > 5.0, leave markup in. --> + <remark> + <xsl:copy-of select="@*"/> + <xsl:choose> + <xsl:when test="$db5.version>5.0"> + <xsl:apply-templates/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="."/> + </xsl:otherwise> + </xsl:choose> + </remark> +</xsl:template> + +<xsl:template match="biblioentry/title + |bibliomset/title + |biblioset/title + |bibliomixed/title" priority="400"> + <citetitle> + <xsl:copy-of select="@*"/> + <xsl:apply-templates/> + </citetitle> +</xsl:template> + +<xsl:template match="biblioentry/titleabbrev|biblioentry/subtitle + |bibliomset/titleabbrev|bibliomset/subtitle + |biblioset/titleabbrev|biblioset/subtitle + |bibliomixed/titleabbrev|bibliomixed/subtitle" + priority="400"> + <xsl:copy> + <xsl:copy-of select="@*"/> + <xsl:apply-templates/> + </xsl:copy> +</xsl:template> + +<xsl:template match="biblioentry/contrib + |bibliomset/contrib + |bibliomixed/contrib" priority="200"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Check conversion of contrib </xsl:text> + <xsl:text>(othercontrib="contrib").</xsl:text> + </xsl:with-param> + </xsl:call-template> + <othercredit class="other" otherclass="contrib"> + <orgname>???</orgname> + <contrib> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </contrib> + </othercredit> +</xsl:template> + +<xsl:template match="link" priority="200"> + <xsl:copy> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </xsl:copy> +</xsl:template> + +<xsl:template match="ulink" priority="200"> + <xsl:choose> + <xsl:when test="node()"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Converting ulink to link.</xsl:text> + </xsl:with-param> + </xsl:call-template> + + <link xlink:href="{@url}"> + <xsl:call-template name="copy.attributes"> + <xsl:with-param name="suppress" select="'url'"/> + </xsl:call-template> + <xsl:apply-templates/> + </link> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Converting ulink to uri.</xsl:text> + </xsl:with-param> + </xsl:call-template> + + <uri xlink:href="{@url}"> + <xsl:call-template name="copy.attributes"> + <xsl:with-param name="suppress" select="'url'"/> + </xsl:call-template> + <xsl:value-of select="@url"/> + </uri> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="olink" priority="200"> + <xsl:if test="@linkmode"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Discarding linkmode on olink.</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:if> + + <xsl:choose> + <xsl:when test="@targetdocent"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Converting olink targetdocent to targetdoc.</xsl:text> + </xsl:with-param> + </xsl:call-template> + + <olink targetdoc="{unparsed-entity-uri(@targetdocent)}"> + <xsl:for-each select="@*"> + <xsl:if test="name(.) != 'targetdocent' + and name(.) != 'linkmode'"> + <xsl:copy/> + </xsl:if> + </xsl:for-each> + <xsl:apply-templates/> + </olink> + </xsl:when> + <xsl:otherwise> + <olink> + <xsl:for-each select="@*"> + <xsl:if test="name(.) != 'linkmode'"> + <xsl:copy/> + </xsl:if> + </xsl:for-each> + <xsl:apply-templates/> + </olink> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="biblioentry/firstname + |biblioentry/surname + |biblioentry/othername + |biblioentry/lineage + |biblioentry/honorific + |bibliomset/firstname + |bibliomset/surname + |bibliomset/othername + |bibliomset/lineage + |bibliomset/honorific" priority="200"> + <xsl:choose> + <xsl:when test="preceding-sibling::firstname + |preceding-sibling::surname + |preceding-sibling::othername + |preceding-sibling::lineage + |preceding-sibling::honorific"> + <!-- nop --> + </xsl:when> + <xsl:otherwise> + <personname> + <xsl:apply-templates select="../firstname + |../surname + |../othername + |../lineage + |../honorific" mode="copy"/> + </personname> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="areaset" priority="200"> + <xsl:copy> + <xsl:call-template name="copy.attributes"> + <xsl:with-param name="suppress" select="'coords'"/> + </xsl:call-template> + <xsl:apply-templates/> + </xsl:copy> +</xsl:template> + +<xsl:template match="date|pubdate" priority="200"> + <xsl:variable name="rp1" select="substring-before(normalize-space(.), ' ')"/> + <xsl:variable name="rp2" + select="substring-before(substring-after(normalize-space(.), ' '), + ' ')"/> + <xsl:variable name="rp3" + select="substring-after(substring-after(normalize-space(.), ' '), ' ')"/> + + <xsl:variable name="p1"> + <xsl:choose> + <xsl:when test="contains($rp1, ',')"> + <xsl:value-of select="substring-before($rp1, ',')"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$rp1"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:variable name="p2"> + <xsl:choose> + <xsl:when test="contains($rp2, ',')"> + <xsl:value-of select="substring-before($rp2, ',')"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$rp2"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:variable name="p3"> + <xsl:choose> + <xsl:when test="contains($rp3, ',')"> + <xsl:value-of select="substring-before($rp3, ',')"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$rp3"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:variable name="date"> + <xsl:choose> + <xsl:when test="string($p1+1) != 'NaN' and string($p3+1) != 'NaN'"> + <xsl:choose> + <xsl:when test="$p2 = 'Jan' or $p2 = 'January'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-01-</xsl:text> + <xsl:number value="$p1" format="01"/> + </xsl:when> + <xsl:when test="$p2 = 'Feb' or $p2 = 'February'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-02-</xsl:text> + <xsl:number value="$p1" format="01"/> + </xsl:when> + <xsl:when test="$p2 = 'Mar' or $p2 = 'March'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-03-</xsl:text> + <xsl:number value="$p1" format="01"/> + </xsl:when> + <xsl:when test="$p2 = 'Apr' or $p2 = 'April'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-04-</xsl:text> + <xsl:number value="$p1" format="01"/> + </xsl:when> + <xsl:when test="$p2 = 'May'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-05-</xsl:text> + <xsl:number value="$p1" format="01"/> + </xsl:when> + <xsl:when test="$p2 = 'Jun' or $p2 = 'June'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-06-</xsl:text> + <xsl:number value="$p1" format="01"/> + </xsl:when> + <xsl:when test="$p2 = 'Jul' or $p2 = 'July'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-07-</xsl:text> + <xsl:number value="$p1" format="01"/> + </xsl:when> + <xsl:when test="$p2 = 'Aug' or $p2 = 'August'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-08-</xsl:text> + <xsl:number value="$p1" format="01"/> + </xsl:when> + <xsl:when test="$p2 = 'Sep' or $p2 = 'September'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-09-</xsl:text> + <xsl:number value="$p1" format="01"/> + </xsl:when> + <xsl:when test="$p2 = 'Oct' or $p2 = 'October'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-10-</xsl:text> + <xsl:number value="$p1" format="01"/> + </xsl:when> + <xsl:when test="$p2 = 'Nov' or $p2 = 'November'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-11-</xsl:text> + <xsl:number value="$p1" format="01"/> + </xsl:when> + <xsl:when test="$p2 = 'Dec' or $p2 = 'December'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-12-</xsl:text> + <xsl:number value="$p1" format="01"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates/> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:when test="string($p2+1) != 'NaN' and string($p3+1) != 'NaN'"> + <xsl:choose> + <xsl:when test="$p1 = 'Jan' or $p1 = 'January'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-01-</xsl:text> + <xsl:number value="$p2" format="01"/> + </xsl:when> + <xsl:when test="$p1 = 'Feb' or $p1 = 'February'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-02-</xsl:text> + <xsl:number value="$p2" format="01"/> + </xsl:when> + <xsl:when test="$p1 = 'Mar' or $p1 = 'March'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-03-</xsl:text> + <xsl:number value="$p2" format="01"/> + </xsl:when> + <xsl:when test="$p1 = 'Apr' or $p1 = 'April'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-04-</xsl:text> + <xsl:number value="$p2" format="01"/> + </xsl:when> + <xsl:when test="$p1 = 'May'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-05-</xsl:text> + <xsl:number value="$p2" format="01"/> + </xsl:when> + <xsl:when test="$p1 = 'Jun' or $p1 = 'June'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-06-</xsl:text> + <xsl:number value="$p2" format="01"/> + </xsl:when> + <xsl:when test="$p1 = 'Jul' or $p1 = 'July'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-07-</xsl:text> + <xsl:number value="$p2" format="01"/> + </xsl:when> + <xsl:when test="$p1 = 'Aug' or $p1 = 'August'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-08-</xsl:text> + <xsl:number value="$p2" format="01"/> + </xsl:when> + <xsl:when test="$p1 = 'Sep' or $p1 = 'September'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-09-</xsl:text> + <xsl:number value="$p2" format="01"/> + </xsl:when> + <xsl:when test="$p1 = 'Oct' or $p1 = 'October'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-10-</xsl:text> + <xsl:number value="$p2" format="01"/> + </xsl:when> + <xsl:when test="$p1 = 'Nov' or $p1 = 'November'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-11-</xsl:text> + <xsl:number value="$p2" format="01"/> + </xsl:when> + <xsl:when test="$p1 = 'Dec' or $p1 = 'December'"> + <xsl:number value="$p3" format="0001"/> + <xsl:text>-12-</xsl:text> + <xsl:number value="$p2" format="01"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates/> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:choose> + <xsl:when test="normalize-space($date) != normalize-space(.)"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Converted </xsl:text> + <xsl:value-of select="normalize-space(.)"/> + <xsl:text> into </xsl:text> + <xsl:value-of select="$date"/> + <xsl:text> for </xsl:text> + <xsl:value-of select="name(.)"/> + </xsl:with-param> + </xsl:call-template> + + <xsl:copy> + <xsl:copy-of select="@*"/> + <xsl:value-of select="$date"/> + </xsl:copy> + </xsl:when> + + <xsl:when test="$defaultDate != ''"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Unparseable date: </xsl:text> + <xsl:value-of select="normalize-space(.)"/> + <xsl:text> in </xsl:text> + <xsl:value-of select="name(.)"/> + <xsl:text> (Using default: </xsl:text> + <xsl:value-of select="$defaultDate"/> + <xsl:text>)</xsl:text> + </xsl:with-param> + </xsl:call-template> + + <xsl:copy> + <xsl:copy-of select="@*"/> + <xsl:copy-of select="$defaultDate"/> + <xsl:comment> + <xsl:value-of select="."/> + </xsl:comment> + </xsl:copy> + </xsl:when> + + <xsl:otherwise> + <!-- these don't really matter anymore + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Unparseable date: </xsl:text> + <xsl:value-of select="normalize-space(.)"/> + <xsl:text> in </xsl:text> + <xsl:value-of select="name(.)"/> + </xsl:with-param> + </xsl:call-template> + --> + <xsl:copy> + <xsl:copy-of select="@*"/> + <xsl:apply-templates/> + </xsl:copy> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="title|subtitle|titleabbrev" priority="300"> + <xsl:variable name="local.name" select="local-name(.)"/> + <xsl:variable name="parent.name" select="local-name(..)"/> + + <!-- First three tests drop element if parent ZZZ already has + ZZZinfo/title (or subtitle, or titleabbrev). --> + <xsl:choose> + <xsl:when test="../*[local-name(.) = concat($parent.name, 'info')]/*[local-name(.) = $local.name]"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Check </xsl:text> + <xsl:value-of select="$parent.name"/> + <xsl:text> title.</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <!-- Before 4.0, <articleinfo> was known as <artheader> --> + <xsl:when test="$parent.name = 'article' and ../artheader/*[local-name(.) = $local.name]"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Check </xsl:text> + <xsl:value-of select="$parent.name"/> + <xsl:text> title.</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="../blockinfo/*[local-name(.) = $local.name]"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Check </xsl:text> + <xsl:value-of select="$parent.name"/> + <xsl:text> title.</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <!-- always drop title, subtitle, and titleabbrev from refentryinfo --> + <xsl:when test="$parent.name = 'refentryinfo'"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Removing title in refentryinfo.</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <!-- Also drop title, subtitle, and titleabbrev when they appear after info. + The title is picked up and moved either into or before the info element + in the templates that handle info elements. --> + <xsl:when test="preceding-sibling::*[local-name(.) = concat($parent.name, 'info')]"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Removing </xsl:text><xsl:value-of select="$local.name"/> + <xsl:text> after </xsl:text><xsl:value-of select="$parent.name"/><xsl:text>info. Moved before or inside info.</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <!-- this covers block elements that use blockinfo--> + <xsl:when test="preceding-sibling::blockinfo"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Removing </xsl:text><xsl:value-of select="$local.name"/> + <xsl:text> after blockinfo. Moved before or inside info.</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <!-- The next clause removes title, subtitle, or titleabbrev if it was + moved inside the info block. Only happens when one or more of these + elements occurs both inside and outside the info element. --> + <xsl:when test="following-sibling::bookinfo[title|subtitle|titleabbrev] or + following-sibling::articleinfo[title|subtitle|titleabbrev] or + following-sibling::artheader[title|subtitle|titleabbrev] or + following-sibling::setinfo[title|subtitle|titleabbrev]"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Removing </xsl:text><xsl:value-of select="$local.name"/> + <xsl:text>. Has been moved inside info.</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:copy> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </xsl:copy> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<!-- Allow abstract inside valid biblio* elements, and inside info elements, otherwise drop --> +<xsl:template match="abstract" priority="300"> + <xsl:choose> + <xsl:when test="not(contains(name(parent::*),'info')) + and not(parent::biblioentry) and not(parent::bibliomixed) + and not(parent::bibliomset) and not(parent::biblioset)"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>CHECK abstract: removed from output (invalid location in 5.0).</xsl:text> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="." mode="copy"/> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="indexterm"> + <!-- don't copy the defaulted significance='normal' attribute --> + <indexterm> + <xsl:call-template name="copy.attributes"> + <xsl:with-param name="suppress"> + <xsl:if test="@significance = 'normal'">significance</xsl:if> + </xsl:with-param> + </xsl:call-template> + <xsl:apply-templates/> + </indexterm> +</xsl:template> + +<xsl:template match="ackno" priority="200"> + <acknowledgements> + <xsl:copy-of select="@*"/> + <para> + <xsl:apply-templates/> + </para> + </acknowledgements> +</xsl:template> + +<xsl:template match="lot|lotentry|tocback|tocchap|tocfront|toclevel1| + toclevel2|toclevel3|toclevel4|toclevel5|tocpart" priority="200"> + <tocdiv> + <xsl:copy-of select="@*"/> + <xsl:apply-templates/> + </tocdiv> +</xsl:template> + +<xsl:template match="action" priority="200"> + <phrase remap="action"> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </phrase> +</xsl:template> + +<xsl:template match="beginpage" priority="200"> + <xsl:comment> beginpage pagenum=<xsl:value-of select="@pagenum"/> </xsl:comment> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Replacing beginpage with comment</xsl:text> + </xsl:with-param> + </xsl:call-template> +</xsl:template> + +<xsl:template match="structname|structfield" priority="200"> + <varname remap="{local-name(.)}"> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </varname> +</xsl:template> + +<!-- ====================================================================== --> +<!-- glossterm and term have broader content models in 4.x than 5.0. + Warn when an unsupported element is found under glossterm. + Because the synopsis elements can contain things that phrase cannot, + leave them as is and warn. + For other elements, change them into phrase recursively and lose attributes. +--> +<xsl:template match="glossterm|term"> + <xsl:element name="{local-name(.)}"> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates mode="clean-terms"/> + </xsl:element> +</xsl:template> + +<!-- Any other elements inside term or glossterm which doesn't have a + template rule are copied +--> +<xsl:template match="*" mode="clean-terms"> + <xsl:apply-templates select="." mode="copy"/> +</xsl:template> + + +<!-- The synopsis elements have child elements that don't work inside phrase, plus + they have attributes that shouldn't be lost. So, leave as is, but warn. --> +<xsl:template match="classsynopsis|cmdsynopsis|constructorsynopsis + |destructorsynopsis|fieldsynopsis|methodsynopsis|synopsis" mode="clean-terms"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>CHECK OUTPUT: Found </xsl:text><xsl:value-of select="local-name(.)"/> + <xsl:text> inside </xsl:text><xsl:value-of select="local-name(..)"/> + </xsl:with-param> + </xsl:call-template> + <xsl:element name="{local-name(.)}"> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </xsl:element> +</xsl:template> + +<!-- The following elements probably can be safely turned into phrase recursively --> +<xsl:template match="authorinitials|corpcredit|interface|medialabel|othercredit|revhistory" mode="clean-terms"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Replacing </xsl:text><xsl:value-of select="local-name(.)"/> + <xsl:text> inside </xsl:text><xsl:value-of select="local-name(..)"/> + <xsl:text> with phrase.</xsl:text> + </xsl:with-param> + </xsl:call-template> + <phrase remap="{local-name(.)}"> + <!-- Don't copy attributes --> + <xsl:apply-templates mode="make-phrase"/> + </phrase> +</xsl:template> + +<!-- affiliation can appear in a much smaller number of elements in 5.0. But, it contains + elements that cannot appear in a phrase. So, replace all child elements, recursively, + with <phrase remap="element name"... Don't keep attributes, which won't work on phrase. --> + +<xsl:template match="affiliation[not(parent::author) and not(parent::collab) and not(parent::editor) and not(parent::org) and not(parent::othercredit) and not(parent::person)]"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>CHECK OUTPUT: Converting </xsl:text><xsl:value-of select="local-name(.)"/> + <xsl:text> to phrase in </xsl:text><xsl:value-of select="local-name(..)"/> + </xsl:with-param> + </xsl:call-template> + <phrase remap="{local-name(.)}"> + <!-- Don't copy attributes --> + <xsl:apply-templates mode="make-phrase"/> + </phrase> +</xsl:template> + +<!-- This template recursively changes an element with remap="name of element". + Does this recursively through children. --> +<xsl:template match="*" mode="make-phrase"> + <phrase remap="{local-name(.)}"> + <!-- Don't copy attributes --> + <xsl:apply-templates mode="make-phrase"/> + </phrase> +</xsl:template> + +<!-- ====================================================================== --> + +<!-- 6 Feb 2008, ndw changed mode=copy so that it only copies the first level, + then it switches back to "normal" mode so that other rewriting templates + catch embedded fixes --> + +<!-- +<xsl:template match="ulink" priority="200" mode="copy"> + <xsl:choose> + <xsl:when test="node()"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Converting ulink to phrase.</xsl:text> + </xsl:with-param> + </xsl:call-template> + + <phrase xlink:href="{@url}"> + <xsl:call-template name="copy.attributes"> + <xsl:with-param name="suppress" select="'url'"/> + </xsl:call-template> + <xsl:apply-templates/> + </phrase> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Converting ulink to uri.</xsl:text> + </xsl:with-param> + </xsl:call-template> + + <uri xlink:href="{@url}"> + <xsl:call-template name="copy.attributes"> + <xsl:with-param name="suppress" select="'url'"/> + </xsl:call-template> + <xsl:value-of select="@url"/> + </uri> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="sgmltag" priority="200" mode="copy"> + <tag> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </tag> +</xsl:template> +--> + +<xsl:template match="*" mode="copy"> + <xsl:copy> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </xsl:copy> +</xsl:template> + +<!-- +<xsl:template match="comment()|processing-instruction()|text()" mode="copy"> + <xsl:copy/> +</xsl:template> +--> + +<!-- ====================================================================== --> + +<xsl:template match="*"> + <xsl:copy> + <xsl:call-template name="copy.attributes"/> + <xsl:apply-templates/> + </xsl:copy> +</xsl:template> + +<xsl:template match="comment()|processing-instruction()|text()"> + <xsl:copy/> +</xsl:template> + +<!-- ====================================================================== --> + +<xsl:template name="copy.attributes"> + <xsl:param name="src" select="."/> + <xsl:param name="suppress" select="''"/> + <xsl:param name="suppress.default" select="''"/> + + <xsl:for-each select="$src/@*"> + <xsl:variable name="suppressed.value"> + <xsl:choose> + <xsl:when test="not(contains($suppress.default, concat(local-name(.),'=')))"> + <xsl:text>this-value-never-matches</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="substring-before(substring-after(concat($suppress.default,' '), concat(local-name(.),'=')),' ')"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <xsl:choose> + <xsl:when test="local-name(.) = 'moreinfo'"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Discarding moreinfo on </xsl:text> + <xsl:value-of select="local-name($src)"/> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:when test="local-name(.) = 'lang'"> + <xsl:attribute name="xml:lang"> + <xsl:value-of select="."/> + </xsl:attribute> + </xsl:when> + <xsl:when test="local-name(.) = 'id'"> + <xsl:attribute name="xml:id"> + <xsl:value-of select="."/> + </xsl:attribute> + </xsl:when> + <xsl:when test="$suppress = local-name(.)"/> + <xsl:when test=". = $suppressed.value"/> + <xsl:when test="local-name(.) = 'float'"> + <xsl:choose> + <xsl:when test=". = '1'"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Discarding float on </xsl:text> + <xsl:value-of select="local-name($src)"/> + </xsl:with-param> + </xsl:call-template> + <xsl:if test="not($src/@floatstyle)"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Adding floatstyle='normal' on </xsl:text> + <xsl:value-of select="local-name($src)"/> + </xsl:with-param> + </xsl:call-template> + <xsl:attribute name="floatstyle"> + <xsl:text>normal</xsl:text> + </xsl:attribute> + </xsl:if> + </xsl:when> + <xsl:when test=". = '0'"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Discarding float on </xsl:text> + <xsl:value-of select="local-name($src)"/> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Discarding float on </xsl:text> + <xsl:value-of select="local-name($src)"/> + </xsl:with-param> + </xsl:call-template> + <xsl:if test="not($src/@floatstyle)"> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Adding floatstyle='</xsl:text> + <xsl:value-of select="."/> + <xsl:text>' on </xsl:text> + <xsl:value-of select="local-name($src)"/> + </xsl:with-param> + </xsl:call-template> + <xsl:attribute name="floatstyle"> + <xsl:value-of select="."/> + </xsl:attribute> + </xsl:if> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:when test="local-name(.) = 'entityref'"> + <xsl:attribute name="fileref"> + <xsl:value-of select="unparsed-entity-uri(@entityref)"/> + </xsl:attribute> + </xsl:when> + + <xsl:when test="local-name($src) = 'simplemsgentry' + and local-name(.) = 'audience'"> + <xsl:attribute name="msgaud"> + <xsl:value-of select="."/> + </xsl:attribute> + </xsl:when> + <xsl:when test="local-name($src) = 'simplemsgentry' + and local-name(.) = 'origin'"> + <xsl:attribute name="msgorig"> + <xsl:value-of select="."/> + </xsl:attribute> + </xsl:when> + <xsl:when test="local-name($src) = 'simplemsgentry' + and local-name(.) = 'level'"> + <xsl:attribute name="msglevel"> + <xsl:value-of select="."/> + </xsl:attribute> + </xsl:when> + + <!-- * for upgrading XSL litprog params documentation --> + <xsl:when test="local-name($src) = 'refmiscinfo' + and local-name(.) = 'role' + and . = 'type' + "> + <xsl:call-template name="emit-message"> + <xsl:with-param name="message"> + <xsl:text>Converting refmiscinfo@role=type to </xsl:text> + <xsl:text>@class=other,otherclass=type</xsl:text> + </xsl:with-param> + </xsl:call-template> + <xsl:attribute name="class">other</xsl:attribute> + <xsl:attribute name="otherclass">type</xsl:attribute> + </xsl:when> + + <xsl:otherwise> + <xsl:copy/> + </xsl:otherwise> + </xsl:choose> + </xsl:for-each> +</xsl:template> + +<!-- ====================================================================== --> + +<xsl:template match="*" mode="addNS"> + <xsl:choose> + <xsl:when test="namespace-uri(.) = ''"> + <xsl:element name="{local-name(.)}" + namespace="http://docbook.org/ns/docbook"> + <xsl:if test="not(ancestor::*[namespace-uri(.)=''])"> + <xsl:attribute name="version"><xsl:value-of select="$db5.version.string"/></xsl:attribute> + </xsl:if> + <xsl:copy-of select="@*"/> + <xsl:apply-templates mode="addNS"/> + </xsl:element> + </xsl:when> + <xsl:otherwise> + <xsl:copy> + <xsl:if test="namespace-uri(.) = 'http://docbook.org/ns/docbook' and + not(ancestor::*[namespace-uri(.)='http://docbook.org/ns/docbook'])"> + <xsl:attribute name="version"><xsl:value-of select="$db5.version.string"/></xsl:attribute> + </xsl:if> + <xsl:copy-of select="@*"/> + <xsl:apply-templates mode="addNS"/> + </xsl:copy> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="comment()|processing-instruction()|text()" mode="addNS"> + <xsl:copy/> +</xsl:template> + +<!-- ====================================================================== --> + +<xsl:template name="emit-message"> + <xsl:param name="message"/> + <xsl:message> + <xsl:value-of select="$message"/> + <xsl:text> (</xsl:text> + <xsl:value-of select="$rootid"/> + <xsl:text>)</xsl:text> + </xsl:message> +</xsl:template> + +</xsl:stylesheet> 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> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglBindAPI.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglBindAPI.xml new file mode 100644 index 0000000..0874cb3 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglBindAPI.xml @@ -0,0 +1,123 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglBindAPI"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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>eglSwapInterval</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 xml: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 xml: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 xml: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>eglSwapInterval</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitClient</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglBindTexImage.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglBindTexImage.xml new file mode 100644 index 0000000..81779e3 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglBindTexImage.xml @@ -0,0 +1,172 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglBindTexImage"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglReleaseTexImage</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglChooseConfig.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglChooseConfig.xml new file mode 100644 index 0000000..87c7ce1 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglChooseConfig.xml @@ -0,0 +1,915 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglChooseConfig"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 OpenVG. + </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 platforms do not support buffer levels other than + zero. The behavior of windows placed in overlay and + underlay planes depends on the underlying platform. + </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 + <constant>EGL_WINDOW_BIT</constant> | + <constant>EGL_PIXMAP_BIT</constant>, + 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 xml: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 xml: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 xml: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 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglClientWaitSync.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglClientWaitSync.xml new file mode 100644 index 0000000..a6b7478 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglClientWaitSync.xml @@ -0,0 +1,161 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglClientWaitSync"> + <info> + <copyright> + <year>2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <refmeta> + <refentrytitle>eglClientWaitSync</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglClientWaitSync</refname> + <refpurpose> + Wait in the client for a sync object to be signalled + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLint <function>eglClientWaitSync</function></funcdef> + <paramdef>(EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLSync <parameter>sync</parameter></paramdef> + <paramdef>EGLint <parameter>flags</parameter></paramdef> + <paramdef>EGLTime <parameter>timeout</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 xml: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>sync</parameter></term> + <listitem><para> + Specifies the sync object to wait on. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem><para> + Specifies flags controlling wait behavior. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem><para> + Specifies wait timeout interval. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 xml:id="description"><title>Description</title> + <para> + <function>eglClientWaitSync</function> blocks the calling thread + until the specified sync object <parameter>sync</parameter> is + signaled, or until <parameter>timeout</parameter> nanoseconds + have passed. + </para> + <para> + More than one <function>eglClientWaitSync</function> may be + outstanding on the same <parameter>sync</parameter> at any given + time. When there are multiple threads blocked on the same + <parameter>sync</parameter> and the sync object is signaled, all + such threads are released, but the order in which they are + released is not defined. + </para> + <para> + If the value of <parameter>timeout</parameter> is zero, then + <function>eglClientWaitSync</function> simply tests the current + status of <parameter>sync</parameter>. If the value of + <parameter>timeout</parameter> is the special value + <constant>EGL_FOREVER</constant>, then + <function>eglClientWaitSync</function> does not time out. For + all other values, <parameter>timeout</parameter> is adjusted to + the closest value allowed by the implementation-dependent + timeout accuracy, which may be substantially longer than one + nanosecond. + </para> + <para> + <function>eglClientWaitSync</function> returns one of three + status values describing the reason for returning. A return + value of <constant>EGL_TIMEOUT_EXPIRED</constant> indicates that + the specified timeout period expired before + <parameter>sync</parameter> was signaled, or if + <parameter>timeout</parameter> is zero, indicates that + <parameter>sync</parameter> is not signaled. A return value of + <constant>EGL_CONDITION_SATISFIED</constant> indicates that + <parameter>sync</parameter> was signaled before the timeout + expired, which includes the case when + <parameter>sync</parameter> was already signaled when + <function>eglClientWaitSync</function> was called. If an error + occurs then an error is generated and + <constant>EGL_FALSE</constant> is returned. + </para> + <para> + If the sync object being blocked upon will not be signaled in + finite time (for example, by an associated fence command issued + previously, but not yet flushed to the graphics pipeline), then + <function>eglClientWaitSync</function> may wait forever. To help + prevent this behavior, if the + <constant>EGL_SYNC_FLUSH_COMMANDS_BIT</constant> bit is set in + <parameter>flags</parameter>, and <parameter>sync</parameter> is + unsignaled when <function>eglClientWaitSync</function> is + called, then the equivalent of Flush() will be performed for the + current API context (i.e., the context returned by + <function>eglGetCurrentContext</function>) before blocking on + <parameter>sync</parameter>. If no context is current for the + bound API, the <constant>EGL_SYNC_FLUSH_COMMANDS_BIT</constant> + bit is ignored. + </para> + <para> + Note: the simple Flush behavior defined by + <constant>EGL_SYNC_FLUSH_COMMANDS_BIT</constant> will not help + when waiting for a fence command issued in a different context's + command stream. Applications which block on a fence sync object + must take additional steps to ensure that the context from which + the associated fence command was issued has flushed that command + to the graphics pipeline. + </para> + </refsect1> + <refsect1 xml:id="errors"><title>Errors</title> + <para> + <function>eglClientWaitSync</function> returns + <constant>EGL_FALSE</constant> on failure. + </para> + <para> + If <parameter>sync</parameter> is not a valid sync object for + <parameter>display</parameter>, an + <constant>EGL_BAD_PARAMETER</constant> error is generated. + </para> + <para> + If <parameter>display</parameter> does not match the + <type>EGLDisplay</type> passed to + <function>eglCreateSync</function> when + <parameter>sync</parameter> was created, the behaviour is + undefined. + </para> + </refsect1> + <refsect1 xml:id="notes"><title>Notes</title> + <para> + <function>eglClientWaitSync</function> is available only if the + EGL version is 1.5 or greater. + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateSync</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitSync</refentrytitle></citerefentry>, + <function>glFinish</function>, + <function>vgFinish</function> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglCopyBuffers.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglCopyBuffers.xml new file mode 100644 index 0000000..0541f20 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglCopyBuffers.xml @@ -0,0 +1,120 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglCopyBuffers"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml:id="notes"><title>Notes</title> + <para> + The color buffer of <parameter>surface</parameter> is left unchanged + after calling <function>eglCopyBuffers</function>. + </para> + </refsect1> + <refsect1 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglCreateContext.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglCreateContext.xml new file mode 100644 index 0000000..73c54b6 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglCreateContext.xml @@ -0,0 +1,212 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglCreateContext"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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_MAJOR_VERSION</constant></term> + <listitem><para> + Must be followed by an integer specifying the requested + major version of an OpenGL or OpenGL ES context. The + default value is 1. This attribute is an alias of the + older <constant>EGL_CONTEXT_CLIENT_VERSION</constant>, + and the tokens may be used interchangeably. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONTEXT_MINOR_VERSION</constant></term> + <listitem><para> + Must be followed by an integer specifying the requested + minor version of an OpenGL or OpenGL ES context. The + default value is 0. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONTEXT_OPENGL_PROFILE_MASK</constant></term> + <listitem><para> + Must be followed by an integer bitmask specifying the + <firstterm>profile</firstterm> of an OpenGL context. + Bits which may be set include + <constant>EGL_CONTEXT_OPENGL_CORE_PROFILE_BIT</constant> + for a core profile and + <constant>EGL_CONTEXT_OPENGL_COMPATIBILITY_PROFILE_BIT</constant> + for a compatibility profile. The default value is + <constant>EGL_CONTEXT_OPENGL_CORE_PROFILE_BIT</constant>. + All OpenGL 3.2 and later implementations are required to + implement the core profile, but implementation of the + compatibility profile is optional. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONTEXT_OPENGL_DEBUG</constant></term> + <listitem><para> + Must be followed by <constant>EGL_TRUE</constant>, + specifying that an OpenGL or OpenGL ES <firstterm>debug + context</firstterm> should be created, or + <constant>EGL_FALSE</constant>, if a non-debug context + should be created. The default value is + <constant>EGL_FALSE</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONTEXT_OPENGL_FORWARD_COMPATIBLE</constant></term> + <listitem><para> + Must be followed by <constant>EGL_TRUE</constant>, + specifying that a + <firstterm>forward-compatible</firstterm> OpenGL context + should be created, or <constant>EGL_FALSE</constant>, if + a non-forward-compatible context should be created. The + default value is <constant>EGL_FALSE</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONTEXT_OPENGL_ROBUST_ACCESS</constant></term> + <listitem><para> + Must be followed by <constant>EGL_TRUE</constant>, + specifying that an OpenGL or OpenGL ES context + supporting <firstterm>robust buffer access</firstterm> + should be created, or <constant>EGL_FALSE</constant>, if + a non-robust context should be created. The default + value is <constant>EGL_FALSE</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_CONTEXT_OPENGL_RESET_NOTIFICATION_STRATEGY</constant></term> + <listitem><para> + Must be followed by + <constant>EGL_LOSE_CONTEXT_ON_RESET</constant>, + specifying that an OpenGL or OpenGL ES context with + reset notification behavior + <constant>GL_LOSE_CONTEXT_ON_RESET_ARB</constant> should + be created, or + <constant>EGL_NO_RESET_NOTIFICATION</constant>, + specifying that an OpenGL or OpenGL ES context with + reset notification behavior + <constant>GL_NO_RESET_NOTIFICATION_ARB</constant> should + be created, as described by the + <constant>GL_ARB_robustness</constant> extension. + </para><para> + If the + <constant>EGL_CONTEXT_OPENGL_ROBUST_ACCESS</constant> + attribute is not set to <constant>EGL_TRUE</constant>, + context creation will not fail, but the resulting + context may not support robust buffer access, and + therefore may not support the requested reset + notification strategy The default value for + <constant>EGL_CONTEXT_OPENGL_RESET_NOTIFICATION_STRATEGY</constant> + is <constant>EGL_NO_RESET_NOTIFICATION</constant> . + </para></listitem> + </varlistentry> + </variablelist> + <para> + There are many possible interactions between requested OpenGL + and OpenGL ES context creation attributes, depending on the API + versions and extensions supported by the implementation. These + interactions are described in detail in the EGL 1.5 + Specification, but are not listed here for compactness. The + requested attributes may not be able to be satisfied, but + context creation may still succeed. Applications should ensure + that the OpenGL or OpenGL ES contexts supports needed features + before using them, by determining the actual context version, + supported extensions, and supported context flags using runtime + queries. + </para> + </refsect1> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglCreateImage.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglCreateImage.xml new file mode 100644 index 0000000..8072ec3 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglCreateImage.xml @@ -0,0 +1,624 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglCreateImage"> + <info> + <copyright> + <year>2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <refmeta> + <refentrytitle>eglCreateImage</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglCreateImage</refname> + <refpurpose> + Create a new <type>EGLImage</type> object + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLImage <function>eglCreateImage</function></funcdef> + <paramdef>(EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLContext <parameter>context</parameter></paramdef> + <paramdef>EGLenum <parameter>target</parameter></paramdef> + <paramdef>EGLClientBuffer <parameter>buffer</parameter></paramdef> + <paramdef>const EGLAttrib *<parameter>attrib_list</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 xml: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>context</parameter></term> + <listitem><para> + Specifies the client API context for which the image is + created. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>target</parameter></term> + <listitem><para> + Specifies the type of resource used as the image source. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>buffer</parameter></term> + <listitem><para> + Specifies the resource to be used as the image source. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrib_list</parameter></term> + <listitem><para> + Specifies attributes used to select sub-sections of the + resource to be used as the image source. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 xml:id="description"><title>Description</title> + <para> + <function>eglCreateImage</function> is used to create an + <type>EGLImage</type> object from an existing image resource + <parameter>buffer</parameter>. <parameter>display</parameter> + specifies the EGL display used for this operation. + <parameter>context</parameter> specifies the EGL client API + context used for this operation, or + <constant>EGL_NO_CONTEXT</constant> if a client API context is + not required. <parameter>target</parameter> specifies the type + of resource being used as the <type>EGLImage</type> source + (examples include two-dimensional textures in OpenGL ES contexts + and <type>VGImage</type> objects in OpenVG contexts). + <parameter>buffer</parameter> is the name (or handle) of a + resource to be used as the <type>EGLImage</type> source, cast + into the type <type>EGLClientBuffer</type>. + <parameter>attrib_list</parameter> is a list of attribute-value + pairs which is used to select sub-sections of + <parameter>buffer</parameter> for use as the + <type>EGLImage</type> source, such as mipmap levels for OpenGL + ES texture map resources, as well as behavioral options, such as + whether to preserve pixel data during creation. If + <parameter>attrib_list</parameter> is + non-<constant>NULL</constant>, the last attribute specified in + the list must be <constant>EGL_NONE</constant>. + </para> + <para> + The resource specified by <parameter>display</parameter>, + <parameter>context</parameter>, <parameter>target</parameter>, + <parameter>buffer</parameter>, and + <parameter>attrib_list</parameter> must not itself be an + <type>EGLImage</type> sibling, or bound to a pbuffer + <type>EGLSurface</type> resource + (<function>eglBindTexImage</function>, + <function>eglCreatePbufferFromClientBuffer</function>). + </para> + <para> + Values accepted for <parameter>target</parameter> are shown in + table <xref linkend="tab-imagetarget"/>. + </para> + <table frame="all" xml:id="tab-imagetarget"> + <title> + Legal values for <function>eglCreateImage</function> <parameter>target</parameter> + </title> + <tgroup cols="2" align="left" colsep="1" rowsep="1"> + <thead> + <row> + <entry><parameter>target</parameter></entry> + <entry>Notes</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>EGL_GL_TEXTURE_2D</constant></entry> + <entry>Used for GL 2D texture images</entry> + </row> + <row> + <entry><constant>EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant></entry> + <entry>Used for the +X face of GL cubemap texture images</entry> + </row> + <row> + <entry><constant>EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant></entry> + <entry>Used for the -X face of GL cubemap texture images</entry> + </row> + <row> + <entry><constant>EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant></entry> + <entry>Used for the +Y face of GL cubemap texture images</entry> + </row> + <row> + <entry><constant>EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant></entry> + <entry>Used for the -Y face of GL cubemap texture images</entry> + </row> + <row> + <entry><constant>EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant></entry> + <entry>Used for the +Z face of GL cubemap texture images</entry> + </row> + <row> + <entry><constant>EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant></entry> + <entry>Used for the -Z face of GL cubemap texture images</entry> + </row> + <row> + <entry><constant>EGL_GL_TEXTURE_3D</constant></entry> + <entry>Used for OpenGL and OpenGL ES 3D texture images</entry> + </row> + <row> + <entry><constant>EGL_GL_RENDERBUFFER</constant></entry> + <entry>Used for OpenGL and OpenGL ES renderbuffer images</entry> + </row> + </tbody> + </tgroup> + </table> + <para> + Attribute names accepted in <parameter>attrib_list</parameter> + are shown in table <xref linkend="tab-imageattr"/>, together + with the <parameter>target</parameter> for which each attribute + name is valid, and the default value used for each attribute if + it is not included in <parameter>attrib_list</parameter>. + </para> + <table frame="all" xml:id="tab-imageattr"> + <title> + Legal attributes for <function>eglCreateImage</function> + <parameter>attrib_list</parameter> parameter + </title> + <tgroup cols="4" align="left" colsep="1" rowsep="1"> + <thead> + <row> + <entry><parameter>target</parameter></entry> + <entry>Notes</entry> + </row> + </thead> + <tbody> + <row> + <entry>Attribute</entry> + <entry>Description</entry> + <entry>Valid <parameter>target</parameter>s</entry> + <entry>Default Value</entry> + </row> + <row> + <entry><constant>EGL_NONE</constant></entry> + <entry>Marks the end of the attribute-value list</entry> + <entry>All</entry> + <entry>N/A</entry> + </row> + <row> + <entry><constant>EGL_GL_TEXTURE_LEVEL</constant></entry> + <entry> + Specifies the mipmap level used as the + <type>EGLImage</type> source. Must be part of + the complete texture object + <parameter>buffer</parameter> + </entry> + <entry> + <constant>EGL_GL_TEXTURE_2D</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_*</constant>, or + <constant>EGL_GL_TEXTURE_3D</constant> + </entry> + <entry>0</entry> + </row> + <row> + <entry><constant>EGL_GL_TEXTURE_ZOFFSET</constant></entry> + <entry> + Specifies the depth offset of the image to use + as the <type>EGLImage</type> source. Must be + part of the complete texture object + <parameter>buffer</parameter> + </entry> + <entry><constant>EGL_GL_TEXTURE_3D</constant></entry> + <entry>0</entry> + </row> + <row> + <entry><constant>EGL_IMAGE_PRESERVED</constant></entry> + <entry>Whether to preserve pixel data</entry> + <entry>All</entry> + <entry><constant>EGL_FALSE</constant></entry> + </row> + </tbody> + </tgroup> + </table> + <para> + <function>eglCreateImage</function> returns an + <type>EGLImage</type> object corresponding to the image data + specified by <parameter>display</parameter>, + <parameter>context</parameter>, <parameter>target</parameter>, + <parameter>buffer</parameter> and + <parameter>attrib_list</parameter> which may be referenced by + client API operations. + </para> + <para> + If <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_2D</constant>, + <constant>EGL_GL_TEXTURE_3D</constant>, + <constant>EGL_GL_RENDERBUFFER</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>, or + <constant>EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>, + <parameter>display</parameter> must be a valid + <type>EGLDisplay</type>, and <parameter>context</parameter> must + be a valid OpenGL or OpenGL ES API context on that display. + </para> + <para> + If <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_2D</constant>, + <parameter>buffer</parameter> must be the name of a nonzero, + <constant>GL_TEXTURE_2D</constant> target texture object, cast + into the type <type>EGLClientBuffer</type>. + </para> + <para> + If <parameter>target</parameter> is one of the + <constant>EGL_GL_TEXTURE_CUBE_MAP_*</constant> enumerants, + <parameter>buffer</parameter> must be the name of a nonzero, + <constant>GL_TEXTURE_CUBE_MAP</constant> (or equivalent in GL + extensions) target texture object, cast into the type + <type>EGLClientBuffer</type>. + </para> + <para> + If <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_3D</constant>, + <parameter>buffer</parameter> must be the name of a nonzero, + <constant>GL_TEXTURE_3D</constant> (or equivalent in GL + extensions) target texture object, cast into the type + <type>EGLClientBuffer</type>. + </para> + <para> + <parameter>attrib_list</parameter> should specify the mipmap + level (<constant>EGL_GL_TEXTURE_LEVEL</constant>) and, where + applicable, z-offset + (<constant>EGL_GL_TEXTURE_ZOFFSET</constant>) which will be used + as the <type>EGLImage</type> source; If not specified, the + default values listed in table <xref linkend="tab-imageattr"/> + will be used instead. Additional values specified in are + ignored. + </para> + <para> + There must exist some levels <emphasis>x</emphasis> and + <emphasis>y</emphasis> such that the mipmap level requested lies + between <emphasis>x</emphasis> and <emphasis>y</emphasis> + (inclusive), the texture would be mipmap complete were + <emphasis>x</emphasis> substituted for the base level and + <emphasis>y</emphasis> substituted for the max level, and all + levels less than <emphasis>x</emphasis> or greater than + <emphasis>y</emphasis> are unspecified. For cubemaps a single + pair <emphasis>x</emphasis> and <emphasis>y</emphasis> must + apply to all faces. For three-dimensional textures, the + specified z-offset must be smaller than the depth of the + specified mipmap level. + </para> + <para> + If <parameter>target</parameter> is + <constant>EGL_GL_RENDERBUFFER</constant>, + <parameter>buffer</parameter> must be the name of a complete, + nonzero, non-multisampled <constant>GL_RENDERBUFFER</constant> + (or equivalent in extensions) target object, cast into the type + <type>EGLClientBuffer</type>. Values specified in + <parameter>attrib_list</parameter> are ignored. + </para> + <para> + If the value of attribute + <constant>EGL_IMAGE_PRESERVED</constant> is + <constant>EGL_FALSE</constant> (the default), then all pixel + data values associated with <parameter>buffer</parameter> will + be undefined after <function>eglCreateImage</function> returns. + </para> + <para> + If the value of attribute + <constant>EGL_IMAGE_PRESERVED</constant> is + <constant>EGL_TRUE</constant>, then all pixel data values + associated with <parameter>buffer</parameter> are preserved. + </para> + </refsect1> + <refsect1 xml:id="errors"><title>Errors</title> + <para> + <function>eglCreateImage</function> returns + <constant>EGL_NO_IMAGE</constant> on failure. The contents of + <parameter>buffer</parameter> will be unaffected. + </para> + <para> + If <parameter>display</parameter> is not the handle of a valid + <type>EGLDisplay</type> object, the error + <constant>EGL_BAD_DISPLAY</constant> is generated. + </para> + <para> + If <parameter>context</parameter> is neither the handle of a + valid <type>EGLContext</type> object on + <parameter>display</parameter> nor + <constant>EGL_NO_CONTEXT</constant>, the error + <constant>EGL_BAD_CONTEXT</constant> is generated. + </para> + <para> + If <parameter>target</parameter> is not one of the values in + table <xref linkend="tab-imagetarget"/>, the error + <constant>EGL_BAD_PARAMETER</constant> is generated. + </para> + <para> + If <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_2D</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_*</constant>, + <constant>EGL_GL_RENDERBUFFER</constant> or + <constant>EGL_GL_TEXTURE_3D</constant>, and + <parameter>display</parameter> is not a valid + <type>EGLDisplay</type>, the error + <constant>EGL_BAD_DISPLAY</constant> is generated. + </para> + <para> + If <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_2D</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_*</constant>, + <constant>EGL_GL_RENDERBUFFER</constant> or + <constant>EGL_GL_TEXTURE_3D</constant>, and + <parameter>context</parameter> is not a valid + <type>EGLContext</type>, the error + <constant>EGL_BAD_CONTEXT</constant> is generated. + </para> + <para> + If <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_2D</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_*</constant>, + <constant>EGL_GL_RENDERBUFFER</constant> or + <constant>EGL_GL_TEXTURE_3D</constant>, and + <parameter>context</parameter> is not a valid GL context, or + does not match the <parameter>display</parameter>, the error + <constant>EGL_BAD_MATCH</constant> is generated. + </para> + <para> + If <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_2D</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_*</constant> or + <constant>EGL_GL_TEXTURE_3D</constant> and + <parameter>buffer</parameter> is not the name of a texture + object of type <parameter>target</parameter>, the error + <constant>EGL_BAD_PARAMETER</constant> is generated. + </para> + <para> + If <parameter>target</parameter> is + <constant>EGL_GL_RENDERBUFFER</constant> and + <parameter>buffer</parameter> is not the name of a renderbuffer + object, or if <parameter>buffer</parameter> is the name of a + multisampled renderbuffer object, the error + <constant>EGL_BAD_PARAMETER</constant> is generated. + </para> + <para> + If <constant>EGL_GL_TEXTURE_LEVEL</constant> is nonzero, + <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_2D</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_*</constant> or + <constant>EGL_GL_TEXTURE_3D</constant>, and + <parameter>buffer</parameter> is not the name of a complete GL + texture object, the error <constant>EGL_BAD_PARAMETER</constant> + is generated. + </para> + <para> + If <constant>EGL_GL_TEXTURE_LEVEL</constant> is 0, + <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_2D</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_*</constant> or + <constant>EGL_GL_TEXTURE_3D</constant>, + <parameter>buffer</parameter> is the name of an incomplete GL + texture object, and any mipmap levels other than mipmap level 0 + are specified, the error <constant>EGL_BAD_PARAMETER</constant> + is generated. + </para> + <para> + If <constant>EGL_GL_TEXTURE_LEVEL</constant> is 0, + <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_2D</constant> or + <constant>EGL_GL_TEXTURE_3D</constant>, + <parameter>buffer</parameter> is not the name of a complete GL + texture object, and mipmap level 0 is not specified, the error + <constant>EGL_BAD_PARAMETER</constant> is generated. + </para> + <para> + If <constant>EGL_GL_TEXTURE_LEVEL</constant> is 0, + <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_CUBE_MAP_*</constant>, + <parameter>buffer</parameter> is not the name of a complete GL + texture object, and one or more faces do not have mipmap level 0 + specified, the error <constant>EGL_BAD_PARAMETER</constant> is + generated. + </para> + <para> + If <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_2D</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_*</constant>, + <constant>EGL_GL_RENDERBUFFER</constant> or + <constant>EGL_GL_TEXTURE_3D</constant> and + <parameter>buffer</parameter> refers to the default GL texture + object (0) for the corresponding GL target, the error + <constant>EGL_BAD_PARAMETER</constant> is generated. + </para> + <para> + If <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_2D</constant>, + <constant>EGL_GL_TEXTURE_CUBE_MAP_*</constant>, or + <constant>EGL_GL_TEXTURE_3D</constant>, and the value specified + in <parameter>attrib_list</parameter> for + <constant>EGL_GL_TEXTURE_LEVEL</constant> is not a valid mipmap + level for the specified GL texture object + <parameter>buffer</parameter>, the error + <constant>EGL_BAD_MATCH</constant> is generated. + </para> + <para> + If <parameter>target</parameter> is + <constant>EGL_GL_TEXTURE_3D</constant>, and the value specified + in <parameter>attrib_list</parameter> for + <constant>EGL_GL_TEXTURE_ZOFFSET</constant> exceeds the depth of + the specified mipmap level-of-detail in + <parameter>buffer</parameter>, the error + <constant>EGL_BAD_PARAMETER</constant> is generated. + </para> + <para> + If an attribute specified in <parameter>attrib_list</parameter> + is not one of the attributes shown in table <xref + linkend="tab-imageattr"/>, the error + <constant>EGL_BAD_PARAMETER</constant> is generated. + </para> + <para> + If an attribute specified in <parameter>attrib_list</parameter> + is not a valid attribute for <parameter>target</parameter>, as + shown in table <xref linkend="tab-imageattr"/>, the error + <constant>EGL_BAD_MATCH</constant> is generated. + </para> + <para> + If the resource specified by <parameter>display</parameter>, + <parameter>context</parameter>, <parameter>target</parameter>, + <parameter>buffer</parameter> and + <parameter>attrib_list</parameter> has an off-screen buffer + bound to it (e.g., by a previous call to + <function>eglBindTexImage</function>), the error + <constant>EGL_BAD_ACCESS</constant> is generated. + </para> + <para> + If the resource specified by <parameter>display</parameter>, + <parameter>context</parameter>, <parameter>target</parameter>, + <parameter>buffer</parameter> and + <parameter>attrib_list</parameter> is bound to an off-screen + buffer (e.g., by a previous call to + <function>eglCreatePbufferFromClientBuffer</function>), the + error <constant>EGL_BAD_ACCESS</constant> is generated. + </para> + <para> + If the resource specified by <parameter>display</parameter>, + <parameter>context</parameter>, <parameter>target</parameter>, + <parameter>buffer</parameter> and + <parameter>attrib_list</parameter> is itself an + <type>EGLImage</type> sibling, the error + <constant>EGL_BAD_ACCESS</constant> is generated. + </para> + <para> + If insufficient memory is available to complete the specified + operation, the error <constant>EGL_BAD_ALLOC</constant> is + generated. + </para> + <para> + If the value specified in <parameter>attrib_list</parameter> for + <constant>EGL_IMAGE_PRESERVED</constant> is + <constant>EGL_TRUE</constant>, and an <type>EGLImage</type> + handle cannot be created from the specified resource such that + the pixel data values in <parameter>buffer</parameter> are + preserved, the error <constant>EGL_BAD_ACCESS</constant> is + generated. + </para> + <para> + Note that the success or failure of + <function>eglCreateImage</function> should not affect the + ability to use <parameter>buffer</parameter> in its original API + context (or context share group) (although the pixel data values + will be undefined if the command succeeds and the value of + <constant>EGL_IMAGE_PRESERVED</constant> is not + <constant>EGL_TRUE</constant>). + </para> + </refsect1> + <refsect1 xml:id="lifetime"><title>Lifetime and Usage of <type>EGLImage</type>s</title> + <para> + Once an <type>EGLImage</type> is created from an + <type>EGLImage</type> source, the memory associated with the + <type>EGLImage</type> source will remain allocated (and all + <type>EGLImage</type> siblings in all client API contexts will + be useable) as long as either of the following conditions is + true: + </para> + <para> + <itemizedlist> + <listitem> + <para> + Any <type>EGLImage</type> siblings exist in any client + API context + </para> + </listitem> + <listitem> + <para> + The <type>EGLImage</type> object exists inside EGL + </para> + </listitem> + </itemizedlist> + </para> + <para> + The semantics for specifying, deleting and using + <type>EGLImage</type> siblings are client API-specific, and are + described in the appropriate API specifications. + </para> + <para> + If an application specifies an <type>EGLImage</type> sibling as + the destination for rendering and/or pixel download operations + (e.g., as an OpenGL or OpenGL ES framebuffer object, + <function>glTexSubImage2D</function>, etc.), the modified image + results will be observed by all <type>EGLImage</type> siblings + in all client API contexts. If multiple client API contexts + access <type>EGLImage</type> sibling resources simultaneously, + with one or more context modifying the image data, rendering + results in all contexts accessing <type>EGLImage</type> siblings + are undefined. + </para> + <para> + Respecification and/or deletion of any <type>EGLImage</type> + sibling (i.e., both <type>EGLImage</type> source and + <type>EGLImage</type> target resources) inside a client API + context (by issuing a subsequent call to commands such as + <function>glTexImage*</function> or + <function>glDeleteTextures</function>, with the + <type>EGLImage</type> sibling resource as the target of the + operation) affects only that client API context and other + contexts within its share group. For an OpenGL or OpenGL ES + context, respecification always results in + <firstterm>orphaning</firstterm> of the <type>EGLImage</type>, + and may also include allocation of additional memory for the + respecified resource and/or copying of the <type>EGLImage</type> + pixel data. + </para> + <para> + Note: Behavior of other types of client APIs generally follows + the OpenGL and OpenGL ES behavior described here, although this + is not mandated yet. + </para> + <para> + Operations inside EGL or any client API context which may affect + the lifetime of an <type>EGLImage</type> (or the memory + allocated for the <type>EGLImage</type>), such as respecifying + and/or deleting an <type>EGLImage</type> sibling inside a client + API context, must be atomic. + </para> + <para> + Applications may create client API resources from an + <type>EGLImage</type> using client API extensions outside the + scope of this document (such as + <constant>GL_OES_EGL_image</constant>, which creates OpenGL ES + texture and renderbuffer objects). If the <type>EGLImage</type> + used to create the client resource was created with the + <constant>EGL_IMAGE_PRESERVED</constant> attribute set to + <constant>EGL_TRUE</constant>, then the pixel data values + associated with the image will be preserved after creating the + client resource; otherwise, the pixel data values will be + undefined. If the <type>EGLImage</type> was created with the + <constant>EGL_IMAGE_PRESERVED</constant> attribute set to + <constant>EGL_TRUE</constant>, and EGL is unable to create the + client resource without modifying the pixel values, then + creation will fail and the pixel data values will be preserved. + </para> + </refsect1> + <refsect1 xml:id="notes"><title>Notes</title> + <para> + <function>eglCreateImage</function> is available only if the EGL + version is 1.5 or greater. + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglBindTexImage</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreatePbufferFromClientBuffer</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglDestroyImage</refentrytitle></citerefentry>, + <function>glDeleteTextures</function>, + <function>glTexImage*</function>, + <function>glTexSubImage2D</function> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePbufferFromClientBuffer.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePbufferFromClientBuffer.xml new file mode 100644 index 0000000..5c60017 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePbufferFromClientBuffer.xml @@ -0,0 +1,386 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglCreatePbufferFromClientBuffer"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml: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_ACCESS</constant> is generated if the buffers + contained in <parameter>buffer</parameter> consist of any + <type>EGLImage</type> siblings. + </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 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePbufferSurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePbufferSurface.xml new file mode 100644 index 0000000..5bb7c8e --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePbufferSurface.xml @@ -0,0 +1,359 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglCreatePbufferSurface"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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_GL_COLORSPACE</constant></term> + <listitem> + <para> + Specifies the color space used by OpenGL and OpenGL ES + when rendering to the surface. If its value is + <constant>EGL_GL_COLORSPACE_SRGB</constant>, then a + non-linear, perceptually uniform color space is assumed, + with a corresponding + <constant>GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING</constant> + value of <constant>GL_SRGB</constant>. If its value is + <constant>EGL_GL_COLORSPACE_LINEAR</constant>, then a + linear color space is assumed, with a corresponding + <constant>GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING</constant> + value of <constant>GL_LINEAR</constant>. The default + value of <constant>EGL_GL_COLORSPACE</constant> is + <constant>EGL_GL_COLORSPACE_LINEAR</constant>. + </para> + <para> + Note that the <constant>EGL_GL_COLORSPACE</constant> + attribute is used only by OpenGL and OpenGL ES contexts + supporting sRGB framebuffers. EGL itself does not + distinguish multiple colorspace models. Refer to the + ``sRGB Conversion'' sections of the OpenGL 4.6 and + OpenGL ES 3.2 Specifications for more information. + </para> + </listitem> + </varlistentry> + <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 xml:id="notes"><title>Notes</title> + <para> + Attribute <constant>EGL_GL_COLORSPACE</constant>, and the + <constant>EGL_OPENGL_ES3_BIT</constant> bit value for attribute + <constant>EGL_RENDERABLE_TYPE</constant>, are supported only if + the EGL version is 1.5 or greater. + </para> + <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 xml: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>, + <constant>EGL_OPENGL_ES2_BIT</constant>, or + <constant>EGL_OPENGL_ES3_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 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePixmapSurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePixmapSurface.xml new file mode 100644 index 0000000..72469f4 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePixmapSurface.xml @@ -0,0 +1,87 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglCreatePixmapSurface"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <refmeta> + <refentrytitle>eglCreatePixmapSurface</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglCreatePixmapSurface</refname> + <refpurpose> + create a new <acronym>EGL</acronym> offscreen 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 xml: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 xml:id="description"><title>Description</title> + <para> + <function>eglCreatePixmapSurface</function> creates an off-screen + EGL pixmap surface and returns a handle to it. The behavior of + <function>eglCreatePixmapSurface</function> is identical to that + of + <citerefentry><refentrytitle>eglCreatePlatformPixmapSurface</refentrytitle></citerefentry> + except that the set of platforms to which + <parameter>display</parameter> is permitted to belong, as well + as the actual type of <parameter>native_pixmap</parameter>, are + implementation specific. + </para> + </refsect1> + <refsect1 xml:id="errors"><title>Errors</title> + <para> + See errors for + <citerefentry><refentrytitle>eglCreatePlatformPixmapSurface</refentrytitle></citerefentry>. + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreatePlatformPixmapSurface</refentrytitle></citerefentry>, + <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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePlatformPixmapSurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePlatformPixmapSurface.xml new file mode 100644 index 0000000..66de1c7 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePlatformPixmapSurface.xml @@ -0,0 +1,270 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglCreatePlatformPixmapSurface"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <refmeta> + <refentrytitle>eglCreatePlatformPixmapSurface</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglCreatePlatformPixmapSurface</refname> + <refpurpose> + create a new <acronym>EGL</acronym> offscreen surface + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLSurface <function>eglCreatePlatformPixmapSurface</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLConfig <parameter>config</parameter></paramdef> + <paramdef>void * <parameter>native_pixmap</parameter></paramdef> + <paramdef>EGLint const * <parameter>attrib_list</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 xml: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 xml:id="description"><title>Description</title> + <para> + <function>eglCreatePlatformPixmapSurface</function> creates an + off-screen <acronym>EGL</acronym> pixmap surface and returns + a handle to it. + </para> + <para> + If <function>eglCreatePlatformPixmapSurface</function> fails to + create a pixmap surface, <constant>EGL_NO_SURFACE</constant> is + returned. + </para> + <para> + <parameter>native_pixmap</parameter> must belong to the same + platform as <parameter>display</parameter>, and EGL considers + the returned <type>EGLSurface</type> as belonging to that same + platform. The EGL extension that defines the platform to which + <parameter>display</parameter> belongs also defines the + requirements for the <parameter>native_pixmap</parameter> + 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_GL_COLORSPACE</constant></term> + <listitem> + <para> + Specifies the color space used by OpenGL and OpenGL ES + when rendering to the surface. If its value is + <constant>EGL_GL_COLORSPACE_SRGB</constant>, then a + non-linear, perceptually uniform color space is assumed, + with a corresponding + <constant>GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING</constant> + value of <constant>GL_SRGB</constant>. If its value is + <constant>EGL_GL_COLORSPACE_LINEAR</constant>, then a + linear color space is assumed, with a corresponding + <constant>GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING</constant> + value of <constant>GL_LINEAR</constant>. The default + value of <constant>EGL_GL_COLORSPACE</constant> is + <constant>EGL_GL_COLORSPACE_SRGB</constant>. + </para> + <para> + Note that the <constant>EGL_GL_COLORSPACE</constant> + attribute is used only by OpenGL and OpenGL ES contexts + supporting sRGB framebuffers. EGL itself does not + distinguish multiple colorspace models. Refer to the + ``sRGB Conversion'' sections of the OpenGL 4.6 and + OpenGL ES 3.2 Specifications for more information. + </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 xml: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> + Attribute <constant>EGL_GL_COLORSPACE</constant> is supported + only if the EGL version is 1.5 or greater. + </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 and EGL itself. Refer to section 11.2 of the OpenVG + 1.0 specification for more information. The platform's use and + interpretation of alpha values is outside the scope of EGL. + However, the preferred behavior is for the window system to + ignore the value of <constant>EGL_VG_ALPHA_FORMAT</constant>. + </para> + </refsect1> + <refsect1 xml:id="errors"><title>Errors</title> + <para> + If <parameter>display</parameter> and + <parameter>native_pixmap</parameter> do not belong to the same + platform, then undefined behavior occurs. + </para> + <para> + <constant>EGL_NO_SURFACE</constant> is returned if creation of + the surface 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 is + already an <type>EGLSurface</type> associated with + <parameter>native_pixmap</parameter> (as a result of a previous + <function>eglCreatePlatformPixmapSurface</function> call). + </para> + <para> + <constant>EGL_BAD_ALLOC</constant> is generated if the + implementation cannot allocate resources for the new EGL window. + </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 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePlatformWindowSurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePlatformWindowSurface.xml new file mode 100644 index 0000000..ee88467 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglCreatePlatformWindowSurface.xml @@ -0,0 +1,296 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglCreatePlatformWindowSurface"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <refmeta> + <refentrytitle>eglCreatePlatformWindowSurface</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglCreatePlatformWindowSurface</refname> + <refpurpose> + create a new <acronym>EGL</acronym> on-screen rendering surface + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLSurface <function>eglCreatePlatformWindowSurface</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLConfig <parameter>config</parameter></paramdef> + <paramdef>void * <parameter>native_window</parameter></paramdef> + <paramdef>EGLAttrib const * <parameter>attrib_list</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 xml: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 a list of attributes for the window surface. + May be <constant>NULL</constant> or empty + (first attribute is <constant>EGL_NONE</constant>). + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 xml:id="description"><title>Description</title> + <para> + <function>eglCreatePlatformWindowSurface</function> creates an + on-screen EGL window surface and returns a handle to it. Any EGL + context created with a compatible <type>EGLConfig</type> can be + used to render into this surface. + </para> + <para> + If <function>eglCreatePlatformWindowSurface</function> fails to + create a window surface, <constant>EGL_NO_SURFACE</constant> is + returned. + </para> + <para> + <parameter>native_window</parameter> must belong to the same + platform as <parameter>display</parameter>, and EGL considers + the returned <type>EGLSurface</type> as belonging to that same + platform. The EGL extension that defines the platform to which + <parameter>display</parameter> belongs also defines the + requirements for the <parameter>native_window</parameter> + 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_GL_COLORSPACE</constant></term> + <listitem> + <para> + Specifies the color space used by OpenGL and OpenGL ES + when rendering to the surface. If its value is + <constant>EGL_GL_COLORSPACE_SRGB</constant>, then a + non-linear, perceptually uniform color space is assumed, + with a corresponding + <constant>GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING</constant> + value of <constant>GL_SRGB</constant>. If its value is + <constant>EGL_GL_COLORSPACE_LINEAR</constant>, then a + linear color space is assumed, with a corresponding + <constant>GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING</constant> + value of <constant>GL_LINEAR</constant>. The default + value of <constant>EGL_GL_COLORSPACE</constant> is + <constant>EGL_GL_COLORSPACE_LINEAR</constant>. + </para> + <para> + Note that the <constant>EGL_GL_COLORSPACE</constant> + attribute is used only by OpenGL and OpenGL ES contexts + supporting sRGB framebuffers. EGL itself does not + distinguish multiple colorspace models. Refer to the + ``sRGB Conversion'' sections of the OpenGL 4.6 and + OpenGL ES 3.2 Specifications for more information. + </para> + </listitem> + </varlistentry> + <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 xml:id="notes"><title>Notes</title> + <para> + Attribute <constant>EGL_GL_COLORSPACE</constant> is supported + only if the EGL version is 1.5 or greater. + </para> + <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 and EGL itself. Refer to section 11.2 of the OpenVG + 1.0 specification for more information. The platform's use and + interpretation of alpha values is outside the scope of EGL. + However, the preferred behavior is for platforms to ignore the + value of <constant>EGL_VG_ALPHA_FORMAT</constant> when + compositing window surfaces. + </para> + </refsect1> + <refsect1 xml:id="errors"><title>Errors</title> + <para> + If <parameter>display</parameter> and + <parameter>native_window</parameter> do not belong to the same + platform, then undefined behavior occurs. + </para> + <para> + <constant>EGL_NO_SURFACE</constant> is returned if creation of + the surface 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 a valid 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 for the same platform as <parameter>display</parameter>. + </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 is + already an <type>EGLSurface</type> associated with + <parameter>native_window</parameter> (as a result of a previous + <function>eglCreatePlatformWindowSurface</function> call). + </para> + <para> + <constant>EGL_BAD_ALLOC</constant> is generated if the + implementation cannot allocate resources for the new EGL window. + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated if the pixel + format of <parameter>native_window</parameter> does not + correspond to the format, type, and size of the color buffers + required by <parameter>config</parameter>. + <constant>EGL_BAD_MATCH</constant> is generated if the pixel + </para> + <para> + <constant>EGL_BAD_MATCH</constant> is generated 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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>, + <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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglCreateSync.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglCreateSync.xml new file mode 100644 index 0000000..551d2a4 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglCreateSync.xml @@ -0,0 +1,311 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglCreateSync"> + <info> + <copyright> + <year>2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <refmeta> + <refentrytitle>eglCreateSync</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglCreateSync</refname> + <refpurpose> + create a new <acronym>EGL</acronym> sync object + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLSync <function>eglCreateSync</function></funcdef> + <paramdef>EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLEnum <parameter>type</parameter></paramdef> + <paramdef>EGLAttrib const * <parameter>attrib_list</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 xml: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>type</parameter></term> + <listitem><para> + Specifies the type of sync object to create. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrib_list</parameter></term> + <listitem><para> + Specifies attributes and attribute values for the sync + object being created. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 xml:id="description"><title>Description</title> + <para> + <firstterm>sync objects</firstterm> are provided to enable + synchronization of client API operations between threads and/or + between API contexts. Sync objects may be tested or waited upon + by application threads. + </para> + <para> + Sync objects have a status with two possible states: + <firstterm>signaled</firstterm> and + <firstterm>unsignaled</firstterm>. Initially, sync objects are + unsignaled. EGL may be asked to wait for a sync object to become + signaled, or a sync object's status may be queried. + </para> + <para> + Depending on the type of a sync object, its status may be + changed either by an external event, or by explicitly signaling + and unsignaling the sync. + </para> + <para> + <function>eglCreateSync</function> creates a sync object of the specified + <parameter>type</parameter> associated with the specified display + <parameter>display</parameter>, and returns a handle to the new object. + <parameter>attrib_list</parameter> is an attribute-value list specifying + other attributes of the sync object, terminated by an attribute entry + <constant>EGL_NONE</constant>. Attributes not specified in the list will be + assigned their default values. + </para> + <para> + Once the <firstterm>condition</firstterm> of the sync object is satisfied, + the sync is signaled, causing any <function>eglClientWaitSync</function> or + <function>eglWaitSync</function> commands blocking on + <parameter>sync</parameter> to unblock. + </para> + </refsect1> + <refsect1 xml:id="fencesync"><title>Creating Fence Sync Objects</title> + <para> + If <parameter>type</parameter> is + <constant>EGL_SYNC_FENCE</constant>, a fence sync object is + created. In this case <parameter>attrib_list</parameter> must be + <constant>NULL</constant> or empty (containing only + <constant>EGL_NONE</constant>). Attributes of the fence sync + object, and their initial values, are: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_SYNC_TYPE</constant></term> + <listitem> + <para> + <constant>EGL_SYNC_FENCE</constant> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SYNC_STATUS</constant></term> + <listitem> + <para> + <constant>EGL_UNSIGNALED</constant> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SYNC_CONDITION</constant></term> + <listitem> + <para> + <constant>EGL_SYNC_PRIOR_COMMANDS_COMPLETE</constant> + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + When a fence sync object is created, <function>eglCreateSync</function> also inserts a + fence command into the command stream of the bound client API's current + context (i.e., the context returned by <function>eglGetCurrentContext</function>), and + associates it with the newly created sync object. + </para> + <para> + The only condition supported for fence sync objects is + <constant>EGL_SYNC_PRIOR_COMMANDS_COMPLETE</constant>, which is satisfied by completion of + the fence command corresponding to the sync object, and all preceding + commands in the associated client API context's command stream. The sync + object will not be signaled until all effects from these commands on the + client API's internal and framebuffer state are fully realized. No other + state is affected by execution of the fence command. + </para> + <para> + Creation of fence sync objects requires support from the bound + client API, and will not succeed unless the client API satisfies + one of the following properties. Note that + <function>eglWaitSync</function> also requires satisfying these + conditions. + </para> + <para> + <itemizedlist> + <listitem> + <para> + client API is OpenGL, and either the OpenGL version is + 3.2 or greater, or the <constant>GL_ARB_sync</constant> + extension is supported. + </para> + </listitem> + <listitem> + <para> + client API is OpenGL ES, and either the OpenGL ES + version is 3.0 or greater, or the + <constant>GL_OES_EGL_sync</constant> extension is + supported. + </para> + </listitem> + <listitem> + <para> + client API is OpenVG, and the + <constant>VG_KHR_EGL_sync</constant> extension is + supported. + </para> + </listitem> + </itemizedlist> + </para> + </refsect1> + <refsect1 xml:id="openclsync"><title>Creating OpenCL Event Sync Objects</title> + <para> + If <parameter>type</parameter> is + <constant>EGL_SYNC_CL_EVENT</constant>, an OpenCL event sync + object is created. In this case + <parameter>attrib_list</parameter> must contain the attribute + <constant>EGL_CL_EVENT_HANDLE</constant>, set to a valid OpenCL + event handle returned by a call to + <function>clEnqueueReleaseGLObjects</function> or + <function>clEnqueueReleaseEGLObjects</function>; other types of + OpenCL event handles are not supported. Note that + <constant>EGL_CL_EVENT_HANDLE</constant> is not a queriable + property of a sync object. Attributes of the OpenCL event sync + object, and their initial values, are: + </para> + <variablelist> + <varlistentry> + <term><constant>EGL_SYNC_TYPE</constant></term> + <listitem> + <para> + <constant>EGL_SYNC_CL_EVENT</constant> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SYNC_STATUS</constant></term> + <listitem> + <para> + Depends on status of <parameter>event</parameter> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_SYNC_CONDITION</constant></term> + <listitem> + <para> + <constant>EGL_SYNC_CL_EVENT_COMPLETE</constant> + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + The status of such a sync object depends on + <parameter>event</parameter>. When the status of + <parameter>event</parameter> is <constant>CL_QUEUED</constant>, + <constant>CL_SUBMITTED</constant>, or + <constant>CL_RUNNING</constant>, the status of the linked sync + object will be <constant>EGL_UNSIGNALED</constant>. When the + status of <parameter>event</parameter> changes to + <constant>CL_COMPLETE</constant>, the status of the linked sync + object will become <constant>EGL_SIGNALED</constant>. + </para> + <para> + The only condition supported for OpenCL event sync objects is + <constant>EGL_SYNC_CL_EVENT_COMPLETE</constant>, which is + satisfied when the status of the OpenCL event associated with + the sync object changes to <constant>CL_COMPLETE</constant>. + </para> + <para> + Creating a linked sync object places a reference on the linked + OpenCL event object. When the sync object is deleted, the + reference will be removed from the event object. + </para> + <para> + However, implementations are not required to validate the OpenCL + event, and passing an invalid event handle in + <parameter>attrib_list</parameter> may result in undefined + behavior up to and including program termination. + </para> + </refsect1> + <refsect1 xml:id="notes"><title>Notes</title> + <para> + <function>eglCreateSync</function> is supported only if the EGL + version is 1.5 or greater. + </para> + </refsect1> + <refsect1 xml:id="errors"><title>Errors</title> + <para> + <function>eglCreateSync</function> returns + <constant>EGL_NO_SYNC</constant> on failure. + </para> + <para> + If <parameter>display</parameter> is not the name of a valid, + initialized <type>EGLDisplay</type>, an + <constant>EGL_BAD_DISPLAY</constant> error is generated. + </para> + <para> + If <parameter>attrib_list</parameter> contains an attribute name + not defined for the type of sync object being created, an + <constant>EGL_BAD_ATTRIBUTE</constant> error is generated. + </para> + <para> + If <parameter>type</parameter> is not a supported type of sync + object, an <constant>EGL_BAD_PARAMETER</constant> error is + generated. + </para> + <para> + If <parameter>type</parameter> is + <constant>EGL_SYNC_FENCE</constant> and no context is current + for the bound API (i.e., + <function>eglGetCurrentContext</function> returns + <constant>EGL_NO_CONTEXT</constant>), an + <constant>EGL_BAD_MATCH</constant> error is generated. + </para> + <para> + If <parameter>type</parameter> is + <constant>EGL_SYNC_FENCE</constant> and + <parameter>display</parameter> does not match the + <type>EGLDisplay</type> of the currently bound context for the + currently bound client API (the <type>EGLDisplay</type> returned + by <function>eglGetCurrentDisplay</function>), an + <constant>EGL_BAD_MATCH</constant> error is generated. + </para> + <para> + If <parameter>type</parameter> is + <constant>EGL_SYNC_FENCE</constant> and the current context for + the currently bound client API does not support fence commands, + an <constant>EGL_BAD_MATCH</constant> error is generated. + </para> + <para> + If <parameter>type</parameter> is + <constant>EGL_SYNC_CL_EVENT</constant> and + <constant>EGL_CL_EVENT_HANDLE</constant> is not specified in + <parameter>attrib_list</parameter>, or its attribute value is + not a valid OpenCL event handle as described above, then an + <constant>EGL_BAD_ATTRIBUTE</constant> error is generated. + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <function>clEnqueueReleaseGLObjects</function>, + <function>clEnqueueReleaseEGLObjects</function>, + <citerefentry><refentrytitle>eglClientWaitSync</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateSync</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentDisplay</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitSync</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglCreateWindowSurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglCreateWindowSurface.xml new file mode 100644 index 0000000..b098a4b --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglCreateWindowSurface.xml @@ -0,0 +1,87 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglCreateWindowSurface"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml:id="description"><title>Description</title> + <para> + <function>eglCreateWindowSurface</function> creates an on-screen + EGL window surface and returns a handle to it. The behavior of + <function>eglCreateWindowSurface</function> is identical to that + of + <citerefentry><refentrytitle>eglCreatePlatformWindowSurface</refentrytitle></citerefentry> + except that the set of platforms to which + <parameter>display</parameter> is permitted to belong, as well + as the actual type of <parameter>native_window</parameter>, are + implementation specific. + </para> + </refsect1> + <refsect1 xml:id="errors"><title>Errors</title> + <para> + See errors for + <citerefentry><refentrytitle>eglCreatePlatformWindowSurface</refentrytitle></citerefentry>. + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreatePlatformWindowSurface</refentrytitle></citerefentry>, + <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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglDestroyContext.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglDestroyContext.xml new file mode 100644 index 0000000..01467ee --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglDestroyContext.xml @@ -0,0 +1,75 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglDestroyContext"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglDestroyImage.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglDestroyImage.xml new file mode 100644 index 0000000..96bb8bd --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglDestroyImage.xml @@ -0,0 +1,85 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglDestroyImage"> + <info> + <copyright> + <year>2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <refmeta> + <refentrytitle>eglDestroyImage</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglDestroyImage</refname> + <refpurpose> + Destroy an <type>EGLImage</type> object + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglDestroyImage</function></funcdef> + <paramdef>(EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLImage <parameter>image</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 xml: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>image</parameter></term> + <listitem><para> + Specifies the image to destroy. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 xml:id="description"><title>Description</title> + <para> + <function>eglDestroyImage</function> is used to destroy the + specified <type>EGLImage</type> object + <parameter>image</parameter>. Once destroyed, + <parameter>image</parameter> may not be used to create any + additional <type>EGLImage</type> target resources within any + client API contexts, although existing <type>EGLImage</type> + siblings may continue to be used. <constant>EGL_TRUE</constant> + is returned on success. + </para> + </refsect1> + <refsect1 xml:id="errors"><title>Errors</title> + <para> + On failure, <function>eglDestroyImage</function> returns + <constant>EGL_FALSE</constant> + </para> + <para> + If <parameter>display</parameter> is not the handle of a valid + <type>EGLDisplay</type> object, the error + <constant>EGL_BAD_DISPLAY</constant> is generated. + </para> + <para> + If <parameter>image</parameter> is not a valid + <type>EGLImage</type> object created with respect to + <parameter>display</parameter>, the error + <constant>EGL_BAD_PARAMETER</constant> is generated. + </para> + </refsect1> + <refsect1 xml:id="notes"><title>Notes</title> + <para> + <function>eglDestroyImage</function> is available only if the + EGL version is 1.5 or greater. + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateImage</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglDestroySurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglDestroySurface.xml new file mode 100644 index 0000000..31024c7 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglDestroySurface.xml @@ -0,0 +1,77 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglDestroySurface"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglDestroySync.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglDestroySync.xml new file mode 100644 index 0000000..d871c2c --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglDestroySync.xml @@ -0,0 +1,98 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglDestroySync"> + <info> + <copyright> + <year>2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <refmeta> + <refentrytitle>eglDestroySync</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglDestroySync</refname> + <refpurpose> + Destroy a sync object + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglDestroySync</function></funcdef> + <paramdef>(EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLSync <parameter>sync</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 xml: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>sync</parameter></term> + <listitem><para> + Specifies the sync object to destroy. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 xml:id="description"><title>Description</title> + <para> + <function>eglDestroySync</function> is used to destroy an + existing sync object. + </para> + <para> + If any <function>eglClientWaitSync</function> or + <function>eglWaitSync</function> commands are blocking on + <parameter>sync</parameter> when + <function>eglDestroySync</function> is called, + <parameter>sync</parameter> is flagged for deletion and will be + deleted when the associated fence command or OpenCL event object + has completed, and <parameter>sync</parameter> is no longer + blocking any such <function>egl*WaitSync</function> command. + Otherwise, the sync object is destroyed immediately. + </para> + <para> + If no errors are generated, <constant>EGL_TRUE</constant> is + returned, and <parameter>sync</parameter> will no longer be the + handle of a valid sync object. + </para> + </refsect1> + <refsect1 xml:id="errors"><title>Errors</title> + <para> + On failure, <function>eglDestroySync</function> returns + <constant>EGL_FALSE</constant>. + </para> + <para> + If <parameter>sync</parameter> is not a valid sync object for + <parameter>display</parameter>, <constant>EGL_FALSE</constant> + is returned and an <constant>EGL_BAD_PARAMETER</constant> error + is generated. + </para> + <para> + If <parameter>display</parameter> does not match the display + passed to <function>eglCreateSync</function> when + <parameter>sync</parameter> was created, the behaviour is + undefined. + </para> + </refsect1> + <refsect1 xml:id="notes"><title>Notes</title> + <para> + <function>eglDestroySync</function> is available only if the EGL + version is 1.5 or greater. + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglClientWaitSync</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateSync</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitSync</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglGetConfigAttrib.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglGetConfigAttrib.xml new file mode 100644 index 0000000..70313fe --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglGetConfigAttrib.xml @@ -0,0 +1,317 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetConfigAttrib"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetConfigs</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglGetConfigs.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglGetConfigs.xml new file mode 100644 index 0000000..a58e722 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglGetConfigs.xml @@ -0,0 +1,105 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetConfigs"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglGetCurrentContext.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglGetCurrentContext.xml new file mode 100644 index 0000000..b646cf2 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglGetCurrentContext.xml @@ -0,0 +1,42 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetCurrentContext"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglGetCurrentDisplay.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglGetCurrentDisplay.xml new file mode 100644 index 0000000..a860304 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglGetCurrentDisplay.xml @@ -0,0 +1,57 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetCurrentDisplay"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml:id="errors"><title>Errors</title> + <para> + Passing <constant>EGL_NO_DISPLAY</constant> to any command + taking an <type>EGLDisplay</type> parameter will generate either + an <constant>EGL_BAD_DISPLAY</constant> error if the EGL + implementation validates <type>EGLDisplay</type> handles, or + undefined behavior as described at the end of section 3.1 of the + EGL 1.5 Specification. The only exception to this rule is that + <function>eglQueryString</function> will accept an + <type>EGLDisplay</type> parameter of + <constant>EGL_NO_DISPLAY</constant> when querying the client + extension string (see section 3.3 of the EGL 1.5 Specification). + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglGetCurrentSurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglGetCurrentSurface.xml new file mode 100644 index 0000000..1299718 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglGetCurrentSurface.xml @@ -0,0 +1,58 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetCurrentSurface"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml:id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>readdraw</parameter></term> + <listitem> + <para> + Specifies whether to return the read surface + (<constant>EGL_READ</constant>) or the draw surface + (<constant>EGL_DRAW</constant>). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 xml: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 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglGetDisplay.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglGetDisplay.xml new file mode 100644 index 0000000..a694edf --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglGetDisplay.xml @@ -0,0 +1,87 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetDisplay"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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> + The behavior of <function>eglGetDisplay</function> is similar to + that of + <citerefentry><refentrytitle>eglGetPlatformDisplay</refentrytitle></citerefentry>, + but is specified in terms of implementation-specific behavior + rather than platform-specific extensions. As for + <citerefentry><refentrytitle>eglGetPlatformDisplay</refentrytitle></citerefentry>, + EGL considers the returned <type>EGLDisplay</type> as belonging + to the same platform as <parameter>display_id</parameter>. + However, the set of platforms to which + <parameter>display_id</parameter> is permitted to belong, as + well as the actual type of <parameter>display_id</parameter>, + are implementation-specific. If + <parameter>display_id</parameter> is + <constant>EGL_DEFAULT_DISPLAY</constant>, a <firstterm>default + display</firstterm> is returned. Multiple calls made to + <function>eglGetDisplay</function> with the same + <parameter>display_id</parameter> will return the same + <type>EGLDisplay</type> handle. + </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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetPlatformDisplay</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglGetError.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglGetError.xml new file mode 100644 index 0000000..3e1fd71 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglGetError.xml @@ -0,0 +1,143 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetError"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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> + When an EGL function could potentially generate several + different errors (for example, when passed both a bad attribute + name, and a bad attribute value for a legal attribute name), the + implementation may choose to generate any one of the applicable + errors. + </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 xml:id="errors"><title>Errors</title> + <para> + A call to <function>eglGetError</function> sets the error to + <constant>EGL_SUCCESS</constant>. + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglGetPlatformDisplay.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglGetPlatformDisplay.xml new file mode 100644 index 0000000..f2f9108 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglGetPlatformDisplay.xml @@ -0,0 +1,122 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetPlatformDisplay"> + <info> + <copyright> + <year>2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <refmeta> + <refentrytitle>eglGetPlatformDisplay</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglGetPlatformDisplay</refname> + <refpurpose> + return an <acronym>EGL</acronym> display connection + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLDisplay <function>eglGetPlatformDisplay</function></funcdef> + <paramdef>EGLenum <parameter>platform</parameter></paramdef> + <paramdef>void * <parameter>native_display</parameter></paramdef> + <paramdef>const EGLAttrib * <parameter>attrib_list</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 xml:id="parameters"><title>Parameters</title> + <variablelist> + <varlistentry> + <term><parameter>platform</parameter></term> + <listitem> + <para> + Specifies the native platform to obtain a display for. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>native_display</parameter></term> + <listitem> + <para> + Specifies the native display to connect to. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrib_list</parameter></term> + <listitem> + <para> + Specifies attributes of the display being obtained. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 xml:id="description"><title>Description</title> + <para> + <function>eglGetPlatformDisplay</function> obtains an + <acronym>EGL</acronym> display connection for the specified + <parameter>platform</parameter> and + <parameter>native_display</parameter>. + </para> + <para> + Valid values for <parameter>platform</parameter> are defined by + EGL extensions, as are requirements for + <parameter>native_display</parameter>. + For example, an extension specification that defines support for + the X11 platform may require that + <parameter>native_display</parameter> be a pointer to an X11 + Display, and an extension specification that defines support for + the Microsoft Windows platform may require that + <parameter>native_display</parameter> be a pointer to a Windows + Device Context. + </para> + <para> + Valid attributes are defined by EGL extensions. + 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> but is required for the + specified <parameter>platform</parameter>, then a default value + is used (and the attribute is said to be specified implicitly). + </para> + <para> + Multiple calls made to + <function>eglGetPlatformDisplay</function> with the same + parameters will return the same <type>EGLDisplay</type> handle. + </para> + <para> + If <parameter>platform</parameter> is valid but no display + matching <parameter>native_display</parameter> is available, + then <constant>EGL_NO_DISPLAY</constant> is returned; no error + condition is raised in this case. + </para> + </refsect1> + <refsect1 xml:id="notes"><title>Notes</title> + <para> + <function>eglGetPlatformDisplay</function> is supported only if + the EGL version is 1.5 or greater. + </para> + </refsect1> + <refsect1 xml:id="errors"><title>Errors</title> + <para> + <function>eglGetPlatformDisplay</function> returns + <constant>EGL_NO_DISPLAY</constant> on failure. + </para> + <para> + An <constant>EGL_BAD_PARAMETER</constant> error is generated if + <parameter>platform</parameter> has an invalid value. + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglGetProcAddress.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglGetProcAddress.xml new file mode 100644 index 0000000..a3d20b0 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglGetProcAddress.xml @@ -0,0 +1,98 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetProcAddress"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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>))(void</paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 xml: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 xml:id="description"><title>Description</title> + <para> + <function>eglGetProcAddress</function> returns the address of + the client API or EGL 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 matching the function's definition in + the corresponding API or extension specification. A return value + of <constant>NULL</constant> indicates that the specific + function does not exist for the 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 make a corresponding query, such as + <function>glGetString</function>(<constant>GL_EXTENSIONS</constant>) + for OpenGL and OpenGL ES extensions; + <function>vgGetString</function>(<constant>VG_EXTENSIONS</constant>) + for OpenVG extensions; + <function>eglQueryString</function>(<parameter>display</parameter>, + <constant>EGL_EXTENSIONS</constant>); or query the EGL or client + API version for non-extension functions, to determine if a + function is supported by EGL or a specific client API context. + </para> + <para> + Client API function pointers returned by + <function>eglGetProcAddress</function> are independent of the + display and the currently bound client API context, and may be + used by any client API context which supports the function. + </para> + <para> + <function>eglGetProcAddress</function> may be queried for all + EGL and client API functions supported by the implementation + (whether those functions are extensions or not, and whether they + are supported by the current client API context or not). + </para> + <para> + For functions that are queryable with + <function>eglGetProcAddress</function>, implementations may + choose to also export those functions statically from the object + libraries implementing those functions. However, portable + clients cannot rely on this behavior. + </para> + </refsect1> + <refsect1 xml:id="notes"><title>Notes</title> + <para> + If the EGL version is not 1.5 or greater, only queries of EGL + and client API <emphasis>extension</emphasis> functions will + succeed. + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <function>glGetString</function> + <citerefentry><refentrytitle>eglQueryString</refentrytitle></citerefentry> </para> + <function>vgGetString</function> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglGetSyncAttrib.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglGetSyncAttrib.xml new file mode 100644 index 0000000..c3f0197 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglGetSyncAttrib.xml @@ -0,0 +1,148 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetSyncAttrib"> + <info> + <copyright> + <year>2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <refmeta> + <refentrytitle>eglGetSyncAttrib</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglGetSyncAttrib</refname> + <refpurpose> + Return an attribute of a sync object + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglGetSyncAttrib</function></funcdef> + <paramdef>(EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLSync <parameter>sync</parameter></paramdef> + <paramdef>EGLint <parameter>attribute</parameter></paramdef> + <paramdef>EGLAttrib *<parameter>value</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 xml: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>sync</parameter></term> + <listitem><para> + Specifies the sync object to query. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>attribute</parameter></term> + <listitem><para> + Specifies the EGL sync object attribute to query. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem><para> + Returns the requested attribute value. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 xml:id="description"><title>Description</title> + <para> + <function>eglGetSyncAttrib</function> is used to query + attributes of the sync object <parameter>sync</parameter>. Legal + values for <parameter>attribute</parameter> depend on the type + of sync object, as shown in table + <xref linkend="tab-syncattr"/>. Assuming no errors are + generated, <constant>EGL_TRUE</constant> is returned and the + value of the queried attribute is returned in + *<parameter>value</parameter>. + </para> + <table frame="all" xml:id="tab-syncattr"> + <title> + Attributes accepted by <function>eglGetSyncAttrib</function> + </title> + <tgroup cols="3" align="left" colsep="1" rowsep="1"> + <thead> + <row> + <entry>Attribute</entry> + <entry>Description</entry> + <entry>Supported Sync Objects</entry> + </row> + </thead> + <tbody> + <row> + <entry>Attribute</entry> + <entry>Description</entry> + <entry>Supported Sync Objects</entry> + </row> + <row> + <entry><constant>EGL_SYNC_TYPE</constant></entry> + <entry>Type of the sync object</entry> + <entry>All</entry> + </row> + <row> + <entry><constant>EGL_SYNC_STATUS</constant></entry> + <entry>Status of the sync object</entry> + <entry>All</entry> + </row> + <row> + <entry><constant>EGL_SYNC_CONDITION</constant></entry> + <entry>Signaling condition</entry> + <entry> + <constant>EGL_SYNC_FENCE</constant> or + <constant>EGL_SYNC_CL_EVENT</constant> + </entry> + </row> + </tbody> + </tgroup> + </table> + </refsect1> + <refsect1 xml:id="errors"><title>Errors</title> + <para> + On failure, <function>eglGetSyncAttrib</function> returns + <constant>EGL_FALSE</constant> and *<parameter>value</parameter> + is not modified. + </para> + <para> + If <parameter>sync</parameter> is not a valid sync object for + <parameter>display</parameter>, an + <constant>EGL_BAD_PARAMETER</constant> error is generated. + </para> + <para> + If <parameter>attribute</parameter> is not one of the attributes + in table <xref linkend="tab-syncattr"/>, an + <constant>EGL_BAD_ATTRIBUTE</constant> error is generated. + </para> + <para> + If <parameter>attribute</parameter> is not supported for the + type of sync object passed in <parameter>sync</parameter>, an + <constant>EGL_BAD_MATCH</constant> error is generated. + </para> + <para> + If <parameter>display</parameter> does not match the display + passed to <function>eglCreateSync</function> when + <parameter>sync</parameter> was created, behaviour is undefined. + </para> + </refsect1> + <refsect1 xml:id="notes"><title>Notes</title> + <para> + <function>eglGetSyncAttrib</function> is available only if the + EGL version is 1.5 or greater. + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateSync</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglInitialize.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglInitialize.xml new file mode 100644 index 0000000..367a986 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglInitialize.xml @@ -0,0 +1,100 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglInitialize"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglTerminate</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglIntro.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglIntro.xml new file mode 100644 index 0000000..0cdd0a1 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglIntro.xml @@ -0,0 +1,275 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglIntro"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 + <firstterm>platform</firstterm>, 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 platform. Most EGL + functions require an EGL display connection, which can be + obtained by calling + <citerefentry><refentrytitle>eglGetPlatformDisplay</refentrytitle></citerefentry> + or + <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>. + To initialize and + query what EGL version is supported on the display + connection, call + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>. + </para> + <para> + The EGL specification does not define the set of platforms that + may be supported by an EGL implementation, nor does it specify + behavior specific to any platform. The set of supported + platforms and their behavior is defined by platform-specific + extensions. To detect if a particular platform is supported, + clients should query the <constant>EGL_EXTENSIONS</constant> + string of <constant>EGL_NO_DISPLAY</constant> using + <citerefentry><refentrytitle>eglQueryString</refentrytitle></citerefentry>. + </para> + <para> + Platforms 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 platform APIs. + </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 platform. EGL pixel buffers are + EGL-only resources, and do not accept rendering through the + platform APIs. + </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 platform 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 platform APIs. + </para> + </refsect1> + <refsect1 xml: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 xml:id="notes"><title>Notes</title> + <para> + Prior to EGL 1.5, platforms were referred to as the + <firstterm>native window system</firstterm>, and + platform-specific queries and APIs were not available. Only a + single native window system was supported. + </para> + </refsect1> + <refsect1 xml: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 extension strings returned + by + <citerefentry><refentrytitle>eglQueryString</refentrytitle></citerefentry>. + </para> + </refsect1> + <refsect1 xml: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 xml: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 xml: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>eglGetPlatformDisplay</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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglMakeCurrent.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglMakeCurrent.xml new file mode 100644 index 0000000..3464640 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglMakeCurrent.xml @@ -0,0 +1,321 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglMakeCurrent"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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. + </para> + <para> + For an OpenGL or OpenGL ES context, <parameter>draw</parameter> + is used for all operations except for any pixel data read back or copied + (<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>. Note that the same + <type>EGLSurface</type> may be specified for both draw and read. + </para> + <para> + For an OpenVG context, the same <type>EGLSurface</type> must be + specified for both <parameter>draw</parameter> and + <parameter>read</parameter>. + </para> + <para> + If the calling thread has already a current rendering context of + the same client API type as <parameter>context</parameter>, then + that context is flushed and marked as no longer current. + <parameter>context</parameter> is then made the current context + for the calling thread. For purposes of + <function>eglMakeCurrent</function>, the client API type of all + OpenGL ES and OpenGL contexts is considered the same. In other + words, if any OpenGL ES context is currently bound and + <parameter>context</parameter> is an OpenGL context, or if any + OpenGL context is currently bound and + <parameter>context</parameter> is an OpenGL ES context, the + currently bound context will be made no longer current and + <parameter>context</parameter> will be made current. + </para> + <para> + OpenGL and OpenGL ES buffer mappings created by e.g. + <function>glMapBuffer</function> are not affected by + <function>eglMakeCurrent</function>; they persist whether the + context owning the buffer is current or not. + </para> + <para> + If <parameter>draw</parameter> is destroyed after + <function>eglMakeCurrent</function> is called, then subsequent + rendering commands will be processed and the context state will + be updated, but the surface contents become undefined. If + <parameter>read</parameter> is destroyed after + <function>eglMakeCurrent</function> then pixel values + <parameter>read</parameter> from the framebuffer (e.g., as + result of calling glReadPixels) are undefined. If a native + window or pixmap underlying the <parameter>draw</parameter> or + <parameter>read</parameter> surfaces is destroyed, rendering and + <parameter>read</parameter>back are handled as above. + </para> + <para> + To release the current context without assigning a new one, set + <parameter>context</parameter> to + <constant>EGL_NO_CONTEXT</constant> and set + <parameter>draw</parameter> and <parameter>read</parameter> to + <constant>EGL_NO_SURFACE</constant> . The currently bound + context for the client API specified by the current rendering + API is flushed and marked as no longer current, and there will + be no current context for that client API after + <function>eglMakeCurrent</function> returns. This is the only + case in which <function>eglMakeCurrent</function> respects the + current rendering API. In all other cases, the client API + affected is determined by <parameter>context</parameter>. This + is the only case where an uninitialized display may be passed to + <function>eglMakeCurrent</function>. + </para> + <para> + If ctx is not <constant>EGL_NO_CONTEXT</constant>, then both + <parameter>draw</parameter> and <parameter>read</parameter> must + not be <constant>EGL_NO_SURFACE</constant> unless + <parameter>context</parameter> is a context which supports being + bound without read and draw surfaces. In this case the context + is made current without a default framebuffer. The meaning of + this is defined by the client API of the supporting context (see + chapter 4 of the OpenGL 3.0 Specification, and the + <constant>GL_OES_surfaceless_context</constant> OpenGL ES + extension.). + </para> + <para> + The first time a OpenGL or OpenGL ES context is made current the + viewport and scissor dimensions are set to the size of the + <parameter>draw</parameter> surface (as though + <function>glViewport</function>(0,0,w,h) and + <function>glScissor</function>(0,0,<parameter>w</parameter>,<parameter>h</parameter>) + were called, where <parameter>w</parameter> and + <parameter>h</parameter> are the width and height of the + surface, respectively). However, the viewport and scissor + dimensions are not modified when <parameter>context</parameter> + is subsequently made current. The client is responsible for + resetting the viewport and scissor in this case. + </para> + <para> + The first time <parameter>context</parameter> is made current, + if it is without a default framebuffer (e.g. both + <parameter>draw</parameter> and <parameter>read</parameter> are + <constant>EGL_NO_SURFACE</constant> ), then the viewport and + scissor regions are set as though + <function>glViewport</function>(0,0,0,0) and + <function>glScissor</function>(0,0,0,0) were called. + </para> + <para> + Implementations may delay allocation of auxiliary buffers for a + surface until they are required by a context (which may result + in the <constant>EGL_BAD_ALLOC</constant> error described + above). Once allocated, however, auxiliary buffers and their + contents persist until a surface is deleted. + </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 xml:id="errors"><title>Errors</title> + <para> + If <parameter>draw</parameter> or <parameter>read</parameter> + are not compatible with <parameter>context</parameter>, then an + <constant>EGL_BAD_MATCH</constant> error is generated. + </para> + <para> + If <parameter>context</parameter> is current to some other + thread, or if either <parameter>draw</parameter> or + <parameter>read</parameter> are bound to contexts in another + thread, an <constant>EGL_BAD_ACCESS</constant> error is + generated. + </para> + <para> + If binding <parameter>context</parameter> would exceed the + number of current contexts of that client API type supported by + the implementation, an <constant>EGL_BAD_ACCESS</constant> error + is generated. + </para> + <para> + If either <parameter>draw</parameter> or + <parameter>read</parameter> are pbuffers created with + <function>eglCreatePbufferFromClientBuffer</function>, and the + underlying bound client API buffers are in use by the client API + that created them, an <constant>EGL_BAD_ACCESS</constant> error + is generated. + </para> + <para> + If <parameter>context</parameter> is not a valid context and is + not <constant>EGL_NO_CONTEXT</constant>, an + <constant>EGL_BAD_CONTEXT</constant> error is generated. + </para> + <para> + If either <parameter>draw</parameter> or + <parameter>read</parameter> are not valid EGL surfaces and are + not <constant>EGL_NO_SURFACE</constant>, an + <constant>EGL_BAD_SURFACE</constant> error is generated. + </para> + <para> + If <parameter>context</parameter> is + <constant>EGL_NO_CONTEXT</constant> and either + <parameter>draw</parameter> or <parameter>read</parameter> are + not <constant>EGL_NO_SURFACE</constant>, an + <constant>EGL_BAD_MATCH</constant> error is generated. + </para> + <para> + If either of <parameter>draw</parameter> or + <parameter>read</parameter> is a valid surface and the other is + <constant>EGL_NO_SURFACE</constant>, an + <constant>EGL_BAD_MATCH</constant> error is generated. + </para> + <para> + If <parameter>context</parameter> does not support being bound + without <parameter>read</parameter> and + <parameter>draw</parameter> surfaces, and both + <parameter>draw</parameter> and <parameter>read</parameter> are + <constant>EGL_NO_SURFACE</constant>, an + <constant>EGL_BAD_MATCH</constant> error is generated. + </para> + <para> + If a native window underlying either <parameter>draw</parameter> + or <parameter>read</parameter> is no longer valid, an + <constant>EGL_BAD_NATIVE_WINDOW</constant> error is generated. + </para> + <para> + If <parameter>draw</parameter> and <parameter>read</parameter> + cannot fit into graphics memory simultaneously, an + <constant>EGL_BAD_MATCH</constant> error is generated. + </para> + <para> + If the previous context of the calling thread has unflushed + commands, and the previous surface is no longer valid, an + <constant>EGL_BAD_CURRENT_SURFACE</constant> error is generated. + </para> + <para> + If the ancillary buffers for <parameter>draw</parameter> and + <parameter>read</parameter> cannot be allocated, an + <constant>EGL_BAD_ALLOC</constant> error is generated. + </para> + <para> + If a power management event has occurred, an + <constant>EGL_CONTEXT_LOST</constant> error is generated. + </para> + <para> + If any of the following are true: + + <itemizedlist> + <listitem> + <para> + <parameter>context</parameter> is not + <constant>EGL_NO_CONTEXT</constant> + </para> + </listitem> + <listitem> + <para> + <parameter>read</parameter> is not + <constant>EGL_NO_SURFACE</constant> + </para> + </listitem> + <listitem> + <para> + <parameter>draw</parameter> is not + <constant>EGL_NO_SURFACE</constant> + </para> + </listitem> + </itemizedlist> + + then an <constant>EGL_NOT_INITIALIZED</constant> error is + generated if <parameter>display</parameter> is a valid but + uninitialized display. + </para> + <para> + As with other commands taking <type>EGLDisplay</type> + parameters, if <parameter>display</parameter> is not a valid + <type>EGLDisplay</type> handle, an + <constant>EGL_BAD_DISPLAY</constant> error is generated. (Some + implementations have chosen to allow + <constant>EGL_NO_DISPLAY</constant> as a valid + <parameter>display</parameter> parameter for + <function>eglMakeCurrent</function>. This behavior is not + portable to all EGL implementations, and should be considered as + an undocumented vendor extension). + </para> + </refsect1> + <refsect1 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglQueryAPI.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglQueryAPI.xml new file mode 100644 index 0000000..f83b6de --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglQueryAPI.xml @@ -0,0 +1,76 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglQueryAPI"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml:id="errors"><title>Errors</title> + <para> + None. + </para> + </refsect1> + <refsect1 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglQueryContext.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglQueryContext.xml new file mode 100644 index 0000000..30ace39 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglQueryContext.xml @@ -0,0 +1,184 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglQueryContext"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglQueryString.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglQueryString.xml new file mode 100644 index 0000000..17fa9e0 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglQueryString.xml @@ -0,0 +1,179 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglQueryString"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <refmeta> + <refentrytitle>eglQueryString</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglQueryString</refname> + <refpurpose> + return a string describing properties of the EGL client or of 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 xml: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 xml:id="description"><title>Description</title> + <para> + <function>eglQueryString</function> returns a pointer to a + static, zero-terminated string describing properties of the EGL + client or of an EGL display connection. + <parameter>name</parameter> may 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-separated 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 name of the vendor responsible for this EGL + implementation. The format and contents of the string + are implementation-dependent. + </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> + <para> + Both the major and minor portions of the version + number are numeric. Their values must match the + <parameter>major</parameter> and + <parameter>minor</parameter> values returned by + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>. + </para> + <para> + The vendor-specific information is optional; if + present, its format and contents are + implementation-specific. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_EXTENSIONS</constant></term> + <listitem> + <para> + Returns a space separated list of supported + extensions to EGL. If there are no extensions, then + the empty string is returned. + </para> + <para> + If <parameter>display</parameter> is + <constant>EGL_NO_DISPLAY</constant>, then the + <constant>EGL_EXTENSIONS</constant> string describes + the set of supported <firstterm>client + extensions</firstterm>. If + <parameter>display</parameter> is a valid, + initialized display, then the + <constant>EGL_EXTENSIONS</constant> string describes + the set of <firstterm>display extensions</firstterm> + supported by that display. The set of supported + client extensions is disjoint from the set of + extensions supported by any given display. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 xml:id="notes"><title>Notes</title> + <para> + <constant>EGL_CLIENT_APIS</constant> is supported only if + the EGL version is 1.2 or greater. + </para> + <para> + A <parameter>display</parameter> of + <constant>EGL_NO_DISPLAY</constant> is supported only if the EGL + version is 1.5 or greater. + </para> + </refsect1> + <refsect1 xml: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, + unless <parameter>display</parameter> is + <constant>EGL_NO_DISPLAY</constant> and + <parameter>name</parameter> is + <constant>EGL_EXTENSIONS</constant>. + </para> + <para> + <constant>EGL_NOT_INITIALIZED</constant> is generated if + <parameter>display</parameter> is a valid but uninitialized + EGLDisplay. + </para> + <para> + <constant>EGL_BAD_PARAMETER</constant> is generated if + <parameter>name</parameter> is not an accepted value. + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglQuerySurface.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglQuerySurface.xml new file mode 100644 index 0000000..574ec71 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglQuerySurface.xml @@ -0,0 +1,310 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglQuerySurface"> + <info> + <copyright> + <year>2003-2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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_GL_COLORSPACE</constant></term> + <listitem><para> + Returns the color space used by OpenGL and OpenGL ES + when rendering to the surface, either + <constant>EGL_GL_COLORSPACE_SRGB</constant> or + <constant>EGL_GL_COLORSPACE_LINEAR</constant>. + </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_VG_ALPHA_FORMAT</constant></term> + <listitem><para> + Returns the interpretation of alpha values used by + OpenVG when rendering to the surface, either + <constant>EGL_VG_ALPHA_FORMAT_NONPRE</constant> or + <constant>EGL_VG_ALPHA_FORMAT_PRE</constant>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><constant>EGL_VG_COLORSPACE</constant></term> + <listitem><para> + Returns the color space used by OpenVG when rendering to + the surface, either + <constant>EGL_VG_COLORSPACE_sRGB</constant> or + <constant>EGL_VG_COLORSPACE_LINEAR</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 xml:id="notes"><title>Notes</title> + <para> + Attribute <constant>EGL_GL_COLORSPACE</constant> is supported + only if the EGL version is 1.5 or greater. + </para> + <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 xml: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 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglReleaseTexImage.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglReleaseTexImage.xml new file mode 100644 index 0000000..eb9ef54 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglReleaseTexImage.xml @@ -0,0 +1,101 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglReleaseTexImage"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglBindTexImage</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglReleaseThread.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglReleaseThread.xml new file mode 100644 index 0000000..6f60215 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglReleaseThread.xml @@ -0,0 +1,125 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglReleaseThread"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetError</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglSurfaceAttrib.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglSurfaceAttrib.xml new file mode 100644 index 0000000..90e626d --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglSurfaceAttrib.xml @@ -0,0 +1,207 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglSurfaceAttrib"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml: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 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglSwapBuffers.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglSwapBuffers.xml new file mode 100644 index 0000000..8a3de8d --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglSwapBuffers.xml @@ -0,0 +1,152 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglSwapBuffers"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml:id="description"><title>Description</title> + <para> + If <parameter>surface</parameter> is a back-buffered window + surface, then the color + buffer is copied (posted) to the native window associated with that + surface. If <parameter>surface</parameter> is a single-buffered + window, pixmap, or pixel buffer surface, + <function>eglSwapBuffers</function> has no effect. + </para> + <para> + The contents of ancillary buffers are always undefined after + calling <function>eglSwapBuffers</function>. The contents of the + color buffer are undefined if the value of the + <constant>EGL_SWAP_BEHAVIOR</constant> attribute of + <parameter>surface</parameter> is not + <constant>EGL_BUFFER_PRESERVED</constant>. The value of + <constant>EGL_SWAP_BEHAVIOR</constant> can be set for some + surfaces using + <citerefentry><refentrytitle>eglSurfaceAttrib</refentrytitle></citerefentry>. + <constant>EGL_SWAP_BEHAVIOR</constant> applies only to the color + buffer. EGL has no way to specify or query whether or not + ancillary buffers are preserved, and applications should not + rely on this behavior. + </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> + </refsect1> + <refsect1 xml:id="resize"><title>Native Window Resizing</title> + <para> + If the native window corresponding to + <parameter>surface</parameter> has been resized prior to the + swap, <parameter>surface</parameter> must be resized to match. + <parameter>surface</parameter> will normally be resized by the + EGL implementation at the time the native window is resized. If + the implementation cannot do this transparently to the client, + then <function>eglSwapBuffers</function> must detect the change + and resize surface prior to copying its pixels to the native + window. If <parameter>surface</parameter> shrinks as a result of + resizing, some rendered pixels are lost. If + <parameter>surface</parameter> grows, the newly allocated buffer + contents are undefined. The resizing behavior described here + only maintains consistency of EGL surfaces and native windows; + clients are still responsible for detecting window size changes + (using platform-specific means) and changing their viewport and + scissor regions accordingly. + </para> + </refsect1> + <refsect1 xml: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. + </para> + </refsect1> + <refsect1 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <function>glFlush</function>, + <citerefentry><refentrytitle>eglCopyBuffers</refentrytitle></citerefentry>, + <function>vgFlush</function> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglSwapInterval.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglSwapInterval.xml new file mode 100644 index 0000000..a6add82 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglSwapInterval.xml @@ -0,0 +1,94 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglSwapInterval"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglTerminate.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglTerminate.xml new file mode 100644 index 0000000..70dd0c3 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglTerminate.xml @@ -0,0 +1,73 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglTerminate"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglWaitClient.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglWaitClient.xml new file mode 100644 index 0000000..a77cf00 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglWaitClient.xml @@ -0,0 +1,84 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglWaitClient"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglWaitGL.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglWaitGL.xml new file mode 100644 index 0000000..033fd8b --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglWaitGL.xml @@ -0,0 +1,82 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglWaitGL"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglWaitClient</refentrytitle></citerefentry> + <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglWaitNative.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglWaitNative.xml new file mode 100644 index 0000000..f4c4595 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglWaitNative.xml @@ -0,0 +1,73 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglWaitNative"> + <info> + <copyright> + <year>2003-2014</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <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 xml: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 xml: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 xml: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 xml: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> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglWaitSync.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglWaitSync.xml new file mode 100644 index 0000000..57d5651 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/eglWaitSync.xml @@ -0,0 +1,134 @@ +<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglWaitSync"> + <info> + <copyright> + <year>2018</year> + <holder>The Khronos Group Inc.</holder> + </copyright> + </info> + <refmeta> + <refentrytitle>eglWaitSync</refentrytitle> + <manvolnum>3G</manvolnum> + </refmeta> + <refnamediv> + <refname>eglWaitSync</refname> + <refpurpose> + Wait in the server for a sync object to be signalled + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>C Specification</title> + <funcsynopsis> + <funcprototype> + <funcdef>EGLBoolean <function>eglWaitSync</function></funcdef> + <paramdef>(EGLDisplay <parameter>display</parameter></paramdef> + <paramdef>EGLSync <parameter>sync</parameter></paramdef> + <paramdef>EGLint <parameter>flags</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + <refsect1 xml: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>sync</parameter></term> + <listitem><para> + Specifies the sync object to wait on. + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem><para> + Specifies flags controlling wait behavior. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 xml:id="description"><title>Description</title> + <para> + <function>eglWaitSync</function> is similar to + <function>eglClientWaitSync</function>, but instead of blocking + and not returning to the application until + <parameter>sync</parameter> is signaled, + <function>eglWaitSync</function> returns immediately. On + success, <constant>EGL_TRUE</constant> is returned, and the + server for the client API context will block until + <parameter>sync</parameter> is signaled. + </para> + <para> + Note: <function>eglWaitSync</function> allows applications to + continue to queue commands from the application in anticipation + of the sync being signaled, potentially increasing parallelism + between application, client API server code, and the GPU. The + server only blocks execution of commands for the specific + context on which <function>eglWaitSync</function> was issued; + other contexts implemented by the same server are not affected.. + </para> + <para> + <parameter>sync</parameter> has the same meaning as for + <function>eglClientWaitSync</function>. + </para> + <para> + <parameter>flags</parameter> must be 0. + </para> + <para> + <function>eglWaitSync</function> requires support from the bound + client API, and will not succeed unless the same client API + properties described for creation of fence syncs in + <citerefentry><refentrytitle>eglCreateSync</refentrytitle></citerefentry> + are satisfied. + </para> + </refsect1> + <refsect1 xml:id="errors"><title>Errors</title> + <para> + <function>eglWaitSync</function> returns + <constant>EGL_FALSE</constant> on failure, and does not cause + the server for the client API context to block. + </para> + <para> + If the current context for the currently bound client API does + not support server waits, an <constant>EGL_BAD_MATCH</constant> + error is generated. + </para> + <para> + If no context is current for the currently bound client API + (i.e., <function>eglGetCurrentContext</function> returns + <constant>EGL_NO_CONTEXT</constant>), an + <constant>EGL_BAD_MATCH</constant> error is generated. + </para> + <para> + If <parameter>display</parameter> does not match the + <type>EGLDisplay</type> passed to + <function>eglCreateSync</function> when + <parameter>sync</parameter> was created, the behavior is + undefined. + </para> + <para> + If <parameter>sync</parameter> is not a valid sync object for + <parameter>display</parameter>, an + <constant>EGL_BAD_PARAMETER</constant> error is generated. + </para> + <para> + If <parameter>flags</parameter> is not 0, an + <constant>EGL_BAD_PARAMETER</constant> error is generated. + </para> + </refsect1> + <refsect1 xml:id="notes"><title>Notes</title> + <para> + <function>eglWaitSync</function> is available only if the EGL + version is 1.5 or greater. + </para> + </refsect1> + <refsect1 xml:id="seealso"><title>See Also</title> + <para> + <citerefentry><refentrytitle>eglClientWaitSync</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglCreateSync</refentrytitle></citerefentry>, + <citerefentry><refentrytitle>eglGetCurrentContext</refentrytitle></citerefentry> + </para> + </refsect1> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> +</refentry> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/headBackground.jpg b/glew/auto/EGL-Registry/sdk/docs/man/headBackground.jpg Binary files differnew file mode 100644 index 0000000..9ae0c2f --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/headBackground.jpg diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/EGL_300.png b/glew/auto/EGL-Registry/sdk/docs/man/html/EGL_300.png Binary files differnew file mode 100644 index 0000000..7c20efb --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/EGL_300.png diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/KhronosLogo.jpg b/glew/auto/EGL-Registry/sdk/docs/man/html/KhronosLogo.jpg Binary files differnew file mode 100644 index 0000000..f8a05f6 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/KhronosLogo.jpg diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/accord.js b/glew/auto/EGL-Registry/sdk/docs/man/html/accord.js new file mode 100644 index 0000000..240489e --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/accord.js @@ -0,0 +1,58 @@ +<!-- Javascript for accordion menus, included by index.php, shared with OpenCL man pages --> +<script type="text/javascript"> +<!-- +var temp, temp2, cookieArray, cookieArray2, cookieCount; +function initiate(){ + cookieCount=0; + if(document.cookie){ + cookieArray=document.cookie.split(";"); + cookieArray2=new Array(); + for(i in cookieArray){ + cookieArray2[cookieArray[i].split("=")[0].replace(/ /g,"")]=cookieArray[i].split("=")[1].replace(/ /g,""); + } + } + cookieArray=(document.cookie.indexOf("state=")>=0)?cookieArray2["state"].split(","):new Array(); + temp=document.getElementById("containerul"); + for(var o=0;o<temp.getElementsByTagName("li").length;o++){ + if(temp.getElementsByTagName("li")[o].getElementsByTagName("ul").length>0){ + temp2 = document.createElement("span"); + temp2.className = "symbols"; + temp2.style.backgroundImage = (cookieArray.length>0)?((cookieArray[cookieCount]=="true")?"url(bullets-contract.gif)":"url(bullets-expand.gif)"):"url(bullets-expand.gif)"; + temp2.onmousedown=function(){ + showhide(this.parentNode); + writeCookie(); + } + temp.getElementsByTagName("li")[o].insertBefore(temp2,temp.getElementsByTagName("li")[o].firstChild) + temp.getElementsByTagName("li")[o].getElementsByTagName("ul")[0].style.display = "none"; + if(cookieArray[cookieCount]=="true"){ + showhide(temp.getElementsByTagName("li")[o]); + } + cookieCount++; + } + else{ + temp2 = document.createElement("span"); + temp2.className = "symbols"; + temp2.style.backgroundImage = "url(bullets-end.gif)"; + temp.getElementsByTagName("li")[o].insertBefore(temp2,temp.getElementsByTagName("li")[o].firstChild); + } + } +} + +function showhide(el){ + el.getElementsByTagName("ul")[0].style.display=(el.getElementsByTagName("ul")[0].style.display=="block")?"none":"block"; + el.getElementsByTagName("span")[0].style.backgroundImage=(el.getElementsByTagName("ul")[0].style.display=="block")?"url(bullets-contract.gif)":"url(bullets-expand.gif)"; +} + +function writeCookie(){ // Runs through the menu and puts the "states" of each nested list into an array, the array is then joined together and assigned to a cookie. + cookieArray=new Array() + for(var q=0;q<temp.getElementsByTagName("li").length;q++){ + if(temp.getElementsByTagName("li")[q].childNodes.length>0){ + if(temp.getElementsByTagName("li")[q].childNodes[0].nodeName=="SPAN" && temp.getElementsByTagName("li")[q].getElementsByTagName("ul").length>0){ + cookieArray[cookieArray.length]=(temp.getElementsByTagName("li")[q].getElementsByTagName("ul")[0].style.display=="block"); + } + } + } + document.cookie="state="+cookieArray.join(",")+";expires="+new Date(new Date().getTime() + 365*24*60*60*1000).toGMTString(); +} +//--> +</script> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/bullets-contract.gif b/glew/auto/EGL-Registry/sdk/docs/man/html/bullets-contract.gif Binary files differnew file mode 100644 index 0000000..bb1e955 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/bullets-contract.gif diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/bullets-end.gif b/glew/auto/EGL-Registry/sdk/docs/man/html/bullets-end.gif Binary files differnew file mode 100644 index 0000000..abd000e --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/bullets-end.gif diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/bullets-expand.gif b/glew/auto/EGL-Registry/sdk/docs/man/html/bullets-expand.gif Binary files differnew file mode 100644 index 0000000..e2dde60 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/bullets-expand.gif diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglBindAPI.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglBindAPI.xhtml new file mode 100644 index 0000000..dbf34c3 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglBindAPI.xhtml @@ -0,0 +1,160 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglBindAPI - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglBindAPI"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglBindAPI — Set the current rendering API</p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglBindAPI</strong>(</code> + </td> + <td>EGLenum <var class="pdparam">api</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>api</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the client API to bind, one of + <code class="constant">EGL_OPENGL_API</code>, + <code class="constant">EGL_OPENGL_ES_API</code>, or + <code class="constant">EGL_OPENVG_API</code>. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglBindAPI</code> 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 + <code class="function">eglCreateContext</code>, + <code class="function">eglGetCurrentContext</code>, + <code class="function">eglGetCurrentDisplay</code>, + <code class="function">eglGetCurrentSurface</code>, + <code class="function">eglMakeCurrent</code>, + <code class="function">eglSwapInterval</code>, + <code class="function">eglWaitClient</code>, and + <code class="function">eglWaitNative</code>. + </p> + <p> + If <em class="parameter"><code>api</code></em> is + <code class="constant">EGL_OPENGL_API</code>, the current rendering + API is set to the OpenGL API. + </p> + <p> + If <em class="parameter"><code>api</code></em> is + <code class="constant">EGL_OPENGL_ES_API</code>, the current + rendering API is set to the OpenGL ES API. + </p> + <p> + If <em class="parameter"><code>api</code></em> is + <code class="constant">EGL_OPENVG_API</code>, the current rendering + API is set to the OpenVG API. + </p> + <p> + If an error occurs, the current rendering API is unchanged. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglBindAPI</code> and the corresponding + <code class="constant">EGL_OPENGL_ES_API</code> and + <code class="constant">EGL_OPENVG_API</code> + <em class="parameter"><code>api</code></em> parameters are supported only if + the EGL version is 1.2 or greater. The + <code class="constant">EGL_OPENGL_API</code> parameter is supported + only if the EGL version is 1.4 or greater. + </p> + <p> + The initial value of the current rendering API is + <code class="constant">EGL_OPENGL_ES_API</code> unless OpenGL ES is + not supported by an implementation, in which case the + initial value is <code class="constant">EGL_NONE</code> (however, + <code class="constant">EGL_NONE</code> is not a valid + <em class="parameter"><code>api</code></em> parameter to + <code class="function">eglBindAPI</code>). + </p> + <p> + The current rendering API can be queried by calling + <code class="function">eglQueryAPI</code>. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure. + </p> + <p> + <code class="constant">EGL_BAD_PARAMETER</code> is generated if + <em class="parameter"><code>api</code></em> is not one of the accepted + tokens, or if the specified client API is not supported by + the EGL implementation. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentDisplay</span></span></a>, + <a class="citerefentry" href="eglGetCurrentSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentSurface</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQueryAPI.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQueryAPI</span></span></a>, + <a class="citerefentry" href="eglSwapInterval.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSwapInterval</span></span></a>, + <a class="citerefentry" href="eglWaitClient.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitClient</span></span></a>, + <a class="citerefentry" href="eglWaitNative.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglBindTexImage.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglBindTexImage.xhtml new file mode 100644 index 0000000..a3c6dbb --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglBindTexImage.xhtml @@ -0,0 +1,228 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglBindTexImage - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglBindTexImage"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglBindTexImage — + Defines a two-dimensional texture image + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglBindTexImage</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSurface <var class="pdparam">surface</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">buffer</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>buffer</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the texture image data.</p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + The texture image consists of the image data in <em class="parameter"><code>buffer</code></em> for the specified surface, and need not be copied. + </p> + <p> + 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 + <code class="constant">EGL_BIND_TO_TEXTURE_RGB</code> or <code class="constant">EGL_BIND_TO_TEXTURE_RGBA</code> attributes. + </p> + <p> + The pbuffer attribute <code class="constant">EGL_TEXTURE_FORMAT</code> determines the base internal format + of the texture. + </p> + <p> + The texture target is derived from the <code class="constant">EGL_TEXTURE_TARGET</code> attribute of surface. + If the attribute value is <code class="constant">EGL_TEXTURE_2D</code>, then <em class="parameter"><code>buffer</code></em> defines a texture for + the two-dimensional texture object which is bound to the current context (hereafter + referred to as the current texture object). + </p> + <p> + If <em class="parameter"><code>display</code></em> and <em class="parameter"><code>surface</code></em> are the display and surface for the calling thread's current + context, <code class="function">eglBindTexImage</code> performs an implicit <a class="citerefentry" href="glFlush.xhtml"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a>. + For other surfaces, <code class="function">eglBindTexImage</code> waits for all effects from previously issued OpenGL ES commands + drawing to the surface to complete before defining the texture image, as + though <a class="citerefentry" href="glFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a> were called on the last context to which that surface were bound. + </p> + <p> + After <code class="function">eglBindTexImage</code> is called, the specified surface is no longer available + for reading or writing. Any read operation, such as <a class="citerefentry" href="glReadPixels.xhtml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a> or + <a class="citerefentry" href="eglCopyBuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCopyBuffers</span></span></a>, 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. + </p> + <p> + Texture mipmap levels are automatically generated when all of the following + conditions are met while calling <code class="function">eglBindTexImage</code>: + </p> + <div class="itemizedlist"> + <ul class="itemizedlist" style="list-style-type: disc; "> + <li class="listitem"> + <p> + The <code class="constant">EGL_MIPMAP_TEXTURE</code> attribute of the pbuffer being bound is + <code class="constant">EGL_TRUE</code>. + </p> + </li> + <li class="listitem"> + <p> + The OpenGL ES texture parameter <code class="constant">GL_GENERATE_MIPMAP</code> is <code class="constant">GL_TRUE</code> for + the currently bound texture. + </p> + </li> + <li class="listitem"> + <p> + The value of the <code class="constant">EGL_MIPMAP_LEVEL</code> attribute of the pbuffer being bound is + equal to the value of the texture parameter <code class="constant">GL_TEXTURE_BASE_LEVEL</code>. + In this case, additional mipmap levels are generated as described in section 3.8 + of the OpenGL ES 1.1 Specification. + </p> + </li> + </ul> + </div> + <p> + In this case, additional mipmap levels are generated as described in section 3.8 + of the OpenGL ES 1.1 Specification. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <a class="citerefentry" href="eglSwapBuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a> has no effect if it is + called on a bound surface. + </p> + <p> + Any existing images associated with the different mipmap levels of the texture object + are freed (it is as if <a class="citerefentry" href="glTexImage.xhtml"><span class="citerefentry"><span class="refentrytitle">glTexImage</span></span></a> + was called with an image of zero width). + </p> + <p> + 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 <a class="citerefentry" href="eglReleaseTexImage.xhtml"><span class="citerefentry"><span class="refentrytitle">eglReleaseTexImage</span></span></a> is called, then the color buffer is released and + the surface is made available for reading and writing. + </p> + <p> + It is not an error to call <a class="citerefentry" href="glTexImage2D.xhtml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a> or + <a class="citerefentry" href="glCopyTexImage2D.xhtml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a> 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. + </p> + <p> + <code class="function">eglBindTexImage</code> is ignored if there is no current rendering context. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_BAD_ACCESS</code> is generated if + <em class="parameter"><code>buffer</code></em> is already bound to a texture. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the + surface attribute <code class="constant">EGL_TEXTURE_FORMAT</code> is + set to <code class="constant">EGL_NO_TEXTURE</code>. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>buffer</code></em> is not a valid buffer + (currently only <code class="constant">EGL_BACK_BUFFER</code> may be + specified). + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL surface, or is + not a pbuffer surface supporting texture binding. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglReleaseTexImage.xhtml"><span class="citerefentry"><span class="refentrytitle">eglReleaseTexImage</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglChooseConfig.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglChooseConfig.xhtml new file mode 100644 index 0000000..ffd6b64 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglChooseConfig.xhtml @@ -0,0 +1,1150 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglChooseConfig - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglChooseConfig"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglChooseConfig — + return a list of EGL frame buffer configurations that match specified attributes + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglChooseConfig</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint const * <var class="pdparam">attrib_list</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLConfig * <var class="pdparam">configs</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">config_size</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint * <var class="pdparam">num_config</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p>Specifies attributes required to match by configs.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>configs</code> + </em> + </span> + </dt> + <dd> + <p>Returns an array of frame buffer configurations.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config_size</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the size of the array of frame buffer configurations.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>num_config</code> + </em> + </span> + </dt> + <dd> + <p>Returns the number of frame buffer configurations returned.</p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglChooseConfig</code> returns in + <em class="parameter"><code>configs</code></em> a list of all + <abbr class="acronym">EGL</abbr> frame buffer configurations that + match the attributes specified in + <em class="parameter"><code>attrib_list</code></em>. The returned + <span class="type">EGLConfig</span>s can be used in any + <abbr class="acronym">EGL</abbr> function that requires an + <abbr class="acronym">EGL</abbr> frame buffer configuration. + </p> + <p> + If <em class="parameter"><code>configs</code></em> is not + <code class="constant">NULL</code>, up to + <em class="parameter"><code>config_size</code></em> configs will be returned + in the array pointed to by <em class="parameter"><code>configs</code></em>. + The number of configs actually returned will be returned in + *<em class="parameter"><code>num_config</code></em>. + </p> + <p> + If <em class="parameter"><code>configs</code></em> is + <code class="constant">NULL</code>, no configs will be returned in + <em class="parameter"><code>configs</code></em>. Instead, the total number of + configs matching <em class="parameter"><code>attrib_list</code></em> will be + returned in *<em class="parameter"><code>num_config</code></em>. In this case + <em class="parameter"><code>config_size</code></em> is ignored. This form of + <code class="function">eglChooseConfig</code> is used to determine + the number of matching frame buffer configurations, followed + by allocating an array of <span class="type">EGLConfig</span> to pass + into another call to <code class="function">eglChooseConfig</code> + with all other parameters unchanged. + </p> + <p> + All attributes in <em class="parameter"><code>attrib_list</code></em>, + including boolean attributes, are immediately followed by + the corresponding desired value. The list is terminated with + <code class="constant">EGL_NONE</code>. If an attribute is not + specified in <em class="parameter"><code>attrib_list</code></em> then the + default value (see below) is used (and the attribute is said + to be specified implicitly). For example, if + <code class="constant">EGL_DEPTH_SIZE</code> is not specified then it + is assumed to be zero. For some attributes, the default is + <code class="constant">EGL_DONT_CARE</code> meaning that any value is + OK for this attribute, so the attribute will not be checked. + </p> + <p> + Attributes are matched in an attribute-specific manner. Some + of the attributes, such as <code class="constant">EGL_LEVEL</code>, + must match the specified value exactly. Others, such as, + <code class="constant">EGL_RED_SIZE</code> 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. + </p> + <p> + For the bitmask attributes + <code class="constant">EGL_CONFORMANT</code>, + <code class="constant">EGL_RENDERABLE_TYPE</code>, and + <code class="constant">EGL_SURFACE_TYPE</code>, 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. + </p> + <p> + Attributes which may appear in + <em class="parameter"><code>attrib_list</code></em>, and their descriptions + and allowed values, are: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_ALPHA_MASK_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + <p> + The alpha mask buffer is used only by OpenVG. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_ALPHA_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BIND_TO_TEXTURE_RGB</code> + </span> + </dt> + <dd> + <p> + Must be followed by + <code class="constant">EGL_DONT_CARE</code>, + <code class="constant">EGL_TRUE</code>, or + <code class="constant">EGL_FALSE</code>. + If <code class="constant">EGL_TRUE</code> 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 <code class="constant">EGL_DONT_CARE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BIND_TO_TEXTURE_RGBA</code> + </span> + </dt> + <dd> + <p> + Must be followed by one of + <code class="constant">EGL_DONT_CARE</code>, + <code class="constant">EGL_TRUE</code>, or + <code class="constant">EGL_FALSE</code>. + If <code class="constant">EGL_TRUE</code> 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 + <code class="constant">EGL_DONT_CARE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BLUE_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BUFFER_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + <p> + The color buffer size is the sum of + <code class="constant">EGL_RED_SIZE</code>, + <code class="constant">EGL_GREEN_SIZE</code>, + <code class="constant">EGL_BLUE_SIZE</code>, and + <code class="constant">EGL_ALPHA_SIZE</code>, 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_COLOR_BUFFER_TYPE</code> + </span> + </dt> + <dd> + <p> + Must be followed by one of + <code class="constant">EGL_RGB_BUFFER</code> or + <code class="constant">EGL_LUMINANCE_BUFFER</code>. + </p> + <p> + <code class="constant">EGL_RGB_BUFFER</code> indicates + an RGB color buffer; in this case, + attributes <code class="constant">EGL_RED_SIZE</code>, + <code class="constant">EGL_GREEN_SIZE</code> and + <code class="constant">EGL_BLUE_SIZE</code> must be non-zero, and + <code class="constant">EGL_LUMINANCE_SIZE</code> must be zero. + </p> + <p> + <code class="constant">EGL_LUMINANCE_BUFFER</code> indicates a luminance color + buffer. In this case <code class="constant">EGL_RED_SIZE</code>, + <code class="constant">EGL_GREEN_SIZE</code>, + <code class="constant">EGL_BLUE_SIZE</code> must be zero, and + <code class="constant">EGL_LUMINANCE_SIZE</code> must be non-zero. + </p> + <p> + For both RGB and luminance color buffers, + <code class="constant">EGL_ALPHA_SIZE</code> may be zero or + non-zero. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_CAVEAT</code> + </span> + </dt> + <dd> + <p> + Must be followed by + <code class="constant">EGL_DONT_CARE</code>, + <code class="constant">EGL_NONE</code>, + <code class="constant">EGL_SLOW_CONFIG</code>, or + <code class="constant">EGL_NON_CONFORMANT_CONFIG</code>. + </p> + <p> + If <code class="constant">EGL_DONT_CARE</code> is specified, + then configs are not matched for this attribute. The + default value is <code class="constant">EGL_DONT_CARE</code>. + </p> + <p> + If <code class="constant">EGL_NONE</code> is specified, then + configs are matched for this attribute, but only + configs with no caveats (neither + <code class="constant">EGL_SLOW_CONFIG</code> or + <code class="constant">EGL_NON_CONFORMANT_CONFIG</code>) will + be considered. + </p> + <p> + If <code class="constant">EGL_SLOW_CONFIG</code> 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. + </p> + <p> + If <code class="constant">EGL_NON_CONFORMANT_CONFIG</code> is + specified, then only configs supporting + non-conformant OpenGL ES contexts will be + considered. + </p> + <p> + If the EGL version is 1.3 or later, caveat + <code class="constant">EGL_NON_CONFORMANT_CONFIG</code> is + obsolete, since the same information can be + specified via the + <code class="constant">EGL_CONFORMANT</code> attribute on a + per-client-API basis, not just for OpenGL ES. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_ID</code> + </span> + </dt> + <dd> + <p> + Must be followed by a valid integer ID that + indicates the desired EGL frame buffer + configuration. When a + <code class="constant">EGL_CONFIG_ID</code> is specified, all + other attributes are ignored. The default value is + <code class="constant">EGL_DONT_CARE</code>. + </p> + <p> + The meaning of config IDs is + implementation-dependent. They are used only to + uniquely identify different frame buffer + configurations. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONFORMANT</code> + </span> + </dt> + <dd> + <p> + 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: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_OPENGL_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating OpenGL contexts. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_OPENGL_ES_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating OpenGL ES 1.0 + and/or 1.1 contexts. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_OPENGL_ES2_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating OpenGL ES 2.0 contexts. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_OPENVG_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating OpenVG contexts. + </p> + </dd> + </dl> + </div> + <p> + For example, if the bitmask is set to + <code class="constant">EGL_OPENGL_ES_BIT</code>, only frame + buffer configurations that support creating + conformant OpenGL ES contexts will match. The + default value is zero. + </p> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_DEPTH_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + <p> + The depth buffer is used only by OpenGL and OpenGL + ES client APIs. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_GREEN_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LEVEL</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + <p> + Most platforms do not support buffer levels other than + zero. The behavior of windows placed in overlay and + underlay planes depends on the underlying platform. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LUMINANCE_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code> + </span> + </dt> + <dd> + <p> + Must be followed by the handle of a valid native + pixmap, cast to <span class="type">EGLint</span>, or + <code class="constant">EGL_NONE</code>. If the value is not + <code class="constant">EGL_NONE</code>, only configs which + support creating pixmap surfaces with this pixmap + using + <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a> + will match this attribute. If the value is + <code class="constant">EGL_NONE</code>, then configs are not + matched for this attribute. The default value is + <code class="constant">EGL_NONE</code>. + </p> + <p> + <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code> was + introduced due to the difficulty of determining an + <span class="type">EGLConfig</span> compatibile with a native + pixmap using only color component sizes. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_NATIVE_RENDERABLE</code> + </span> + </dt> + <dd> + <p> + Must be followed by + <code class="constant">EGL_DONT_CARE</code>, + <code class="constant">EGL_TRUE</code>, or + <code class="constant">EGL_FALSE</code>. + If <code class="constant">EGL_TRUE</code> is specified, then + only frame buffer configurations that allow native + rendering into the surface will be considered. The + default value is <code class="constant">EGL_DONT_CARE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MAX_SWAP_INTERVAL</code> + </span> + </dt> + <dd> + <p> + Must be followed by a integer that indicates the + maximum value that can be passed to + <a class="citerefentry" href="eglSwapInterval.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSwapInterval</span></span></a>. + The default value is + <code class="constant">EGL_DONT_CARE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MIN_SWAP_INTERVAL</code> + </span> + </dt> + <dd> + <p> + Must be followed by a integer that indicates the + minimum value that can be passed to eglSwapInterval. + The default value is <code class="constant">EGL_DONT_CARE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RED_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SAMPLE_BUFFERS</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SAMPLES</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_STENCIL_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + <p> + The stencil buffer is used only by OpenGL and + OpenGL ES client APIs. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RENDERABLE_TYPE</code> + </span> + </dt> + <dd> + <p> + Must be followed by a bitmask indicating which types + of client API contexts the frame buffer + configuration must support creating with + <a class="citerefentry" href="eglCreateContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>). + Mask bits are the same as for attribute + <code class="constant">EGL_CONFORMANT</code>. The default + value is <code class="constant">EGL_OPENGL_ES_BIT</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SURFACE_TYPE</code> + </span> + </dt> + <dd> + <p> + Must be followed by a bitmask indicating which EGL + surface types and capabilities the frame buffer + configuration must support. Mask bits include: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX_BIT</code> + </span> + </dt> + <dd> + <p> + Config allows specifying box filtered + multisample resolve behavior with + <a class="citerefentry" href="eglSurfaceAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_PBUFFER_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating pixel buffer surfaces. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_PIXMAP_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating pixmap surfaces. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SWAP_BEHAVIOR_PRESERVED_BIT</code> + </span> + </dt> + <dd> + <p> + Config allows setting swap behavior for + color buffers with + <a class="citerefentry" href="eglSurfaceAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE_BIT</code> + </span> + </dt> + <dd> + <p> + Config allows specifying OpenVG rendering + with premultiplied alpha values at surface + creation time (see + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + and + <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>). + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_COLORSPACE_LINEAR_BIT</code> + </span> + </dt> + <dd> + <p> + Config allows specifying OpenVG rendering in + a linear colorspace at surface creation time + (see + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + and + <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>). + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_WINDOW_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating window surfaces. + </p> + </dd> + </dl> + </div> + <p> + For example, if the bitmask is set to + <code class="constant">EGL_WINDOW_BIT</code> | + <code class="constant">EGL_PIXMAP_BIT</code>, + only frame buffer configurations that support both + windows and pixmaps will be considered. The default + value is <code class="constant">EGL_WINDOW_BIT</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_TYPE</code> + </span> + </dt> + <dd> + <p> + Must be followed by one of + <code class="constant">EGL_NONE</code> or + <code class="constant">EGL_TRANSPARENT_RGB</code>. If + <code class="constant">EGL_NONE</code> is specified, then + only opaque frame buffer configurations will be + considered. If + <code class="constant">EGL_TRANSPARENT_RGB</code> is + specified, then only transparent frame buffer + configurations will be considered. The default value + is <code class="constant">EGL_NONE</code>. + </p> + <p> + Most implementations support only opaque frame + buffer configurations. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_RED_VALUE</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_DONT_CARE</code>. + </p> + <p> + This attribute is ignored unless + <code class="constant">EGL_TRANSPARENT_TYPE</code> is included in + <em class="parameter"><code>attrib_list</code></em> and specified as + <code class="constant">EGL_TRANSPARENT_RGB</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_GREEN_VALUE</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_DONT_CARE</code>. + </p> + <p> + This attribute is ignored unless + <code class="constant">EGL_TRANSPARENT_TYPE</code> is included in + <em class="parameter"><code>attrib_list</code></em> and specified as + <code class="constant">EGL_TRANSPARENT_RGB</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_BLUE_VALUE</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_DONT_CARE</code>. + </p> + <p> + This attribute is ignored unless + <code class="constant">EGL_TRANSPARENT_TYPE</code> is included in + <em class="parameter"><code>attrib_list</code></em> and specified as + <code class="constant">EGL_TRANSPARENT_RGB</code>. + </p> + </dd> + </dl> + </div> + <p> + 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): + </p> + <div class="orderedlist"> + <ol class="orderedlist" type="1"> + <li class="listitem"> + <p> + Special: by <code class="constant">EGL_CONFIG_CAVEAT</code>, + where the precedence is <code class="constant">EGL_NONE</code>, + <code class="constant">EGL_SLOW_CONFIG</code>, and + <code class="constant">EGL_NON_CONFORMANT_CONFIG</code>. + </p> + </li> + <li class="listitem"> + <p> + Special: by <code class="constant">EGL_COLOR_BUFFER_TYPE</code>, + where the precedence is + <code class="constant">EGL_RGB_BUFFER</code>, + <code class="constant">EGL_LUMINANCE_BUFFER</code>. + </p> + </li> + <li class="listitem"> + <p> + Special: by larger total number of color bits (for an + RGB color buffer, this is the sum of + <code class="constant">EGL_RED_SIZE</code>, + <code class="constant">EGL_GREEN_SIZE</code>, + <code class="constant">EGL_BLUE_SIZE</code>, and + <code class="constant">EGL_ALPHA_SIZE</code>; for a luminance + color buffer, the sum of + <code class="constant">EGL_LUMINANCE_SIZE</code> and + <code class="constant">EGL_ALPHA_SIZE</code>). If the requested + number of bits in <em class="parameter"><code>attrib_list</code></em> is + <code class="constant">0</code> or + <code class="constant">EGL_DONT_CARE</code> for a particular + color component, then the number of bits for that + component is not considered. + </p> + <p> + This sort rule places configs with deeper color buffers + before configs with shallower color buffers, which may + be counterintuitive. + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_BUFFER_SIZE</code>. + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_SAMPLE_BUFFERS</code>. + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_SAMPLES</code>. + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_DEPTH_SIZE</code>. + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_STENCIL_SIZE</code>. + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_ALPHA_MASK_SIZE</code>. + </p> + </li> + <li class="listitem"> + <p> + Special: <code class="constant">EGL_NATIVE_VISUAL_TYPE</code> + (the actual sort order is implementation-defined, + depending on the meaning of native visual types). + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_CONFIG_ID</code> (this is + always the last sorting rule, and guarantees a unique + ordering). + </p> + </li> + </ol> + </div> + <p> + <span class="type">EGLConfigs</span> are not sorted with respect to the + attributes <code class="constant">EGL_BIND_TO_TEXTURE_RGB</code>, + <code class="constant">EGL_BIND_TO_TEXTURE_RGBA</code>, + <code class="constant">EGL_CONFORMANT</code>, + <code class="constant">EGL_LEVEL</code>, + <code class="constant">EGL_NATIVE_RENDERABLE</code>, + <code class="constant">EGL_MAX_SWAP_INTERVAL</code>, + <code class="constant">EGL_MIN_SWAP_INTERVAL</code>, + <code class="constant">EGL_RENDERABLE_TYPE</code>, + <code class="constant">EGL_SURFACE_TYPE</code>, + <code class="constant">EGL_TRANSPARENT_TYPE</code>, + <code class="constant">EGL_TRANSPARENT_RED_VALUE</code>, + <code class="constant">EGL_TRANSPARENT_GREEN_VALUE</code>, and + <code class="constant">EGL_TRANSPARENT_BLUE_VALUE</code>. + </p> + </div> + <div class="refsect1" id="examples"> + <h2>Examples</h2> + <p> + 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. + </p> + <pre class="programlisting">EGLint const attrib_list[] = { + EGL_RED_SIZE, 4, + EGL_GREEN_SIZE, 4, + EGL_BLUE_SIZE, 4, + EGL_NONE +};</pre> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="constant">EGL_RENDERABLE_TYPE</code> bit + <code class="constant">EGL_OPENGL_BIT</code>, and + <code class="constant">EGL_SURFACE_TYPE</code> bits + <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX_BIT</code> and + <code class="constant">EGL_SWAP_BEHAVIOR_PRESERVED_BIT</code> are + supported only if the EGL version is 1.4 or greater. + </p> + <p> + <code class="constant">EGL_CONFORMANT</code>, + <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code>, + <code class="constant">EGL_RENDERABLE_TYPE</code> bit + <code class="constant">EGL_OPENGL_ES2_BIT</code>, and + <code class="constant">EGL_SURFACE_TYPE</code> bits + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE_BIT</code> and + <code class="constant">EGL_VG_COLORSPACE_LINEAR_BIT</code> are + supported only if the EGL version is 1.3 or greater. + </p> + <p> + <code class="constant">EGL_ALPHA_MASK_SIZE</code>, + <code class="constant">EGL_COLOR_BUFFER_TYPE</code>, + <code class="constant">EGL_LUMINANCE_SIZE</code>, + <code class="constant">EGL_RENDERABLE_TYPE</code>, and + <code class="constant">EGL_RENDERABLE_TYPE</code> bits + <code class="constant">EGL_OPENGL_ES_BIT</code> and + <code class="constant">EGL_OPENVG_BIT</code> are supported only if + the EGL version is 1.2 or greater. + </p> + <p> + If OpenGL or OpenGL ES rendering is supported for a + luminance color buffer, it is treated as RGB rendering with + the value of <code class="constant">GL_RED_BITS</code> equal to + <code class="constant">EGL_LUMINANCE_SIZE</code> and the values of + <code class="constant">GL_GREEN_BITS</code> and + <code class="constant">GL_BLUE_BITS</code> 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. + </p> + <p> + <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a> + and + <a class="citerefentry" href="eglGetConfigAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a> + can be used to implement selection algorithms other than the + generic one implemented by + <code class="function">eglChooseConfig</code>. Call + <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a> + to retrieve all the frame buffer configurations, or + alternatively, all the frame buffer configurations with a + particular set of attributes. Next call + <a class="citerefentry" href="eglGetConfigAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a> + to retrieve additional attributes for the frame buffer + configurations and then select between them. + </p> + <p> + EGL implementors are strongly discouraged, but not + proscribed, from changing the selection algorithm used by + <code class="function">eglChooseConfig</code>. Therefore, selections + may change from release to release of the client-side + library. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>configs</code></em> and + <em class="parameter"><code>num_config</code></em> are not modified when + <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attribute_list</code></em> contains an invalid frame buffer + configuration attribute or an + attribute value that is unrecognized or out of range. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_PARAMETER</code> is generated if + <em class="parameter"><code>num_config</code></em> is <code class="constant">NULL</code>. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglGetConfigAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a>, + <a class="citerefentry" href="eglSurfaceAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>, + <a class="citerefentry" href="eglSwapInterval.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSwapInterval</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglClientWaitSync.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglClientWaitSync.xhtml new file mode 100644 index 0000000..daccb25 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglClientWaitSync.xhtml @@ -0,0 +1,226 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglClientWaitSync - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglClientWaitSync"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglClientWaitSync — + Wait in the client for a sync object to be signalled + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLint <strong class="fsfunc">eglClientWaitSync</strong>(</code> + </td> + <td>(EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSync <var class="pdparam">sync</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">flags</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLTime <var class="pdparam">timeout</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the <abbr class="acronym">EGL</abbr> display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>sync</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the sync object to wait on. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>flags</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies flags controlling wait behavior. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>timeout</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies wait timeout interval. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglClientWaitSync</code> blocks the calling thread + until the specified sync object <em class="parameter"><code>sync</code></em> is + signaled, or until <em class="parameter"><code>timeout</code></em> nanoseconds + have passed. + </p> + <p> + More than one <code class="function">eglClientWaitSync</code> may be + outstanding on the same <em class="parameter"><code>sync</code></em> at any given + time. When there are multiple threads blocked on the same + <em class="parameter"><code>sync</code></em> and the sync object is signaled, all + such threads are released, but the order in which they are + released is not defined. + </p> + <p> + If the value of <em class="parameter"><code>timeout</code></em> is zero, then + <code class="function">eglClientWaitSync</code> simply tests the current + status of <em class="parameter"><code>sync</code></em>. If the value of + <em class="parameter"><code>timeout</code></em> is the special value + <code class="constant">EGL_FOREVER</code>, then + <code class="function">eglClientWaitSync</code> does not time out. For + all other values, <em class="parameter"><code>timeout</code></em> is adjusted to + the closest value allowed by the implementation-dependent + timeout accuracy, which may be substantially longer than one + nanosecond. + </p> + <p> + <code class="function">eglClientWaitSync</code> returns one of three + status values describing the reason for returning. A return + value of <code class="constant">EGL_TIMEOUT_EXPIRED</code> indicates that + the specified timeout period expired before + <em class="parameter"><code>sync</code></em> was signaled, or if + <em class="parameter"><code>timeout</code></em> is zero, indicates that + <em class="parameter"><code>sync</code></em> is not signaled. A return value of + <code class="constant">EGL_CONDITION_SATISFIED</code> indicates that + <em class="parameter"><code>sync</code></em> was signaled before the timeout + expired, which includes the case when + <em class="parameter"><code>sync</code></em> was already signaled when + <code class="function">eglClientWaitSync</code> was called. If an error + occurs then an error is generated and + <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + If the sync object being blocked upon will not be signaled in + finite time (for example, by an associated fence command issued + previously, but not yet flushed to the graphics pipeline), then + <code class="function">eglClientWaitSync</code> may wait forever. To help + prevent this behavior, if the + <code class="constant">EGL_SYNC_FLUSH_COMMANDS_BIT</code> bit is set in + <em class="parameter"><code>flags</code></em>, and <em class="parameter"><code>sync</code></em> is + unsignaled when <code class="function">eglClientWaitSync</code> is + called, then the equivalent of Flush() will be performed for the + current API context (i.e., the context returned by + <code class="function">eglGetCurrentContext</code>) before blocking on + <em class="parameter"><code>sync</code></em>. If no context is current for the + bound API, the <code class="constant">EGL_SYNC_FLUSH_COMMANDS_BIT</code> + bit is ignored. + </p> + <p> + Note: the simple Flush behavior defined by + <code class="constant">EGL_SYNC_FLUSH_COMMANDS_BIT</code> will not help + when waiting for a fence command issued in a different context's + command stream. Applications which block on a fence sync object + must take additional steps to ensure that the context from which + the associated fence command was issued has flushed that command + to the graphics pipeline. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="function">eglClientWaitSync</code> returns + <code class="constant">EGL_FALSE</code> on failure. + </p> + <p> + If <em class="parameter"><code>sync</code></em> is not a valid sync object for + <em class="parameter"><code>display</code></em>, an + <code class="constant">EGL_BAD_PARAMETER</code> error is generated. + </p> + <p> + If <em class="parameter"><code>display</code></em> does not match the + <span class="type">EGLDisplay</span> passed to + <code class="function">eglCreateSync</code> when + <em class="parameter"><code>sync</code></em> was created, the behaviour is + undefined. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglClientWaitSync</code> is available only if the + EGL version is 1.5 or greater. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateSync</span></span></a>, + <a class="citerefentry" href="eglGetCurrentContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentContext</span></span></a>, + <a class="citerefentry" href="eglWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitSync</span></span></a>, + <code class="function">glFinish</code>, + <code class="function">vgFinish</code> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglCopyBuffers.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCopyBuffers.xhtml new file mode 100644 index 0000000..c5c10aa --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCopyBuffers.xhtml @@ -0,0 +1,170 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglCopyBuffers - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglCopyBuffers"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglCopyBuffers — + copy <abbr class="acronym">EGL</abbr> surface color buffer to a native pixmap + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglCopyBuffers</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSurface <var class="pdparam">surface</var>, </td> + </tr> + <tr> + <td> </td> + <td>NativePixmapType <var class="pdparam">native_pixmap</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface whose color buffer is to be copied. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>native_pixmap</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the native pixmap as target of the copy. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglCopyBuffers</code> copies the color buffer of + <em class="parameter"><code>surface</code></em> to <em class="parameter"><code>native_pixmap</code></em>. + </p> + <p> + <code class="function">eglCopyBuffers</code> performs an implicit + <a class="citerefentry" href="glFlush.xhtml"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a> + before it returns. Subsequent + GL commands may be issued immediately after calling + <code class="function">eglCopyBuffers</code>, + but are not executed until copying of the color buffer is completed. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + The color buffer of <em class="parameter"><code>surface</code></em> is left unchanged + after calling <code class="function">eglCopyBuffers</code>. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if swapping of the + surface buffers fails, <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL drawing surface. + </p> + <p> + <code class="constant">EGL_BAD_NATIVE_PIXMAP</code> is generated if + the implementation does not support native pixmaps. + </p> + <p> + <code class="constant">EGL_BAD_NATIVE_PIXMAP</code> may be generated if + <em class="parameter"><code>native_pixmap</code></em> is not a valid native pixmap. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + the format of <em class="parameter"><code>native_pixmap</code></em> is not compatible + with the color buffer of <em class="parameter"><code>surface</code></em>. + </p> + <p> + <code class="constant">EGL_CONTEXT_LOST</code> 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. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="glFlush.xhtml"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a>, + <a class="citerefentry" href="eglSwapBuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreateContext.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreateContext.xhtml new file mode 100644 index 0000000..3b60280 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreateContext.xhtml @@ -0,0 +1,287 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglCreateContext - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglCreateContext"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglCreateContext — + create a new <abbr class="acronym">EGL</abbr> rendering context + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLContext <strong class="fsfunc">eglCreateContext</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLConfig <var class="pdparam">config</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLContext <var class="pdparam">share_context</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint const * <var class="pdparam">attrib_list</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the + <abbr class="acronym">EGL</abbr> + display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL frame buffer configuration that + defines the frame buffer resource available to the rendering context. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>share_context</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies another + <abbr class="acronym">EGL</abbr> + 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 + <em class="parameter"><code>share_context</code></em> shares data. + <code class="constant">EGL_NO_CONTEXT</code> indicates that + no sharing is to take place. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies attributes and attribute values for the + context being created. Only the attribute + <code class="constant">EGL_CONTEXT_CLIENT_VERSION</code> may + be specified. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglCreateContext</code> creates an EGL + rendering context for the current rendering API (as set with + <code class="function">eglBindAPI</code>) and returns a handle to the + context. The context can then be used to render into an EGL + drawing surface. If <code class="function">eglCreateContext</code> + fails to create a rendering context, + <code class="constant">EGL_NO_CONTEXT</code> is returned. + </p> + <p> + If <em class="parameter"><code>share_context</code></em> is not + <code class="constant">EGL_NO_CONTEXT</code>, then all shareable data + in the context (as defined by the client API specification + for the current rendering API) are shared by context + <em class="parameter"><code>share_context</code></em>, all other contexts + <em class="parameter"><code>share_context</code></em> 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. + </p> + <p> + <em class="parameter"><code>attrib_list</code></em> specifies a list of + attributes for the context. The list has the same structure + as described for <code class="function">eglChooseConfig</code>. The + attributes and attribute values which may be specified are + as follows: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_MAJOR_VERSION</code> + </span> + </dt> + <dd> + <p> + Must be followed by an integer specifying the requested + major version of an OpenGL or OpenGL ES context. The + default value is 1. This attribute is an alias of the + older <code class="constant">EGL_CONTEXT_CLIENT_VERSION</code>, + and the tokens may be used interchangeably. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_MINOR_VERSION</code> + </span> + </dt> + <dd> + <p> + Must be followed by an integer specifying the requested + minor version of an OpenGL or OpenGL ES context. The + default value is 0. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_OPENGL_PROFILE_MASK</code> + </span> + </dt> + <dd> + <p> + Must be followed by an integer bitmask specifying the + <em class="firstterm">profile</em> of an OpenGL context. + Bits which may be set include + <code class="constant">EGL_CONTEXT_OPENGL_CORE_PROFILE_BIT</code> + for a core profile and + <code class="constant">EGL_CONTEXT_OPENGL_COMPATIBILITY_PROFILE_BIT</code> + for a compatibility profile. The default value is + <code class="constant">EGL_CONTEXT_OPENGL_CORE_PROFILE_BIT</code>. + All OpenGL 3.2 and later implementations are required to + implement the core profile, but implementation of the + compatibility profile is optional. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_OPENGL_DEBUG</code> + </span> + </dt> + <dd> + <p> + Must be followed by <code class="constant">EGL_TRUE</code>, + specifying that an OpenGL or OpenGL ES <em class="firstterm">debug + context</em> should be created, or + <code class="constant">EGL_FALSE</code>, if a non-debug context + should be created. The default value is + <code class="constant">EGL_FALSE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_OPENGL_FORWARD_COMPATIBLE</code> + </span> + </dt> + <dd> + <p> + Must be followed by <code class="constant">EGL_TRUE</code>, + specifying that a + <em class="firstterm">forward-compatible</em> OpenGL context + should be created, or <code class="constant">EGL_FALSE</code>, if + a non-forward-compatible context should be created. The + default value is <code class="constant">EGL_FALSE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_OPENGL_ROBUST_ACCESS</code> + </span> + </dt> + <dd> + <p> + Must be followed by <code class="constant">EGL_TRUE</code>, + specifying that an OpenGL or OpenGL ES context + supporting <em class="firstterm">robust buffer access</em> + should be created, or <code class="constant">EGL_FALSE</code>, if + a non-robust context should be created. The default + value is <code class="constant">EGL_FALSE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_OPENGL_RESET_NOTIFICATION_STRATEGY</code> + </span> + </dt> + <dd> + <p> + Must be followed by + <code class="constant">EGL_LOSE_CONTEXT_ON_RESET</code>, + specifying that an OpenGL or OpenGL ES context with + reset notification behavior + <code class="constant">GL_LOSE_CONTEXT_ON_RESET_ARB</code> should + be created, or + <code class="constant">EGL_NO_RESET_NOTIFICATION</code>, + specifying that an OpenGL or OpenGL ES context with + reset notification behavior + <code class="constant">GL_NO_RESET_NOTIFICATION_ARB</code> should + be created, as described by the + <code class="constant">GL_ARB_robustness</code> extension. + </p> + <p> + If the + <code class="constant">EGL_CONTEXT_OPENGL_ROBUST_ACCESS</code> + attribute is not set to <code class="constant">EGL_TRUE</code>, + context creation will not fail, but the resulting + context may not support robust buffer access, and + therefore may not support the requested reset + notification strategy The default value for + <code class="constant">EGL_CONTEXT_OPENGL_RESET_NOTIFICATION_STRATEGY</code> + is <code class="constant">EGL_NO_RESET_NOTIFICATION</code> . + </p> + </dd> + </dl> + </div> + <p> + There are many possible interactions between requested OpenGL + and OpenGL ES context creation attributes, depending on the API + versions and extensions supported by the implementation. These + interactions are described in detail in the EGL 1.5 + Specification, but are not listed here for compactness. The + requested attributes may not be able to be satisfied, but + context creation may still succeed. Applications should ensure + that the OpenGL or OpenGL ES contexts supports needed features + before using them, by determining the actual context version, + supported extensions, and supported context flags using runtime + queries. + </p> + </div> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreateImage.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreateImage.xhtml new file mode 100644 index 0000000..633cd0b --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreateImage.xhtml @@ -0,0 +1,774 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglCreateImage - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglCreateImage"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglCreateImage — + Create a new <span class="type">EGLImage</span> object + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLImage <strong class="fsfunc">eglCreateImage</strong>(</code> + </td> + <td>(EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLContext <var class="pdparam">context</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLenum <var class="pdparam">target</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLClientBuffer <var class="pdparam">buffer</var>, </td> + </tr> + <tr> + <td> </td> + <td>const EGLAttrib *<var class="pdparam">attrib_list</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the <abbr class="acronym">EGL</abbr> display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>context</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the client API context for which the image is + created. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>target</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the type of resource used as the image source. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>buffer</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the resource to be used as the image source. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies attributes used to select sub-sections of the + resource to be used as the image source. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglCreateImage</code> is used to create an + <span class="type">EGLImage</span> object from an existing image resource + <em class="parameter"><code>buffer</code></em>. <em class="parameter"><code>display</code></em> + specifies the EGL display used for this operation. + <em class="parameter"><code>context</code></em> specifies the EGL client API + context used for this operation, or + <code class="constant">EGL_NO_CONTEXT</code> if a client API context is + not required. <em class="parameter"><code>target</code></em> specifies the type + of resource being used as the <span class="type">EGLImage</span> source + (examples include two-dimensional textures in OpenGL ES contexts + and <span class="type">VGImage</span> objects in OpenVG contexts). + <em class="parameter"><code>buffer</code></em> is the name (or handle) of a + resource to be used as the <span class="type">EGLImage</span> source, cast + into the type <span class="type">EGLClientBuffer</span>. + <em class="parameter"><code>attrib_list</code></em> is a list of attribute-value + pairs which is used to select sub-sections of + <em class="parameter"><code>buffer</code></em> for use as the + <span class="type">EGLImage</span> source, such as mipmap levels for OpenGL + ES texture map resources, as well as behavioral options, such as + whether to preserve pixel data during creation. If + <em class="parameter"><code>attrib_list</code></em> is + non-<code class="constant">NULL</code>, the last attribute specified in + the list must be <code class="constant">EGL_NONE</code>. + </p> + <p> + The resource specified by <em class="parameter"><code>display</code></em>, + <em class="parameter"><code>context</code></em>, <em class="parameter"><code>target</code></em>, + <em class="parameter"><code>buffer</code></em>, and + <em class="parameter"><code>attrib_list</code></em> must not itself be an + <span class="type">EGLImage</span> sibling, or bound to a pbuffer + <span class="type">EGLSurface</span> resource + (<code class="function">eglBindTexImage</code>, + <code class="function">eglCreatePbufferFromClientBuffer</code>). + </p> + <p> + Values accepted for <em class="parameter"><code>target</code></em> are shown in + table <a class="xref" href="#tab-imagetarget" title="Table 1. Legal values for eglCreateImage target">Table 1, “ + Legal values for <code class="function">eglCreateImage</code> <em class="parameter"><code>target</code></em> + ”</a>. + </p> + <div class="table" id="tab-imagetarget"> + <div class="table-title">Table 1. + Legal values for <code class="function">eglCreateImage</code> <em class="parameter"><code>target</code></em> + </div> + <div class="table-contents"> + <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; "> + <colgroup> + <col/> + <col/> + </colgroup> + <thead> + <tr> + <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <em class="parameter"> + <code>target</code> + </em> + </th> + <th style="text-align: left; border-bottom: 2px solid ; ">Notes</th> + </tr> + </thead> + <tbody> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_GL_TEXTURE_2D</code> + </td> + <td style="text-align: left; border-bottom: 2px solid ; ">Used for GL 2D texture images</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_X</code> + </td> + <td style="text-align: left; border-bottom: 2px solid ; ">Used for the +X face of GL cubemap texture images</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_X</code> + </td> + <td style="text-align: left; border-bottom: 2px solid ; ">Used for the -X face of GL cubemap texture images</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_Y</code> + </td> + <td style="text-align: left; border-bottom: 2px solid ; ">Used for the +Y face of GL cubemap texture images</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</code> + </td> + <td style="text-align: left; border-bottom: 2px solid ; ">Used for the -Y face of GL cubemap texture images</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_Z</code> + </td> + <td style="text-align: left; border-bottom: 2px solid ; ">Used for the +Z face of GL cubemap texture images</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code> + </td> + <td style="text-align: left; border-bottom: 2px solid ; ">Used for the -Z face of GL cubemap texture images</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_GL_TEXTURE_3D</code> + </td> + <td style="text-align: left; border-bottom: 2px solid ; ">Used for OpenGL and OpenGL ES 3D texture images</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; "> + <code class="constant">EGL_GL_RENDERBUFFER</code> + </td> + <td style="text-align: left; ">Used for OpenGL and OpenGL ES renderbuffer images</td> + </tr> + </tbody> + </table> + </div> + </div> + <br class="table-break"/> + <p> + Attribute names accepted in <em class="parameter"><code>attrib_list</code></em> + are shown in table <a class="xref" href="#tab-imageattr" title="Table 2. Legal attributes for eglCreateImage attrib_list parameter">Table 2, “ + Legal attributes for <code class="function">eglCreateImage</code> + <em class="parameter"><code>attrib_list</code></em> parameter + ”</a>, together + with the <em class="parameter"><code>target</code></em> for which each attribute + name is valid, and the default value used for each attribute if + it is not included in <em class="parameter"><code>attrib_list</code></em>. + </p> + <div class="table" id="tab-imageattr"> + <div class="table-title">Table 2. + Legal attributes for <code class="function">eglCreateImage</code> + <em class="parameter"><code>attrib_list</code></em> parameter + </div> + <div class="table-contents"> + <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; "> + <colgroup> + <col/> + <col/> + <col/> + <col/> + </colgroup> + <thead> + <tr> + <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <em class="parameter"> + <code>target</code> + </em> + </th> + <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Notes</th> + <td style="border-right: 2px solid ; border-bottom: 2px solid ; " class="auto-generated"> </td> + <td style="border-bottom: 2px solid ; " class="auto-generated"> </td> + </tr> + </thead> + <tbody> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Attribute</td> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Description</td> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Valid <em class="parameter"><code>target</code></em>s</td> + <td style="text-align: left; border-bottom: 2px solid ; ">Default Value</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_NONE</code> + </td> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Marks the end of the attribute-value list</td> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">All</td> + <td style="text-align: left; border-bottom: 2px solid ; ">N/A</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_GL_TEXTURE_LEVEL</code> + </td> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + Specifies the mipmap level used as the + <span class="type">EGLImage</span> source. Must be part of + the complete texture object + <em class="parameter"><code>buffer</code></em> + </td> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_GL_TEXTURE_2D</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_*</code>, or + <code class="constant">EGL_GL_TEXTURE_3D</code> + </td> + <td style="text-align: left; border-bottom: 2px solid ; ">0</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_GL_TEXTURE_ZOFFSET</code> + </td> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + Specifies the depth offset of the image to use + as the <span class="type">EGLImage</span> source. Must be + part of the complete texture object + <em class="parameter"><code>buffer</code></em> + </td> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_GL_TEXTURE_3D</code> + </td> + <td style="text-align: left; border-bottom: 2px solid ; ">0</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; "> + <code class="constant">EGL_IMAGE_PRESERVED</code> + </td> + <td style="text-align: left; border-right: 2px solid ; ">Whether to preserve pixel data</td> + <td style="text-align: left; border-right: 2px solid ; ">All</td> + <td style="text-align: left; "> + <code class="constant">EGL_FALSE</code> + </td> + </tr> + </tbody> + </table> + </div> + </div> + <br class="table-break"/> + <p> + <code class="function">eglCreateImage</code> returns an + <span class="type">EGLImage</span> object corresponding to the image data + specified by <em class="parameter"><code>display</code></em>, + <em class="parameter"><code>context</code></em>, <em class="parameter"><code>target</code></em>, + <em class="parameter"><code>buffer</code></em> and + <em class="parameter"><code>attrib_list</code></em> which may be referenced by + client API operations. + </p> + <p> + If <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_2D</code>, + <code class="constant">EGL_GL_TEXTURE_3D</code>, + <code class="constant">EGL_GL_RENDERBUFFER</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_X</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_X</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_Y</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_Z</code>, or + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code>, + <em class="parameter"><code>display</code></em> must be a valid + <span class="type">EGLDisplay</span>, and <em class="parameter"><code>context</code></em> must + be a valid OpenGL or OpenGL ES API context on that display. + </p> + <p> + If <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_2D</code>, + <em class="parameter"><code>buffer</code></em> must be the name of a nonzero, + <code class="constant">GL_TEXTURE_2D</code> target texture object, cast + into the type <span class="type">EGLClientBuffer</span>. + </p> + <p> + If <em class="parameter"><code>target</code></em> is one of the + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_*</code> enumerants, + <em class="parameter"><code>buffer</code></em> must be the name of a nonzero, + <code class="constant">GL_TEXTURE_CUBE_MAP</code> (or equivalent in GL + extensions) target texture object, cast into the type + <span class="type">EGLClientBuffer</span>. + </p> + <p> + If <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_3D</code>, + <em class="parameter"><code>buffer</code></em> must be the name of a nonzero, + <code class="constant">GL_TEXTURE_3D</code> (or equivalent in GL + extensions) target texture object, cast into the type + <span class="type">EGLClientBuffer</span>. + </p> + <p> + <em class="parameter"><code>attrib_list</code></em> should specify the mipmap + level (<code class="constant">EGL_GL_TEXTURE_LEVEL</code>) and, where + applicable, z-offset + (<code class="constant">EGL_GL_TEXTURE_ZOFFSET</code>) which will be used + as the <span class="type">EGLImage</span> source; If not specified, the + default values listed in table <a class="xref" href="#tab-imageattr" title="Table 2. Legal attributes for eglCreateImage attrib_list parameter">Table 2, “ + Legal attributes for <code class="function">eglCreateImage</code> + <em class="parameter"><code>attrib_list</code></em> parameter + ”</a> + will be used instead. Additional values specified in are + ignored. + </p> + <p> + There must exist some levels <span class="emphasis"><em>x</em></span> and + <span class="emphasis"><em>y</em></span> such that the mipmap level requested lies + between <span class="emphasis"><em>x</em></span> and <span class="emphasis"><em>y</em></span> + (inclusive), the texture would be mipmap complete were + <span class="emphasis"><em>x</em></span> substituted for the base level and + <span class="emphasis"><em>y</em></span> substituted for the max level, and all + levels less than <span class="emphasis"><em>x</em></span> or greater than + <span class="emphasis"><em>y</em></span> are unspecified. For cubemaps a single + pair <span class="emphasis"><em>x</em></span> and <span class="emphasis"><em>y</em></span> must + apply to all faces. For three-dimensional textures, the + specified z-offset must be smaller than the depth of the + specified mipmap level. + </p> + <p> + If <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_RENDERBUFFER</code>, + <em class="parameter"><code>buffer</code></em> must be the name of a complete, + nonzero, non-multisampled <code class="constant">GL_RENDERBUFFER</code> + (or equivalent in extensions) target object, cast into the type + <span class="type">EGLClientBuffer</span>. Values specified in + <em class="parameter"><code>attrib_list</code></em> are ignored. + </p> + <p> + If the value of attribute + <code class="constant">EGL_IMAGE_PRESERVED</code> is + <code class="constant">EGL_FALSE</code> (the default), then all pixel + data values associated with <em class="parameter"><code>buffer</code></em> will + be undefined after <code class="function">eglCreateImage</code> returns. + </p> + <p> + If the value of attribute + <code class="constant">EGL_IMAGE_PRESERVED</code> is + <code class="constant">EGL_TRUE</code>, then all pixel data values + associated with <em class="parameter"><code>buffer</code></em> are preserved. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="function">eglCreateImage</code> returns + <code class="constant">EGL_NO_IMAGE</code> on failure. The contents of + <em class="parameter"><code>buffer</code></em> will be unaffected. + </p> + <p> + If <em class="parameter"><code>display</code></em> is not the handle of a valid + <span class="type">EGLDisplay</span> object, the error + <code class="constant">EGL_BAD_DISPLAY</code> is generated. + </p> + <p> + If <em class="parameter"><code>context</code></em> is neither the handle of a + valid <span class="type">EGLContext</span> object on + <em class="parameter"><code>display</code></em> nor + <code class="constant">EGL_NO_CONTEXT</code>, the error + <code class="constant">EGL_BAD_CONTEXT</code> is generated. + </p> + <p> + If <em class="parameter"><code>target</code></em> is not one of the values in + table <a class="xref" href="#tab-imagetarget" title="Table 1. Legal values for eglCreateImage target">Table 1, “ + Legal values for <code class="function">eglCreateImage</code> <em class="parameter"><code>target</code></em> + ”</a>, the error + <code class="constant">EGL_BAD_PARAMETER</code> is generated. + </p> + <p> + If <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_2D</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_*</code>, + <code class="constant">EGL_GL_RENDERBUFFER</code> or + <code class="constant">EGL_GL_TEXTURE_3D</code>, and + <em class="parameter"><code>display</code></em> is not a valid + <span class="type">EGLDisplay</span>, the error + <code class="constant">EGL_BAD_DISPLAY</code> is generated. + </p> + <p> + If <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_2D</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_*</code>, + <code class="constant">EGL_GL_RENDERBUFFER</code> or + <code class="constant">EGL_GL_TEXTURE_3D</code>, and + <em class="parameter"><code>context</code></em> is not a valid + <span class="type">EGLContext</span>, the error + <code class="constant">EGL_BAD_CONTEXT</code> is generated. + </p> + <p> + If <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_2D</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_*</code>, + <code class="constant">EGL_GL_RENDERBUFFER</code> or + <code class="constant">EGL_GL_TEXTURE_3D</code>, and + <em class="parameter"><code>context</code></em> is not a valid GL context, or + does not match the <em class="parameter"><code>display</code></em>, the error + <code class="constant">EGL_BAD_MATCH</code> is generated. + </p> + <p> + If <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_2D</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_*</code> or + <code class="constant">EGL_GL_TEXTURE_3D</code> and + <em class="parameter"><code>buffer</code></em> is not the name of a texture + object of type <em class="parameter"><code>target</code></em>, the error + <code class="constant">EGL_BAD_PARAMETER</code> is generated. + </p> + <p> + If <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_RENDERBUFFER</code> and + <em class="parameter"><code>buffer</code></em> is not the name of a renderbuffer + object, or if <em class="parameter"><code>buffer</code></em> is the name of a + multisampled renderbuffer object, the error + <code class="constant">EGL_BAD_PARAMETER</code> is generated. + </p> + <p> + If <code class="constant">EGL_GL_TEXTURE_LEVEL</code> is nonzero, + <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_2D</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_*</code> or + <code class="constant">EGL_GL_TEXTURE_3D</code>, and + <em class="parameter"><code>buffer</code></em> is not the name of a complete GL + texture object, the error <code class="constant">EGL_BAD_PARAMETER</code> + is generated. + </p> + <p> + If <code class="constant">EGL_GL_TEXTURE_LEVEL</code> is 0, + <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_2D</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_*</code> or + <code class="constant">EGL_GL_TEXTURE_3D</code>, + <em class="parameter"><code>buffer</code></em> is the name of an incomplete GL + texture object, and any mipmap levels other than mipmap level 0 + are specified, the error <code class="constant">EGL_BAD_PARAMETER</code> + is generated. + </p> + <p> + If <code class="constant">EGL_GL_TEXTURE_LEVEL</code> is 0, + <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_2D</code> or + <code class="constant">EGL_GL_TEXTURE_3D</code>, + <em class="parameter"><code>buffer</code></em> is not the name of a complete GL + texture object, and mipmap level 0 is not specified, the error + <code class="constant">EGL_BAD_PARAMETER</code> is generated. + </p> + <p> + If <code class="constant">EGL_GL_TEXTURE_LEVEL</code> is 0, + <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_*</code>, + <em class="parameter"><code>buffer</code></em> is not the name of a complete GL + texture object, and one or more faces do not have mipmap level 0 + specified, the error <code class="constant">EGL_BAD_PARAMETER</code> is + generated. + </p> + <p> + If <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_2D</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_*</code>, + <code class="constant">EGL_GL_RENDERBUFFER</code> or + <code class="constant">EGL_GL_TEXTURE_3D</code> and + <em class="parameter"><code>buffer</code></em> refers to the default GL texture + object (0) for the corresponding GL target, the error + <code class="constant">EGL_BAD_PARAMETER</code> is generated. + </p> + <p> + If <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_2D</code>, + <code class="constant">EGL_GL_TEXTURE_CUBE_MAP_*</code>, or + <code class="constant">EGL_GL_TEXTURE_3D</code>, and the value specified + in <em class="parameter"><code>attrib_list</code></em> for + <code class="constant">EGL_GL_TEXTURE_LEVEL</code> is not a valid mipmap + level for the specified GL texture object + <em class="parameter"><code>buffer</code></em>, the error + <code class="constant">EGL_BAD_MATCH</code> is generated. + </p> + <p> + If <em class="parameter"><code>target</code></em> is + <code class="constant">EGL_GL_TEXTURE_3D</code>, and the value specified + in <em class="parameter"><code>attrib_list</code></em> for + <code class="constant">EGL_GL_TEXTURE_ZOFFSET</code> exceeds the depth of + the specified mipmap level-of-detail in + <em class="parameter"><code>buffer</code></em>, the error + <code class="constant">EGL_BAD_PARAMETER</code> is generated. + </p> + <p> + If an attribute specified in <em class="parameter"><code>attrib_list</code></em> + is not one of the attributes shown in table <a class="xref" href="#tab-imageattr" title="Table 2. Legal attributes for eglCreateImage attrib_list parameter">Table 2, “ + Legal attributes for <code class="function">eglCreateImage</code> + <em class="parameter"><code>attrib_list</code></em> parameter + ”</a>, the error + <code class="constant">EGL_BAD_PARAMETER</code> is generated. + </p> + <p> + If an attribute specified in <em class="parameter"><code>attrib_list</code></em> + is not a valid attribute for <em class="parameter"><code>target</code></em>, as + shown in table <a class="xref" href="#tab-imageattr" title="Table 2. Legal attributes for eglCreateImage attrib_list parameter">Table 2, “ + Legal attributes for <code class="function">eglCreateImage</code> + <em class="parameter"><code>attrib_list</code></em> parameter + ”</a>, the error + <code class="constant">EGL_BAD_MATCH</code> is generated. + </p> + <p> + If the resource specified by <em class="parameter"><code>display</code></em>, + <em class="parameter"><code>context</code></em>, <em class="parameter"><code>target</code></em>, + <em class="parameter"><code>buffer</code></em> and + <em class="parameter"><code>attrib_list</code></em> has an off-screen buffer + bound to it (e.g., by a previous call to + <code class="function">eglBindTexImage</code>), the error + <code class="constant">EGL_BAD_ACCESS</code> is generated. + </p> + <p> + If the resource specified by <em class="parameter"><code>display</code></em>, + <em class="parameter"><code>context</code></em>, <em class="parameter"><code>target</code></em>, + <em class="parameter"><code>buffer</code></em> and + <em class="parameter"><code>attrib_list</code></em> is bound to an off-screen + buffer (e.g., by a previous call to + <code class="function">eglCreatePbufferFromClientBuffer</code>), the + error <code class="constant">EGL_BAD_ACCESS</code> is generated. + </p> + <p> + If the resource specified by <em class="parameter"><code>display</code></em>, + <em class="parameter"><code>context</code></em>, <em class="parameter"><code>target</code></em>, + <em class="parameter"><code>buffer</code></em> and + <em class="parameter"><code>attrib_list</code></em> is itself an + <span class="type">EGLImage</span> sibling, the error + <code class="constant">EGL_BAD_ACCESS</code> is generated. + </p> + <p> + If insufficient memory is available to complete the specified + operation, the error <code class="constant">EGL_BAD_ALLOC</code> is + generated. + </p> + <p> + If the value specified in <em class="parameter"><code>attrib_list</code></em> for + <code class="constant">EGL_IMAGE_PRESERVED</code> is + <code class="constant">EGL_TRUE</code>, and an <span class="type">EGLImage</span> + handle cannot be created from the specified resource such that + the pixel data values in <em class="parameter"><code>buffer</code></em> are + preserved, the error <code class="constant">EGL_BAD_ACCESS</code> is + generated. + </p> + <p> + Note that the success or failure of + <code class="function">eglCreateImage</code> should not affect the + ability to use <em class="parameter"><code>buffer</code></em> in its original API + context (or context share group) (although the pixel data values + will be undefined if the command succeeds and the value of + <code class="constant">EGL_IMAGE_PRESERVED</code> is not + <code class="constant">EGL_TRUE</code>). + </p> + </div> + <div class="refsect1" id="lifetime"> + <h2>Lifetime and Usage of <span class="type">EGLImage</span>s</h2> + <p> + Once an <span class="type">EGLImage</span> is created from an + <span class="type">EGLImage</span> source, the memory associated with the + <span class="type">EGLImage</span> source will remain allocated (and all + <span class="type">EGLImage</span> siblings in all client API contexts will + be useable) as long as either of the following conditions is + true: + </p> + <p> + </p> + <div class="itemizedlist"> + <ul class="itemizedlist" style="list-style-type: disc; "> + <li class="listitem"> + <p> + Any <span class="type">EGLImage</span> siblings exist in any client + API context + </p> + </li> + <li class="listitem"> + <p> + The <span class="type">EGLImage</span> object exists inside EGL + </p> + </li> + </ul> + </div> + <p> + </p> + <p> + The semantics for specifying, deleting and using + <span class="type">EGLImage</span> siblings are client API-specific, and are + described in the appropriate API specifications. + </p> + <p> + If an application specifies an <span class="type">EGLImage</span> sibling as + the destination for rendering and/or pixel download operations + (e.g., as an OpenGL or OpenGL ES framebuffer object, + <code class="function">glTexSubImage2D</code>, etc.), the modified image + results will be observed by all <span class="type">EGLImage</span> siblings + in all client API contexts. If multiple client API contexts + access <span class="type">EGLImage</span> sibling resources simultaneously, + with one or more context modifying the image data, rendering + results in all contexts accessing <span class="type">EGLImage</span> siblings + are undefined. + </p> + <p> + Respecification and/or deletion of any <span class="type">EGLImage</span> + sibling (i.e., both <span class="type">EGLImage</span> source and + <span class="type">EGLImage</span> target resources) inside a client API + context (by issuing a subsequent call to commands such as + <code class="function">glTexImage*</code> or + <code class="function">glDeleteTextures</code>, with the + <span class="type">EGLImage</span> sibling resource as the target of the + operation) affects only that client API context and other + contexts within its share group. For an OpenGL or OpenGL ES + context, respecification always results in + <em class="firstterm">orphaning</em> of the <span class="type">EGLImage</span>, + and may also include allocation of additional memory for the + respecified resource and/or copying of the <span class="type">EGLImage</span> + pixel data. + </p> + <p> + Note: Behavior of other types of client APIs generally follows + the OpenGL and OpenGL ES behavior described here, although this + is not mandated yet. + </p> + <p> + Operations inside EGL or any client API context which may affect + the lifetime of an <span class="type">EGLImage</span> (or the memory + allocated for the <span class="type">EGLImage</span>), such as respecifying + and/or deleting an <span class="type">EGLImage</span> sibling inside a client + API context, must be atomic. + </p> + <p> + Applications may create client API resources from an + <span class="type">EGLImage</span> using client API extensions outside the + scope of this document (such as + <code class="constant">GL_OES_EGL_image</code>, which creates OpenGL ES + texture and renderbuffer objects). If the <span class="type">EGLImage</span> + used to create the client resource was created with the + <code class="constant">EGL_IMAGE_PRESERVED</code> attribute set to + <code class="constant">EGL_TRUE</code>, then the pixel data values + associated with the image will be preserved after creating the + client resource; otherwise, the pixel data values will be + undefined. If the <span class="type">EGLImage</span> was created with the + <code class="constant">EGL_IMAGE_PRESERVED</code> attribute set to + <code class="constant">EGL_TRUE</code>, and EGL is unable to create the + client resource without modifying the pixel values, then + creation will fail and the pixel data values will be preserved. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglCreateImage</code> is available only if the EGL + version is 1.5 or greater. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglBindTexImage.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindTexImage</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferFromClientBuffer.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferFromClientBuffer</span></span></a>, + <a class="citerefentry" href="eglDestroyImage.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroyImage</span></span></a>, + <code class="function">glDeleteTextures</code>, + <code class="function">glTexImage*</code>, + <code class="function">glTexSubImage2D</code> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePbufferFromClientBuffer.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePbufferFromClientBuffer.xhtml new file mode 100644 index 0000000..b6d87bc --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePbufferFromClientBuffer.xhtml @@ -0,0 +1,468 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglCreatePbufferFromClientBuffer - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglCreatePbufferFromClientBuffer"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglCreatePbufferFromClientBuffer — + create a new <abbr class="acronym">EGL</abbr> pixel buffer surface + bound to an OpenVG image + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLSurface <strong class="fsfunc">eglCreatePbufferFromClientBuffer</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLenum <var class="pdparam">buftype</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLClientBuffer <var class="pdparam">buffer</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLConfig <var class="pdparam">config</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint const * <var class="pdparam">attrib_list</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>buftype</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the type of client API buffer to be bound. + Must be <code class="constant">EGL_OPENVG_IMAGE</code>, + corresponding to an OpenVG <span class="type">VGImage</span> + buffer. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>buffer</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the OpenVG <span class="type">VGImage</span> handle of + the buffer to be bound. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies pixel buffer surface attributes. + May be <code class="constant">NULL</code> or empty + (first attribute is <code class="constant">EGL_NONE</code>). + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglCreatePbufferFromClientBuffer</code> creates an + off-screen pixel buffer surface and returns its handle. If + <code class="function">eglCreatePbufferFromClientBuffer</code> fails to create + a pixel buffer surface, <code class="constant">EGL_NO_SURFACE</code> + is returned. + </p> + <p> + The new pixel buffer surface is similar to a pixel buffer + created with + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + but storage for the color buffer is provided by a client API + buffer. Other buffer required by + <em class="parameter"><code>config</code></em>, such as depth, stencil, and + alpha mask, are allocated by EGL. + </p> + <p> + <em class="parameter"><code>buftype</code></em> must be + <code class="constant">EGL_OPENVG_IMAGE</code>, corresponding to an + OpenVG <span class="type">VGImage</span> buffer. + <em class="parameter"><code>buffer</code></em> must be a valid + <span class="type">VGImage</span> handle in the current OpenVG context, + cast into the type <span class="type">EGLClientBuffer</span>. + </p> + <p> + The height, width,, OpenVG alpha format, and OpenVG + colorspace (surface attributes + <code class="constant">EGL_HEIGHT</code>, + <code class="constant">EGL_WIDTH</code>, + <code class="constant">EGL_VG_ALPHA_FORMAT</code>, and + <code class="constant">EGL_VG_COLORSPACE</code>, respectively) of the + resulting surface are determined by the size and format of + <em class="parameter"><code>buffer</code></em>. + </p> + <p> + Surface attributes are specified as a list of + attribute-value pairs, terminated with + <code class="constant">EGL_NONE</code>. Accepted attributes are: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_MIPMAP_TEXTURE</code> + </span> + </dt> + <dd> + <p> + Specifies whether storage for mipmaps should be + allocated. Space for mipmaps will be set aside if + the attribute value is <code class="constant">EGL_TRUE</code> + and <code class="constant">EGL_TEXTURE_FORMAT</code> is not + <code class="constant">EGL_NO_TEXTURE</code>. The default + value is <code class="constant">EGL_FALSE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_FORMAT</code> + </span> + </dt> + <dd> + <p> + Specifies the format of the texture that will be + created when a pbuffer is bound to a texture map. + Possible values are + <code class="constant">EGL_NO_TEXTURE</code>, + <code class="constant">EGL_TEXTURE_RGB</code>, and + <code class="constant">EGL_TEXTURE_RGBA</code>. The default + value is <code class="constant">EGL_NO_TEXTURE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_TARGET</code> + </span> + </dt> + <dd> + <p> + Specifies the target for the texture that will be + created when the pbuffer is created with a texture + format of <code class="constant">EGL_TEXTURE_RGB</code> or + <code class="constant">EGL_TEXTURE_RGBA</code>. Possible + values are <code class="constant">EGL_NO_TEXTURE</code>, or + <code class="constant">EGL_TEXTURE_2D</code>. The default + value is <code class="constant">EGL_NO_TEXTURE</code>. + </p> + </dd> + </dl> + </div> + <p> + Any EGL rendering context that was created with respect to + <em class="parameter"><code>config</code></em> can be used to render into the + surface. Use + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + to attach an EGL rendering context to the surface. + </p> + <p> + Use + <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + to retrieve the dimensions of the allocated pixel buffer + surface or the ID of <em class="parameter"><code>config</code></em>. + </p> + <p> + Use <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a> + to destroy the surface. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglCreatePbufferFromClientBuffer</code> is + supported only if the EGL version is 1.2 or greater, and if + the EGL implementation supports the OpenVG client API. + </p> + <p> + Currently + <code class="function">eglCreatePbufferFromClientBuffer</code> only + supports binding OpenVG <span class="type">VGImage</span> 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 <span class="type">EGLImageKHR</span> + images, are a more flexible and general framework to satisfy + most of the same needs. + </p> + <p> + If the value of <em class="parameter"><code>config</code></em> attribute + <code class="constant">EGL_TEXTURE_FORMAT</code> is not + <code class="constant">EGL_NO_TEXTURE</code>, then the pbuffer width + and height specify the size of the level zero texture image + </p> + <p> + If <code class="constant">EGL_LARGEST_PBUFFER</code> is specified and + if the pbuffer will be used as a texture (i.e. the value of + <code class="constant">EGL_TEXTURE_TARGET</code> is + <code class="constant">EGL_TEXTURE_2D</code>, and the value of + <code class="constant">EGL_TEXTURE FORMAT</code> is + <code class="constant">EGL_TEXTURE_RGB</code> or + <code class="constant">EGL_TEXTURE_RGBA</code>), 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). + </p> + <p> + 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). + </p> + <p> + 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: + </p> + <div class="orderedlist"> + <ol class="orderedlist" type="1"> + <li class="listitem"> + <p> + Bound buffers may be used exclusively by either EGL, + or the client API that originally created them. For + example, if a <span class="type">VGImage</span> is bound to a + pbuffer, and that pbuffer is bound to any client API + rendering context, then the <span class="type">VGImage</span> 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 <span class="type">VGImage</span> is in use by + OpenVG, the pbuffer it is bound to may not be made + current to any client API context using + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>. + </p> + </li> + <li class="listitem"> + <p> + Binding a buffer creates an additional reference to + it, and implementations must respect outstanding + references when destroying objects. For example, if + a <span class="type">VGImage</span> is bound to a pbuffer, + destroying the image with + <code class="function">vgDestroyImage</code> will not free + the underlying buffer, because it is still in use by + EGL. However, following + <code class="function">vgDestroyImage</code> 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 + <code class="function">eglDestroySurface</code> will not free + the underlying buffer, because it is still in use by + OpenVG . However, following + <code class="function">eglDestroySurface</code> the buffer + may only be referred to via the OpenVG + <span class="type">VGImage</span> handle, since the EGL pbuffer + handle no longer exists. + </p> + </li> + </ol> + </div> + <p> + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_NO_SURFACE</code> is returned if creation of + the context fails. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONFIG</code> is generated if + <em class="parameter"><code>config</code></em> is not an EGL frame buffer configuration. + </p> + <p> + <code class="constant">EGL_BAD_PARAMETER</code> is generated if + <em class="parameter"><code>buftype</code></em> is not + <code class="constant">EGL_OPENVG_IMAGE</code>, or if + <em class="parameter"><code>buffer</code></em> is not a valid handle to a + <span class="type">VGImage</span> object in the currently bound OpenVG + context. + </p> + <p> + <code class="constant">EGL_BAD_ACCESS</code> is generated if there is + no current OpenVG context, or if + <em class="parameter"><code>buffer</code></em> is already bound to another + pixel buffer or in use by OpenVG as discussed in the Notes + section above. + </p> + <p> + <code class="constant">EGL_BAD_ACCESS</code> is generated if the buffers + contained in <em class="parameter"><code>buffer</code></em> consist of any + <span class="type">EGLImage</span> siblings. + </p> + <p> + <code class="constant">EGL_BAD_ALLOC</code> is generated if there are not + enough resources to allocate the new surface. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains an invalid pixel + buffer attribute or if an attribute value is not recognized + or out of range. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains any of the + attributes <code class="constant">EGL_MIPMAP_TEXTURE</code>, + <code class="constant">EGL_TEXTURE_FORMAT</code>, or + <code class="constant">EGL_TEXTURE_TARGET</code>, and + <em class="parameter"><code>config</code></em> does not support OpenGL ES + rendering (e.g. the EGL version is 1.2 or later, and the + <code class="constant">EGL_RENDERABLE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em> does not include at least one + of <code class="constant">EGL_OPENGL_ES_BIT</code> or + <code class="constant">EGL_OPENGL_ES2_BIT</code>). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>config</code></em> does not support rendering to + pixel buffers (the <code class="constant">EGL_SURFACE_TYPE</code> + attribute does not contain + <code class="constant">EGL_PBUFFER_BIT</code>). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the + buffers contained in <em class="parameter"><code>buffer</code></em> do not + match the bit depths for those buffers specified by + <em class="parameter"><code>config</code></em>. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the + <code class="constant">EGL_TEXTURE_FORMAT</code> attribute is not + <code class="constant">EGL_NO_TEXTURE</code>, and + <code class="constant">EGL_WIDTH</code> and/or + <code class="constant">EGL_HEIGHT</code> 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). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + the <code class="constant">EGL_TEXTURE_FORMAT</code> attribute is + <code class="constant">EGL_NO_TEXTURE</code>, and + <code class="constant">EGL_TEXTURE_TARGET</code> is something other + than <code class="constant">EGL_NO_TEXTURE</code>; or, + <code class="constant">EGL_TEXTURE_FORMAT</code> is something other + than <code class="constant">EGL_NO_TEXTURE</code>, and + <code class="constant">EGL_TEXTURE_TARGET</code> is + <code class="constant">EGL_NO_TEXTURE</code>. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> 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 <span class="type">VGImage</span> being bound to a + pixel buffer which will be used as a mipmapped OpenGL ES + texture (e.g. whose <code class="constant">EGL_MIPMAP_TEXTURE</code> + attribute is <code class="constant">TRUE</code>). Any such + constraints should be documented by the implementation + release notes. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePbufferSurface.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePbufferSurface.xhtml new file mode 100644 index 0000000..a51f67e --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePbufferSurface.xhtml @@ -0,0 +1,435 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglCreatePbufferSurface - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.2"/> + </head> + <body> + <header/> + <div class="refentry" id="eglCreatePbufferSurface"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglCreatePbufferSurface — + create a new <abbr class="acronym">EGL</abbr> pixel buffer surface + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLSurface <strong class="fsfunc">eglCreatePbufferSurface</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLConfig <var class="pdparam">config</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint const * <var class="pdparam">attrib_list</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies pixel buffer surface attributes. + May be <code class="constant">NULL</code> or empty + (first attribute is <code class="constant">EGL_NONE</code>). + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglCreatePbufferSurface</code> creates an + off-screen pixel buffer surface and returns its handle. If + <code class="function">eglCreatePbufferSurface</code> fails to create + a pixel buffer surface, <code class="constant">EGL_NO_SURFACE</code> + is returned. + </p> + <p> + Surface attributes are specified as a list of + attribute-value pairs, terminated with + <code class="constant">EGL_NONE</code>. Accepted attributes + are: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_GL_COLORSPACE</code> + </span> + </dt> + <dd> + <p> + Specifies the color space used by OpenGL and OpenGL ES + when rendering to the surface. If its value is + <code class="constant">EGL_GL_COLORSPACE_SRGB</code>, then a + non-linear, perceptually uniform color space is assumed, + with a corresponding + <code class="constant">GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING</code> + value of <code class="constant">GL_SRGB</code>. If its value is + <code class="constant">EGL_GL_COLORSPACE_LINEAR</code>, then a + linear color space is assumed, with a corresponding + <code class="constant">GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING</code> + value of <code class="constant">GL_LINEAR</code>. The default + value of <code class="constant">EGL_GL_COLORSPACE</code> is + <code class="constant">EGL_GL_COLORSPACE_LINEAR</code>. + </p> + <p> + Note that the <code class="constant">EGL_GL_COLORSPACE</code> + attribute is used only by OpenGL and OpenGL ES contexts + supporting sRGB framebuffers. EGL itself does not + distinguish multiple colorspace models. Refer to the + ``sRGB Conversion'' sections of the OpenGL 4.6 and + OpenGL ES 3.2 Specifications for more information. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_HEIGHT</code> + </span> + </dt> + <dd> + <p> + Specifies the required height of the pixel buffer + surface. The default value is + <code class="constant">0</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LARGEST_PBUFFER</code> + </span> + </dt> + <dd> + <p> + Requests the largest available pixel buffer surface + when the allocation would otherwise fail. Use + <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + to retrieve the dimensions of the allocated pixel + buffer. The default value is + <code class="constant">EGL_FALSE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MIPMAP_TEXTURE</code> + </span> + </dt> + <dd> + <p> + Specifies whether storage for mipmaps should be + allocated. Space for mipmaps will be set aside if + the attribute value is <code class="constant">EGL_TRUE</code> + and <code class="constant">EGL_TEXTURE_FORMAT</code> is not + <code class="constant">EGL_NO_TEXTURE</code>. The default + value is <code class="constant">EGL_FALSE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_FORMAT</code> + </span> + </dt> + <dd> + <p> + Specifies the format of the texture that will be + created when a pbuffer is bound to a texture map. + Possible values are + <code class="constant">EGL_NO_TEXTURE</code>, + <code class="constant">EGL_TEXTURE_RGB</code>, and + <code class="constant">EGL_TEXTURE_RGBA</code>. The default + value is <code class="constant">EGL_NO_TEXTURE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_TARGET</code> + </span> + </dt> + <dd> + <p> + Specifies the target for the texture that will be + created when the pbuffer is created with a texture + format of <code class="constant">EGL_TEXTURE_RGB</code> or + <code class="constant">EGL_TEXTURE_RGBA</code>. Possible + values are <code class="constant">EGL_NO_TEXTURE</code>, or + <code class="constant">EGL_TEXTURE_2D</code>. The default + value is <code class="constant">EGL_NO_TEXTURE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_ALPHA_FORMAT</code> + </span> + </dt> + <dd> + <p> + Specifies how alpha values are interpreted by OpenVG + when rendering to the surface. If its value is + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>, + then alpha values are not premultipled. If its value + is <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code>, + then alpha values are premultiplied. The default + value of <code class="constant">EGL_VG_ALPHA_FORMAT</code> is + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_COLORSPACE</code> + </span> + </dt> + <dd> + <p> + Specifies the color space used by OpenVG when + rendering to the surface. If its value is + <code class="constant">EGL_VG_COLORSPACE_sRGB</code>, then a + non-linear, perceptually uniform color space is + assumed, with a corresponding + <span class="type">VGImageFormat</span> of form + <code class="constant">VG_s*</code>. If its value is + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code>, then + a linear color space is assumed, with a + corresponding <span class="type">VGImageFormat</span> of form + <code class="constant">VG_l*</code>. The default value of + <code class="constant">EGL_VG_COLORSPACE</code> is + <code class="constant">EGL_VG_COLORSPACE_sRGB</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_WIDTH</code> + </span> + </dt> + <dd> + <p> + Specifies the required width of the pixel buffer + surface. The default value is + <code class="constant">0</code>. + </p> + </dd> + </dl> + </div> + <p> + Any EGL rendering context that was created with respect to + <em class="parameter"><code>config</code></em> can be used to render into the + surface. Use + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + to attach an EGL rendering context to the surface. + </p> + <p> + Use + <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + to retrieve the dimensions of the allocated pixel buffer + surface or the ID of <em class="parameter"><code>config</code></em>. + </p> + <p> + Use <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a> + to destroy the surface. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + Attribute <code class="constant">EGL_GL_COLORSPACE</code>, and the + <code class="constant">EGL_OPENGL_ES3_BIT</code> bit value for attribute + <code class="constant">EGL_RENDERABLE_TYPE</code>, are supported only if + the EGL version is 1.5 or greater. + </p> + <p> + Attributes + <code class="constant">EGL_RENDERABLE_TYPE</code>, + <code class="constant">EGL_VG_ALPHA_FORMAT</code>, and + <code class="constant">EGL_VG_COLORSPACE</code>, and the + corresponding attribute values, are supported only if the + EGL version is 1.2 or greater. + </p> + <p> + If the value of <em class="parameter"><code>config</code></em> attribute + <code class="constant">EGL_TEXTURE_FORMAT</code> is not + <code class="constant">EGL_NO_TEXTURE</code>, then the pbuffer width + and height specify the size of the level zero texture image + </p> + <p> + If <code class="constant">EGL_LARGEST_PBUFFER</code> is specified and + if the pbuffer will be used as a texture (i.e. the value of + <code class="constant">EGL_TEXTURE_TARGET</code> is + <code class="constant">EGL_TEXTURE_2D</code>, and the value of + <code class="constant">EGL_TEXTURE FORMAT</code> is + <code class="constant">EGL_TEXTURE_RGB</code> or + <code class="constant">EGL_TEXTURE_RGBA</code>), 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). + </p> + <p> + 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). + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_NO_SURFACE</code> is returned if creation of + the context fails. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONFIG</code> is generated if + <em class="parameter"><code>config</code></em> is not an EGL frame buffer configuration. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains an invalid pixel + buffer attribute or if an attribute value is not recognized + or out of range. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains any of the + attributes <code class="constant">EGL_MIPMAP_TEXTURE</code>, + <code class="constant">EGL_TEXTURE_FORMAT</code>, or + <code class="constant">EGL_TEXTURE_TARGET</code>, and + <em class="parameter"><code>config</code></em> does not support OpenGL ES + rendering (e.g. the EGL version is 1.2 or later, and the + <code class="constant">EGL_RENDERABLE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em> does not include at least one + of <code class="constant">EGL_OPENGL_ES_BIT</code>, + <code class="constant">EGL_OPENGL_ES2_BIT</code>, or + <code class="constant">EGL_OPENGL_ES3_BIT</code>), + </p> + <p> + <code class="constant">EGL_BAD_ALLOC</code> is generated if there are not + enough resources to allocate the new surface. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>config</code></em> does not support rendering to pixel buffers + (the <code class="constant">EGL_SURFACE_TYPE</code> attribute does not contain + <code class="constant">EGL_PBUFFER_BIT</code>). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the + <code class="constant">EGL_TEXTURE_FORMAT</code> attribute is not + <code class="constant">EGL_NO_TEXTURE</code>, and + <code class="constant">EGL_WIDTH</code> and/or + <code class="constant">EGL_HEIGHT</code> 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). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + the <code class="constant">EGL_TEXTURE_FORMAT</code> attribute is + <code class="constant">EGL_NO_TEXTURE</code>, and + <code class="constant">EGL_TEXTURE_TARGET</code> is something other + than <code class="constant">EGL_NO_TEXTURE</code>; or, + <code class="constant">EGL_TEXTURE_FORMAT</code> is something other + than <code class="constant">EGL_NO_TEXTURE</code>, and + <code class="constant">EGL_TEXTURE_TARGET</code> is + <code class="constant">EGL_NO_TEXTURE</code>. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>config</code></em> does not support the specified + OpenVG alpha format attribute (the value of + <code class="constant">EGL_VG_ALPHA_FORMAT</code> is + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code> and the + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE_BIT</code> is not set + in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em>) or colorspace attribute (the + value of <code class="constant">EGL_VG_COLORSPACE</code> is + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code> and the + <code class="constant">EGL_VG_COLORSPACE_LINEAR_IT</code> is not set + in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em>). + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePixmapSurface.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePixmapSurface.xhtml new file mode 100644 index 0000000..19b72cd --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePixmapSurface.xhtml @@ -0,0 +1,150 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglCreatePixmapSurface - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglCreatePixmapSurface"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglCreatePixmapSurface — + create a new <abbr class="acronym">EGL</abbr> offscreen surface + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLSurface <strong class="fsfunc">eglCreatePixmapSurface</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLConfig <var class="pdparam">config</var>, </td> + </tr> + <tr> + <td> </td> + <td>NativePixmapType <var class="pdparam">native_pixmap</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint const * <var class="pdparam">attrib_list</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>native_pixmap</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the native pixmap.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies pixmap surface attributes. + May be <code class="constant">NULL</code> or empty + (first attribute is <code class="constant">EGL_NONE</code>). + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglCreatePixmapSurface</code> creates an off-screen + EGL pixmap surface and returns a handle to it. The behavior of + <code class="function">eglCreatePixmapSurface</code> is identical to that + of + <a class="citerefentry" href="eglCreatePlatformPixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePlatformPixmapSurface</span></span></a> + except that the set of platforms to which + <em class="parameter"><code>display</code></em> is permitted to belong, as well + as the actual type of <em class="parameter"><code>native_pixmap</code></em>, are + implementation specific. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + See errors for + <a class="citerefentry" href="eglCreatePlatformPixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePlatformPixmapSurface</span></span></a>. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreatePlatformPixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePlatformPixmapSurface</span></span></a>, + <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePlatformPixmapSurface.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePlatformPixmapSurface.xhtml new file mode 100644 index 0000000..b58d4fe --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePlatformPixmapSurface.xhtml @@ -0,0 +1,341 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglCreatePlatformPixmapSurface - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglCreatePlatformPixmapSurface"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglCreatePlatformPixmapSurface — + create a new <abbr class="acronym">EGL</abbr> offscreen surface + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLSurface <strong class="fsfunc">eglCreatePlatformPixmapSurface</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLConfig <var class="pdparam">config</var>, </td> + </tr> + <tr> + <td> </td> + <td>void * <var class="pdparam">native_pixmap</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint const * <var class="pdparam">attrib_list</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>native_pixmap</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the native pixmap.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies pixmap surface attributes. + May be <code class="constant">NULL</code> or empty + (first attribute is <code class="constant">EGL_NONE</code>). + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglCreatePlatformPixmapSurface</code> creates an + off-screen <abbr class="acronym">EGL</abbr> pixmap surface and returns + a handle to it. + </p> + <p> + If <code class="function">eglCreatePlatformPixmapSurface</code> fails to + create a pixmap surface, <code class="constant">EGL_NO_SURFACE</code> is + returned. + </p> + <p> + <em class="parameter"><code>native_pixmap</code></em> must belong to the same + platform as <em class="parameter"><code>display</code></em>, and EGL considers + the returned <span class="type">EGLSurface</span> as belonging to that same + platform. The EGL extension that defines the platform to which + <em class="parameter"><code>display</code></em> belongs also defines the + requirements for the <em class="parameter"><code>native_pixmap</code></em> + parameter. + </p> + <p> + Surface attributes are specified as a list of + attribute-value pairs, terminated with + <code class="constant">EGL_NONE</code>. Accepted attributes + are: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_GL_COLORSPACE</code> + </span> + </dt> + <dd> + <p> + Specifies the color space used by OpenGL and OpenGL ES + when rendering to the surface. If its value is + <code class="constant">EGL_GL_COLORSPACE_SRGB</code>, then a + non-linear, perceptually uniform color space is assumed, + with a corresponding + <code class="constant">GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING</code> + value of <code class="constant">GL_SRGB</code>. If its value is + <code class="constant">EGL_GL_COLORSPACE_LINEAR</code>, then a + linear color space is assumed, with a corresponding + <code class="constant">GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING</code> + value of <code class="constant">GL_LINEAR</code>. The default + value of <code class="constant">EGL_GL_COLORSPACE</code> is + <code class="constant">EGL_GL_COLORSPACE_SRGB</code>. + </p> + <p> + Note that the <code class="constant">EGL_GL_COLORSPACE</code> + attribute is used only by OpenGL and OpenGL ES contexts + supporting sRGB framebuffers. EGL itself does not + distinguish multiple colorspace models. Refer to the + ``sRGB Conversion'' sections of the OpenGL 4.6 and + OpenGL ES 3.2 Specifications for more information. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_ALPHA_FORMAT</code> + </span> + </dt> + <dd> + <p> + Specifies how alpha values are interpreted by OpenVG + when rendering to the surface. If its value is + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>, + then alpha values are not premultipled. If its value + is <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code>, + then alpha values are premultiplied. The default + value of <code class="constant">EGL_VG_ALPHA_FORMAT</code> is + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_COLORSPACE</code> + </span> + </dt> + <dd> + <p> + Specifies the color space used by OpenVG when + rendering to the surface. If its value is + <code class="constant">EGL_VG_COLORSPACE_sRGB</code>, then a + non-linear, perceptually uniform color space is + assumed, with a corresponding + <span class="type">VGImageFormat</span> of form + <code class="constant">VG_s*</code>. If its value is + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code>, then + a linear color space is assumed, with a + corresponding <span class="type">VGImageFormat</span> of form + <code class="constant">VG_l*</code>. The default value of + <code class="constant">EGL_VG_COLORSPACE</code> is + <code class="constant">EGL_VG_COLORSPACE_sRGB</code>. + </p> + </dd> + </dl> + </div> + <p> + Any EGL rendering context that was created with respect to + <em class="parameter"><code>config</code></em> can be used to render into the + surface. Use + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + to attach an EGL rendering context to the surface. + </p> + <p> + Use + <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + to retrieve the ID of <em class="parameter"><code>config</code></em>. + </p> + <p> + Use <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a> + to destroy the surface. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + The <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code> attribute + of + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a> + can be used to select a frame buffer configuration matching + a specified native pixmap. + </p> + <p> + Attribute <code class="constant">EGL_GL_COLORSPACE</code> is supported + only if the EGL version is 1.5 or greater. + </p> + <p> + Attributes + <code class="constant">EGL_VG_ALPHA_FORMAT</code> and + <code class="constant">EGL_VG_COLORSPACE</code>, and the + corresponding attribute values, are supported only if the + EGL version is 1.2 or greater. + </p> + <p> + The <code class="constant">EGL_VG_ALPHA_FORMAT</code> and + <code class="constant">EGL_VG_COLORSPACE</code> attributes are used only + by OpenVG and EGL itself. Refer to section 11.2 of the OpenVG + 1.0 specification for more information. The platform's use and + interpretation of alpha values is outside the scope of EGL. + However, the preferred behavior is for the window system to + ignore the value of <code class="constant">EGL_VG_ALPHA_FORMAT</code>. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + If <em class="parameter"><code>display</code></em> and + <em class="parameter"><code>native_pixmap</code></em> do not belong to the same + platform, then undefined behavior occurs. + </p> + <p> + <code class="constant">EGL_NO_SURFACE</code> is returned if creation of + the surface fails. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONFIG</code> is generated if + <em class="parameter"><code>config</code></em> is not an EGL config. + </p> + <p> + <code class="constant">EGL_BAD_NATIVE_PIXMAP</code> may be generated if + <em class="parameter"><code>native_pixmap</code></em> is not a valid native pixmap. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains an invalid pixmap attribute + or if an attribute value is not recognized or out of range. + </p> + <p> + <code class="constant">EGL_BAD_ALLOC</code> is generated if there is + already an <span class="type">EGLSurface</span> associated with + <em class="parameter"><code>native_pixmap</code></em> (as a result of a previous + <code class="function">eglCreatePlatformPixmapSurface</code> call). + </p> + <p> + <code class="constant">EGL_BAD_ALLOC</code> is generated if the + implementation cannot allocate resources for the new EGL window. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the attributes of + <em class="parameter"><code>native_pixmap</code></em> do not correspond to + <em class="parameter"><code>config</code></em> or if + <em class="parameter"><code>config</code></em> does not support rendering to pixmaps + (the <code class="constant">EGL_SURFACE_TYPE</code> attribute does not contain + <code class="constant">EGL_PIXMAP_BIT</code>). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>config</code></em> does not support the specified + OpenVG alpha format attribute (the value of + <code class="constant">EGL_VG_ALPHA_FORMAT</code> is + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code> and the + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE_BIT</code> is not set + in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em>) or colorspace attribute (the + value of <code class="constant">EGL_VG_COLORSPACE</code> is + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code> and the + <code class="constant">EGL_VG_COLORSPACE_LINEAR_IT</code> is not set + in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em>). + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePlatformWindowSurface.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePlatformWindowSurface.xhtml new file mode 100644 index 0000000..f95ab1f --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreatePlatformWindowSurface.xhtml @@ -0,0 +1,368 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglCreatePlatformWindowSurface - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglCreatePlatformWindowSurface"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglCreatePlatformWindowSurface — + create a new <abbr class="acronym">EGL</abbr> on-screen rendering surface + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLSurface <strong class="fsfunc">eglCreatePlatformWindowSurface</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLConfig <var class="pdparam">config</var>, </td> + </tr> + <tr> + <td> </td> + <td>void * <var class="pdparam">native_window</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLAttrib const * <var class="pdparam">attrib_list</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>native_window</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the native window.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies a list of attributes for the window surface. + May be <code class="constant">NULL</code> or empty + (first attribute is <code class="constant">EGL_NONE</code>). + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglCreatePlatformWindowSurface</code> creates an + on-screen EGL window surface and returns a handle to it. Any EGL + context created with a compatible <span class="type">EGLConfig</span> can be + used to render into this surface. + </p> + <p> + If <code class="function">eglCreatePlatformWindowSurface</code> fails to + create a window surface, <code class="constant">EGL_NO_SURFACE</code> is + returned. + </p> + <p> + <em class="parameter"><code>native_window</code></em> must belong to the same + platform as <em class="parameter"><code>display</code></em>, and EGL considers + the returned <span class="type">EGLSurface</span> as belonging to that same + platform. The EGL extension that defines the platform to which + <em class="parameter"><code>display</code></em> belongs also defines the + requirements for the <em class="parameter"><code>native_window</code></em> + parameter. + </p> + <p> + Surface attributes are specified as a list of + attribute-value pairs, terminated with + <code class="constant">EGL_NONE</code>. Accepted attributes + are: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_GL_COLORSPACE</code> + </span> + </dt> + <dd> + <p> + Specifies the color space used by OpenGL and OpenGL ES + when rendering to the surface. If its value is + <code class="constant">EGL_GL_COLORSPACE_SRGB</code>, then a + non-linear, perceptually uniform color space is assumed, + with a corresponding + <code class="constant">GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING</code> + value of <code class="constant">GL_SRGB</code>. If its value is + <code class="constant">EGL_GL_COLORSPACE_LINEAR</code>, then a + linear color space is assumed, with a corresponding + <code class="constant">GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING</code> + value of <code class="constant">GL_LINEAR</code>. The default + value of <code class="constant">EGL_GL_COLORSPACE</code> is + <code class="constant">EGL_GL_COLORSPACE_LINEAR</code>. + </p> + <p> + Note that the <code class="constant">EGL_GL_COLORSPACE</code> + attribute is used only by OpenGL and OpenGL ES contexts + supporting sRGB framebuffers. EGL itself does not + distinguish multiple colorspace models. Refer to the + ``sRGB Conversion'' sections of the OpenGL 4.6 and + OpenGL ES 3.2 Specifications for more information. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RENDER_BUFFER</code> + </span> + </dt> + <dd> + <p> + Specifies which buffer should be used for client API + rendering to the window. If its value is + <code class="constant">EGL_SINGLE_BUFFER</code>, then client + APIs should render directly into the visible window. + If its value is + <code class="constant">EGL_BACK_BUFFER</code>, then client + APIs should render into the back buffer. The default + value of <code class="constant">EGL_RENDER_BUFFER</code> is + <code class="constant">EGL_BACK_BUFFER</code>. + </p> + <p> + Client APIs may not be able to respect the requested + rendering buffer. To determine the actual buffer + being rendered to by a context, call + <a class="citerefentry" href="eglQueryContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQueryContext</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_ALPHA_FORMAT</code> + </span> + </dt> + <dd> + <p> + Specifies how alpha values are interpreted by OpenVG + when rendering to the surface. If its value is + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>, + then alpha values are not premultipled. If its value + is <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code>, + then alpha values are premultiplied. The default + value of <code class="constant">EGL_VG_ALPHA_FORMAT</code> is + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_COLORSPACE</code> + </span> + </dt> + <dd> + <p> + Specifies the color space used by OpenVG when + rendering to the surface. If its value is + <code class="constant">EGL_VG_COLORSPACE_sRGB</code>, then a + non-linear, perceptually uniform color space is + assumed, with a corresponding + <span class="type">VGImageFormat</span> of form + <code class="constant">VG_s*</code>. If its value is + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code>, then + a linear color space is assumed, with a + corresponding <span class="type">VGImageFormat</span> of form + <code class="constant">VG_l*</code>. The default value of + <code class="constant">EGL_VG_COLORSPACE</code> is + <code class="constant">EGL_VG_COLORSPACE_sRGB</code>. + </p> + </dd> + </dl> + </div> + <p> + Any EGL rendering context that was created with respect to + <em class="parameter"><code>config</code></em> can be used to render into the + surface. Use + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + to attach an EGL rendering context to the surface. + </p> + <p> + Use + <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + to retrieve the ID of <em class="parameter"><code>config</code></em>. + </p> + <p> + Use + <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a> + to destroy the surface. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + Attribute <code class="constant">EGL_GL_COLORSPACE</code> is supported + only if the EGL version is 1.5 or greater. + </p> + <p> + Attributes <code class="constant">EGL_RENDER_BUFFER</code>, + <code class="constant">EGL_VG_ALPHA_FORMAT</code>, and + <code class="constant">EGL_VG_COLORSPACE</code>, and the + corresponding attribute values, are supported only if the + EGL version is 1.2 or greater. + </p> + <p> + The <code class="constant">EGL_VG_ALPHA_FORMAT</code> and + <code class="constant">EGL_VG_COLORSPACE</code> attributes are used only + by OpenVG and EGL itself. Refer to section 11.2 of the OpenVG + 1.0 specification for more information. The platform's use and + interpretation of alpha values is outside the scope of EGL. + However, the preferred behavior is for platforms to ignore the + value of <code class="constant">EGL_VG_ALPHA_FORMAT</code> when + compositing window surfaces. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + If <em class="parameter"><code>display</code></em> and + <em class="parameter"><code>native_window</code></em> do not belong to the same + platform, then undefined behavior occurs. + </p> + <p> + <code class="constant">EGL_NO_SURFACE</code> is returned if creation of + the surface fails. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONFIG</code> is generated if + <em class="parameter"><code>config</code></em> is not a valid EGL frame buffer + configuration. + </p> + <p> + <code class="constant">EGL_BAD_NATIVE_WINDOW</code> may be generated if + <em class="parameter"><code>native_window</code></em> is not a valid native + window for the same platform as <em class="parameter"><code>display</code></em>. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains an invalid window attribute + or if an attribute value is not recognized or is out of range. + </p> + <p> + <code class="constant">EGL_BAD_ALLOC</code> is generated if there is + already an <span class="type">EGLSurface</span> associated with + <em class="parameter"><code>native_window</code></em> (as a result of a previous + <code class="function">eglCreatePlatformWindowSurface</code> call). + </p> + <p> + <code class="constant">EGL_BAD_ALLOC</code> is generated if the + implementation cannot allocate resources for the new EGL window. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the pixel + format of <em class="parameter"><code>native_window</code></em> does not + correspond to the format, type, and size of the color buffers + required by <em class="parameter"><code>config</code></em>. + <code class="constant">EGL_BAD_MATCH</code> is generated if the pixel + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>config</code></em> does not support rendering to + windows (the <code class="constant">EGL_SURFACE_TYPE</code> attribute + does not contain <code class="constant">EGL_WINDOW_BIT</code>). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>config</code></em> does not support the specified + OpenVG alpha format attribute (the value of + <code class="constant">EGL_VG_ALPHA_FORMAT</code> is + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code> and the + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE_BIT</code> is not set + in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em>) or colorspace attribute (the + value of <code class="constant">EGL_VG_COLORSPACE</code> is + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code> and the + <code class="constant">EGL_VG_COLORSPACE_LINEAR_IT</code> is not set + in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em>). + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreateSync.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreateSync.xhtml new file mode 100644 index 0000000..5ca5676 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreateSync.xhtml @@ -0,0 +1,389 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglCreateSync - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglCreateSync"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglCreateSync — + create a new <abbr class="acronym">EGL</abbr> sync object + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLSync <strong class="fsfunc">eglCreateSync</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLEnum <var class="pdparam">type</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLAttrib const * <var class="pdparam">attrib_list</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the <abbr class="acronym">EGL</abbr> display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>type</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the type of sync object to create. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies attributes and attribute values for the sync + object being created. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <em class="firstterm">sync objects</em> are provided to enable + synchronization of client API operations between threads and/or + between API contexts. Sync objects may be tested or waited upon + by application threads. + </p> + <p> + Sync objects have a status with two possible states: + <em class="firstterm">signaled</em> and + <em class="firstterm">unsignaled</em>. Initially, sync objects are + unsignaled. EGL may be asked to wait for a sync object to become + signaled, or a sync object's status may be queried. + </p> + <p> + Depending on the type of a sync object, its status may be + changed either by an external event, or by explicitly signaling + and unsignaling the sync. + </p> + <p> + <code class="function">eglCreateSync</code> creates a sync object of the specified + <em class="parameter"><code>type</code></em> associated with the specified display + <em class="parameter"><code>display</code></em>, and returns a handle to the new object. + <em class="parameter"><code>attrib_list</code></em> is an attribute-value list specifying + other attributes of the sync object, terminated by an attribute entry + <code class="constant">EGL_NONE</code>. Attributes not specified in the list will be + assigned their default values. + </p> + <p> + Once the <em class="firstterm">condition</em> of the sync object is satisfied, + the sync is signaled, causing any <code class="function">eglClientWaitSync</code> or + <code class="function">eglWaitSync</code> commands blocking on + <em class="parameter"><code>sync</code></em> to unblock. + </p> + </div> + <div class="refsect1" id="fencesync"> + <h2>Creating Fence Sync Objects</h2> + <p> + If <em class="parameter"><code>type</code></em> is + <code class="constant">EGL_SYNC_FENCE</code>, a fence sync object is + created. In this case <em class="parameter"><code>attrib_list</code></em> must be + <code class="constant">NULL</code> or empty (containing only + <code class="constant">EGL_NONE</code>). Attributes of the fence sync + object, and their initial values, are: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_SYNC_TYPE</code> + </span> + </dt> + <dd> + <p> + <code class="constant">EGL_SYNC_FENCE</code> + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SYNC_STATUS</code> + </span> + </dt> + <dd> + <p> + <code class="constant">EGL_UNSIGNALED</code> + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SYNC_CONDITION</code> + </span> + </dt> + <dd> + <p> + <code class="constant">EGL_SYNC_PRIOR_COMMANDS_COMPLETE</code> + </p> + </dd> + </dl> + </div> + <p> + When a fence sync object is created, <code class="function">eglCreateSync</code> also inserts a + fence command into the command stream of the bound client API's current + context (i.e., the context returned by <code class="function">eglGetCurrentContext</code>), and + associates it with the newly created sync object. + </p> + <p> + The only condition supported for fence sync objects is + <code class="constant">EGL_SYNC_PRIOR_COMMANDS_COMPLETE</code>, which is satisfied by completion of + the fence command corresponding to the sync object, and all preceding + commands in the associated client API context's command stream. The sync + object will not be signaled until all effects from these commands on the + client API's internal and framebuffer state are fully realized. No other + state is affected by execution of the fence command. + </p> + <p> + Creation of fence sync objects requires support from the bound + client API, and will not succeed unless the client API satisfies + one of the following properties. Note that + <code class="function">eglWaitSync</code> also requires satisfying these + conditions. + </p> + <p> + </p> + <div class="itemizedlist"> + <ul class="itemizedlist" style="list-style-type: disc; "> + <li class="listitem"> + <p> + client API is OpenGL, and either the OpenGL version is + 3.2 or greater, or the <code class="constant">GL_ARB_sync</code> + extension is supported. + </p> + </li> + <li class="listitem"> + <p> + client API is OpenGL ES, and either the OpenGL ES + version is 3.0 or greater, or the + <code class="constant">GL_OES_EGL_sync</code> extension is + supported. + </p> + </li> + <li class="listitem"> + <p> + client API is OpenVG, and the + <code class="constant">VG_KHR_EGL_sync</code> extension is + supported. + </p> + </li> + </ul> + </div> + <p> + </p> + </div> + <div class="refsect1" id="openclsync"> + <h2>Creating OpenCL Event Sync Objects</h2> + <p> + If <em class="parameter"><code>type</code></em> is + <code class="constant">EGL_SYNC_CL_EVENT</code>, an OpenCL event sync + object is created. In this case + <em class="parameter"><code>attrib_list</code></em> must contain the attribute + <code class="constant">EGL_CL_EVENT_HANDLE</code>, set to a valid OpenCL + event handle returned by a call to + <code class="function">clEnqueueReleaseGLObjects</code> or + <code class="function">clEnqueueReleaseEGLObjects</code>; other types of + OpenCL event handles are not supported. Note that + <code class="constant">EGL_CL_EVENT_HANDLE</code> is not a queriable + property of a sync object. Attributes of the OpenCL event sync + object, and their initial values, are: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_SYNC_TYPE</code> + </span> + </dt> + <dd> + <p> + <code class="constant">EGL_SYNC_CL_EVENT</code> + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SYNC_STATUS</code> + </span> + </dt> + <dd> + <p> + Depends on status of <em class="parameter"><code>event</code></em> + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SYNC_CONDITION</code> + </span> + </dt> + <dd> + <p> + <code class="constant">EGL_SYNC_CL_EVENT_COMPLETE</code> + </p> + </dd> + </dl> + </div> + <p> + The status of such a sync object depends on + <em class="parameter"><code>event</code></em>. When the status of + <em class="parameter"><code>event</code></em> is <code class="constant">CL_QUEUED</code>, + <code class="constant">CL_SUBMITTED</code>, or + <code class="constant">CL_RUNNING</code>, the status of the linked sync + object will be <code class="constant">EGL_UNSIGNALED</code>. When the + status of <em class="parameter"><code>event</code></em> changes to + <code class="constant">CL_COMPLETE</code>, the status of the linked sync + object will become <code class="constant">EGL_SIGNALED</code>. + </p> + <p> + The only condition supported for OpenCL event sync objects is + <code class="constant">EGL_SYNC_CL_EVENT_COMPLETE</code>, which is + satisfied when the status of the OpenCL event associated with + the sync object changes to <code class="constant">CL_COMPLETE</code>. + </p> + <p> + Creating a linked sync object places a reference on the linked + OpenCL event object. When the sync object is deleted, the + reference will be removed from the event object. + </p> + <p> + However, implementations are not required to validate the OpenCL + event, and passing an invalid event handle in + <em class="parameter"><code>attrib_list</code></em> may result in undefined + behavior up to and including program termination. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglCreateSync</code> is supported only if the EGL + version is 1.5 or greater. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="function">eglCreateSync</code> returns + <code class="constant">EGL_NO_SYNC</code> on failure. + </p> + <p> + If <em class="parameter"><code>display</code></em> is not the name of a valid, + initialized <span class="type">EGLDisplay</span>, an + <code class="constant">EGL_BAD_DISPLAY</code> error is generated. + </p> + <p> + If <em class="parameter"><code>attrib_list</code></em> contains an attribute name + not defined for the type of sync object being created, an + <code class="constant">EGL_BAD_ATTRIBUTE</code> error is generated. + </p> + <p> + If <em class="parameter"><code>type</code></em> is not a supported type of sync + object, an <code class="constant">EGL_BAD_PARAMETER</code> error is + generated. + </p> + <p> + If <em class="parameter"><code>type</code></em> is + <code class="constant">EGL_SYNC_FENCE</code> and no context is current + for the bound API (i.e., + <code class="function">eglGetCurrentContext</code> returns + <code class="constant">EGL_NO_CONTEXT</code>), an + <code class="constant">EGL_BAD_MATCH</code> error is generated. + </p> + <p> + If <em class="parameter"><code>type</code></em> is + <code class="constant">EGL_SYNC_FENCE</code> and + <em class="parameter"><code>display</code></em> does not match the + <span class="type">EGLDisplay</span> of the currently bound context for the + currently bound client API (the <span class="type">EGLDisplay</span> returned + by <code class="function">eglGetCurrentDisplay</code>), an + <code class="constant">EGL_BAD_MATCH</code> error is generated. + </p> + <p> + If <em class="parameter"><code>type</code></em> is + <code class="constant">EGL_SYNC_FENCE</code> and the current context for + the currently bound client API does not support fence commands, + an <code class="constant">EGL_BAD_MATCH</code> error is generated. + </p> + <p> + If <em class="parameter"><code>type</code></em> is + <code class="constant">EGL_SYNC_CL_EVENT</code> and + <code class="constant">EGL_CL_EVENT_HANDLE</code> is not specified in + <em class="parameter"><code>attrib_list</code></em>, or its attribute value is + not a valid OpenCL event handle as described above, then an + <code class="constant">EGL_BAD_ATTRIBUTE</code> error is generated. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <code class="function">clEnqueueReleaseGLObjects</code>, + <code class="function">clEnqueueReleaseEGLObjects</code>, + <a class="citerefentry" href="eglClientWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglClientWaitSync</span></span></a>, + <a class="citerefentry" href="eglCreateSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateSync</span></span></a>, + <a class="citerefentry" href="eglGetCurrentContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentDisplay</span></span></a>, + <a class="citerefentry" href="eglWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitSync</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreateWindowSurface.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreateWindowSurface.xhtml new file mode 100644 index 0000000..0a29d77 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglCreateWindowSurface.xhtml @@ -0,0 +1,149 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglCreateWindowSurface - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglCreateWindowSurface"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglCreateWindowSurface — + create a new <abbr class="acronym">EGL</abbr> window surface + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLSurface <strong class="fsfunc">eglCreateWindowSurface</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLConfig <var class="pdparam">config</var>, </td> + </tr> + <tr> + <td> </td> + <td>NativeWindowType <var class="pdparam">native_window</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint const * <var class="pdparam">attrib_list</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>native_window</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the native window.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies window surface attributes. + May be <code class="constant">NULL</code> or empty + (first attribute is <code class="constant">EGL_NONE</code>). + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglCreateWindowSurface</code> creates an on-screen + EGL window surface and returns a handle to it. The behavior of + <code class="function">eglCreateWindowSurface</code> is identical to that + of + <a class="citerefentry" href="eglCreatePlatformWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePlatformWindowSurface</span></span></a> + except that the set of platforms to which + <em class="parameter"><code>display</code></em> is permitted to belong, as well + as the actual type of <em class="parameter"><code>native_window</code></em>, are + implementation specific. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + See errors for + <a class="citerefentry" href="eglCreatePlatformWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePlatformWindowSurface</span></span></a>. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreatePlatformWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePlatformWindowSurface</span></span></a>, + <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroyContext.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroyContext.xhtml new file mode 100644 index 0000000..6a5569d --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroyContext.xhtml @@ -0,0 +1,121 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglDestroyContext - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglDestroyContext"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglDestroyContext — + destroy an <abbr class="acronym">EGL</abbr> rendering context + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglDestroyContext</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLContext <var class="pdparam">context</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>context</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL rendering context to be destroyed. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + If the EGL rendering context <em class="parameter"><code>context</code></em> is not + current to any thread, + <code class="function">eglDestroyContext</code> destroys it immediately. + Otherwise, <em class="parameter"><code>context</code></em> is destroyed when it becomes + not current to any thread. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if destruction of + the context fails, <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONTEXT</code> is generated if + <em class="parameter"><code>context</code></em> is not an EGL rendering context. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroyImage.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroyImage.xhtml new file mode 100644 index 0000000..8c2f3aa --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroyImage.xhtml @@ -0,0 +1,132 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglDestroyImage - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglDestroyImage"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglDestroyImage — + Destroy an <span class="type">EGLImage</span> object + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglDestroyImage</strong>(</code> + </td> + <td>(EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLImage <var class="pdparam">image</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the <abbr class="acronym">EGL</abbr> display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>image</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the image to destroy. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglDestroyImage</code> is used to destroy the + specified <span class="type">EGLImage</span> object + <em class="parameter"><code>image</code></em>. Once destroyed, + <em class="parameter"><code>image</code></em> may not be used to create any + additional <span class="type">EGLImage</span> target resources within any + client API contexts, although existing <span class="type">EGLImage</span> + siblings may continue to be used. <code class="constant">EGL_TRUE</code> + is returned on success. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + On failure, <code class="function">eglDestroyImage</code> returns + <code class="constant">EGL_FALSE</code> + </p> + <p> + If <em class="parameter"><code>display</code></em> is not the handle of a valid + <span class="type">EGLDisplay</span> object, the error + <code class="constant">EGL_BAD_DISPLAY</code> is generated. + </p> + <p> + If <em class="parameter"><code>image</code></em> is not a valid + <span class="type">EGLImage</span> object created with respect to + <em class="parameter"><code>display</code></em>, the error + <code class="constant">EGL_BAD_PARAMETER</code> is generated. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglDestroyImage</code> is available only if the + EGL version is 1.5 or greater. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateImage.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateImage</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroySurface.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroySurface.xhtml new file mode 100644 index 0000000..652f508 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroySurface.xhtml @@ -0,0 +1,123 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglDestroySurface - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglDestroySurface"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglDestroySurface — + destroy an <abbr class="acronym">EGL</abbr> surface + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglDestroySurface</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSurface <var class="pdparam">surface</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL surface to be destroyed. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + If the EGL surface <em class="parameter"><code>surface</code></em> is not current to any + thread, <code class="function">eglDestroySurface</code> destroys it immediately. + Otherwise, <em class="parameter"><code>surface</code></em> 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. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if destruction of + the surface fails, <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL surface. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroySync.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroySync.xhtml new file mode 100644 index 0000000..7db22eb --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroySync.xhtml @@ -0,0 +1,145 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglDestroySync - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglDestroySync"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglDestroySync — + Destroy a sync object + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglDestroySync</strong>(</code> + </td> + <td>(EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSync <var class="pdparam">sync</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the <abbr class="acronym">EGL</abbr> display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>sync</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the sync object to destroy. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglDestroySync</code> is used to destroy an + existing sync object. + </p> + <p> + If any <code class="function">eglClientWaitSync</code> or + <code class="function">eglWaitSync</code> commands are blocking on + <em class="parameter"><code>sync</code></em> when + <code class="function">eglDestroySync</code> is called, + <em class="parameter"><code>sync</code></em> is flagged for deletion and will be + deleted when the associated fence command or OpenCL event object + has completed, and <em class="parameter"><code>sync</code></em> is no longer + blocking any such <code class="function">egl*WaitSync</code> command. + Otherwise, the sync object is destroyed immediately. + </p> + <p> + If no errors are generated, <code class="constant">EGL_TRUE</code> is + returned, and <em class="parameter"><code>sync</code></em> will no longer be the + handle of a valid sync object. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + On failure, <code class="function">eglDestroySync</code> returns + <code class="constant">EGL_FALSE</code>. + </p> + <p> + If <em class="parameter"><code>sync</code></em> is not a valid sync object for + <em class="parameter"><code>display</code></em>, <code class="constant">EGL_FALSE</code> + is returned and an <code class="constant">EGL_BAD_PARAMETER</code> error + is generated. + </p> + <p> + If <em class="parameter"><code>display</code></em> does not match the display + passed to <code class="function">eglCreateSync</code> when + <em class="parameter"><code>sync</code></em> was created, the behaviour is + undefined. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglDestroySync</code> is available only if the EGL + version is 1.5 or greater. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglClientWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglClientWaitSync</span></span></a>, + <a class="citerefentry" href="eglCreateSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateSync</span></span></a>, + <a class="citerefentry" href="eglWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitSync</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetConfigAttrib.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetConfigAttrib.xhtml new file mode 100644 index 0000000..726d487 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetConfigAttrib.xhtml @@ -0,0 +1,508 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetConfigAttrib - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglGetConfigAttrib"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglGetConfigAttrib — + return information about an <abbr class="acronym">EGL</abbr> frame buffer + configuration + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglGetConfigAttrib</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLConfig <var class="pdparam">config</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">attribute</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint * <var class="pdparam">value</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL frame buffer configuration to be + queried. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attribute</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL rendering context attribute to be + returned.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>value</code> + </em> + </span> + </dt> + <dd> + <p>Returns the requested value.</p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglGetConfigAttrib</code> returns in + <em class="parameter"><code>value</code></em> the value of + <em class="parameter"><code>attribute</code></em> for + <em class="parameter"><code>config</code></em> + (config attributes are described in more detail in the + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a> + reference page). + <em class="parameter"><code>attribute</code></em> can be one of the following: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_ALPHA_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the number of bits of alpha stored in the + color buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_ALPHA_MASK_SIZE</code> + </span> + </dt> + <dd> + <p> + Returns the number of bits in the alpha mask buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BIND_TO_TEXTURE_RGB</code> + </span> + </dt> + <dd> + <p>Returns <code class="constant">EGL_TRUE</code> if color buffers can be + bound to an RGB texture, + <code class="constant">EGL_FALSE</code> otherwise. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BIND_TO_TEXTURE_RGBA</code> + </span> + </dt> + <dd> + <p>Returns <code class="constant">EGL_TRUE</code> if color buffers can be + bound to an RGBA texture, + <code class="constant">EGL_FALSE</code> otherwise. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BLUE_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the number of bits of blue stored in the + color buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BUFFER_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the depth of the color buffer. + It is the sum of + <code class="constant">EGL_RED_SIZE</code>, + <code class="constant">EGL_GREEN_SIZE</code>, + <code class="constant">EGL_BLUE_SIZE</code>, and + <code class="constant">EGL_ALPHA_SIZE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_COLOR_BUFFER_TYPE</code> + </span> + </dt> + <dd> + <p> + Returns the color buffer type. Possible types are + <code class="constant">EGL_RGB_BUFFER</code> and + <code class="constant">EGL_LUMINANCE_BUFFER</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_CAVEAT</code> + </span> + </dt> + <dd> + <p>Returns the caveats for the frame buffer configuration. + Possible caveat values are + <code class="constant">EGL_NONE</code>, + <code class="constant">EGL_SLOW_CONFIG</code>, and + <code class="constant">EGL_NON_CONFORMANT</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_ID</code> + </span> + </dt> + <dd> + <p>Returns the ID of the frame buffer configuration. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONFORMANT</code> + </span> + </dt> + <dd> + <p> + Returns a bitmask indicating which client API contexts + created with respect to this config are conformant. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_DEPTH_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the number of bits in the depth buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_GREEN_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the number of bits of green stored in the + color buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LEVEL</code> + </span> + </dt> + <dd> + <p>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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LUMINANCE_SIZE</code> + </span> + </dt> + <dd> + <p> + Returns the number of bits of luminance stored in the luminance buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MAX_PBUFFER_WIDTH</code> + </span> + </dt> + <dd> + <p>Returns the maximum width of a pixel buffer surface in pixels. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MAX_PBUFFER_HEIGHT</code> + </span> + </dt> + <dd> + <p>Returns the maximum height of a pixel buffer surface in pixels. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MAX_PBUFFER_PIXELS</code> + </span> + </dt> + <dd> + <p>Returns the maximum size of a pixel buffer surface in pixels. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MAX_SWAP_INTERVAL</code> + </span> + </dt> + <dd> + <p>Returns the maximum value that can be passed to eglSwapInterval. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MIN_SWAP_INTERVAL</code> + </span> + </dt> + <dd> + <p>Returns the minimum value that can be passed to eglSwapInterval. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_NATIVE_RENDERABLE</code> + </span> + </dt> + <dd> + <p>Returns <code class="constant">EGL_TRUE</code> if native rendering + APIs can render into the surface, + <code class="constant">EGL_FALSE</code> otherwise. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_NATIVE_VISUAL_ID</code> + </span> + </dt> + <dd> + <p>Returns the ID of the associated native visual. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_NATIVE_VISUAL_TYPE</code> + </span> + </dt> + <dd> + <p>Returns the type of the associated native visual. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RED_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the number of bits of red stored in the + color buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RENDERABLE_TYPE</code> + </span> + </dt> + <dd> + <p> + Returns a bitmask indicating the types of supported + client API contexts. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SAMPLE_BUFFERS</code> + </span> + </dt> + <dd> + <p>Returns the number of multisample buffers. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SAMPLES</code> + </span> + </dt> + <dd> + <p>Returns the number of samples per pixel.</p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_STENCIL_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the number of bits in the stencil buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SURFACE_TYPE</code> + </span> + </dt> + <dd> + <p> + Returns a bitmask indicating the types of supported EGL + surfaces. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_TYPE</code> + </span> + </dt> + <dd> + <p>Returns the type of supported transparency. + Possible transparency values are: + <code class="constant">EGL_NONE</code>, and + <code class="constant">EGL_TRANSPARENT_RGB</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_RED_VALUE</code> + </span> + </dt> + <dd> + <p>Returns the transparent red value.</p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_GREEN_VALUE</code> + </span> + </dt> + <dd> + <p>Returns the transparent green value.</p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_BLUE_VALUE</code> + </span> + </dt> + <dd> + <p>Returns the transparent blue value.</p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="constant">EGL_CONFORMANT</code> is supported only if the + EGL version is 1.3 or greater. + </p> + <p> + <code class="constant">EGL_ALPHA_MASK_SIZE</code>, + <code class="constant">EGL_COLOR_BUFFER_TYPE</code>, + <code class="constant">EGL_LUMINANCE_SIZE</code>, and + <code class="constant">EGL_RENDERABLE_TYPE</code> are supported only + if the EGL version is 1.2 or greater. + </p> + <p> + While <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code> can be + specified in the attribute list passed to + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + it is not an attribute of the resulting config and cannot be + queried using <code class="function">eglGetConfigAttrib</code>. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>value</code></em> is not modified when + <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONFIG</code> is generated if + <em class="parameter"><code>config</code></em> is not an EGL frame buffer configuration. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attribute</code></em> is not a valid frame buffer + configuration attribute. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetConfigs.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetConfigs.xhtml new file mode 100644 index 0000000..bd34046 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetConfigs.xhtml @@ -0,0 +1,169 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetConfigs - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglGetConfigs"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglGetConfigs — + return a list of all <abbr class="acronym">EGL</abbr> frame buffer configurations + for a display + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglGetConfigs</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLConfig * <var class="pdparam">configs</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">config_size</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint * <var class="pdparam">num_config</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>configs</code> + </em> + </span> + </dt> + <dd> + <p>Returns a list of configs.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config_size</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the size of the list of configs. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>num_config</code> + </em> + </span> + </dt> + <dd> + <p>Returns the number of configs returned. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglGetConfigs</code> 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. + </p> + <p> + <em class="parameter"><code>configs</code></em> does not return values, if it is specified + as + <code class="constant">NULL</code>. This is useful for querying just the + number of all frame buffer configurations. + </p> + <p> + Use + <a class="citerefentry" href="eglGetConfigAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a> + to retrieve individual attribute values of a frame buffer configuration. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>configs</code></em> and <em class="parameter"><code>num_config</code></em> + are not modified when + <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_PARAMETER</code> is generated if + <em class="parameter"><code>num_config</code></em> is <code class="constant">NULL</code>. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetCurrentContext.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetCurrentContext.xhtml new file mode 100644 index 0000000..9d80ed2 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetCurrentContext.xhtml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetCurrentContext - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglGetCurrentContext"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglGetCurrentContext — + return the current <abbr class="acronym">EGL</abbr> rendering context + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLContext <strong class="fsfunc">eglGetCurrentContext</strong>(</code> + </td> + <td><code>void)</code>;</td> + <td> </td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglGetCurrentContext</code> returns the current + <abbr class="acronym">EGL</abbr> rendering context, as specified by + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>. + If no context is current, <code class="constant">EGL_NO_CONTEXT</code> is returned. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetCurrentDisplay.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetCurrentDisplay.xhtml new file mode 100644 index 0000000..6c8a04d --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetCurrentDisplay.xhtml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetCurrentDisplay - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglGetCurrentDisplay"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglGetCurrentDisplay — + return the display for the current <abbr class="acronym">EGL</abbr> rendering context + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLDisplay <strong class="fsfunc">eglGetCurrentDisplay</strong>(</code> + </td> + <td><code>void)</code>;</td> + <td> </td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglGetCurrentDisplay</code> returns the current + <abbr class="acronym">EGL</abbr> display connection for the current + <abbr class="acronym">EGL</abbr> rendering context, as specified by + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>. + If no context is current, <code class="constant">EGL_NO_DISPLAY</code> is returned. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + Passing <code class="constant">EGL_NO_DISPLAY</code> to any command + taking an <span class="type">EGLDisplay</span> parameter will generate either + an <code class="constant">EGL_BAD_DISPLAY</code> error if the EGL + implementation validates <span class="type">EGLDisplay</span> handles, or + undefined behavior as described at the end of section 3.1 of the + EGL 1.5 Specification. The only exception to this rule is that + <code class="function">eglQueryString</code> will accept an + <span class="type">EGLDisplay</span> parameter of + <code class="constant">EGL_NO_DISPLAY</code> when querying the client + extension string (see section 3.3 of the EGL 1.5 Specification). + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglGetDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>, + <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetCurrentSurface.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetCurrentSurface.xhtml new file mode 100644 index 0000000..285e842 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetCurrentSurface.xhtml @@ -0,0 +1,92 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetCurrentSurface - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglGetCurrentSurface"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglGetCurrentSurface — + return the read or draw surface for the current <abbr class="acronym">EGL</abbr> rendering context + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLSurface <strong class="fsfunc">eglGetCurrentSurface</strong>(</code> + </td> + <td>EGLint <var class="pdparam">readdraw</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>readdraw</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies whether to return the read surface + (<code class="constant">EGL_READ</code>) or the draw surface + (<code class="constant">EGL_DRAW</code>). + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglGetCurrentSurface</code> returns the read or draw + surface attached to the current + <abbr class="acronym">EGL</abbr> rendering context, as specified by + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>. + If no context is current, <code class="constant">EGL_NO_SURFACE</code> is returned. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetDisplay.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetDisplay.xhtml new file mode 100644 index 0000000..47bbea1 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetDisplay.xhtml @@ -0,0 +1,121 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetDisplay - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglGetDisplay"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglGetDisplay — + return an <abbr class="acronym">EGL</abbr> display connection + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLDisplay <strong class="fsfunc">eglGetDisplay</strong>(</code> + </td> + <td>NativeDisplayType <var class="pdparam">native_display</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>native_display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the display to connect to. + <code class="constant">EGL_DEFAULT_DISPLAY</code> indicates the default display. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglGetDisplay</code> obtains the + <abbr class="acronym">EGL</abbr> display connection for the native + display <em class="parameter"><code>native_display</code></em>. + </p> + <p> + The behavior of <code class="function">eglGetDisplay</code> is similar to + that of + <a class="citerefentry" href="eglGetPlatformDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetPlatformDisplay</span></span></a>, + but is specified in terms of implementation-specific behavior + rather than platform-specific extensions. As for + <a class="citerefentry" href="eglGetPlatformDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetPlatformDisplay</span></span></a>, + EGL considers the returned <span class="type">EGLDisplay</span> as belonging + to the same platform as <em class="parameter"><code>display_id</code></em>. + However, the set of platforms to which + <em class="parameter"><code>display_id</code></em> is permitted to belong, as + well as the actual type of <em class="parameter"><code>display_id</code></em>, + are implementation-specific. If + <em class="parameter"><code>display_id</code></em> is + <code class="constant">EGL_DEFAULT_DISPLAY</code>, a <em class="firstterm">default + display</em> is returned. Multiple calls made to + <code class="function">eglGetDisplay</code> with the same + <em class="parameter"><code>display_id</code></em> will return the same + <span class="type">EGLDisplay</span> handle. + </p> + <p> + If <em class="parameter"><code>display_id</code></em> is + <code class="constant">EGL_DEFAULT_DISPLAY</code>, a default display connection is returned. + </p> + <p> + If no display connection matching <em class="parameter"><code>native_display</code></em> is + available, <code class="constant">EGL_NO_DISPLAY</code> is returned. No + error is generated. + </p> + <p> + Use <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a> + to initialize the display connection. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>, + <a class="citerefentry" href="eglGetPlatformDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetPlatformDisplay</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetError.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetError.xhtml new file mode 100644 index 0000000..248841c --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetError.xhtml @@ -0,0 +1,233 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetError - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglGetError"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglGetError — + return error information + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLint <strong class="fsfunc">eglGetError</strong>(</code> + </td> + <td><code>void)</code>;</td> + <td> </td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglGetError</code> returns the error of the last + called <abbr class="acronym">EGL</abbr> function in the current thread. + Initially, the error is set to <code class="constant">EGL_SUCCESS</code>. + </p> + <p> + When an EGL function could potentially generate several + different errors (for example, when passed both a bad attribute + name, and a bad attribute value for a legal attribute name), the + implementation may choose to generate any one of the applicable + errors. + </p> + <p> + The following errors are currently defined: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_SUCCESS</code> + </span> + </dt> + <dd> + <p>The last function succeeded without error. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_NOT_INITIALIZED</code> + </span> + </dt> + <dd> + <p>EGL is not initialized, or could not be initialized, + for the specified EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_ACCESS</code> + </span> + </dt> + <dd> + <p>EGL cannot access a requested resource + (for example a context is bound in another thread). + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_ALLOC</code> + </span> + </dt> + <dd> + <p>EGL failed to allocate resources for the requested + operation.</p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_ATTRIBUTE</code> + </span> + </dt> + <dd> + <p>An unrecognized attribute or attribute value was + passed in the attribute list. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_CONTEXT</code> + </span> + </dt> + <dd> + <p>An <span class="type">EGLContext</span> argument does not name a + valid EGL rendering context. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_CONFIG</code> + </span> + </dt> + <dd> + <p> + An <span class="type">EGLConfig</span> argument does not name a valid + EGL frame buffer configuration. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_CURRENT_SURFACE</code> + </span> + </dt> + <dd> + <p>The current surface of the calling thread is a window, + pixel buffer or pixmap that is no longer valid. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_DISPLAY</code> + </span> + </dt> + <dd> + <p>An <span class="type">EGLDisplay</span> argument does not name a + valid EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_SURFACE</code> + </span> + </dt> + <dd> + <p>An <span class="type">EGLSurface</span> argument does not name a + valid surface (window, pixel buffer or pixmap) configured for + GL rendering. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_MATCH</code> + </span> + </dt> + <dd> + <p>Arguments are inconsistent (for example, a valid + context requires buffers not supplied by a valid surface). + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_PARAMETER</code> + </span> + </dt> + <dd> + <p>One or more argument values are invalid.</p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_NATIVE_PIXMAP</code> + </span> + </dt> + <dd> + <p> + A <span class="type">NativePixmapType</span> argument does not refer to + a valid native pixmap. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_NATIVE_WINDOW</code> + </span> + </dt> + <dd> + <p>A <span class="type">NativeWindowType</span> argument does not refer + to a valid native window. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_LOST</code> + </span> + </dt> + <dd> + <p> + A power management event has occurred. The application must destroy all + contexts and reinitialise OpenGL ES state and objects to continue rendering. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + A call to <code class="function">eglGetError</code> sets the error to + <code class="constant">EGL_SUCCESS</code>. + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetPlatformDisplay.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetPlatformDisplay.xhtml new file mode 100644 index 0000000..6d6f134 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetPlatformDisplay.xhtml @@ -0,0 +1,172 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetPlatformDisplay - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglGetPlatformDisplay"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglGetPlatformDisplay — + return an <abbr class="acronym">EGL</abbr> display connection + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLDisplay <strong class="fsfunc">eglGetPlatformDisplay</strong>(</code> + </td> + <td>EGLenum <var class="pdparam">platform</var>, </td> + </tr> + <tr> + <td> </td> + <td>void * <var class="pdparam">native_display</var>, </td> + </tr> + <tr> + <td> </td> + <td>const EGLAttrib * <var class="pdparam">attrib_list</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>platform</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the native platform to obtain a display for. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>native_display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the native display to connect to. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies attributes of the display being obtained. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglGetPlatformDisplay</code> obtains an + <abbr class="acronym">EGL</abbr> display connection for the specified + <em class="parameter"><code>platform</code></em> and + <em class="parameter"><code>native_display</code></em>. + </p> + <p> + Valid values for <em class="parameter"><code>platform</code></em> are defined by + EGL extensions, as are requirements for + <em class="parameter"><code>native_display</code></em>. + For example, an extension specification that defines support for + the X11 platform may require that + <em class="parameter"><code>native_display</code></em> be a pointer to an X11 + Display, and an extension specification that defines support for + the Microsoft Windows platform may require that + <em class="parameter"><code>native_display</code></em> be a pointer to a Windows + Device Context. + </p> + <p> + Valid attributes are defined by EGL extensions. + All attributes in <em class="parameter"><code>attrib_list</code></em>, + including boolean attributes, are immediately followed by + the corresponding desired value. + The list is terminated with <code class="constant">EGL_NONE</code>. + If an attribute is not specified in + <em class="parameter"><code>attrib_list</code></em> but is required for the + specified <em class="parameter"><code>platform</code></em>, then a default value + is used (and the attribute is said to be specified implicitly). + </p> + <p> + Multiple calls made to + <code class="function">eglGetPlatformDisplay</code> with the same + parameters will return the same <span class="type">EGLDisplay</span> handle. + </p> + <p> + If <em class="parameter"><code>platform</code></em> is valid but no display + matching <em class="parameter"><code>native_display</code></em> is available, + then <code class="constant">EGL_NO_DISPLAY</code> is returned; no error + condition is raised in this case. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglGetPlatformDisplay</code> is supported only if + the EGL version is 1.5 or greater. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="function">eglGetPlatformDisplay</code> returns + <code class="constant">EGL_NO_DISPLAY</code> on failure. + </p> + <p> + An <code class="constant">EGL_BAD_PARAMETER</code> error is generated if + <em class="parameter"><code>platform</code></em> has an invalid value. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>, + <a class="citerefentry" href="eglGetDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetProcAddress.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetProcAddress.xhtml new file mode 100644 index 0000000..8583280 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetProcAddress.xhtml @@ -0,0 +1,133 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetProcAddress - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglGetProcAddress"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglGetProcAddress — + return a <abbr class="acronym">GL</abbr> or an <abbr class="acronym">EGL</abbr> + extension function + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">void (* <strong class="fsfunc">eglGetProcAddress</strong>(</code> + </td> + <td>char const * <var class="pdparam">procname</var>))(void<code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>procname</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the name of the function to return. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglGetProcAddress</code> returns the address of + the client API or EGL function named by + <em class="parameter"><code>procname</code></em>. <em class="parameter"><code>procname</code></em> + must be a null-terminated string. The pointer returned should be + cast to a function pointer matching the function's definition in + the corresponding API or extension specification. A return value + of <code class="constant">NULL</code> indicates that the specific + function does not exist for the implementation. + </p> + <p> + A non-<code class="constant">NULL</code> return value does not guarantee + that an extension function is actually supported at runtime. The + client must also make a corresponding query, such as + <code class="function">glGetString</code>(<code class="constant">GL_EXTENSIONS</code>) + for OpenGL and OpenGL ES extensions; + <code class="function">vgGetString</code>(<code class="constant">VG_EXTENSIONS</code>) + for OpenVG extensions; + <code class="function">eglQueryString</code>(<em class="parameter"><code>display</code></em>, + <code class="constant">EGL_EXTENSIONS</code>); or query the EGL or client + API version for non-extension functions, to determine if a + function is supported by EGL or a specific client API context. + </p> + <p> + Client API function pointers returned by + <code class="function">eglGetProcAddress</code> are independent of the + display and the currently bound client API context, and may be + used by any client API context which supports the function. + </p> + <p> + <code class="function">eglGetProcAddress</code> may be queried for all + EGL and client API functions supported by the implementation + (whether those functions are extensions or not, and whether they + are supported by the current client API context or not). + </p> + <p> + For functions that are queryable with + <code class="function">eglGetProcAddress</code>, implementations may + choose to also export those functions statically from the object + libraries implementing those functions. However, portable + clients cannot rely on this behavior. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + If the EGL version is not 1.5 or greater, only queries of EGL + and client API <span class="emphasis"><em>extension</em></span> functions will + succeed. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <code class="function">glGetString</code> + <a class="citerefentry" href="eglQueryString.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQueryString</span></span></a> </p> + <code class="function">vgGetString</code> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetSyncAttrib.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetSyncAttrib.xhtml new file mode 100644 index 0000000..de9009b --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglGetSyncAttrib.xhtml @@ -0,0 +1,231 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetSyncAttrib - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglGetSyncAttrib"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglGetSyncAttrib — + Return an attribute of a sync object + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglGetSyncAttrib</strong>(</code> + </td> + <td>(EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSync <var class="pdparam">sync</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">attribute</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLAttrib *<var class="pdparam">value</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the <abbr class="acronym">EGL</abbr> display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>sync</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the sync object to query. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attribute</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL sync object attribute to query. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>value</code> + </em> + </span> + </dt> + <dd> + <p> + Returns the requested attribute value. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglGetSyncAttrib</code> is used to query + attributes of the sync object <em class="parameter"><code>sync</code></em>. Legal + values for <em class="parameter"><code>attribute</code></em> depend on the type + of sync object, as shown in table + <a class="xref" href="#tab-syncattr" title="Table 1. Attributes accepted by eglGetSyncAttrib">Table 1, “ + Attributes accepted by <code class="function">eglGetSyncAttrib</code> + ”</a>. Assuming no errors are + generated, <code class="constant">EGL_TRUE</code> is returned and the + value of the queried attribute is returned in + *<em class="parameter"><code>value</code></em>. + </p> + <div class="table" id="tab-syncattr"> + <div class="table-title">Table 1. + Attributes accepted by <code class="function">eglGetSyncAttrib</code> + </div> + <div class="table-contents"> + <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; "> + <colgroup> + <col/> + <col/> + <col/> + </colgroup> + <thead> + <tr> + <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Attribute</th> + <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Description</th> + <th style="text-align: left; border-bottom: 2px solid ; ">Supported Sync Objects</th> + </tr> + </thead> + <tbody> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Attribute</td> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Description</td> + <td style="text-align: left; border-bottom: 2px solid ; ">Supported Sync Objects</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_SYNC_TYPE</code> + </td> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Type of the sync object</td> + <td style="text-align: left; border-bottom: 2px solid ; ">All</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> + <code class="constant">EGL_SYNC_STATUS</code> + </td> + <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Status of the sync object</td> + <td style="text-align: left; border-bottom: 2px solid ; ">All</td> + </tr> + <tr> + <td style="text-align: left; border-right: 2px solid ; "> + <code class="constant">EGL_SYNC_CONDITION</code> + </td> + <td style="text-align: left; border-right: 2px solid ; ">Signaling condition</td> + <td style="text-align: left; "> + <code class="constant">EGL_SYNC_FENCE</code> or + <code class="constant">EGL_SYNC_CL_EVENT</code> + </td> + </tr> + </tbody> + </table> + </div> + </div> + <br class="table-break"/> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + On failure, <code class="function">eglGetSyncAttrib</code> returns + <code class="constant">EGL_FALSE</code> and *<em class="parameter"><code>value</code></em> + is not modified. + </p> + <p> + If <em class="parameter"><code>sync</code></em> is not a valid sync object for + <em class="parameter"><code>display</code></em>, an + <code class="constant">EGL_BAD_PARAMETER</code> error is generated. + </p> + <p> + If <em class="parameter"><code>attribute</code></em> is not one of the attributes + in table <a class="xref" href="#tab-syncattr" title="Table 1. Attributes accepted by eglGetSyncAttrib">Table 1, “ + Attributes accepted by <code class="function">eglGetSyncAttrib</code> + ”</a>, an + <code class="constant">EGL_BAD_ATTRIBUTE</code> error is generated. + </p> + <p> + If <em class="parameter"><code>attribute</code></em> is not supported for the + type of sync object passed in <em class="parameter"><code>sync</code></em>, an + <code class="constant">EGL_BAD_MATCH</code> error is generated. + </p> + <p> + If <em class="parameter"><code>display</code></em> does not match the display + passed to <code class="function">eglCreateSync</code> when + <em class="parameter"><code>sync</code></em> was created, behaviour is undefined. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglGetSyncAttrib</code> is available only if the + EGL version is 1.5 or greater. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateSync</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglInitialize.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglInitialize.xhtml new file mode 100644 index 0000000..4544be2 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglInitialize.xhtml @@ -0,0 +1,149 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglInitialize - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglInitialize"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglInitialize — + initialize an <abbr class="acronym">EGL</abbr> display connection + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglInitialize</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint * <var class="pdparam">major</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint * <var class="pdparam">minor</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection to initialize. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>major</code> + </em> + </span> + </dt> + <dd> + <p> + Returns the major version number of the EGL implementation. + May be <code class="constant">NULL</code>. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>minor</code> + </em> + </span> + </dt> + <dd> + <p> + Returns the minor version number of the EGL implementation. + May be <code class="constant">NULL</code>. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglInitialize</code> initialized the EGL display + connection obtained with + <a class="citerefentry" href="eglGetDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>. + Initializing an already initialized EGL display connection has no + effect besides returning the version numbers. + </p> + <p> + <em class="parameter"><code>major</code></em> and <em class="parameter"><code>minor</code></em> + do not return values if they are specified as <code class="constant">NULL</code>. + </p> + <p> + Use <a class="citerefentry" href="eglTerminate.xhtml"><span class="citerefentry"><span class="refentrytitle">eglTerminate</span></span></a> + to release resources associated with an EGL display connection. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if + <code class="function">eglInitialize</code> fails, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>major</code></em> and <em class="parameter"><code>minor</code></em> are not + modified when <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> cannot be initialized. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglGetDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>, + <a class="citerefentry" href="eglTerminate.xhtml"><span class="citerefentry"><span class="refentrytitle">eglTerminate</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglIntro.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglIntro.xhtml new file mode 100644 index 0000000..b82eade --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglIntro.xhtml @@ -0,0 +1,304 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglIntro - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglIntro"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglIntro — + introduction to managing client API rendering through the + <abbr class="acronym">EGL</abbr> API. + </p> + </div> + <div class="refsect1" id="overview"> + <h2>Overview</h2> + <p> + The <em class="firstterm">Khronos Native Platform Graphics + Interface</em> (EGL) provides a means for rendering + using a <em class="firstterm">client API</em> 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 + <em class="firstterm">platform</em>, such as Microsoft Windows or + the X Window System. + </p> + <p> + Depending on its implementation EGL might be more or less + tightly integrated into the platform. Most EGL + functions require an EGL display connection, which can be + obtained by calling + <a class="citerefentry" href="eglGetPlatformDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetPlatformDisplay</span></span></a> + or + <a class="citerefentry" href="eglGetDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>. + To initialize and + query what EGL version is supported on the display + connection, call + <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>. + </p> + <p> + The EGL specification does not define the set of platforms that + may be supported by an EGL implementation, nor does it specify + behavior specific to any platform. The set of supported + platforms and their behavior is defined by platform-specific + extensions. To detect if a particular platform is supported, + clients should query the <code class="constant">EGL_EXTENSIONS</code> + string of <code class="constant">EGL_NO_DISPLAY</code> using + <a class="citerefentry" href="eglQueryString.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQueryString</span></span></a>. + </p> + <p> + Platforms 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 platform APIs. + </p> + <p> + An EGL <em class="firstterm">surface</em> extends a native + window or pixmap with additional <em class="firstterm">auxillary + buffers</em>. 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. + </p> + <p> + 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 platform. EGL pixel buffers are + EGL-only resources, and do not accept rendering through the + platform APIs. + </p> + <p> + 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. + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a> + returns an <span class="type">EGLConfig</span> matching the required + attributes, if any. A complete list of EGL frame buffer + configurations can be obtained by calling + <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>. + Attributes of a particular EGL frame buffer configuration + can be queried by calling + <a class="citerefentry" href="eglGetConfigAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a>. + </p> + <p> + 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 + <a class="citerefentry" href="eglGetConfigAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a>. + For pixel buffers, no underlying native resource is + required. + </p> + <p> + To create an EGL window surface from a native window, call + <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>. + To create an EGL pixmap surface from a native pixmap, call + <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>. + To create a pixel buffer (pbuffer) surface (which has no + associated native buffer), call + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a> + To create a pixel buffer (pbuffer) surface whose color + buffer is provided by an OpenVG <span class="type">VGImage</span>, call + <a class="citerefentry" href="eglCreatePbufferFromClientBuffer.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferFromClientBuffer</span></span></a>. + Use + <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a> + to release previously allocated resources. + </p> + <p> + 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 + <a class="citerefentry" href="eglCreateContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>. + The type of client API context created (OpenGL ES, OpenVG, + etc.) can be changed by first calling + <a class="citerefentry" href="eglBindAPI.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>. + </p> + <p> + An EGL rendering context may be bound to one or two EGL + surfaces by calling + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>. + This context/surface(s) association specifies the + <em class="firstterm">current context</em> and + <em class="firstterm">current surface</em>, and is used by all + client API rendering commands for the bound context until + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + is called with different arguments. + </p> + <p> + Both platform 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 + <a class="citerefentry" href="eglWaitClient.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitClient</span></span></a>, + <a class="citerefentry" href="eglWaitNative.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a>, + and possibly by calling other platform APIs. + </p> + </div> + <div class="refsect1" id="examples"> + <h2>Examples</h2> + <p> + 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. + </p> + <pre class="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; +} +</pre> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + Prior to EGL 1.5, platforms were referred to as the + <em class="firstterm">native window system</em>, and + platform-specific queries and APIs were not available. Only a + single native window system was supported. + </p> + </div> + <div class="refsect1" id="usingeglextensions"> + <h2>Using EGL Extensions</h2> + <p> + All supported EGL extensions will have a corresponding definition in + <code class="filename">egl.h</code> and a token in the extension strings returned + by + <a class="citerefentry" href="eglQueryString.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQueryString</span></span></a>. + </p> + </div> + <div class="refsect1" id="futureeglversions"> + <h2>Future EGL Versions</h2> + <p> + <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a> + and + <a class="citerefentry" href="eglQueryString.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQueryString</span></span></a> + can be used to determine at run-time what version of EGL is available. + To check the EGL version at compile-time, test whether + <code class="constant">EGL_VERSION_<em class="replaceable"><code>x</code></em>_<em class="replaceable"><code>y</code></em></code> + is defined, where <em class="replaceable"><code>x</code></em> and + <em class="replaceable"><code>y</code></em> are the major and minor version + numbers. + </p> + </div> + <div class="refsect1" id="files"> + <h2>Files</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="filename">GLES/egl.h</code> + </span> + </dt> + <dd> + <p> + EGL header file + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + + <a class="citerefentry" href="eglBindAPI.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglCreateContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferFromClientBuffer.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferFromClientBuffer</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglDestroyContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroyContext</span></span></a>, + <a class="citerefentry" href="eglDestroySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglGetDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>, + <a class="citerefentry" href="eglGetPlatformDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetPlatformDisplay</span></span></a>, + <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQueryString.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQueryString</span></span></a>, + <a class="citerefentry" href="eglSwapBuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a>, + <a class="citerefentry" href="eglTerminate.xhtml"><span class="citerefentry"><span class="refentrytitle">eglTerminate</span></span></a>, + <a class="citerefentry" href="eglWaitGL.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitGL</span></span></a>, + <a class="citerefentry" href="eglWaitNative.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglMakeCurrent.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglMakeCurrent.xhtml new file mode 100644 index 0000000..14f28ec --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglMakeCurrent.xhtml @@ -0,0 +1,381 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglMakeCurrent - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglMakeCurrent"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglMakeCurrent — + attach an EGL rendering context to EGL surfaces + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglMakeCurrent</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSurface <var class="pdparam">draw</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSurface <var class="pdparam">read</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLContext <var class="pdparam">context</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the <abbr class="acronym">EGL</abbr> display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>draw</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the <abbr class="acronym">EGL</abbr> draw surface.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>read</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the <abbr class="acronym">EGL</abbr> read surface.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>context</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the <abbr class="acronym">EGL</abbr> rendering context + to be attached to the surfaces. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglMakeCurrent</code> binds <em class="parameter"><code>context</code></em> + to the current rendering thread and to the <em class="parameter"><code>draw</code></em> + and <em class="parameter"><code>read</code></em> surfaces. + </p> + <p> + For an OpenGL or OpenGL ES context, <em class="parameter"><code>draw</code></em> + is used for all operations except for any pixel data read back or copied + (<a class="citerefentry" href="glReadPixels.xhtml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>, + <a class="citerefentry" href="glCopyTexImage2D.xhtml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>, and + <a class="citerefentry" href="glCopyTexSubImage2D.xhtml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>), + which is taken from the frame buffer values of + <em class="parameter"><code>read</code></em>. Note that the same + <span class="type">EGLSurface</span> may be specified for both draw and read. + </p> + <p> + For an OpenVG context, the same <span class="type">EGLSurface</span> must be + specified for both <em class="parameter"><code>draw</code></em> and + <em class="parameter"><code>read</code></em>. + </p> + <p> + If the calling thread has already a current rendering context of + the same client API type as <em class="parameter"><code>context</code></em>, then + that context is flushed and marked as no longer current. + <em class="parameter"><code>context</code></em> is then made the current context + for the calling thread. For purposes of + <code class="function">eglMakeCurrent</code>, the client API type of all + OpenGL ES and OpenGL contexts is considered the same. In other + words, if any OpenGL ES context is currently bound and + <em class="parameter"><code>context</code></em> is an OpenGL context, or if any + OpenGL context is currently bound and + <em class="parameter"><code>context</code></em> is an OpenGL ES context, the + currently bound context will be made no longer current and + <em class="parameter"><code>context</code></em> will be made current. + </p> + <p> + OpenGL and OpenGL ES buffer mappings created by e.g. + <code class="function">glMapBuffer</code> are not affected by + <code class="function">eglMakeCurrent</code>; they persist whether the + context owning the buffer is current or not. + </p> + <p> + If <em class="parameter"><code>draw</code></em> is destroyed after + <code class="function">eglMakeCurrent</code> is called, then subsequent + rendering commands will be processed and the context state will + be updated, but the surface contents become undefined. If + <em class="parameter"><code>read</code></em> is destroyed after + <code class="function">eglMakeCurrent</code> then pixel values + <em class="parameter"><code>read</code></em> from the framebuffer (e.g., as + result of calling glReadPixels) are undefined. If a native + window or pixmap underlying the <em class="parameter"><code>draw</code></em> or + <em class="parameter"><code>read</code></em> surfaces is destroyed, rendering and + <em class="parameter"><code>read</code></em>back are handled as above. + </p> + <p> + To release the current context without assigning a new one, set + <em class="parameter"><code>context</code></em> to + <code class="constant">EGL_NO_CONTEXT</code> and set + <em class="parameter"><code>draw</code></em> and <em class="parameter"><code>read</code></em> to + <code class="constant">EGL_NO_SURFACE</code> . The currently bound + context for the client API specified by the current rendering + API is flushed and marked as no longer current, and there will + be no current context for that client API after + <code class="function">eglMakeCurrent</code> returns. This is the only + case in which <code class="function">eglMakeCurrent</code> respects the + current rendering API. In all other cases, the client API + affected is determined by <em class="parameter"><code>context</code></em>. This + is the only case where an uninitialized display may be passed to + <code class="function">eglMakeCurrent</code>. + </p> + <p> + If ctx is not <code class="constant">EGL_NO_CONTEXT</code>, then both + <em class="parameter"><code>draw</code></em> and <em class="parameter"><code>read</code></em> must + not be <code class="constant">EGL_NO_SURFACE</code> unless + <em class="parameter"><code>context</code></em> is a context which supports being + bound without read and draw surfaces. In this case the context + is made current without a default framebuffer. The meaning of + this is defined by the client API of the supporting context (see + chapter 4 of the OpenGL 3.0 Specification, and the + <code class="constant">GL_OES_surfaceless_context</code> OpenGL ES + extension.). + </p> + <p> + The first time a OpenGL or OpenGL ES context is made current the + viewport and scissor dimensions are set to the size of the + <em class="parameter"><code>draw</code></em> surface (as though + <code class="function">glViewport</code>(0,0,w,h) and + <code class="function">glScissor</code>(0,0,<em class="parameter"><code>w</code></em>,<em class="parameter"><code>h</code></em>) + were called, where <em class="parameter"><code>w</code></em> and + <em class="parameter"><code>h</code></em> are the width and height of the + surface, respectively). However, the viewport and scissor + dimensions are not modified when <em class="parameter"><code>context</code></em> + is subsequently made current. The client is responsible for + resetting the viewport and scissor in this case. + </p> + <p> + The first time <em class="parameter"><code>context</code></em> is made current, + if it is without a default framebuffer (e.g. both + <em class="parameter"><code>draw</code></em> and <em class="parameter"><code>read</code></em> are + <code class="constant">EGL_NO_SURFACE</code> ), then the viewport and + scissor regions are set as though + <code class="function">glViewport</code>(0,0,0,0) and + <code class="function">glScissor</code>(0,0,0,0) were called. + </p> + <p> + Implementations may delay allocation of auxiliary buffers for a + surface until they are required by a context (which may result + in the <code class="constant">EGL_BAD_ALLOC</code> error described + above). Once allocated, however, auxiliary buffers and their + contents persist until a surface is deleted. + </p> + <p> + Use + <a class="citerefentry" href="eglGetCurrentContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentDisplay</span></span></a>, and + <a class="citerefentry" href="eglGetCurrentSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentSurface</span></span></a> + to query the current rendering context and associated display connection and surfaces. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + If <em class="parameter"><code>draw</code></em> or <em class="parameter"><code>read</code></em> + are not compatible with <em class="parameter"><code>context</code></em>, then an + <code class="constant">EGL_BAD_MATCH</code> error is generated. + </p> + <p> + If <em class="parameter"><code>context</code></em> is current to some other + thread, or if either <em class="parameter"><code>draw</code></em> or + <em class="parameter"><code>read</code></em> are bound to contexts in another + thread, an <code class="constant">EGL_BAD_ACCESS</code> error is + generated. + </p> + <p> + If binding <em class="parameter"><code>context</code></em> would exceed the + number of current contexts of that client API type supported by + the implementation, an <code class="constant">EGL_BAD_ACCESS</code> error + is generated. + </p> + <p> + If either <em class="parameter"><code>draw</code></em> or + <em class="parameter"><code>read</code></em> are pbuffers created with + <code class="function">eglCreatePbufferFromClientBuffer</code>, and the + underlying bound client API buffers are in use by the client API + that created them, an <code class="constant">EGL_BAD_ACCESS</code> error + is generated. + </p> + <p> + If <em class="parameter"><code>context</code></em> is not a valid context and is + not <code class="constant">EGL_NO_CONTEXT</code>, an + <code class="constant">EGL_BAD_CONTEXT</code> error is generated. + </p> + <p> + If either <em class="parameter"><code>draw</code></em> or + <em class="parameter"><code>read</code></em> are not valid EGL surfaces and are + not <code class="constant">EGL_NO_SURFACE</code>, an + <code class="constant">EGL_BAD_SURFACE</code> error is generated. + </p> + <p> + If <em class="parameter"><code>context</code></em> is + <code class="constant">EGL_NO_CONTEXT</code> and either + <em class="parameter"><code>draw</code></em> or <em class="parameter"><code>read</code></em> are + not <code class="constant">EGL_NO_SURFACE</code>, an + <code class="constant">EGL_BAD_MATCH</code> error is generated. + </p> + <p> + If either of <em class="parameter"><code>draw</code></em> or + <em class="parameter"><code>read</code></em> is a valid surface and the other is + <code class="constant">EGL_NO_SURFACE</code>, an + <code class="constant">EGL_BAD_MATCH</code> error is generated. + </p> + <p> + If <em class="parameter"><code>context</code></em> does not support being bound + without <em class="parameter"><code>read</code></em> and + <em class="parameter"><code>draw</code></em> surfaces, and both + <em class="parameter"><code>draw</code></em> and <em class="parameter"><code>read</code></em> are + <code class="constant">EGL_NO_SURFACE</code>, an + <code class="constant">EGL_BAD_MATCH</code> error is generated. + </p> + <p> + If a native window underlying either <em class="parameter"><code>draw</code></em> + or <em class="parameter"><code>read</code></em> is no longer valid, an + <code class="constant">EGL_BAD_NATIVE_WINDOW</code> error is generated. + </p> + <p> + If <em class="parameter"><code>draw</code></em> and <em class="parameter"><code>read</code></em> + cannot fit into graphics memory simultaneously, an + <code class="constant">EGL_BAD_MATCH</code> error is generated. + </p> + <p> + If the previous context of the calling thread has unflushed + commands, and the previous surface is no longer valid, an + <code class="constant">EGL_BAD_CURRENT_SURFACE</code> error is generated. + </p> + <p> + If the ancillary buffers for <em class="parameter"><code>draw</code></em> and + <em class="parameter"><code>read</code></em> cannot be allocated, an + <code class="constant">EGL_BAD_ALLOC</code> error is generated. + </p> + <p> + If a power management event has occurred, an + <code class="constant">EGL_CONTEXT_LOST</code> error is generated. + </p> + <p> + If any of the following are true: + + </p> + <div class="itemizedlist"> + <ul class="itemizedlist" style="list-style-type: disc; "> + <li class="listitem"> + <p> + <em class="parameter"><code>context</code></em> is not + <code class="constant">EGL_NO_CONTEXT</code> + </p> + </li> + <li class="listitem"> + <p> + <em class="parameter"><code>read</code></em> is not + <code class="constant">EGL_NO_SURFACE</code> + </p> + </li> + <li class="listitem"> + <p> + <em class="parameter"><code>draw</code></em> is not + <code class="constant">EGL_NO_SURFACE</code> + </p> + </li> + </ul> + </div> + <p> + + then an <code class="constant">EGL_NOT_INITIALIZED</code> error is + generated if <em class="parameter"><code>display</code></em> is a valid but + uninitialized display. + </p> + <p> + As with other commands taking <span class="type">EGLDisplay</span> + parameters, if <em class="parameter"><code>display</code></em> is not a valid + <span class="type">EGLDisplay</span> handle, an + <code class="constant">EGL_BAD_DISPLAY</code> error is generated. (Some + implementations have chosen to allow + <code class="constant">EGL_NO_DISPLAY</code> as a valid + <em class="parameter"><code>display</code></em> parameter for + <code class="function">eglMakeCurrent</code>. This behavior is not + portable to all EGL implementations, and should be considered as + an undocumented vendor extension). + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="glReadPixels.xhtml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>, + <a class="citerefentry" href="glCopyTexImage2D.xhtml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>, + <a class="citerefentry" href="glCopyTexSubImage2D.xhtml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>, + <a class="citerefentry" href="eglCreateContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglGetCurrentContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentDisplay</span></span></a>, + <a class="citerefentry" href="eglGetCurrentSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentSurface</span></span></a>, + <a class="citerefentry" href="eglGetDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>, + <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglQueryAPI.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglQueryAPI.xhtml new file mode 100644 index 0000000..45e5a80 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglQueryAPI.xhtml @@ -0,0 +1,107 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglQueryAPI - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglQueryAPI"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglQueryAPI — Query the current rendering API</p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLenum <strong class="fsfunc">eglQueryAPI</strong>(</code> + </td> + <td><code>void)</code>;</td> + <td> </td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglQueryAPI</code> returns the value of the + current rendering API for EGL in the thread it is called + from. The current rendering API is set by + <a class="citerefentry" href="eglBindAPI.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, + and affects the behavior of other EGL commands. + </p> + <p> + The value returned will be one of the valid + <em class="parameter"><code>api</code></em> parameters to + <a class="citerefentry" href="eglBindAPI.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, or + <code class="constant">EGL_NONE</code>. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglQueryAPI</code> is supported only if the + EGL version is 1.2 or greater. + </p> + <p> + The initial value of the current rendering API is + <code class="constant">EGL_OPENGL_ES_API</code> unless OpenGL ES is + not supported by an implementation, in which case the + initial value is <code class="constant">EGL_NONE</code> (however, + <code class="constant">EGL_NONE</code> is not a valid + <em class="parameter"><code>api</code></em> parameter to + <code class="function">eglQueryAPI</code>). + </p> + <p> + The current rendering API can be changed by calling + <a class="citerefentry" href="eglBindAPI.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + None. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglBindAPI.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, + <a class="citerefentry" href="eglCreateContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentDisplay</span></span></a>, + <a class="citerefentry" href="eglGetCurrentSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentSurface</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglWaitClient.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitClient</span></span></a>, + <a class="citerefentry" href="eglWaitNative.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglQueryContext.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglQueryContext.xhtml new file mode 100644 index 0000000..c121448 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglQueryContext.xhtml @@ -0,0 +1,267 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglQueryContext - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglQueryContext"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglQueryContext — + return <abbr class="acronym">EGL</abbr> rendering context information + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglQueryContext</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLContext <var class="pdparam">context</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">attribute</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint * <var class="pdparam">value</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>context</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL rendering context to query. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attribute</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL rendering context attribute to be returned. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>value</code> + </em> + </span> + </dt> + <dd> + <p> + Returns the requested value. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglQueryContext</code> returns in + <em class="parameter"><code>value</code></em> the value of + <em class="parameter"><code>attribute</code></em> for <em class="parameter"><code>context</code></em>. + <em class="parameter"><code>attribute</code></em> can be one of the following: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_ID</code> + </span> + </dt> + <dd> + <p> + Returns the ID of the EGL frame buffer configuration + with respect to which the context was created. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_CLIENT_TYPE</code> + </span> + </dt> + <dd> + <p> + Returns the type of client API which the context + supports (one of + <code class="constant">EGL_OPENGL_API</code>, + <code class="constant">EGL_OPENGL_ES_API</code>, or + <code class="constant">EGL_OPENVG_API</code>). + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_CLIENT_VERSION</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RENDER_BUFFER</code> + </span> + </dt> + <dd> + <p> + 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: + </p> + <div class="itemizedlist"> + <ul style="list-style-type: disc; " class="itemizedlist"> + <li class="listitem"> + <p> + If the context is bound to a pixmap surface, + then <code class="constant">EGL_SINGLE_BUFFER</code> will + be returned. + </p> + </li> + <li class="listitem"> + <p> + If the context is bound to a pbuffer surface, + then <code class="constant">EGL_BACK_BUFFER</code> will + be returned. + </p> + </li> + <li class="listitem"> + <p> + If the context is bound to a window surface, + then either <code class="constant">EGL_BACK_BUFFER</code> + or <code class="constant">EGL_SINGLE_BUFFER</code> may be + returned. The value returned depends on both the + buffer requested by the setting of the + <code class="constant">EGL_RENDER_BUFFER</code> property + of the surface (which may be queried by calling + <code class="function">eglQuerySurface</code>), and on + the client API (not all client APIs support + single-buffer rendering to window surfaces). + </p> + </li> + <li class="listitem"> + <p> + If the context is not bound to a surface, such + as an OpenGL ES context bound to a framebuffer + object, then <code class="constant">EGL_NONE</code> will + be returned. + </p> + </li> + </ul> + </div> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + Attributes <code class="constant">EGL_CONTEXT_CLIENT_TYPE</code> and + <code class="constant">EGL_RENDER_BUFFER</code> are supported only if + the EGL version is 1.2 or greater. + </p> + <p> + Attribute <code class="constant">EGL_CONTEXT_CLIENT_VERSION</code> is + supported only if the EGL version is 1.3 or greater. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>value</code></em> is not modified when + <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONTEXT</code> is generated if + <em class="parameter"><code>context</code></em> is not an EGL rendering context. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attribute</code></em> is not a valid context attribute. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglQueryString.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglQueryString.xhtml new file mode 100644 index 0000000..663d046 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglQueryString.xhtml @@ -0,0 +1,236 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglQueryString - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglQueryString"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglQueryString — + return a string describing properties of the EGL client or of an + <abbr class="acronym">EGL</abbr> display connection + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">char const * <strong class="fsfunc">eglQueryString</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">name</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>name</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies a symbolic constant, one of + <code class="constant">EGL_CLIENT_APIS</code>, + <code class="constant">EGL_VENDOR</code>, + <code class="constant">EGL_VERSION</code>, or + <code class="constant">EGL_EXTENSIONS</code>. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglQueryString</code> returns a pointer to a + static, zero-terminated string describing properties of the EGL + client or of an EGL display connection. + <em class="parameter"><code>name</code></em> may be one of the following: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_CLIENT_APIS</code> + </span> + </dt> + <dd> + <p> + Returns a string describing which client rendering + APIs are supported. The string contains a + space-separated list of API names. The list must + include at least one of <code class="code">OpenGL</code>, + <code class="code">OpenGL_ES</code>, or <code class="code">OpenVG</code>. + These strings correspond respectively to values + <code class="constant">EGL_OPENGL_API</code>, + <code class="constant">EGL_OPENGL_ES_API</code>, and + <code class="constant">EGL_OPENVG_API</code> of the + <a class="citerefentry" href="eglBindAPI.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, + <em class="parameter"><code>api</code></em> argument. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VENDOR</code> + </span> + </dt> + <dd> + <p> + Returns the name of the vendor responsible for this EGL + implementation. The format and contents of the string + are implementation-dependent. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VERSION</code> + </span> + </dt> + <dd> + <p> + Returns a version or release number. The + <code class="constant">EGL_VERSION</code> string is laid out + as follows: + </p> + <p> + <em class="replaceable"><code>major_version</code></em>.<em class="replaceable"><code>minor_version</code></em> + space + <em class="replaceable"><code>vendor_specific_info</code></em> + </p> + <p> + Both the major and minor portions of the version + number are numeric. Their values must match the + <em class="parameter"><code>major</code></em> and + <em class="parameter"><code>minor</code></em> values returned by + <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>. + </p> + <p> + The vendor-specific information is optional; if + present, its format and contents are + implementation-specific. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_EXTENSIONS</code> + </span> + </dt> + <dd> + <p> + Returns a space separated list of supported + extensions to EGL. If there are no extensions, then + the empty string is returned. + </p> + <p> + If <em class="parameter"><code>display</code></em> is + <code class="constant">EGL_NO_DISPLAY</code>, then the + <code class="constant">EGL_EXTENSIONS</code> string describes + the set of supported <em class="firstterm">client + extensions</em>. If + <em class="parameter"><code>display</code></em> is a valid, + initialized display, then the + <code class="constant">EGL_EXTENSIONS</code> string describes + the set of <em class="firstterm">display extensions</em> + supported by that display. The set of supported + client extensions is disjoint from the set of + extensions supported by any given display. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="constant">EGL_CLIENT_APIS</code> is supported only if + the EGL version is 1.2 or greater. + </p> + <p> + A <em class="parameter"><code>display</code></em> of + <code class="constant">EGL_NO_DISPLAY</code> is supported only if the EGL + version is 1.5 or greater. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">NULL</code> is returned on failure. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection, + unless <em class="parameter"><code>display</code></em> is + <code class="constant">EGL_NO_DISPLAY</code> and + <em class="parameter"><code>name</code></em> is + <code class="constant">EGL_EXTENSIONS</code>. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> is a valid but uninitialized + EGLDisplay. + </p> + <p> + <code class="constant">EGL_BAD_PARAMETER</code> is generated if + <em class="parameter"><code>name</code></em> is not an accepted value. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglBindAPI.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, + <a class="citerefentry" href="eglGetDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>, + <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglQuerySurface.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglQuerySurface.xhtml new file mode 100644 index 0000000..14b4be2 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglQuerySurface.xhtml @@ -0,0 +1,435 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglQuerySurface - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglQuerySurface"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglQuerySurface — + return <abbr class="acronym">EGL</abbr> surface information + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglQuerySurface</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSurface <var class="pdparam">surface</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">attribute</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint * <var class="pdparam">value</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface to query. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attribute</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface attribute to be returned. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>value</code> + </em> + </span> + </dt> + <dd> + <p> + Returns the requested value. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglQuerySurface</code> returns in + <em class="parameter"><code>value</code></em> the value of + <em class="parameter"><code>attribute</code></em> for <em class="parameter"><code>surface</code></em>. + <em class="parameter"><code>attribute</code></em> can be one of the following: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_ID</code> + </span> + </dt> + <dd> + <p> + Returns the ID of the EGL frame buffer configuration + with respect to which the surface was created. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_GL_COLORSPACE</code> + </span> + </dt> + <dd> + <p> + Returns the color space used by OpenGL and OpenGL ES + when rendering to the surface, either + <code class="constant">EGL_GL_COLORSPACE_SRGB</code> or + <code class="constant">EGL_GL_COLORSPACE_LINEAR</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_HEIGHT</code> + </span> + </dt> + <dd> + <p> + Returns the height of the surface in pixels. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_HORIZONTAL_RESOLUTION</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_DISPLAY_SCALING</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LARGEST_PBUFFER</code> + </span> + </dt> + <dd> + <p> + Returns the same attribute value specified when the + surface was created with + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>. + For a window or pixmap surface, + <em class="parameter"><code>value</code></em> is not modified. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MIPMAP_LEVEL</code> + </span> + </dt> + <dd> + <p> + Returns which level of the mipmap to render to, if + texture has mipmaps. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MIPMAP_TEXTURE</code> + </span> + </dt> + <dd> + <p> + Returns <code class="constant">EGL_TRUE</code> if texture has + mipmaps, <code class="constant">EGL_FALSE</code> otherwise. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> + </span> + </dt> + <dd> + <p> + Returns the filter used when resolving the + multisample buffer. The filter may be either + <code class="constant">EGL_MULTISAMPLE_RESOLVE_DEFAULT</code> + or <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX</code>, + as described for + <a class="citerefentry" href="eglSurfaceAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_PIXEL_ASPECT_RATIO</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_DISPLAY_SCALING</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RENDER_BUFFER</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_BACK_BUFFER</code>. For a pixmap + surface, it is always + <code class="constant">EGL_SINGLE_BUFFER</code>. To determine + the actual buffer being rendered to by a context, + call + <a class="citerefentry" href="eglQueryContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQueryContext</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SWAP_BEHAVIOR</code> + </span> + </dt> + <dd> + <p> + Returns the effect on the color buffer when posting + a surface with + <a class="citerefentry" href="eglSwapBuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a>. + Swap behavior may be either + <code class="constant">EGL_BUFFER_PRESERVED</code> or + <code class="constant">EGL_BUFFER_DESTROYED</code>, as + described for + <a class="citerefentry" href="eglSurfaceAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_FORMAT</code> + </span> + </dt> + <dd> + <p> + Returns format of texture. Possible values are + <code class="constant">EGL_NO_TEXTURE</code>, + <code class="constant">EGL_TEXTURE_RGB</code>, and + <code class="constant">EGL_TEXTURE_RGBA</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_TARGET</code> + </span> + </dt> + <dd> + <p> + Returns type of texture. Possible values are + <code class="constant">EGL_NO_TEXTURE</code>, or + <code class="constant">EGL_TEXTURE_2D</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VERTICAL_RESOLUTION</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_DISPLAY_SCALING</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_ALPHA_FORMAT</code> + </span> + </dt> + <dd> + <p> + Returns the interpretation of alpha values used by + OpenVG when rendering to the surface, either + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code> or + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_COLORSPACE</code> + </span> + </dt> + <dd> + <p> + Returns the color space used by OpenVG when rendering to + the surface, either + <code class="constant">EGL_VG_COLORSPACE_sRGB</code> or + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_WIDTH</code> + </span> + </dt> + <dd> + <p> + Returns the width of the surface in pixels. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + Attribute <code class="constant">EGL_GL_COLORSPACE</code> is supported + only if the EGL version is 1.5 or greater. + </p> + <p> + Attribute <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> is + supported only if the EGL version is 1.4 or greater. + </p> + <p> + Attributes <code class="constant">EGL_DISPLAY_SCALING</code>. + <code class="constant">EGL_HORIZONTAL_RESOLUTION</code>, + <code class="constant">EGL_PIXEL_ASPECT_RATIO</code>, + <code class="constant">EGL_RENDER_BUFFER</code>, + <code class="constant">EGL_SWAP_BEHAVIOR</code>, and + <code class="constant">EGL_VERTICAL_RESOLUTION</code> are supported + only if the EGL version is 1.2 or greater. + </p> + <p> + Querying attributes <code class="constant">EGL_TEXTURE_FORMAT</code>, + <code class="constant">EGL_TEXTURE_TARGET</code>, + <code class="constant">EGL_MIPMAP_TEXTURE</code>, or + <code class="constant">EGL_MIPMAP_LEVEL</code> for a non-pbuffer + surface is not an error, but <em class="parameter"><code>value</code></em> is + not modified. + </p> + <p> + <code class="constant">EGL_DISPLAY_SCALING</code> 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. + </p> + <p> + For an offscreen (pbuffer or pixmap) surface, or a surface + whose pixel dot pitch or aspect ratio are unknown, querying + <code class="constant">EGL_HORIZONTAL_RESOLUTION</code>, + <code class="constant">EGL_PIXEL_ASPECT_RATIO</code>, or + <code class="constant">EGL_VERTICAL_RESOLUTION</code> will return the + constant value <code class="constant">EGL_UNKNOWN</code> (-1). + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>value</code></em> is not modified when + <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL surface. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attribute</code></em> is not a valid surface attribute. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglSurfaceAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>, + <a class="citerefentry" href="eglSwapBuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglReleaseTexImage.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglReleaseTexImage.xhtml new file mode 100644 index 0000000..7040263 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglReleaseTexImage.xhtml @@ -0,0 +1,155 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglReleaseTexImage - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglReleaseTexImage"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglReleaseTexImage — + Releases a color buffer that is being used as a texture + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglReleaseTexImage</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSurface <var class="pdparam">surface</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">buffer</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>buffer</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the texture image data.</p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + 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. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + 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. + </p> + <p> + 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 <a class="citerefentry" href="eglBindTexImage.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindTexImage</span></span></a> + and <code class="function">eglReleaseTexImage</code>. + </p> + <p> + After a color buffer is released from a texture (either explicitly by calling + <code class="function">eglReleaseTexImage</code> or implicitly by calling a routine such as + <a class="citerefentry" href="glTexImage2D.xhtml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>), + all texture images that were defined by the color buffer become <code class="constant">NULL</code> + (it is as if <a class="citerefentry" href="glTexImage.xhtml"><span class="citerefentry"><span class="refentrytitle">glTexImage</span></span></a> was called with an image of zero width). + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the + surface attribute <code class="constant">EGL_TEXTURE_FORMAT</code> is + set to <code class="constant">EGL_NO_TEXTURE</code>. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>buffer</code></em> is not a valid buffer + (currently only <code class="constant">EGL_BACK_BUFFER</code> may be + specified). + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL surface, or is + not a bound pbuffer surface. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglBindTexImage.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindTexImage</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglReleaseThread.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglReleaseThread.xhtml new file mode 100644 index 0000000..a894b68 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglReleaseThread.xhtml @@ -0,0 +1,158 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglReleaseThread - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglReleaseThread"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglReleaseThread — Release EGL per-thread state</p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglReleaseThread</strong>(</code> + </td> + <td><code>void)</code>;</td> + <td> </td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglReleaseThread</code> returns the EGL to its + state at thread initialization, releasing all per-thread + state including the error status returned by + <span class="command"><strong>eglGetError</strong></span>, the currently bound + rendering API defined by <span class="command"><strong>eglBindAPI</strong></span>, 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. + </p> + <p> + <code class="constant">EGL_TRUE</code> is returned on success, and the + following actions are taken: + </p> + <div class="itemizedlist"> + <ul class="itemizedlist" style="list-style-type: disc; "> + <li class="listitem"> + <p> + For each client API supported by EGL, if there is a + currently bound context, that context is released. + This is equivalent to calling + <code class="function">eglMakeCurrent</code> with ctx set to + <code class="constant">EGL_NO_CONTEXT</code> and both draw + and read set to <code class="constant">EGL_NO_SURFACE</code> + (see section 3.7.3). + </p> + </li> + <li class="listitem"> + <p> + The current rendering API is reset to its value at + thread initialization (see + <span class="command"><strong>eglBindAPI</strong></span>). + </p> + </li> + <li class="listitem"> + <p> + Any additional implementation-dependent per-thread + state maintained by EGL is marked for deletion as + soon as possible. + </p> + </li> + </ul> + </div> + <p> + <code class="function">eglReleaseThread</code> 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. + </p> + <p> + Resources explicitly allocated by calls to EGL, such as + contexts, surfaces, and configuration lists, are not + affected by <code class="function">eglReleaseThread</code>. Such + resources belong not to the thread, but to the EGL + implementation as a whole. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglReleaseThread</code> is supported only if the + EGL version is 1.2 or greater. + </p> + <p> + Applications may call other EGL routines from a thread + following <code class="function">eglReleaseThread</code>, but any + such call may reallocate the EGL state previously released. + In particular, calling <code class="function">eglGetError</code> + immediately following a successful call to + <code class="function">eglReleaseThread</code> will return + <code class="constant">EGL_SUCCESS</code>, but will also result in + reallocating per-thread state. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. There are no + defined conditions under which failure will occur. Even if + EGL is not initialized on any EGLDisplay, + <code class="function">eglReleaseThread</code> should succeed. + </p> + <p> + However, platform-dependent failures may be signaled through + the value returned from <code class="function">eglGetError</code>. + Unless the platform-dependent behavior is known, a failed + call to <code class="function">eglReleaseThread</code> should be + assumed to leave the current rendering API, and the + currently bound contexts for each supported client API, in + an unknown state. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglBindAPI.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, + <a class="citerefentry" href="eglGetError.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetError</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglSurfaceAttrib.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglSurfaceAttrib.xhtml new file mode 100644 index 0000000..0da8ac3 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglSurfaceAttrib.xhtml @@ -0,0 +1,274 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglSurfaceAttrib - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglSurfaceAttrib"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglSurfaceAttrib — + set an <abbr class="acronym">EGL</abbr> surface attribute + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglSurfaceAttrib</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSurface <var class="pdparam">surface</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">attribute</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">value</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attribute</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface attribute to set. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>value</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the attributes required value. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglSurfaceAttrib</code> sets the value of + <em class="parameter"><code>attribute</code></em> for + <em class="parameter"><code>surface</code></em> to + <em class="parameter"><code>value</code></em>. + <em class="parameter"><code>attribute</code></em> can be one of the + following: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_MIPMAP_LEVEL</code> + </span> + </dt> + <dd> + <p> + For mipmap textures, the + <code class="constant">EGL_MIPMAP_LEVEL</code> 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 <code class="constant">0</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> + </span> + </dt> + <dd> + <p> + 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 + <em class="parameter"><code>value</code></em> of + <code class="constant">EGL_MULTISAMPLE_RESOLVE_DEFAULT</code> + chooses the default implementation-defined filtering + method, while + <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX</code> + chooses a one-pixel wide box filter placing equal + weighting on all multisample values. + </p> + <p> + The initial value of + <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> is + <code class="constant">EGL_MULTISAMPLE_RESOLVE_DEFAULT</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SWAP_BEHAVIOR</code> + </span> + </dt> + <dd> + <p> + Specifies the effect on the color buffer of posting + a surface with + <a class="citerefentry" href="eglSwapBuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a>. + A <em class="parameter"><code>value</code></em> of + <code class="constant">EGL_BUFFER_PRESERVED</code> indicates + that color buffer contents are unaffected, while + <code class="constant">EGL_BUFFER_DESTROYED</code> indicates + that color buffer contents may be destroyed or + changed by the operation. + </p> + <p> + The initial value of + <code class="constant">EGL_SWAP_BEHAVIOR</code> is chosen by + the implementation. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + Attribute <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> is + supported only if the EGL version is 1.4 or greater. + </p> + <p> + Attribute <code class="constant">EGL_SWAP_BEHAVIOR</code> is + supported only if the EGL version is 1.2 or greater. + </p> + <p> + If the value of pbuffer attribute + <code class="constant">EGL_TEXTURE_FORMAT</code> is + <code class="constant">EGL_NO_TEXTURE</code>, the value of attribute + <code class="constant">EGL_TEXTURE_TARGET</code> is + <code class="constant">EGL_NO_TEXTURE</code>, or + <em class="parameter"><code>surface</code></em> is not a pbuffer, then + attribute <code class="constant">EGL_MIPMAP_LEVEL</code> may be set, + but has no effect. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>attribute</code></em> is + <code class="constant">EGL_MULTISAMPLE_RESOLVE</code>, + <em class="parameter"><code>value</code></em> is + <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX</code>, and the + <code class="constant">EGL_SURFACE_TYPE</code> attribute of the + <span class="type">EGLConfig</span> used to create + <em class="parameter"><code>surface</code></em> does not contain + <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX_BIT</code>. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>attribute</code></em> is + <code class="constant">EGL_SWAP_BEHAVIOR</code>, + <em class="parameter"><code>value</code></em> is + <code class="constant">EGL_BUFFER_PRESERVED</code>, and the + <code class="constant">EGL_SURFACE_TYPE</code> attribute of the + <span class="type">EGLConfig</span> used to create + <em class="parameter"><code>surface</code></em> does not contain + <code class="constant">EGL_SWAP_BEHAVIOR_PRESERVED_BIT</code>. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL surface. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attribute</code></em> is not a valid surface attribute. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglQuerySurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglSwapBuffers.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglSwapBuffers.xhtml new file mode 100644 index 0000000..b256152 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglSwapBuffers.xhtml @@ -0,0 +1,196 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglSwapBuffers - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglSwapBuffers"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglSwapBuffers — + post <abbr class="acronym">EGL</abbr> surface color buffer to a native window + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglSwapBuffers</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSurface <var class="pdparam">surface</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL drawing surface whose buffers are to be swapped. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + If <em class="parameter"><code>surface</code></em> is a back-buffered window + surface, then the color + buffer is copied (posted) to the native window associated with that + surface. If <em class="parameter"><code>surface</code></em> is a single-buffered + window, pixmap, or pixel buffer surface, + <code class="function">eglSwapBuffers</code> has no effect. + </p> + <p> + The contents of ancillary buffers are always undefined after + calling <code class="function">eglSwapBuffers</code>. The contents of the + color buffer are undefined if the value of the + <code class="constant">EGL_SWAP_BEHAVIOR</code> attribute of + <em class="parameter"><code>surface</code></em> is not + <code class="constant">EGL_BUFFER_PRESERVED</code>. The value of + <code class="constant">EGL_SWAP_BEHAVIOR</code> can be set for some + surfaces using + <a class="citerefentry" href="eglSurfaceAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>. + <code class="constant">EGL_SWAP_BEHAVIOR</code> applies only to the color + buffer. EGL has no way to specify or query whether or not + ancillary buffers are preserved, and applications should not + rely on this behavior. + </p> + <p> + <code class="function">eglSwapBuffers</code> performs an implicit + flush operation on the context (<code class="function">glFlush</code> + for an OpenGL ES or OpenGL context, + <code class="function">vgFlush</code> for an OpenVG context) bound to + <em class="parameter"><code>surface</code></em> before swapping. Subsequent + client API commands may be issued on that context + immediately after calling + <code class="function">eglSwapBuffers</code>, but are not executed + until the buffer exchange is completed. + </p> + </div> + <div class="refsect1" id="resize"> + <h2>Native Window Resizing</h2> + <p> + If the native window corresponding to + <em class="parameter"><code>surface</code></em> has been resized prior to the + swap, <em class="parameter"><code>surface</code></em> must be resized to match. + <em class="parameter"><code>surface</code></em> will normally be resized by the + EGL implementation at the time the native window is resized. If + the implementation cannot do this transparently to the client, + then <code class="function">eglSwapBuffers</code> must detect the change + and resize surface prior to copying its pixels to the native + window. If <em class="parameter"><code>surface</code></em> shrinks as a result of + resizing, some rendered pixels are lost. If + <em class="parameter"><code>surface</code></em> grows, the newly allocated buffer + contents are undefined. The resizing behavior described here + only maintains consistency of EGL surfaces and native windows; + clients are still responsible for detecting window size changes + (using platform-specific means) and changing their viewport and + scissor regions accordingly. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + Attribute <code class="constant">EGL_SWAP_BEHAVIOR</code> 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 <code class="constant">EGL_BUFFER_DESTROYED</code>. + </p> + <p> + The EGL 1.4 specification was updated to acknowledge that + ancillary buffers are not necessarily preserved after a swap, + and that the <code class="constant">EGL_SWAP_BEHAVIOR</code> 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. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if swapping of the + surface buffers fails, <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL drawing surface. + </p> + <p> + <code class="constant">EGL_CONTEXT_LOST</code> 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. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <code class="function">glFlush</code>, + <a class="citerefentry" href="eglCopyBuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCopyBuffers</span></span></a>, + <code class="function">vgFlush</code> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglSwapInterval.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglSwapInterval.xhtml new file mode 100644 index 0000000..80eb980 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglSwapInterval.xhtml @@ -0,0 +1,137 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglSwapInterval - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglSwapInterval"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglSwapInterval — + specifies the minimum number of video frame periods + per buffer swap for the window associated with the current context. + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglSwapInterval</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">interval</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>interval</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the minimum number of video frames that are displayed before + a buffer swap will occur. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + The interval takes effect when <a class="citerefentry" href="eglSwapBuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a> is + first called subsequent to the <code class="function">eglSwapInterval</code> call. + </p> + <p> + The <em class="parameter"><code>interval</code></em> specified by the function applies to the draw surface + bound to the context that is current on the calling thread. + </p> + <p> + If <em class="parameter"><code>interval</code></em> is set to a value of <code class="constant">0</code>, 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 <span class="type">EGLConfig</span> attributes + <code class="constant">EGL_MIN_SWAP_INTERVAL</code> and <code class="constant">EGL_MAX_SWAP_INTERVAL</code> respectively. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + The swap interval has no effect on <a class="citerefentry" href="eglCopyBuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCopyBuffers</span></span></a>. + </p> + <p> + The default swap interval is 1. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_CONTEXT</code> is generated if there is no current context + on the calling thread. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if there is no surface + bound to the current context. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglSwapBuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglTerminate.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglTerminate.xhtml new file mode 100644 index 0000000..4c32f9b --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglTerminate.xhtml @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglTerminate - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglTerminate"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglTerminate — + terminate an <abbr class="acronym">EGL</abbr> display connection + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglTerminate</strong>(</code> + </td> + <td>EGLDisplay <var class="pdparam">display</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection to terminate. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglTerminate</code> 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 <em class="parameter"><code>display</code></em> is current to any thread, + they are not released until they are no longer current as a result of + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>. + </p> + <p> + Terminating an already terminated EGL display connection has no effect. + A terminated display may be re-initialized by calling + <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a> + again. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if + <code class="function">eglTerminate</code> fails, + <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.xhtml"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglWaitClient.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglWaitClient.xhtml new file mode 100644 index 0000000..5f88491 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglWaitClient.xhtml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglWaitClient - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglWaitClient"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglWaitClient — + Complete client API execution prior to subsequent native + rendering calls + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglWaitClient</strong>(</code> + </td> + <td><code>void)</code>;</td> + <td> </td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + All rendering calls for the currently bound context, for the + current rendering API, made prior to + <code class="function">eglWaitClient</code> are guaranteed to be + executed before native rendering calls made after + <code class="function">eglWaitClient</code>. The same result can be + achieved using client API-specific commands such as + <a class="citerefentry" href="glFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a> + or + <a class="citerefentry" href="vgFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">vgFinish</span></span></a>. + </p> + <p> + <code class="function">eglWaitClient</code> is ignored if there is no + current EGL rendering context for the current rendering API. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if + <code class="function">eglWaitClient</code> fails, + <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + If there is no current context for the current rendering + API, the function has no effect but still returns + <code class="constant">EGL_TRUE</code>. + </p> + <p> + <code class="constant">EGL_BAD_CURRENT_SURFACE</code> 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. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglWaitClient</code> is supported only if the + EGL version is 1.2 or greater. + </p> + <p> + <code class="function">eglWaitClient</code> is a generalized version + of <code class="function">eglWaitGL</code>, supporting multiple + client APIs. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="glFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a>, + <a class="citerefentry" href="glFlush.xhtml"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a>, + <a class="citerefentry" href="eglWaitGL.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitGL</span></span></a>, + <a class="citerefentry" href="eglWaitNative.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a>, + <a class="citerefentry" href="vgFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">vgFinish</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglWaitGL.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglWaitGL.xhtml new file mode 100644 index 0000000..020a502 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglWaitGL.xhtml @@ -0,0 +1,112 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglWaitGL - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglWaitGL"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglWaitGL — + Complete GL execution prior to subsequent native rendering + calls + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglWaitGL</strong>(</code> + </td> + <td><code>void)</code>;</td> + <td> </td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + All OpenGL ES rendering calls for the currently bound OpenGL + ES context made prior to <code class="function">eglWaitGL</code> are + guaranteed to be executed before native rendering calls made + after <code class="function">eglWaitGL</code>. The same result can be + achieved using + <a class="citerefentry" href="glFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a>. + </p> + <p> + <code class="function">eglWaitGL</code> is ignored if there is no + current EGL rendering context for OpenGL ES. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglWaitClient</code> is supported only if the + EGL version is 1.2 or greater. + </p> + <p> + <code class="function">eglWaitClient</code> is a generalized version + of <code class="function">eglWaitGL</code>, supporting multiple + client APIs. For backwards compatibility, + <code class="function">eglWaitGL</code> continues to be supported and + is equivalent to the series of commands + </p> + <pre class="programlisting"> + EGLenum api = <code class="function">eglQueryAPI</code>(); + <code class="function">eglBindAPI</code>(<code class="constant">EGL_OPENGL_ES_API</code>); + <code class="function">eglWaitClient</code>(); + <code class="function">eglBindAPI</code>(api); + </pre> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if + <code class="function">eglWaitGL</code> fails, + <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_CURRENT_SURFACE</code> 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. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="glFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a>, + <a class="citerefentry" href="eglWaitClient.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitClient</span></span></a> + <a class="citerefentry" href="eglWaitNative.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglWaitNative.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglWaitNative.xhtml new file mode 100644 index 0000000..16cf5dd --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglWaitNative.xhtml @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglWaitNative - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglWaitNative"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglWaitNative — + complete native execution prior to subsequent GL rendering calls + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglWaitNative</strong>(</code> + </td> + <td>EGLint <var class="pdparam">engine</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>engine</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies a particular marking engine to be waited on. + Must be <code class="constant">EGL_CORE_NATIVE_ENGINE</code>. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + Native rendering calls made prior to <code class="function">eglWaitNative</code> + are guaranteed to be executed before GL rendering calls made after + <code class="function">eglWaitNative</code>. + </p> + <p> + <code class="function">eglWaitNative</code> + is ignored if there is no current + <abbr class="acronym">EGL</abbr> + rendering context. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="constant">EGL_BAD_PARAMETER</code> is generated if + <em class="parameter"><code>engine</code></em> is not a recognized marking engine. + </p> + <p> + <code class="constant">EGL_BAD_CURRENT_SURFACE</code> + 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. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="glFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a>, + <a class="citerefentry" href="glFlush.xhtml"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a>, + <a class="citerefentry" href="eglWaitClient.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitClient</span></span></a>, + <a class="citerefentry" href="eglWaitGL.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitGL</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglWaitSync.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglWaitSync.xhtml new file mode 100644 index 0000000..4eeff76 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglWaitSync.xhtml @@ -0,0 +1,190 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglWaitSync - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglWaitSync"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglWaitSync — + Wait in the server for a sync object to be signalled + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglWaitSync</strong>(</code> + </td> + <td>(EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSync <var class="pdparam">sync</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLint <var class="pdparam">flags</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the <abbr class="acronym">EGL</abbr> display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>sync</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the sync object to wait on. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>flags</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies flags controlling wait behavior. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglWaitSync</code> is similar to + <code class="function">eglClientWaitSync</code>, but instead of blocking + and not returning to the application until + <em class="parameter"><code>sync</code></em> is signaled, + <code class="function">eglWaitSync</code> returns immediately. On + success, <code class="constant">EGL_TRUE</code> is returned, and the + server for the client API context will block until + <em class="parameter"><code>sync</code></em> is signaled. + </p> + <p> + Note: <code class="function">eglWaitSync</code> allows applications to + continue to queue commands from the application in anticipation + of the sync being signaled, potentially increasing parallelism + between application, client API server code, and the GPU. The + server only blocks execution of commands for the specific + context on which <code class="function">eglWaitSync</code> was issued; + other contexts implemented by the same server are not affected.. + </p> + <p> + <em class="parameter"><code>sync</code></em> has the same meaning as for + <code class="function">eglClientWaitSync</code>. + </p> + <p> + <em class="parameter"><code>flags</code></em> must be 0. + </p> + <p> + <code class="function">eglWaitSync</code> requires support from the bound + client API, and will not succeed unless the same client API + properties described for creation of fence syncs in + <a class="citerefentry" href="eglCreateSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateSync</span></span></a> + are satisfied. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + <code class="function">eglWaitSync</code> returns + <code class="constant">EGL_FALSE</code> on failure, and does not cause + the server for the client API context to block. + </p> + <p> + If the current context for the currently bound client API does + not support server waits, an <code class="constant">EGL_BAD_MATCH</code> + error is generated. + </p> + <p> + If no context is current for the currently bound client API + (i.e., <code class="function">eglGetCurrentContext</code> returns + <code class="constant">EGL_NO_CONTEXT</code>), an + <code class="constant">EGL_BAD_MATCH</code> error is generated. + </p> + <p> + If <em class="parameter"><code>display</code></em> does not match the + <span class="type">EGLDisplay</span> passed to + <code class="function">eglCreateSync</code> when + <em class="parameter"><code>sync</code></em> was created, the behavior is + undefined. + </p> + <p> + If <em class="parameter"><code>sync</code></em> is not a valid sync object for + <em class="parameter"><code>display</code></em>, an + <code class="constant">EGL_BAD_PARAMETER</code> error is generated. + </p> + <p> + If <em class="parameter"><code>flags</code></em> is not 0, an + <code class="constant">EGL_BAD_PARAMETER</code> error is generated. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglWaitSync</code> is available only if the EGL + version is 1.5 or greater. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglClientWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglClientWaitSync</span></span></a>, + <a class="citerefentry" href="eglCreateSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateSync</span></span></a>, + <a class="citerefentry" href="eglGetCurrentContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentContext</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/index.php b/glew/auto/EGL-Registry/sdk/docs/man/html/index.php new file mode 100644 index 0000000..70d55cb --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/index.php @@ -0,0 +1,121 @@ +<html> +<head> + <link rel="stylesheet" type="text/css" href="style-index.css" /> + <title>EGL Reference Pages</title> + <?php include 'accord.js'; ?> +</head> +<body> + <a href="indexflat.php">Use alternate (flat) index</a> + <div id="navwrap"> + <ul id="containerul"> <!-- Must wrap entire list for expand/contract --> + <li class="Level1"> + <a href="start.html" target="pagedisplay">Introduction</a> + </li> + <li class="Level1">EGL Entry Points + <ul class="Level2"> + <a name="b"></a> + <li>b + <ul class="Level3"> + <li><a href="eglBindAPI.xhtml" target="pagedisplay">eglBindAPI</a></li> + <li><a href="eglBindTexImage.xhtml" target="pagedisplay">eglBindTexImage</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="c"></a> + <li>c + <ul class="Level3"> + <li><a href="eglChooseConfig.xhtml" target="pagedisplay">eglChooseConfig</a></li> + <li><a href="eglClientWaitSync.xhtml" target="pagedisplay">eglClientWaitSync</a></li> + <li><a href="eglCopyBuffers.xhtml" target="pagedisplay">eglCopyBuffers</a></li> + <li><a href="eglCreateContext.xhtml" target="pagedisplay">eglCreateContext</a></li> + <li><a href="eglCreateImage.xhtml" target="pagedisplay">eglCreateImage</a></li> + <li><a href="eglCreatePbufferFromClientBuffer.xhtml" target="pagedisplay">eglCreatePbufferFromClientBuffer</a></li> + <li><a href="eglCreatePbufferSurface.xhtml" target="pagedisplay">eglCreatePbufferSurface</a></li> + <li><a href="eglCreatePixmapSurface.xhtml" target="pagedisplay">eglCreatePixmapSurface</a></li> + <li><a href="eglCreatePlatformPixmapSurface.xhtml" target="pagedisplay">eglCreatePlatformPixmapSurface</a></li> + <li><a href="eglCreatePlatformWindowSurface.xhtml" target="pagedisplay">eglCreatePlatformWindowSurface</a></li> + <li><a href="eglCreateSync.xhtml" target="pagedisplay">eglCreateSync</a></li> + <li><a href="eglCreateWindowSurface.xhtml" target="pagedisplay">eglCreateWindowSurface</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="d"></a> + <li>d + <ul class="Level3"> + <li><a href="eglDestroyContext.xhtml" target="pagedisplay">eglDestroyContext</a></li> + <li><a href="eglDestroyImage.xhtml" target="pagedisplay">eglDestroyImage</a></li> + <li><a href="eglDestroySurface.xhtml" target="pagedisplay">eglDestroySurface</a></li> + <li><a href="eglDestroySync.xhtml" target="pagedisplay">eglDestroySync</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="g"></a> + <li>g + <ul class="Level3"> + <li><a href="eglGetConfigAttrib.xhtml" target="pagedisplay">eglGetConfigAttrib</a></li> + <li><a href="eglGetConfigs.xhtml" target="pagedisplay">eglGetConfigs</a></li> + <li><a href="eglGetCurrentContext.xhtml" target="pagedisplay">eglGetCurrentContext</a></li> + <li><a href="eglGetCurrentDisplay.xhtml" target="pagedisplay">eglGetCurrentDisplay</a></li> + <li><a href="eglGetCurrentSurface.xhtml" target="pagedisplay">eglGetCurrentSurface</a></li> + <li><a href="eglGetDisplay.xhtml" target="pagedisplay">eglGetDisplay</a></li> + <li><a href="eglGetError.xhtml" target="pagedisplay">eglGetError</a></li> + <li><a href="eglGetPlatformDisplay.xhtml" target="pagedisplay">eglGetPlatformDisplay</a></li> + <li><a href="eglGetProcAddress.xhtml" target="pagedisplay">eglGetProcAddress</a></li> + <li><a href="eglGetSyncAttrib.xhtml" target="pagedisplay">eglGetSyncAttrib</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="i"></a> + <li>i + <ul class="Level3"> + <li><a href="eglInitialize.xhtml" target="pagedisplay">eglInitialize</a></li> + <li><a href="eglIntro.xhtml" target="pagedisplay">eglIntro</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="m"></a> + <li>m + <ul class="Level3"> + <li><a href="eglMakeCurrent.xhtml" target="pagedisplay">eglMakeCurrent</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="q"></a> + <li>q + <ul class="Level3"> + <li><a href="eglQueryAPI.xhtml" target="pagedisplay">eglQueryAPI</a></li> + <li><a href="eglQueryContext.xhtml" target="pagedisplay">eglQueryContext</a></li> + <li><a href="eglQueryString.xhtml" target="pagedisplay">eglQueryString</a></li> + <li><a href="eglQuerySurface.xhtml" target="pagedisplay">eglQuerySurface</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="r"></a> + <li>r + <ul class="Level3"> + <li><a href="eglReleaseTexImage.xhtml" target="pagedisplay">eglReleaseTexImage</a></li> + <li><a href="eglReleaseThread.xhtml" target="pagedisplay">eglReleaseThread</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="s"></a> + <li>s + <ul class="Level3"> + <li><a href="eglSurfaceAttrib.xhtml" target="pagedisplay">eglSurfaceAttrib</a></li> + <li><a href="eglSwapBuffers.xhtml" target="pagedisplay">eglSwapBuffers</a></li> + <li><a href="eglSwapInterval.xhtml" target="pagedisplay">eglSwapInterval</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="t"></a> + <li>t + <ul class="Level3"> + <li><a href="eglTerminate.xhtml" target="pagedisplay">eglTerminate</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="w"></a> + <li>w + <ul class="Level3"> + <li><a href="eglWaitClient.xhtml" target="pagedisplay">eglWaitClient</a></li> + <li><a href="eglWaitGL.xhtml" target="pagedisplay">eglWaitGL</a></li> + <li><a href="eglWaitNative.xhtml" target="pagedisplay">eglWaitNative</a></li> + <li><a href="eglWaitSync.xhtml" target="pagedisplay">eglWaitSync</a></li> + </ul> <!-- End Level3 --> + </li> + </ul> <!-- End Level2 --> + </li> <!-- End Level1 --> + </div> <!-- End containerurl --> + <script type="text/javascript">initiate();</script> +</body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/indexflat.php b/glew/auto/EGL-Registry/sdk/docs/man/html/indexflat.php new file mode 100644 index 0000000..a272d65 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/indexflat.php @@ -0,0 +1,135 @@ +<html> +<head> + <link rel="stylesheet" type="text/css" href="style-index.css" /> + <title>EGL Reference Pages</title> + <!-- Don't include accord.js --> +</head> +<body> + <a href="index.php">Use alternate (accordion-style) index</a> + <center> +<div id="container"> + <b><a href="#b" style="text-decoration:none">b</a></b> + <b><a href="#c" style="text-decoration:none">c</a></b> + <b><a href="#d" style="text-decoration:none">d</a></b> + <b><a href="#g" style="text-decoration:none">g</a></b> + <b><a href="#i" style="text-decoration:none">i</a></b> + <b><a href="#m" style="text-decoration:none">m</a></b> + <b><a href="#q" style="text-decoration:none">q</a></b> + <b><a href="#r" style="text-decoration:none">r</a></b> + <b><a href="#s" style="text-decoration:none">s</a></b> + <b><a href="#t" style="text-decoration:none">t</a></b> + <b><a href="#w" style="text-decoration:none">w</a></b> + </div> +</center> + <div id="navwrap"> + <ul id="containerul"> <!-- Must wrap entire list for expand/contract --> + <li class="Level1"> + <a href="start.html" target="pagedisplay">Introduction</a> + </li> + <li class="Level1">EGL Entry Points + <ul class="Level2"> + <a name="b"></a> + <li>b + <ul class="Level3"> + <li><a href="eglBindAPI.xhtml" target="pagedisplay">eglBindAPI</a></li> + <li><a href="eglBindTexImage.xhtml" target="pagedisplay">eglBindTexImage</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="c"></a> + <li>c + <ul class="Level3"> + <li><a href="eglChooseConfig.xhtml" target="pagedisplay">eglChooseConfig</a></li> + <li><a href="eglClientWaitSync.xhtml" target="pagedisplay">eglClientWaitSync</a></li> + <li><a href="eglCopyBuffers.xhtml" target="pagedisplay">eglCopyBuffers</a></li> + <li><a href="eglCreateContext.xhtml" target="pagedisplay">eglCreateContext</a></li> + <li><a href="eglCreateImage.xhtml" target="pagedisplay">eglCreateImage</a></li> + <li><a href="eglCreatePbufferFromClientBuffer.xhtml" target="pagedisplay">eglCreatePbufferFromClientBuffer</a></li> + <li><a href="eglCreatePbufferSurface.xhtml" target="pagedisplay">eglCreatePbufferSurface</a></li> + <li><a href="eglCreatePixmapSurface.xhtml" target="pagedisplay">eglCreatePixmapSurface</a></li> + <li><a href="eglCreatePlatformPixmapSurface.xhtml" target="pagedisplay">eglCreatePlatformPixmapSurface</a></li> + <li><a href="eglCreatePlatformWindowSurface.xhtml" target="pagedisplay">eglCreatePlatformWindowSurface</a></li> + <li><a href="eglCreateSync.xhtml" target="pagedisplay">eglCreateSync</a></li> + <li><a href="eglCreateWindowSurface.xhtml" target="pagedisplay">eglCreateWindowSurface</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="d"></a> + <li>d + <ul class="Level3"> + <li><a href="eglDestroyContext.xhtml" target="pagedisplay">eglDestroyContext</a></li> + <li><a href="eglDestroyImage.xhtml" target="pagedisplay">eglDestroyImage</a></li> + <li><a href="eglDestroySurface.xhtml" target="pagedisplay">eglDestroySurface</a></li> + <li><a href="eglDestroySync.xhtml" target="pagedisplay">eglDestroySync</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="g"></a> + <li>g + <ul class="Level3"> + <li><a href="eglGetConfigAttrib.xhtml" target="pagedisplay">eglGetConfigAttrib</a></li> + <li><a href="eglGetConfigs.xhtml" target="pagedisplay">eglGetConfigs</a></li> + <li><a href="eglGetCurrentContext.xhtml" target="pagedisplay">eglGetCurrentContext</a></li> + <li><a href="eglGetCurrentDisplay.xhtml" target="pagedisplay">eglGetCurrentDisplay</a></li> + <li><a href="eglGetCurrentSurface.xhtml" target="pagedisplay">eglGetCurrentSurface</a></li> + <li><a href="eglGetDisplay.xhtml" target="pagedisplay">eglGetDisplay</a></li> + <li><a href="eglGetError.xhtml" target="pagedisplay">eglGetError</a></li> + <li><a href="eglGetPlatformDisplay.xhtml" target="pagedisplay">eglGetPlatformDisplay</a></li> + <li><a href="eglGetProcAddress.xhtml" target="pagedisplay">eglGetProcAddress</a></li> + <li><a href="eglGetSyncAttrib.xhtml" target="pagedisplay">eglGetSyncAttrib</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="i"></a> + <li>i + <ul class="Level3"> + <li><a href="eglInitialize.xhtml" target="pagedisplay">eglInitialize</a></li> + <li><a href="eglIntro.xhtml" target="pagedisplay">eglIntro</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="m"></a> + <li>m + <ul class="Level3"> + <li><a href="eglMakeCurrent.xhtml" target="pagedisplay">eglMakeCurrent</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="q"></a> + <li>q + <ul class="Level3"> + <li><a href="eglQueryAPI.xhtml" target="pagedisplay">eglQueryAPI</a></li> + <li><a href="eglQueryContext.xhtml" target="pagedisplay">eglQueryContext</a></li> + <li><a href="eglQueryString.xhtml" target="pagedisplay">eglQueryString</a></li> + <li><a href="eglQuerySurface.xhtml" target="pagedisplay">eglQuerySurface</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="r"></a> + <li>r + <ul class="Level3"> + <li><a href="eglReleaseTexImage.xhtml" target="pagedisplay">eglReleaseTexImage</a></li> + <li><a href="eglReleaseThread.xhtml" target="pagedisplay">eglReleaseThread</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="s"></a> + <li>s + <ul class="Level3"> + <li><a href="eglSurfaceAttrib.xhtml" target="pagedisplay">eglSurfaceAttrib</a></li> + <li><a href="eglSwapBuffers.xhtml" target="pagedisplay">eglSwapBuffers</a></li> + <li><a href="eglSwapInterval.xhtml" target="pagedisplay">eglSwapInterval</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="t"></a> + <li>t + <ul class="Level3"> + <li><a href="eglTerminate.xhtml" target="pagedisplay">eglTerminate</a></li> + </ul> <!-- End Level3 --> + </li> + <a name="w"></a> + <li>w + <ul class="Level3"> + <li><a href="eglWaitClient.xhtml" target="pagedisplay">eglWaitClient</a></li> + <li><a href="eglWaitGL.xhtml" target="pagedisplay">eglWaitGL</a></li> + <li><a href="eglWaitNative.xhtml" target="pagedisplay">eglWaitNative</a></li> + <li><a href="eglWaitSync.xhtml" target="pagedisplay">eglWaitSync</a></li> + </ul> <!-- End Level3 --> + </li> + </ul> <!-- End Level2 --> + </li> <!-- End Level1 --> + </div> <!-- End containerurl --> +</body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/khronos-man.css b/glew/auto/EGL-Registry/sdk/docs/man/html/khronos-man.css new file mode 100644 index 0000000..017c2d0 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/khronos-man.css @@ -0,0 +1,209 @@ +/* Taken from OpenCL styles-css.xsl, which is imbedded in CL man pages * +/* This style sets a margin around the entire page */ +html, body { + margin: 10px; +} + +p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; +} + +h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; +} + +h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; +} + +h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; +} + +li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; +} + +.pdparam { + font: italic 16px verdana, sans-serif; +} + +.term { + font: italic 16px verdana, sans-serif; + font-weight: normal; +} + +.type { + font: normal 16px verdana, sans-serif !important; +} + +.parameter { + font-style: italic; +} + +a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; +} + +a:hover { + background-color: #FFFF99; + font: normal 16px; +} + +div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; +} + +div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; +} + +div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; +} + +div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; +} + +code.constant { + font: normal 16px courier new, monospace !important; +} + +span.errorname { + font: normal 16px verdana, sans-serif !important; +} + +code.function { + font: bold 16px verdana, sans-serif !important; +} + +b.fsfunc { + font: bold 16px verdana, sans-serif !important; +} + +code.varname { + font: italic 16px verdana, sans-serif; +} + +code.replaceable { + font: italic 16px courier new, monospace; +} + +code.funcdef { + font: normal 16px verdana, sans-serif !important; +} + +.citerefentry { + font: normal 16px verdana, sans-serif !important; +} + +.parameter { + font-style: italic; +} + +code.fsfunc { + font: normal 16px verdana, sans-serif !important; +} + +/* PARAMETER: This style controls spacing between the terms in Parameter section */ +dt { + margin-top: 15px; +} + +/* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ +div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; +} + +div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; +} + +div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; +} + +div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; +} + + +/* EXAMPLE: These styles apply only to the Example section */ +div.refsect2 { + font: normal 16px courier new, monospace !important; +} + +div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; +} + +div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; +} + +/* <refsect3> is used only for the copyright statement (copyright.xml) + at the bottom of the page + */ +div.refsect3 p { + font: normal 11px verdana, sans-serif; + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/khronos-man.xsl b/glew/auto/EGL-Registry/sdk/docs/man/html/khronos-man.xsl new file mode 100644 index 0000000..8b8adb5 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/khronos-man.xsl @@ -0,0 +1,126 @@ +<?xml version='1.0'?> +<xsl:stylesheet + xmlns="http://www.w3.org/1999/xhtml" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="1.0"> + + <xsl:import href="http://docbook.sourceforge.net/release/xsl-ns/current/xhtml5/onechunk.xsl"/> + + <!-- These two options generate a file named ID.xhtml, where ID is the value + of the document xml:id attribute, when processed with the chunking + spreadsheet onechunk.xsl. See + http://www.sagehill.net/docbookxsl/OneChunk.html --> + <xsl:param name="use.id.as.filename">1</xsl:param> + <xsl:param name="root.filename"></xsl:param> + + <!-- html.stylesheet adds the specified stylesheet to the page headers. + docbook.css.link removes the default docbook.css. + --> + <xsl:param name="html.stylesheet">khronos-man.css</xsl:param> + <xsl:param name="docbook.css.link">0</xsl:param> + <xsl:param name="docbook.css.source"></xsl:param> + + <!-- Indent HTML, which requires using onechunk.xsl instead of docbook.xsl --> + <xsl:param name="chunker.output.indent">yes</xsl:param> + + <!-- Style parameters --> + <xsl:param name="funcsynopsis.style">ansi</xsl:param> + <xsl:param name="citerefentry.link" select="'1'"></xsl:param> + + <!-- Generate links in href= attributes for <citerefentry>. Note + that in the XSL-NS stylesheets, using the Docbook namespace + prefix on the select expressions is *required*. Declaring + xmlns:db at xsl:stylesheet scope causes other problems. + + If there is a value specified for the href attribute in + citerefentry, then create the link from that attribute instead + of the refentrytitle. + --> + <!-- The @href syntax isn't used by EGL at present --> + <xsl:template xmlns:db="http://docbook.org/ns/docbook" + name="generate.citerefentry.link"> + <xsl:choose> + <xsl:when test="@href"> + <xsl:value-of select="@href"/> + <xsl:text>.xhtml</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="db:refentrytitle"/> + <xsl:text>.xhtml</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + + <!-- Reasonable defaults for tables --> + <xsl:param name="default.table.frame">all</xsl:param> + <xsl:param name="table.borders.with.css" select="1"></xsl:param> + <xsl:param name="table.cell.border.thickness">2px</xsl:param> + <xsl:param name="table.frame.border.thickness">2px</xsl:param> + + <!-- Add MathJax <script> tags to document <head> --> + <!-- Now that the xmlns:db is declared above, it gets emitted on the + <script> elements for unknown reasons + --> + <!-- Per http://docs.mathjax.org/en/latest/start.html#secure-access-to-the-cdn + use their secure URI, instead of the HTTP URI + src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"> + --> + <!-- This isn't used by EGL at present --> +<!-- + <xsl:template name="user.head.content"> + <script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + MathML: { + extensions: ["content-mathml.js"] + }, + tex2jax: { + inlineMath: [['$','$'], ['\\(','\\)']] + } + }); + </script> + <script type="text/javascript" + src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"> + </script> + </xsl:template> +--> + + <!-- Add boilerplate to XHTML page title element describing which + set of man pages this is. This should really be an XSL + parameter which could be set on the command line --> + <xsl:template name="user.head.title"> + <xsl:param name="node" select="."/> + <xsl:param name="title"/> + <title> + <xsl:copy-of select="$title"/> + <xsl:text> - EGL Reference Pages</xsl:text> + </title> + </xsl:template> + + <!-- Root template for processing the document --> + <xsl:template match="*" mode="process.root"> + <xsl:variable name="doc" select="self::*"/> + <xsl:call-template name="user.preroot"/> + <xsl:call-template name="root.messages"/> + <xsl:apply-templates select="."/> + </xsl:template> + + <!-- The directives in egl-man.xsl used to be here --> + + <!-- The template refsect3 is inserted here to deal with the + copyright. This adds in the text from the include file + copyright.inc.xsl --> + <!-- + <xsl:template match="refsect3"> + <div class="{name(.)}"> + <xsl:call-template name="language.attribute"/> + <xsl:call-template name="anchor"> + <xsl:with-param name="conditional" select="0"/> + </xsl:call-template> + <xsl:apply-templates/> + <xsl:value-of select="$copyright"/> + </div> + </xsl:template> + --> + +</xsl:stylesheet> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/makeindex.py b/glew/auto/EGL-Registry/sdk/docs/man/html/makeindex.py new file mode 100644 index 0000000..9cde015 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/makeindex.py @@ -0,0 +1,316 @@ +#!/usr/bin/python3 +# +# Copyright (c) 2013-2014 The Khronos Group Inc. +# +# Permission is hereby granted, free of charge, to any person obtaining a +# copy of this software and/or associated documentation files (the +# "Materials"), to deal in the Materials without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Materials, and to +# permit persons to whom the Materials are furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Materials. +# +# THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +# MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS. + +import io, os, re, string, sys; + +if __name__ == '__main__': + if (len(sys.argv) != 5): + print('Usage:', sys.argv[0], ' gendir srcdir accordfilename flatfilename', file=sys.stderr) + exit(1) + else: + gendir = sys.argv[1] + srcdir = sys.argv[2] + accordfilename = sys.argv[3] + flatfilename = sys.argv[4] + # print(' gendir = ', gendir, ' srcdir = ', srcdir, 'accordfilename = ', accordfilename, 'flatfilename = ', flatfilename) +else: + print('Unknown invocation mode', file=sys.stderr) + exit(1) + +# Various levels of indentation in generated HTML +ind1 = ' ' +ind2 = ind1 + ind1 +ind3 = ind2 + ind1 +ind4 = ind2 + ind2 + +# Symbolic names +notAlias = False +isAlias = True + +# Page title +pageTitle = 'EGL Reference Pages' + +# Docbook source and generated HTML 5 file extensions +srcext = '.xml' +genext = '.xhtml' + +# List of generated files +files = os.listdir(gendir) + +# Feature - class representing a command or function to be indexed, used +# as dictionary values keyed by the feature name to be indexed. +# +# Members +# file - name of file containing the feature +# feature - feature name for the index (basis for the dictionary key). +# alias - True if this is an alias of another feature in the file. +# Usually if alias is False, feature is the basename of file. +# apiCommand - True if this is an API command, or should be grouped +# like one +class Feature: + def __init__(self, + file = None, + feature = None, + alias = False, + apiCommand = None): + self.file = file + self.feature = feature + self.alias = alias + self.apiCommand = apiCommand + # This is the API-dependent command prefix + self.prefix = 'egl' + self.prefixLen = len(self.prefix) + def makeKey(self): + # Return dictionary / sort key based on the feature name + if (self.apiCommand and self.feature[0:self.prefixLen] + == self.prefix): + return self.feature[self.prefixLen:] + else: + return self.feature + +# Add dictionary entry for specified Feature. +# The key used is the feature name, with the leading 'gl' stripped +# off if this is an API command +def addkey(dict, feature): + key = feature.makeKey() + if (key in dict.keys()): + print('Key', key, ' already exists in dictionary!') + else: + dict[key] = feature + +# Create list of entry point names to be indexed. +# Unlike the old Perl script, this proceeds as follows: +# - Each .xhtml page with a parent .xml page gets an +# index entry for its base name. +# - Additionally, each <function> tag inside a <funcdef> +# in the parent page gets an aliased index entry. +# - Each .xhtml page *without* a parent is reported but +# not indexed. +# - Each collision in index terms is reported. +# - Index terms are keys in a dictionary whose entries +# are [ pagename, alias, glPrefix ] where pagename is +# the base name of the indexed page and alias is True +# if this index isn't the same as pagename. +# - API keys have their glPrefix value set to True, +# GLSL keys to False. There is a simplistic way of +# telling the files apart based on the file name: +# +# * Everything starting with 'egl[A-Z]' is API +# * 'removedTypes.*' is API (more may be added) +# * Everything else is GLSL + +def isAPIfile(entrypoint): + if (re.match('^egl[A-Z]', entrypoint) or entrypoint == 'removedTypes'): + return True + else: + return False + +# Dictionary of all keys mapped to Feature values +refIndex = {} + +for file in files: + # print('Processing file', file) + (entrypoint,ext) = os.path.splitext(file) + if (ext == genext): + parent = srcdir + '/' + entrypoint + srcext + # Determine if this is an API or GLSL page + apiCommand = isAPIfile(entrypoint) + if (os.path.exists(parent)): + addkey(refIndex, Feature(file, entrypoint, False, apiCommand)) + # Search parent file for <function> tags inside <funcdef> tags + # This doesn't search for <varname> inside <fieldsynopsis>, because + # those aren't on the same line and it's hard. + fp = open(parent) + for line in fp.readlines(): + # Look for <function> tag contents and add as aliases + # Don't add the same key twice + for m in re.finditer(r"<funcdef>.*<function>(.*)</function>.*</funcdef>", line): + funcname = m.group(1) + if (funcname != entrypoint): + addkey(refIndex, Feature(file, funcname, True, apiCommand)) + fp.close() + else: + print('No parent page for', file, ', will not be indexed') + +# Some utility functions for generating the navigation table +# Opencl_tofc.html uses style.css instead of style-index.css +# flatMenu - if True, don't include accordion JavaScript, +# generating a flat (expanded) menu. +# letters - if not None, include per-letter links to within +# the indices for each letter in the list. +# altMenu - if not None, the name of the alternate index to +# link to. +def printHeader(fp, flatMenu = False, letters = None, altMenu = None): + if (flatMenu): + scriptInclude = ' <!-- Don\'t include accord.js -->' + else: + scriptInclude = ' <?php include \'accord.js\'; ?>' + + print('<html>', + '<head>', + ' <link rel="stylesheet" type="text/css" href="style-index.css" />', + ' <title>' + pageTitle + '</title>', + scriptInclude, + '</head>', + '<body>', + sep='\n', file=fp) + + if (altMenu): + if (flatMenu): + altLabel = '(accordion-style)' + else: + altLabel = '(flat)' + print(' <a href="' + altMenu + '">' + + 'Use alternate ' + altLabel + ' index' + + '</a>', file=fp) + + if (letters): + print(' <center>\n<div id="container">', file=fp) + for letter in letters: + print(' <b><a href="#' + + letter + + '" style="text-decoration:none">' + + letter + + '</a></b> ', file=fp) + print(' </div>\n</center>', file=fp) + + print(' <div id="navwrap">', + ' <ul id="containerul"> <!-- Must wrap entire list for expand/contract -->', + ' <li class="Level1">', + ' <a href="start.html" target="pagedisplay">Introduction</a>', + ' </li>', + sep='\n', file=fp) + +def printFooter(fp, flatMenu = False): + print(' </div> <!-- End containerurl -->', file=fp) + if (not flatMenu): + print(' <script type="text/javascript">initiate();</script>', file=fp) + print('</body>', + '</html>', + sep='\n', file=fp) + +# Add a nav table entry. key = link name, feature = Feature info for key +def addMenuLink(key, feature, fp): + file = feature.file + linkname = feature.feature + + print(ind4 + '<li><a href="' + file + '" target="pagedisplay">' + + linkname + '</a></li>', + sep='\n', file=fp) + +# Begin index section for a letter, include an anchor to link to +def beginLetterSection(letter, fp): + print(ind2 + '<a name="' + letter + '"></a>', + ind2 + '<li>' + letter, + ind3 + '<ul class="Level3">', + sep='\n', file=fp) + +# End index section for a letter +def endLetterSection(opentable, fp): + if (opentable == 0): + return + print(ind3 + '</ul> <!-- End Level3 -->', + ind2 + '</li>', + sep='\n', file=fp) + +# Return the keys in a dictionary sorted by name. +# Select only keys matching whichKeys (see genDict below) +def sortedKeys(dict, whichKeys): + list = [] + for key in dict.keys(): + if (whichKeys == 'all' or + (whichKeys == 'api' and dict[key].apiCommand) or + (whichKeys == 'glsl' and not dict[key].apiCommand)): + list.append(key) + list.sort(key=str.lower) + return list + +# Generate accordion menu for this dictionary, titled as specified. +# +# If whichKeys is 'all', generate index for all features +# If whichKeys is 'api', generate index only for API features +# If whichKeys is 'glsl', generate index only for GLSL features +# +# fp is the file to write to +def genDict(dict, title, whichKeys, fp): + print(ind1 + '<li class="Level1">' + title, + ind2 + '<ul class="Level2">', + sep='\n', file=fp) + + # Print links for sorted keys in each letter section + curletter = '' + opentable = 0 + + # Determine which letters are in the table of contents for this + # dictionary. If apiPrefix is set, strip the API prefix from each + # key containing it first. + + # Generatesorted list of page indexes. Select keys matching whichKeys. + keys = sortedKeys(dict, whichKeys) + + # print('@ Sorted list of page indexes:\n', keys) + + for key in keys: + # Character starting this key + c = str.lower(key[0]) + + if (c != curletter): + endLetterSection(opentable, fp) + # Start a new subtable for this letter + beginLetterSection(c, fp) + opentable = 1 + curletter = c + addMenuLink(key, dict[key], fp) + endLetterSection(opentable, fp) + + print(ind2 + '</ul> <!-- End Level2 -->', + ind1 + '</li> <!-- End Level1 -->', + sep='\n', file=fp) + +###################################################################### + +# Generate the accordion menu +fp = open(accordfilename, 'w') +printHeader(fp, flatMenu = False, altMenu = flatfilename) + +genDict(refIndex, 'EGL Entry Points', 'all', fp) + +printFooter(fp, flatMenu = False) +fp.close() + +###################################################################### + +# Generate the non-accordion menu, with combined API and GLSL sections +fp = open(flatfilename, 'w') + +# Set containing all index letters +indices = { key[0].lower() for key in refIndex.keys() } +letters = [c for c in indices] +letters.sort() + +printHeader(fp, flatMenu = True, letters = letters, altMenu = accordfilename) + +genDict(refIndex, 'EGL Entry Points', 'all', fp) + +printFooter(fp, flatMenu = True) +fp.close() diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/old-egl-man.xsl b/glew/auto/EGL-Registry/sdk/docs/man/html/old-egl-man.xsl new file mode 100644 index 0000000..e91022b --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/old-egl-man.xsl @@ -0,0 +1,174 @@ +<!-- The following is content that used to be in the EGL XSL directives + now found in khronos-man.xsl. It is OpenCL formatting stuff done by + Miller & Mattson and is being ignored for the moment. --> + + <!-- Set this param to a placeholder for the base URL of the + external specification document. Include the beginning of the + 'namedest' function as well. See the script pageNumberLookup.rb + to see how this placeholder gets replaced by the actual spec + URL and target page number. This placeholder can be any string, + and only needs to match the same placeholder string in + pageNumberLookup.rb. --> + <!-- This isn't used by EGL at present --> + <xsl:param name="SpecBaseUrl">http://www.khronos.org/registry/egl/specs/eglTBD.pdf#namedest=</xsl:param> + + <!-- The following template creates the link for the Specification section --> + <!-- This isn't used by EGL at present --> + <xsl:template match="olink"> + <xsl:text disable-output-escaping="yes"><a href="</xsl:text> + <xsl:value-of select="$SpecBaseUrl" /> + <xsl:value-of select="@uri" /> + <xsl:text disable-output-escaping="yes">" target="OpenCL Spec"></xsl:text> + <xsl:value-of select="." /> + <xsl:text disable-output-escaping="yes"></a></xsl:text> + </xsl:template> + + <!-- The following enables use of ulink for regular URLs on the pages--> + <!-- This isn't used by EGL at present --> + <xsl:template match="ulink"> + <xsl:text disable-output-escaping="yes"><a href="</xsl:text> + <xsl:value-of select="@url" /> + <xsl:text disable-output-escaping="yes">"></xsl:text> + <xsl:value-of select="." /> + <xsl:text disable-output-escaping="yes"></a></xsl:text> + </xsl:template> + + + <!-- The templates gentext-refname and refnamediv are inserted here so + we can have the refname displayed as the H1 header on the page --> + <xsl:template name="gentext-refname"> + <xsl:param name="key" select="local-name(.)"/> + <xsl:param name="lang"> + <xsl:call-template name="l10n.language"/> + </xsl:param> + <xsl:value-of select="refname"/> + </xsl:template> + + <xsl:template match="refnamediv"> + <div class="{name(.)}"> + <xsl:call-template name="anchor"/> + <xsl:choose> + <xsl:when test="preceding-sibling::refnamediv"> + <!-- no title on secondary refnamedivs! --> + </xsl:when> + <xsl:when test="$refentry.generate.name != 0"> + <h1> + <xsl:call-template name="gentext-refname"> + <xsl:with-param name="key" select="'RefName'"/> + </xsl:call-template> + </h1> + </xsl:when> + <xsl:when test="$refentry.generate.title != 0"> + <h2> + <xsl:choose> + <xsl:when test="../refmeta/refentrytitle"> + <xsl:apply-templates select="../refmeta/refentrytitle"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="refname[1]"/> + </xsl:otherwise> + </xsl:choose> + </h2> + </xsl:when> + </xsl:choose> + <p> + <xsl:apply-templates/> + </p> + </div> + </xsl:template> + + <!-- The templates refname and refpurpose are inserted here so that we can + modify the layout of these values on the HTML page --> + <xsl:template match="refname" /> + <xsl:template match="refpurpose"> + <xsl:apply-templates/> + </xsl:template> + + + <!-- The Link template allows us to embed links in the <funcprototype>, + even though this is not valid DocBook markup --> + <xsl:template match="link" mode="ansi-tabular"> + <xsl:apply-templates select="."/> + </xsl:template> + + <!-- This is somewhat redundant with the following template --> + <xsl:template match="funcdef/replaceable"> + <xsl:call-template name="inline.italicseq"/> + </xsl:template> + + <!-- The following template enables the <replaceable> tag inside + <funcdef>, <paramdef>, and <function> to generate <em> in the HTML output --> + <xsl:template match="funcdef/replaceable" mode="ansi-tabular"> + <xsl:call-template name="inline.italicseq"/> + </xsl:template> + + <xsl:template match="paramdef/replaceable" mode="ansi-tabular"> + <xsl:call-template name="inline.italicseq"/> + </xsl:template> + + <xsl:template match="function/replaceable" mode="ansi-nontabular"> + <xsl:call-template name="inline.italicseq"/> + </xsl:template> + + <xsl:template match="refname/replaceable" mode="kr-nontabular"> + <xsl:call-template name="inline.italicseq"/> + </xsl:template> + + <!-- The templates funcprototype and paramdef are here so we can modify + the layout of the synopsis so that it is not broken into so many + columns in the table, control indenting, and more. --> + + <!-- funcprototype: ansi, tabular --> + + <xsl:template match="funcprototype" mode="ansi-tabular"> + <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <xsl:if test="following-sibling::funcprototype"> + <xsl:attribute name="style">padding-bottom: 1em</xsl:attribute> + </xsl:if> + <tr valign="bottom"> + <td> + <xsl:apply-templates select="funcdef" mode="ansi-tabular"/> + <xsl:apply-templates select="(void|varargs|paramdef)[1]" mode="ansi-tabular"/> + </td> + </tr> + <xsl:for-each select="(void|varargs|paramdef)[position() > 1]"> + <tr valign="top"> + <td> </td> + <xsl:apply-templates select="." mode="ansi-tabular"/> + </tr> + </xsl:for-each> + </table> + </xsl:template> + + <xsl:template match="paramdef" mode="ansi-tabular"> + <xsl:choose> + <xsl:when test="type and funcparams"> + <td> + <xsl:apply-templates select="type" mode="kr-tabular-funcsynopsis-mode"/> + <xsl:text> </xsl:text> + </td> + <td> + <xsl:apply-templates select="type/following-sibling::node()" mode="kr-tabular-funcsynopsis-mode"/> + </td> + </xsl:when> + <xsl:otherwise> + <td> + <xsl:apply-templates select="parameter/preceding-sibling::node()[not(self::parameter)]" mode="ansi-tabular"/> + <xsl:text> </xsl:text> + <xsl:apply-templates select="parameter" mode="ansi-tabular"/> + <xsl:apply-templates select="parameter/following-sibling::node()[not(self::parameter)]" mode="ansi-tabular"/> + <xsl:choose> + <xsl:when test="following-sibling::*"> + <xsl:text>, </xsl:text> + </xsl:when> + <xsl:otherwise> + <code>)</code> + <!-- OpenCL functions do not end with a semi-colon. + <xsl:text>;</xsl:text> --> + </xsl:otherwise> + </xsl:choose> + </td> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/present.css b/glew/auto/EGL-Registry/sdk/docs/man/html/present.css new file mode 100644 index 0000000..6a02d35 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/present.css @@ -0,0 +1,47 @@ +@charset "utf-8"; +/* CSS Document */ + li { font: normal 14px verdana, sans-serif; line-height: 14px; } + ul { font: normal 14px verdana, sans-serif; line-height: 14px; } + a:link, a:visited {color:blue; text-decoration:none;} + a:hover {color:blue; text-decoration:none; background-color:FFFF99; } + + #navwrap { + width: 320px; + margin:0 0 0 4px; + padding:0; + } + + #containerul, #containerul ul{ + text-align:left; + margin:0 0 0 4px; /* Removes browser default margins applied to the lists. */ + padding:0; /* Removes browser default padding applied to the lists. */ + } + + #containerul li{ + margin:0 0 0 15px; /* A left margin to indent the list items and give the menu a sense of structure. */ + padding:4px 0 0 2px; + list-style-type:none; /* Removes the bullet point that usually goes next to each item in a list. */ + font: normal 12px verdana, sans-serif; + } + + #containerul li.Level1 { + margin:0 0 0 0; + padding:4px 0 0 2px; + list-style-type:none; /* Removes the bullet point that usually goes next to each item in a list. */ + font: normal 14px verdana, sans-serif; + } + + #containerul .symbols{ /* Various styles to position the symbols next to the items in the menu. */ + background-repeat:no-repeat; + float:left; + height:14px; + margin-right:5px; + margin-top:1px; + width:14px; + } + +#containerul ul.Level2 { + margin:0; + padding: 0; + } + diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/start.html b/glew/auto/EGL-Registry/sdk/docs/man/html/start.html new file mode 100644 index 0000000..36c5528 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/start.html @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title>EGL Reference Pages</title> + <link rel="stylesheet" href="khronos-man.css"/> + </head> + <body> + <div class="refentry" id="start"> + <div class="titlepage"/> + <div class="refnamediv"> + <h1>EGL Reference Pages</h1> + <p/> + </div> + <div class="refsect1" id="description"> + <p> + <img src="EGL_300.png" alt="" + hspace="40" vspace="40" border="0" align="right" + xmlns="http://www.w3.org/1999/xhtml" /> + </p> + <p> EGL™ is an interface between Khronos rendering + APIs such as OpenGL ES or OpenVG and the underlying + native platform window system. It handles graphics + context management, surface/buffer binding, and + rendering synchronization and enables high-performance, + accelerated, mixed-mode 2D and 3D rendering using other + Khronos APIs. </p> + <p> The reference pages describe EGL 1.5, but can be used + with earlier versions since each page notes when + features are available only starting with specific older + versions (1.2, 1.3, and 1.4). </p> + <p> A more detailed overview of EGL functionality and + technical concepts can be found in the <a + target="pagedisplay" href="eglIntro.html">eglIntro</a> + page. </p> + </div> + <div class="refsect1" id="description"> + <h2>Browser Compatibility</h2> + <p> The reference pages are now generated in HTML5 format. + Some pages contain imbedded MathML and rely on <a + href="http://www.mathjax.org/">MathJax</a> to render + mathematical equations on browsers which do not natively + support MathML. This should work much better on Chrome, + Safari, and other browsers which don't support MathML. + </p> + <p> However, HTML5 isn't well supported on IE 8 or earlier + versions. We recommend you use a more recent browser for + viewing the reference pages. </p> + </div> + <div class="refsect1" id="description"> + <h2>Downloading Reference Page Sources</h2> + <p> The Docbook source for the reference pages is available + in the <a + href="https://github.com/KhronosGroup/EGL-Registry/"> + KhronosGroup/EGL-Registry</a> GitHub repository. You can + build a ref page distribution of your own using open + source tools. See the <a + href="https://github.com/KhronosGroup/OpenGL-Refpages/blob/master/README.adoc"> + OpenGL refpage README</a> for more information on needed + tools. </p> + </div> + <div class="refsect1" id="description"> + <h2>Feedback</h2> + <p> If you find errors in or problems with the reference + pages, please file a GitHub issue in the <a + href="https://github.com/KhronosGroup/EGL-Registry/"> + KhronosGroup/EGL-Registry</a> GitHub repository. If you + have a fix available, please propose a pull request in + the same repository. </p> + </div> + <div class="refsect3"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2018 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/style-index.css b/glew/auto/EGL-Registry/sdk/docs/man/html/style-index.css new file mode 100644 index 0000000..00fd1ed --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/style-index.css @@ -0,0 +1,2 @@ +@import url("undohtml.css"); +@import url("present.css"); diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/undohtml.css b/glew/auto/EGL-Registry/sdk/docs/man/html/undohtml.css new file mode 100644 index 0000000..a2d510f --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/undohtml.css @@ -0,0 +1,9 @@ +/* -- undo browser HTML defaults -- */ +/* -- Global resets of all default items -- */ + +:link,:visited {text-decoration: none;} +ul,ol {list-style: none;} +h1,h2,h3,h4,h5,h6,pre,code,p {font-size: 1em;} +ul,ol,dl,li,dt,dd,h1,h2,h3,h4,h5,h6,pre,form,body,html,p,blockquote,fieldset,input {margin: 0; padding: 0;} +a img,:link img,:visited img {border: none;} +address {font-style: normal;} diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/vn b/glew/auto/EGL-Registry/sdk/docs/man/html/vn new file mode 100644 index 0000000..c59df02 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/vn @@ -0,0 +1,221 @@ +<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:x="urn:schemas-microsoft-com:office:excel" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40"><head><meta http-equiv=Content-Type content="text/html; charset=us-ascii"><meta name=Generator content="Microsoft Word 12 (filtered medium)"><!--[if !mso]><style>v\:* {behavior:url(#default#VML);} +o\:* {behavior:url(#default#VML);} +w\:* {behavior:url(#default#VML);} +.shape {behavior:url(#default#VML);} +</style><![endif]--><style><!-- +/* Font Definitions */ +@font-face + {font-family:"MS Mincho"; + panose-1:2 2 6 9 4 2 5 8 3 4;} +@font-face + {font-family:"Cambria Math"; + panose-1:2 4 5 3 5 4 6 3 2 4;} +@font-face + {font-family:Calibri; + panose-1:2 15 5 2 2 2 4 3 2 4;} +@font-face + {font-family:Tahoma; + panose-1:2 11 6 4 3 5 4 4 2 4;} +@font-face + {font-family:"\@MS Mincho"; + panose-1:2 2 6 9 4 2 5 8 3 4;} +@font-face + {font-family:Consolas; + panose-1:2 11 6 9 2 2 4 3 2 4;} +/* Style Definitions */ +p.MsoNormal, li.MsoNormal, div.MsoNormal + {margin:0cm; + margin-bottom:.0001pt; + font-size:11.0pt; + font-family:"Calibri","sans-serif";} +h1 + {mso-style-priority:9; + mso-style-link:"Heading 1 Char"; + margin:0cm; + margin-bottom:.0001pt; + text-indent:0cm; + page-break-after:avoid; + mso-list:l0 level1 lfo2; + font-size:12.0pt; + font-family:"Tahoma","sans-serif"; + color:black;} +h2 + {mso-style-priority:9; + mso-style-link:"Heading 2 Char"; + margin:0cm; + margin-bottom:.0001pt; + text-indent:0cm; + page-break-after:avoid; + mso-list:l0 level2 lfo2; + font-size:10.0pt; + font-family:"Tahoma","sans-serif";} +a:link, span.MsoHyperlink + {mso-style-priority:99; + color:blue; + text-decoration:underline;} +a:visited, span.MsoHyperlinkFollowed + {mso-style-priority:99; + color:purple; + text-decoration:underline;} +p.MsoPlainText, li.MsoPlainText, div.MsoPlainText + {mso-style-priority:99; + mso-style-link:"Plain Text Char"; + margin:0cm; + margin-bottom:.0001pt; + font-size:10.5pt; + font-family:Consolas;} +p.MsoListParagraph, li.MsoListParagraph, div.MsoListParagraph + {mso-style-priority:34; + margin-top:0cm; + margin-right:0cm; + margin-bottom:0cm; + margin-left:36.0pt; + margin-bottom:.0001pt; + font-size:11.0pt; + font-family:"Calibri","sans-serif";} +span.Heading1Char + {mso-style-name:"Heading 1 Char"; + mso-style-priority:9; + mso-style-link:"Heading 1"; + font-family:"Tahoma","sans-serif"; + color:black; + font-weight:bold;} +span.Heading2Char + {mso-style-name:"Heading 2 Char"; + mso-style-priority:9; + mso-style-link:"Heading 2"; + font-family:"Tahoma","sans-serif"; + font-weight:bold;} +span.PlainTextChar + {mso-style-name:"Plain Text Char"; + mso-style-priority:99; + mso-style-link:"Plain Text"; + font-family:Consolas;} +span.EmailStyle22 + {mso-style-type:personal-compose; + font-family:"Calibri","sans-serif"; + color:windowtext;} +span.EmailStyle23 + {mso-style-type:personal; + font-family:"Calibri","sans-serif"; + color:windowtext;} +span.EmailStyle24 + {mso-style-type:personal; + font-family:"Calibri","sans-serif"; + color:windowtext;} +span.EmailStyle25 + {mso-style-type:personal; + font-family:"Calibri","sans-serif"; + color:windowtext;} +span.EmailStyle26 + {mso-style-type:personal; + font-family:"Calibri","sans-serif"; + color:windowtext;} +span.EmailStyle27 + {mso-style-type:personal; + font-family:"Calibri","sans-serif"; + color:windowtext;} +span.EmailStyle28 + {mso-style-type:personal; + font-family:"Calibri","sans-serif"; + color:windowtext;} +span.EmailStyle29 + {mso-style-type:personal; + font-family:"Calibri","sans-serif"; + color:windowtext;} +.MsoChpDefault + {mso-style-type:export-only; + font-size:10.0pt;} +@page WordSection1 + {size:612.0pt 792.0pt; + margin:72.0pt 72.0pt 72.0pt 72.0pt;} +div.WordSection1 + {page:WordSection1;} +/* List Definitions */ +@list l0 + {mso-list-id:1; + mso-list-template-ids:699138934;} +@list l0:level1 + {mso-level-number-format:none; + mso-level-style-link:"Heading 1"; + mso-level-suffix:none; + mso-level-text:""; + mso-level-tab-stop:0cm; + mso-level-number-position:left; + margin-left:0cm; + text-indent:0cm;} +@list l0:level2 + {mso-level-number-format:none; + mso-level-style-link:"Heading 2"; + mso-level-suffix:none; + mso-level-text:""; + mso-level-tab-stop:0cm; + mso-level-number-position:left; + margin-left:0cm; + text-indent:0cm;} +@list l0:level3 + {mso-level-number-format:none; + mso-level-suffix:none; + mso-level-text:""; + mso-level-tab-stop:0cm; + mso-level-number-position:left; + margin-left:0cm; + text-indent:0cm;} +@list l0:level4 + {mso-level-number-format:none; + mso-level-suffix:none; + mso-level-text:""; + mso-level-tab-stop:0cm; + mso-level-number-position:left; + margin-left:0cm; + text-indent:0cm;} +@list l0:level5 + {mso-level-number-format:none; + mso-level-suffix:none; + mso-level-text:""; + mso-level-tab-stop:0cm; + mso-level-number-position:left; + margin-left:0cm; + text-indent:0cm;} +@list l0:level6 + {mso-level-number-format:none; + mso-level-suffix:none; + mso-level-text:""; + mso-level-tab-stop:0cm; + mso-level-number-position:left; + margin-left:0cm; + text-indent:0cm;} +@list l0:level7 + {mso-level-number-format:none; + mso-level-suffix:none; + mso-level-text:""; + mso-level-tab-stop:0cm; + mso-level-number-position:left; + margin-left:0cm; + text-indent:0cm;} +@list l0:level8 + {mso-level-number-format:none; + mso-level-suffix:none; + mso-level-text:""; + mso-level-tab-stop:0cm; + mso-level-number-position:left; + margin-left:0cm; + text-indent:0cm;} +@list l0:level9 + {mso-level-number-format:none; + mso-level-suffix:none; + mso-level-text:""; + mso-level-tab-stop:0cm; + mso-level-number-position:left; + margin-left:0cm; + text-indent:0cm;} +ol + {margin-bottom:0cm;} +ul + {margin-bottom:0cm;} +--></style><!--[if gte mso 9]><xml> +<o:shapedefaults v:ext="edit" spidmax="1026" /> +</xml><![endif]--><!--[if gte mso 9]><xml> +<o:shapelayout v:ext="edit"> +<o:idmap v:ext="edit" data="1" /> +</o:shapelayout></xml><![endif]--></head><body lang=EN-GB link=blue vlink=purple><div class=WordSection1><p class=MsoNormal style='page-break-after:avoid'><b><span lang=EN-US style='font-size:16.0pt;color:black'>Call-in Details<o:p></o:p></span></b></p><p class=MsoPlainText style='text-align:justify'><span lang=EN-US style='font-size:11.0pt;font-family:"Calibri","sans-serif"'>U.S. Toll-free: +1 (866) 365-4406<o:p></o:p></span></p><p class=MsoPlainText style='text-align:justify'><span lang=EN-US style='font-size:11.0pt;font-family:"Calibri","sans-serif"'>U.S. Toll: +1 (303) 248-9655<o:p></o:p></span></p><p class=MsoPlainText style='text-align:justify'><b><span lang=EN-US style='font-size:11.0pt;font-family:"Calibri","sans-serif"'>Access code: 8040316#<o:p></o:p></span></b></p><p class=MsoPlainText style='text-align:justify'><span lang=EN-US style='font-size:11.0pt;font-family:"Calibri","sans-serif"'><a href="https://conf.cfer.com/?sp_id=154&comp_id=345368&an=3032489655&ac=8040316&startview=GOS&login=true">List of international dial-in numbers</a><o:p></o:p></span></p><p class=MsoPlainText style='text-align:justify'><span lang=EN-US style='font-size:11.0pt;font-family:"Calibri","sans-serif"'><o:p> </o:p></span></p><p class=MsoPlainText><span lang=EN-US style='font-size:11.0pt;font-family:"Calibri","sans-serif"'>Please let me know if you have any additional agenda items, intend to discuss a dormant item or wish to prioritise a topic.<o:p></o:p></span></p><p class=MsoPlainText><span lang=EN-US style='font-size:11.0pt;font-family:"Calibri","sans-serif"'><o:p> </o:p></span></p><p class=MsoPlainText><span lang=EN-US style='font-size:11.0pt;font-family:"Calibri","sans-serif"'>Alon<o:p></o:p></span></p><div class=MsoNormal align=center style='text-align:center'><b><span lang=EN-US><hr size=2 width="100%" align=center></span></b></div><p class=MsoNormal style='margin-top:6.0pt;page-break-after:avoid'><b><span lang=EN-US style='font-size:16.0pt;color:black'>Agenda<o:p></o:p></span></b></p><p class=MsoNormal style='margin-top:6.0pt;page-break-after:avoid'><b><span lang=EN-US style='font-size:12.0pt;color:black'>Corrections to previous minutes<o:p></o:p></span></b></p><p class=MsoNormal style='margin-top:6.0pt'><span lang=EN-US>- Minutes of EGL call 16th July 2014<o:p></o:p></span></p><p class=MsoNormal style='margin-top:6.0pt'><span lang=EN-US><o:p> </o:p></span></p><p class=MsoNormal style='margin-top:6.0pt'><b><span lang=EN-US style='font-size:12.0pt'>Future direction of EGL<o:p></o:p></span></b></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'><span lang=EN-US style='color:black'><a href="https://cvs.khronos.org/wiki/index.php/EGL/EGLNextGoals">Wiki page for EGL future direction goal discussion</a><o:p></o:p></span></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'><span lang=EN-US>Alon – big news from GL Common F2F in Bellevue was the contribution of XGL from AMD and the group agreeing to use it as starting point for GL Common<br>Alon – I raised at the meeting and on the today’s GL Common call how XGL deals with platform integration and interoperation with other Khronos APIs, open issue<br>Alon – need to decide how to take things forwards, identify any problems such as IP zone issue if that's a problem, how we should structure discussions given GL progression.<br>...<br>Alon – If we could make sure that in two weeks time we have that, possibly have some sort of straw poll to see if we have agreement on how to proceed<br>Alon – If you have any suggestions on what I should be doing as chair at this point, always open to them<br><b>[ACTION]<i> All – poll across your company to gauge position on direction, what problem would need EGL-like API to solve, initial proposals for COB PDT 29th July 2014</i></b><i><br></i>[ACTION]<i> All – help engage GL Common group in discussion, understanding of your company’s current thoughts here<br></i>[ACTION]<i> Alon – put out email to GL Common group with information on previous EGL2 discussions, background information<br></i>[ACTION]<i> All – add proposed goals and input to wiki<br></i>[ACTION] <i>Chad – vtable proposal – will draft up what an API would look like<br></i>[ACTION]<i> </i></span><i>Jon – put together matrix of functionality</i><span lang=EN-US><o:p></o:p></span></p><p class=MsoNormal style='margin-top:6.0pt'><b><span lang=EN-US style='font-size:12.0pt'><o:p> </o:p></span></b></p><p class=MsoNormal style='margin-top:6.0pt'><b><span lang=EN-US style='font-size:12.0pt'>New proposals<o:p></o:p></span></b></p><p class=MsoNormal style='margin-top:6.0pt'><b><span lang=EN-US>- <a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=11550">Bug 11550</a> – Partial update extension</span></b><span lang=EN-US><o:p></o:p></span></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'><span lang=EN-US>Latest spec draft – <a href="https://cvs.khronos.org/svn/repos/registry/trunk/egl/extensions/drafts/EGL_KHR_partial_update.txt">EGL_KHR_partial_update draft spec</a><o:p></o:p></span></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'>Ray – Sent an email a week ago explaining a problem – passing damaged regions through to a compositor isn't possible with the API as it is at the moment<br>Alon – Sent on the 6th July at 11:33 UK time, for those who don't have it to hand<br><span lang=EN-US>[ACTION]<i> All – consider Ray’s solution to resolving compositor information issue, Antoine’s suggestions<br></i>[ACTION]<i> Jesse – ping Antoine to get his opinion</i></span><o:p></o:p></p><p class=MsoNormal style='margin-top:6.0pt'><b><span lang=EN-US>- </span><a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=12459">Bug 12459</a> – Create EGL_KHR_context_flush_control</b><b><span lang=EN-US><o:p></o:p></span></b></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt;page-break-after:avoid'><span lang=EN-US>[ACTION] <i>Jon – open bug</i><b><span style='color:black'><o:p></o:p></span></b></span></p><p class=MsoNormal style='margin-top:6.0pt;page-break-after:avoid'><b><span lang=EN-US style='color:black'>- <a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=10232">Bug 10232</a> – Add Device Enumeration API to EGL 1.x<o:p></o:p></span></b></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'>James – Updated specs, need to publish them at the end of the month. Last call for feedback if you have any<br><span lang=EN-US>[ACTION] <i>All – last change for feedback on EXT device extensions before they’re published</i><o:p></o:p></span></p><p class=MsoNormal style='margin-top:6.0pt'><b><span lang=EN-US>- <a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=10943">Bug 10943</a> – EGL_KHR_debug debugging API<o:p></o:p></span></b></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'><span lang=EN-US>[ACTION] <i>All – review options and comment on bug</i><o:p></o:p></span></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:0cm;margin-bottom:.0001pt;text-indent:0cm;page-break-after:avoid;mso-list:l0 level1 lfo2'><b><span lang=EN-US style='color:black'>- <a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=10091">Bug 10091</a> – EGL_KHR_no_config creating surfaces & contexts without configs<o:p></o:p></span></b></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt;text-indent:0cm;page-break-after:avoid;mso-list:l0 level1 lfo2'><span lang=EN-US style='color:black'><a href="https://cvs.khronos.org/svn/repos/registry/trunk/egl/extensions/drafts/EGL_KHR_no_config.txt">EGL_KHR_no_config draft spec</a>, </span><span style='color:black'><a href="https://cvs.khronos.org/svn/repos/registry/trunk/egl/extensions/drafts/EGL_KHR_rgba_no_config.txt">EGL_KHR_rgba_no_config draft spec</a><o:p></o:p></span></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt;text-indent:0cm;page-break-after:avoid;mso-list:l0 level1 lfo2'><span lang=EN-US>[ACTION]<i> All – consider fuzzy vs exact match options</i><b><span style='color:black'><o:p></o:p></span></b></span></p><p class=MsoNormal style='margin-top:6.0pt'><b>- </b><a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=12127"><b>Bug 12127</b></a><b> – eglSwapBuffers completion notifications<o:p></o:p></b></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'><span lang=EN-US>[ACTION]<i> Chad – enumerate different types of state</i><o:p></o:p></span></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:0cm;margin-bottom:.0001pt;text-indent:0cm;page-break-after:avoid;mso-list:l0 level1 lfo2'><b><span style='color:black'>- <a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=12230">Bug 12230</a> – Timestamps in EGL and client APIs</span></b><b><span lang=EN-US style='color:black'><o:p></o:p></span></b></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt;text-indent:0cm;page-break-after:avoid;mso-list:l0 level1 lfo2'><span lang=EN-US>Alon – KCam WG notified about this, no feedback yet<b><span style='color:black'><o:p></o:p></span></b></span></p><p class=MsoNormal style='margin-top:6.0pt'><b><span lang=EN-US style='font-size:12.0pt'><o:p> </o:p></span></b></p><p class=MsoNormal style='margin-top:6.0pt'><b><span lang=EN-US style='font-size:12.0pt'>Issues<o:p></o:p></span></b></p><p class=MsoNormal style='margin-top:6.0pt'><b>- <a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=12456">Bug 12456</a> - eglMakeCurrent flush behaviour when same context and surfaces are made current<o:p></o:p></b></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'>New bug<o:p></o:p></p><p class=MsoNormal style='margin-top:6.0pt'><b>- <a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=12457">Bug 12457</a> - Trivial wording updates to EGL_KHR_gl_colorspace<o:p></o:p></b></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'>New bug<o:p></o:p></p><p class=MsoNormal style='margin-top:6.0pt'><b>- <a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=12072">Bug 12072</a> – No way to completely release an EGLDisplay</b><span lang=EN-US><o:p></o:p></span></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'><span lang=EN-US>Alon – suggest we do a straw poll on next call, see if conclusion between the 3 options<br>James – sounds good to me<br>[ACTION] <i>All – review options and comment<br></i>[ACTION] <i>Alon – post explanation of terminate refcount issue</i><o:p></o:p></span></p><p class=MsoNormal style='margin-top:6.0pt'><o:p> </o:p></p><p class=MsoNormal style='margin-top:6.0pt'><b><span lang=EN-US style='font-size:12.0pt'>Dormant topics</span></b><span lang=EN-US style='font-size:12.0pt'> (please indicate before next call if you’d like to discuss these)<o:p></o:p></span></p><p class=MsoNormal style='margin-top:6.0pt'><b><span lang=EN-US>- </span><a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=10159" title="ASSIGNED - Remove FOURCC dependency and define VX specific formats">Bug 10159</a> – </b><b><span lang=EN-US>Khronos color format proposal<o:p></o:p></span></b></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'>Andrew – Not accepted into VX 1.0, updates on bug, no longer a rush, hoping that something will go in in 1.1<span lang=EN-US><br>[ACTION]<i> </i></span><i><span lang=EN-US style='font-size:10.0pt;font-family:"Tahoma","sans-serif"'>All – continue providing feedback on bug</span></i><span lang=EN-US><o:p></o:p></span></p><p class=MsoNormal style='margin-top:6.0pt'><span lang=EN-US>- <b><a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=11606">Bug 11606</a> – GPU Resource Monitoring proposal<o:p></o:p></b></span></p><p class=MsoNormal style='margin-top:6.0pt;text-indent:36.0pt'><span lang=EN-US><a href="https://www.khronos.org/members/login/groups/EGL/F2F%20Materials/Phoenix%20Jan14/GPU%20Resource%20Monitoring%20-%20Phoenix%20F2F%20-%20Jan%202014.pdf">GPU Resource Monitoring slides from Phoenix F2F</a><o:p></o:p></span></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'><span lang=EN-US>[ACTION]<i> </i></span><i>All – request feedback, especially from SOC teams<o:p></o:p></i></p><p class=MsoNormal style='margin-top:6.0pt;page-break-after:avoid'><b><span lang=EN-US>- <a href="https://cvs.khronos.org/bugzilla/show_bug.cgi?id=11481">Bug 11481</a> – Remove thread restriction for eglSwapBuffers in EGL 1.5<o:p></o:p></span></b></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt;text-indent:0cm;page-break-after:avoid;mso-list:l0 level1 lfo2'><span lang=EN-US>[ACTION]<i> <span style='color:black'>Chad – will update bug as discussed (</span>Postponed indefinitely)</i></span><i><o:p></o:p></i></p><p class=MsoNormal style='margin-top:6.0pt'><b><span lang=EN-US>- Streaming / feedback from Cross-API Interop sessions<o:p></o:p></span></b></p><p class=MsoNormal style='margin-top:6.0pt;text-indent:36.0pt'><span lang=EN-US>Discussion page <a href="https://cvs.khronos.org/wiki/index.php?title=OpenCL/EGLStream">https://cvs.khronos.org/wiki/index.php?title=OpenCL/EGLStream</a><o:p></o:p></span></p><p class=MsoNormal style='mso-margin-top-alt:6.0pt;margin-right:0cm;margin-bottom:0cm;margin-left:36.0pt;margin-bottom:.0001pt'><span lang=EN-US>[ACTION]<i> </i></span><i><span lang=EN-US style='font-size:10.0pt;font-family:"Tahoma","sans-serif"'>All – provide further topology / use-case feedback<br></span></i><span lang=EN-US>[ACTION]<i> Alon/</i></span><i><span lang=EN-US style='font-size:10.0pt;font-family:"Tahoma","sans-serif"'>Mikael – discuss how to push metadata proposal forwards<br></span></i><span lang=EN-US>[ACTION]<i> </i></span><i><span lang=EN-US style='font-size:10.0pt;font-family:"Tahoma","sans-serif"'>Neil – invite StreamInput members to Cross-API session and get topology input</span></i><span lang=EN-US><o:p></o:p></span></p></div></body></html>
\ No newline at end of file diff --git a/glew/auto/EGL-Registry/sdk/docs/man/index.php b/glew/auto/EGL-Registry/sdk/docs/man/index.php new file mode 100644 index 0000000..b97647b --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/index.php @@ -0,0 +1,9 @@ +<html> +<head> +<title>EGL Reference Pages</title> +</head> +<frameset rows="85,*"> + <frame scrolling="no" noresize frameborder="0" marginwidth="0" marginheight="0" src="top.php"> + <frame noresize frameborder="0" marginwidth="0" marginheight="0" src="bottom.php"> +</frameset> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/mkshar b/glew/auto/EGL-Registry/sdk/docs/man/mkshar new file mode 100644 index 0000000..52cc006 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/mkshar @@ -0,0 +1,3 @@ +#!/bin/sh +set -x +shar -mwxTD $* > xml.shar diff --git a/glew/auto/EGL-Registry/sdk/docs/man/reference.xml b/glew/auto/EGL-Registry/sdk/docs/man/reference.xml new file mode 100644 index 0000000..a75da4d --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/reference.xml @@ -0,0 +1,182 @@ +<?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.5 + </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="eglClientWaitSync.xml"/> + <xi:include href="eglCopyBuffers.xml"/> + <xi:include href="eglCreateContext.xml"/> + <xi:include href="eglCreateImage.xml"/> + <xi:include href="eglCreatePbufferSurface.xml"/> + <xi:include href="eglCreatePixmapSurface.xml"/> + <xi:include href="eglCreateSync.xml"/> + <xi:include href="eglCreateWindowSurface.xml"/> + <xi:include href="eglDestroyContext.xml"/> + <xi:include href="eglDestroyImage.xml"/> + <xi:include href="eglDestroySurface.xml"/> + <xi:include href="eglDestroySync.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="eglGetPlatformDisplay.xml"/> + <xi:include href="eglGetProcAddress.xml"/> + <xi:include href="eglGetSyncAttrib.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"/> + <xi:include href="eglWaitSync.xml"/> + </chapter> + <xi:include href="license-full.xml"/> +</book> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/setvars b/glew/auto/EGL-Registry/sdk/docs/man/setvars new file mode 100644 index 0000000..49c878e --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/setvars @@ -0,0 +1,5 @@ +#!/usr/bin/tcsh +# Set variables for comparisons +set egl=/home/tree/khronos/registry/trunk/public/egl/sdk/docs/man/xhtml +set es=/home/tree/khronos/ogles/trunk/sdk/docs/man3/docbook4/xhtml +set esnew=/home/tree/khronos/ogles/trunk/sdk/docs/man3/html diff --git a/glew/auto/EGL-Registry/sdk/docs/man/top.php b/glew/auto/EGL-Registry/sdk/docs/man/top.php new file mode 100644 index 0000000..9bdbf00 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/top.php @@ -0,0 +1,46 @@ +<html> +<head> + <!-- Should actually use PHP features & import stylesheet - see + OpenGL ES top.php for example --> + <title>EGL Reference Pages</title> + <style xmlns="" type="text/css"> + body { + background-image:url(headBackground.jpg) no-repeat; + } + p { + font-family:verdana,sans-serif; font-size:80%; color: white; + margin-top:0px; margin-bottom:0px; position:absolute; + bottom:2px; left:5px; + } + a:link, a:visited { text-decoration:none; color:white} + h1 { + font: bold 1.4em verdana,sans-serif; text-align: left; + color: black; margin-top:10px; margin-bottom:3px; + padding-top:0px; padding-bottom:0px; + } + #search { + position:absolute; top:15px; right: 20px; margin: 0; padding: 0; + } + #search fieldset { + border: 0; margin: 0; padding: 0; + } + </style> +</head> +<body background="headBackground.jpg"> + <h1> <!-- <img src="html/EGL_300.jpg" alt="" width="50" height="50" border="0" align="middle">--> EGL Reference Pages</h1> + <div id="search"> + <!-- search not supported yet + <fieldset> + <form method="get" action="/opencl/search/opencl_1_2/swish.cgi" enctype="application/x-www-form-urlencoded" class="form" target="pagedisplay"> + <input maxlength="200" value="processor" size="15" type="text" name="query" /> + <input value="Search!" type="submit" name="submit" /> + </fieldset> + --> + </div> + <p><a href="http://www.khronos.org/egl/" target="EGL">More EGL Info</a> + <a href="http://www.khronos.org/registry/egl/" target="EGL Specification">EGL Specification</a> > + <a href="http://www.khronos.org/files/egl-1-4-quick-reference-card.pdf" target="EGL Quick Reference">EGL Quick Reference Card</a> + </p> + + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/EGL_300.png b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/EGL_300.png Binary files differnew file mode 100644 index 0000000..7c20efb --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/EGL_300.png diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/Header.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/Header.html new file mode 100644 index 0000000..f360d64 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/Header.html @@ -0,0 +1,37 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <title>EGL Reference Pages</title> + <style xmlns="" type="text/css"> + body { background-image:url(headBackground.jpg) no-repeat; } + p { font-family:verdana,sans-serif; font-size:80%; color: white; + margin-top:0px; margin-bottom:0px; position:absolute; bottom:2px; left:5px;} + a:link, a:visited { text-decoration:none; color:white} + h1 {font: bold 1.4em verdana,sans-serif; text-align: left; color: black; + margin-top:10px; margin-bottom:3px; padding-top:0px; padding-bottom:0px; } + #search { + position:absolute; top:15px; right: 20px; margin: 0; padding: 0; + } + #search fieldset { + border: 0; margin: 0; padding: 0; + } + </style> +</head> +<body background="headBackground.jpg"> + <h1> <!-- <img src="EGL_300.jpg" alt="" width="50" height="50" border="0" align="middle">--> EGL Reference Pages</h1> + <div id="search"> + <!-- search not supported yet + <fieldset> + <form method="get" action="/opencl/search/opencl_1_2/swish.cgi" enctype="application/x-www-form-urlencoded" class="form" target="pagedisplay"> + <input maxlength="200" value="processor" size="15" type="text" name="query" /> + <input value="Search!" type="submit" name="submit" /> + </fieldset> + --> + </div> + <p><a href="http://www.khronos.org/egl/" target="EGL">More EGL Info</a> + <a href="http://www.khronos.org/registry/egl/" target="EGL Specification">EGL Specification</a> > + <a href="http://www.khronos.org/files/egl-1-4-quick-reference-card.pdf" target="EGL Quick Reference">EGL Quick Reference Card</a> + </p> + + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/Intro.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/Intro.html new file mode 100644 index 0000000..8f82ab5 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/Intro.html @@ -0,0 +1,116 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> +/* This style sets a margin around the entire page */ + html, body { margin: 10px; } + + p { font-family:verdana,sans-serif; font-size:95%; + margin-top:0px; margin-bottom:20px; padding-top:0px; padding-bottom:0px; } + + h1 {font: bold 1.75em verdana,sans-serif; + margin-top:0px; margin-bottom:3px; padding-top:0px; padding-bottom:0px; } + + h2 { font-family:verdana,sans-serif; font-size:1.20em + margin-top:28px; margin-bottom:3px; padding-top:0px; padding-bottom:0px; } + + li { font-family:verdana,sans-serif; font-size:95%; + margin-top:0px; margin-bottom:18px; padding-top:0px; padding-bottom:0px; } + + code, constant {font: normal 1.1em 'courier new',monospace; } + code.function {font: bold 1.1em 'courier new',monospace; } + code.varname {font: italic 1.1em 'courier new',monospace; } + code.funcdef {font: normal 1.1em 'courier new',monospace; } + .citerefentry {font: normal 1.1em 'courier new',monospace; } + .parameter { font-style: italic; } + code.fsfunc {font: normal 1.1em 'courier new',monospace; } + div.funcsynopsis {font: normal 1.1em 'courier new',monospace; text-align:left; background-color:#e6e6e6;} + div.funcsynopsis table { margin-top: 10px; border-collapse:separate; } + div.funcsynopsis td {background-color:#e6e6e6; border:0px solid black; padding:2px; } + div.refsect1 {font-family:verdana,sans-serif; font-size:95%;} + +/* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { margin-top:15px; } + +/* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { font-family:verdana,sans-serif; font-size:75%; + margin-top:50px; margin-bottom:20px; padding-top:0px; padding-bottom:0px; } + +/* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { margin-top: 10px; background-color:#FFF; width:100%; border-collapse:collapse; } + div.refsect1 td {background-color:#FFF; border:1px solid black; padding:5px; + font: normal 95% verdana,san-serif;} + div.refsect1 th {background-color:#FFF; border:1px solid black; padding:5px; + font: bold 95% verdana,san-serif;} + +/* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { font-family:verdana,sans-serif; } + h3 { font:bold 1.25em verdana,sans-serif; font-size:135%; + margin-top:28px; margin-bottom:3px; padding-top:0px; padding-bottom:0px; } + div.refsect2 table {margin-top:0px; background-color:#e6e6e6; + width:100%; border:0px solid black; padding:2px;} + div.refsect2 td {background-color:##e6e6e6; white-space: pre; font: normal 1.1em 'courier new',monospace;} + +/* SPECIFICATION: Add an Acrobat Reader icon to PDF links + a[href$=".pdf"] {background: url(pdficon_small1.gif) left center no-repeat; padding-left: 22px;} + a[href$=".pdf"]:hover {background: url(pdficon_small1.gif) left center no-repeat;}*/ + +</style> + <title>EGL Reference Pages</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /> + <meta name="keywords" content="OpenCl Reference Title Page" /> + </head> + <body> + <div class="refentry" lang="en" xml:lang="en"> + <a id="id4796348"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <a xmlns="http://www.w3.org/1999/xhtml" id="Memory Objects"></a> + <h1>EGL Reference Pages</h1> + <p></p> + </div> + <div class="refsect1" lang="en" xml:lang="en"> + <a id="description"></a> + <h2></h2> + <p> + <img src="EGL_300.png" alt="" + hspace="40" vspace="40" border="0" align="right" + xmlns="http://www.w3.org/1999/xhtml" /> + EGL™ is an interface between Khronos rendering APIs + such as OpenGL ES or OpenVG and the underlying native + platform window system. It handles graphics context + management, surface/buffer binding, and rendering + synchronization and enables high-performance, accelerated, + mixed-mode 2D and 3D rendering using other Khronos APIs. + </p> + <p> + The reference pages describe the latest approved version of + EGL, EGL 1.4, but can be used with earlier versions since + each page notes when features are available only starting + with specific versions (1.2, 1.3, and 1.4). + </p> + <p> + A more detailed overview of EGL functionality and technical + concepts can be found in the + <a target="pagedisplay" href="eglIntro.html">eglIntro</a> + page. + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4> + <img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><br> + Copyright © 2007-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> + diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/KhronosLogo.jpg b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/KhronosLogo.jpg Binary files differnew file mode 100644 index 0000000..f8a05f6 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/KhronosLogo.jpg diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/TOC.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/TOC.html new file mode 100644 index 0000000..69b3ff8 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/TOC.html @@ -0,0 +1,179 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> + +<html> +<head> + <title>Table of Contents</title> +<link href="style.css" rel="stylesheet" type="text/css" /> + +<script type="text/javascript"> +<!-- +var temp, temp2, cookieArray, cookieArray2, cookieCount; +function initiate(){ + cookieCount=0; + if(document.cookie){ + cookieArray=document.cookie.split(";"); + cookieArray2=new Array(); + for(i in cookieArray){ + cookieArray2[cookieArray[i].split("=")[0].replace(/ /g,"")]=cookieArray[i].split("=")[1].replace(/ /g,""); + } + } + cookieArray=(document.cookie.indexOf("state=")>=0)?cookieArray2["state"].split(","):new Array(); + temp=document.getElementById("containerul"); + for(var o=0;o<temp.getElementsByTagName("li").length;o++){ + if(temp.getElementsByTagName("li")[o].getElementsByTagName("ul").length>0){ + temp2 = document.createElement("span"); + temp2.className = "symbols"; + temp2.style.backgroundImage = (cookieArray.length>0)?((cookieArray[cookieCount]=="true")?"url(bullets-contract.gif)":"url(bullets-expand.gif)"):"url(bullets-expand.gif)"; + temp2.onmousedown=function(){ + showhide(this.parentNode); + writeCookie(); + } + temp.getElementsByTagName("li")[o].insertBefore(temp2,temp.getElementsByTagName("li")[o].firstChild) + temp.getElementsByTagName("li")[o].getElementsByTagName("ul")[0].style.display = "none"; + if(cookieArray[cookieCount]=="true"){ + showhide(temp.getElementsByTagName("li")[o]); + } + cookieCount++; + } + else{ + temp2 = document.createElement("span"); + temp2.className = "symbols"; + temp2.style.backgroundImage = "url(bullets-end.gif)"; + temp.getElementsByTagName("li")[o].insertBefore(temp2,temp.getElementsByTagName("li")[o].firstChild); + } + } +} + +function showhide(el){ + el.getElementsByTagName("ul")[0].style.display=(el.getElementsByTagName("ul")[0].style.display=="block")?"none":"block"; + el.getElementsByTagName("span")[0].style.backgroundImage=(el.getElementsByTagName("ul")[0].style.display=="block")?"url(bullets-contract.gif)":"url(bullets-expand.gif)"; +} + +function writeCookie(){ // Runs through the menu and puts the "states" of each nested list into an array, the array is then joined together and assigned to a cookie. + cookieArray=new Array() + for(var q=0;q<temp.getElementsByTagName("li").length;q++){ + if(temp.getElementsByTagName("li")[q].childNodes.length>0){ + if(temp.getElementsByTagName("li")[q].childNodes[0].nodeName=="SPAN" && temp.getElementsByTagName("li")[q].getElementsByTagName("ul").length>0){ + cookieArray[cookieArray.length]=(temp.getElementsByTagName("li")[q].getElementsByTagName("ul")[0].style.display=="block"); + } + } + } + document.cookie="state="+cookieArray.join(",")+";expires="+new Date(new Date().getTime() + 365*24*60*60*1000).toGMTString(); +} +//--> +</script> + +</head> +<body> +<div id="navwrap"> + <ul id="containerul"> <!-- This ul must wrap entire list for expand/contract to work --> + <li class="lev1"> + <a href="Intro.html" target="pagedisplay">Introduction</a> + </li> + <li class="lev1">Alphabetic Contents (<i>egl</i> prefix on function + names is ignored for sorting purposes) + <ul class="Level2"> + <li>B + <ul class="Level3"> + <li><a target="pagedisplay" href="eglBindAPI.html">eglBindAPI</a></li> + <li><a target="pagedisplay" href="eglBindTexImage.html">eglBindTexImage</a></li> + </ul> + </li> + <li>C + <ul class="Level3"> + <li><a target="pagedisplay" href="eglChooseConfig.html">eglChooseConfig</a></li> + <li><a target="pagedisplay" href="eglCopyBuffers.html">eglCopyBuffers</a></li> + <li><a target="pagedisplay" href="eglCreateContext.html">eglCreateContext</a></li> + <li><a target="pagedisplay" href="eglCreatePbufferFromClientBuffer.html">eglCreatePbufferFromClientBuffer</a></li> + <li><a target="pagedisplay" href="eglCreatePbufferSurface.html">eglCreatePbufferSurface</a></li> + <li><a target="pagedisplay" href="eglCreatePixmapSurface.html">eglCreatePixmapSurface</a></li> + <li><a target="pagedisplay" href="eglCreateWindowSurface.html">eglCreateWindowSurface</a></li> + </ul> + </li> + <li>D + <ul class="Level3"> + <li><a target="pagedisplay" href="eglDestroyContext.html">eglDestroyContext</a></li> + <li><a target="pagedisplay" href="eglDestroySurface.html">eglDestroySurface</a></li> + </ul> + </li> + <li>G + <ul class="Level3"> + <li><a target="pagedisplay" href="eglGetConfigAttrib.html">eglGetConfigAttrib</a></li> + <li><a target="pagedisplay" href="eglGetConfigs.html">eglGetConfigs</a></li> + <li><a target="pagedisplay" href="eglGetCurrentContext.html">eglGetCurrentContext</a></li> + <li><a target="pagedisplay" href="eglGetCurrentDisplay.html">eglGetCurrentDisplay</a></li> + <li><a target="pagedisplay" href="eglGetCurrentSurface.html">eglGetCurrentSurface</a></li> + <li><a target="pagedisplay" href="eglGetDisplay.html">eglGetDisplay</a></li> + <li><a target="pagedisplay" href="eglGetError.html">eglGetError</a></li> + <li><a target="pagedisplay" href="eglGetProcAddress.html">eglGetProcAddress</a></li> + </ul> + </li> + <li>I + <ul class="Level3"> + <li><a target="pagedisplay" href="eglInitialize.html">eglInitialize</a></li> + <li><a target="pagedisplay" href="eglIntro.html">eglIntro</a></li> + </ul> + </li> + <li>M + <ul class="Level3"> + <li><a target="pagedisplay" href="eglMakeCurrent.html">eglMakeCurrent</a></li> + </ul> + </li> + <li>Q + <ul class="Level3"> + <li><a target="pagedisplay" href="eglQueryAPI.html">eglQueryAPI</a></li> + <li><a target="pagedisplay" href="eglQueryContext.html">eglQueryContext</a></li> + <li><a target="pagedisplay" href="eglQueryString.html">eglQueryString</a></li> + <li><a target="pagedisplay" href="eglQuerySurface.html">eglQuerySurface</a></li> + </ul> + </li> + <li>R + <ul class="Level3"> + <li><a target="pagedisplay" href="eglReleaseTexImage.html">eglReleaseTexImage</a></li> + <li><a target="pagedisplay" href="eglReleaseThread.html">eglReleaseThread</a></li> + </ul> + </li> + <li>S + <ul class="Level3"> + <li><a target="pagedisplay" href="eglSurfaceAttrib.html">eglSurfaceAttrib</a></li> + <li><a target="pagedisplay" href="eglSwapBuffers.html">eglSwapBuffers</a></li> + <li><a target="pagedisplay" href="eglSwapInterval.html">eglSwapInterval</a></li> + </ul> + </li> + <li>T + <ul class="Level3"> + <li><a target="pagedisplay" href="eglTerminate.html">eglTerminate</a></li> + </ul> + </li> + <li>W + <ul class="Level3"> + <li><a target="pagedisplay" href="eglWaitClient.html">eglWaitClient</a></li> + <li><a target="pagedisplay" href="eglWaitGL.html">eglWaitGL</a></li> + <li><a target="pagedisplay" href="eglWaitNative.html">eglWaitNative</a></li> + <ul class="Level3"> + </ul> + </li> + </ul> <!-- /Level2 --> + </li> + +<!-- later - include other categories such as + <li class="lev1">EGL Runtime + ... + </li> + + <li class="lev1"> + <a href="preprocessorDirectives.html" target="pagedisplay">Preprocessor Directives and Macros</a> + </li> + + <li class="lev1">Optional Extensions + ... + </li> +later --> + </ul> <!-- /containerurl --> +</div> <!-- /navwrap --> +<script type="text/javascript"> +initiate(); // This must be placed immediately after the menu in order to format it properly. +</script> +<p> </p> +</body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/bullets-contract.gif b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/bullets-contract.gif Binary files differnew file mode 100644 index 0000000..bb1e955 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/bullets-contract.gif diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/bullets-end.gif b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/bullets-end.gif Binary files differnew file mode 100644 index 0000000..abd000e --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/bullets-end.gif diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/bullets-expand.gif b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/bullets-expand.gif Binary files differnew file mode 100644 index 0000000..e2dde60 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/bullets-expand.gif diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/copyright.inc.xsl b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/copyright.inc.xsl new file mode 100644 index 0000000..d58ca32 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/copyright.inc.xsl @@ -0,0 +1,15 @@ +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> +<xsl:param name="copyright"> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</xsl:param> +</xsl:stylesheet> + diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/ctop.xsl b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/ctop.xsl new file mode 100644 index 0000000..a6800f4 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/ctop.xsl @@ -0,0 +1,1319 @@ +<!-- saved from url=(0013)about:internet --> +<xsl:stylesheet + version="1.0" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:mml="http://www.w3.org/1998/Math/MathML" +> + +<!-- +$Id: ctop.xsl,v 1.3 2002/09/20 08:41:39 davidc Exp $ + +Copyright David Carlisle 2001, 2002. + +Use and distribution of this code are permitted under the terms of the <a +href="http://www.w3.org/Consortium/Legal/copyright-software-19980720" +>W3C Software Notice and License</a>. +--> + +<xsl:output method="xml" /> + +<xsl:template mode="c2p" match="*"> +<xsl:copy> + <xsl:copy-of select="@*"/> + <xsl:apply-templates mode="c2p"/> +</xsl:copy> +</xsl:template> + + +<!-- 4.4.1.1 cn --> + +<xsl:template mode="c2p" match="mml:cn"> + <mml:mn><xsl:apply-templates mode="c2p"/></mml:mn> +</xsl:template> + +<xsl:template mode="c2p" match="mml:cn[@type='complex-cartesian']"> + <mml:mrow> + <mml:mn><xsl:apply-templates mode="c2p" select="text()[1]"/></mml:mn> + <mml:mo>+</mml:mo> + <mml:mn><xsl:apply-templates mode="c2p" select="text()[2]"/></mml:mn> + <mml:mo><!--⁢--><!--invisible times--></mml:mo> + <mml:mi>i<!-- imaginary i --></mml:mi> + </mml:mrow> +</xsl:template> + +<xsl:template mode="c2p" match="mml:cn[@type='rational']"> + <mml:mrow> + <mml:mn><xsl:apply-templates mode="c2p" select="text()[1]"/></mml:mn> + <mml:mo>/</mml:mo> + <mml:mn><xsl:apply-templates mode="c2p" select="text()[2]"/></mml:mn> + </mml:mrow> +</xsl:template> + +<xsl:template mode="c2p" match="mml:cn[@type='integer']"> + <xsl:choose> + <xsl:when test="not(@base) or @base=10"> + <mml:mn><xsl:apply-templates mode="c2p"/></mml:mn> + </xsl:when> + <xsl:otherwise> + <mml:msub> + <mml:mn><xsl:apply-templates mode="c2p"/></mml:mn> + <mml:mn><xsl:value-of select="@base"/></mml:mn> + </mml:msub> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template mode="c2p" match="mml:cn[@type='complex-polar']"> + <mml:mrow> + <mml:mn><xsl:apply-templates mode="c2p" select="text()[1]"/></mml:mn> + <mml:mo><!--⁢--><!--invisible times--></mml:mo> + <mml:msup> + <mml:mi>e<!-- exponential e--></mml:mi> + <mml:mrow> + <mml:mi>i<!-- imaginary i--></mml:mi> + <mml:mo><!--⁢--><!--invisible times--></mml:mo> + <mml:mn><xsl:apply-templates mode="c2p" select="text()[2]"/></mml:mn> + </mml:mrow> + </mml:msup> + </mml:mrow> +</xsl:template> + +<xsl:template mode="c2p" match="mml:cn[@type='e-notation']"> + <mml:mn><xsl:apply-templates mode="c2p" select="text()[1]"/>E<xsl:apply-templates mode="c2p" select="text()[2]"/></mml:mn> +</xsl:template> + +<!-- 4.4.1.1 ci --> + +<xsl:template mode="c2p" match="mml:ci/text()"> + <mml:mi><xsl:value-of select="."/></mml:mi> +</xsl:template> + +<xsl:template mode="c2p" match="mml:ci"> + <mml:mrow><xsl:apply-templates mode="c2p"/></mml:mrow> +</xsl:template> + +<!-- 4.4.1.2 csymbol --> + +<xsl:template mode="c2p" match="mml:csymbol/text()"> + <mml:mo><xsl:apply-templates mode="c2p"/></mml:mo> +</xsl:template> + +<xsl:template mode="c2p" match="mml:csymbol"> + <mml:mrow><xsl:apply-templates mode="c2p"/></mml:mrow> +</xsl:template> + +<!-- 4.4.2.1 apply 4.4.2.2 reln --> + +<xsl:template mode="c2p" match="mml:apply|mml:reln"> + <mml:mrow> + <xsl:apply-templates mode="c2p" select="*[1]"> + <xsl:with-param name="p" select="10"/> + </xsl:apply-templates> + <mml:mo><!--⁢--><!--invisible times--></mml:mo> + <mml:mfenced open="(" close=")" separators=","> + <xsl:apply-templates mode="c2p" select="*[position()>1]"/> + </mml:mfenced> + </mml:mrow> +</xsl:template> + +<!-- 4.4.2.3 fn --> +<xsl:template mode="c2p" match="mml:fn"> + <mml:mrow><xsl:apply-templates mode="c2p"/></mml:mrow> +</xsl:template> + +<!-- 4.4.2.4 interval --> +<xsl:template mode="c2p" match="mml:interval[*[2]]"> + <mml:mfenced open="[" close="]"><xsl:apply-templates mode="c2p"/></mml:mfenced> +</xsl:template> +<xsl:template mode="c2p" match="mml:interval[*[2]][@closure='open']"> + <mml:mfenced open="(" close=")"><xsl:apply-templates mode="c2p"/></mml:mfenced> +</xsl:template> +<xsl:template mode="c2p" match="mml:interval[*[2]][@closure='open-closed']"> + <mml:mfenced open="(" close="]"><xsl:apply-templates mode="c2p"/></mml:mfenced> +</xsl:template> +<xsl:template mode="c2p" match="mml:interval[*[2]][@closure='closed-open']"> + <mml:mfenced open="[" close=")"><xsl:apply-templates mode="c2p"/></mml:mfenced> +</xsl:template> + +<xsl:template mode="c2p" match="mml:interval"> + <mml:mfenced open="{{" close="}}"><xsl:apply-templates mode="c2p"/></mml:mfenced> +</xsl:template> + +<!-- 4.4.2.5 inverse --> + +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:inverse]]"> + <mml:msup> + <xsl:apply-templates mode="c2p" select="*[2]"/> + <mml:mrow><mml:mo>(</mml:mo><mml:mn>-1</mml:mn><mml:mo>)</mml:mo></mml:mrow> + </mml:msup> +</xsl:template> + +<!-- 4.4.2.6 sep --> + +<!-- 4.4.2.7 condition --> +<xsl:template mode="c2p" match="mml:condition"> + <mml:mrow><xsl:apply-templates mode="c2p"/></mml:mrow> +</xsl:template> + +<!-- 4.4.2.8 declare --> +<xsl:template mode="c2p" match="mml:declare"/> + +<!-- 4.4.2.9 lambda --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:lambda]]"> + <mml:mrow> + <mml:mi>λ<!--lambda--></mml:mi> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:bvar/*"/></mml:mrow> + <mml:mo>.</mml:mo> + <mml:mfenced> + <xsl:apply-templates mode="c2p" select="*[last()]"/> + </mml:mfenced> +</mml:mrow> +</xsl:template> + + +<!-- 4.4.2.10 compose --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:compose]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="1"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>∘<!-- o --></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + + +<!-- 4.4.2.11` ident --> +<xsl:template mode="c2p" match="mml:ident"> +<mml:mo>id</mml:mo> +</xsl:template> + +<!-- 4.4.2.12` domain --> +<xsl:template mode="c2p" match="mml:domain"> +<mml:mo>domain</mml:mo> +</xsl:template> + +<!-- 4.4.2.13` codomain --> +<xsl:template mode="c2p" match="mml:codomain"> +<mml:mo>codomain</mml:mo> +</xsl:template> + +<!-- 4.4.2.14` image --> +<xsl:template mode="c2p" match="mml:image"> +<mml:mo>image</mml:mo> +</xsl:template> + +<!-- 4.4.2.15` domainofapplication --> +<xsl:template mode="c2p" match="mml:domainofapplication"> + <mml:error/> +</xsl:template> + +<!-- 4.4.2.16` piecewise --> +<xsl:template mode="c2p" match="mml:piecewise"> +<mml:mrow> +<mml:mo>{</mml:mo> +<mml:mtable> + <xsl:for-each select="mml:piece|mml:otherwise"> + <mml:mtr> + <mml:mtd><xsl:apply-templates mode="c2p" select="*[1]"/></mml:mtd> + <mml:mtd><mml:mtext>  if  </mml:mtext></mml:mtd> + <mml:mtd><xsl:apply-templates mode="c2p" select="*[2]"/></mml:mtd> + </mml:mtr> + </xsl:for-each> +</mml:mtable> +</mml:mrow> +</xsl:template> + + +<!-- 4.4.3.1 quotient --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:quotient]]"> +<mml:mrow> +<mml:mo>⌊<!-- lfloor--></mml:mo> +<xsl:apply-templates mode="c2p" select="*[2]"/> +<mml:mo>/</mml:mo> +<xsl:apply-templates mode="c2p" select="*[3]"/> +<mml:mo>⌋<!-- rfloor--></mml:mo> +</mml:mrow> +</xsl:template> + + + +<!-- 4.4.3.2 factorial --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:factorial]]"> +<mml:mrow> +<xsl:apply-templates mode="c2p" select="*[2]"> + <xsl:with-param name="p" select="7"/> +</xsl:apply-templates> +<mml:mo>!</mml:mo> +</mml:mrow> +</xsl:template> + + +<!-- 4.4.3.3 divide --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:divide]]"> + <xsl:param name="p" select="0"/> +<xsl:call-template name="binary"> + <xsl:with-param name="mo"><mml:mo>/</mml:mo></xsl:with-param> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="this-p" select="3"/> +</xsl:call-template> +</xsl:template> + + +<!-- 4.4.3.4 max min--> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:max]]"> +<mml:mrow> + <mml:mo>max</mml:mo> + <xsl:call-template name="set"/> +</mml:mrow> +</xsl:template> + +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:min]]"> +<mml:mrow> + <mml:mo>max</mml:mo> + <xsl:call-template name="set"/> +</mml:mrow> +</xsl:template> + +<!-- 4.4.3.5 minus--> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:minus] and count(*)=2]"> +<mml:mrow> + <mml:mo>−<!--minus--></mml:mo> + <xsl:apply-templates mode="c2p" select="*[2]"> + <xsl:with-param name="p" select="5"/> + </xsl:apply-templates> +</mml:mrow> +</xsl:template> + +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:minus] and count(*)>2]"> + <xsl:param name="p" select="0"/> +<xsl:call-template name="binary"> + <xsl:with-param name="mo"><mml:mo>−<!--minus--></mml:mo></xsl:with-param> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="this-p" select="2"/> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.3.6 plus--> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:plus]]"> + <xsl:param name="p" select="0"/> + <mml:mrow> + <xsl:if test="$p > 2"><mml:mo>(</mml:mo></xsl:if> + <xsl:for-each select="*[position()>1]"> + <xsl:if test="position() > 1"> + <mml:mo> + <xsl:choose> + <xsl:when test="self::mml:apply[*[1][self::mml:times] and + *[2][self::mml:apply/*[1][self::mml:minus] or self::mml:cn[not(mml:sep) and + (number(.) < 0)]]]">−<!--minus--></xsl:when> + <xsl:otherwise>+</xsl:otherwise> + </xsl:choose> + </mml:mo> + </xsl:if> + <xsl:choose> + <xsl:when test="self::mml:apply[*[1][self::mml:times] and + *[2][self::mml:cn[not(mml:sep) and (number(.) <0)]]]"> + <mml:mrow> + <mml:mn><xsl:value-of select="-(*[2])"/></mml:mn> + <mml:mo><!--⁢--><!--invisible times--></mml:mo> + <xsl:apply-templates mode="c2p" select="."> + <xsl:with-param name="first" select="2"/> + <xsl:with-param name="p" select="2"/> + </xsl:apply-templates> + </mml:mrow> + </xsl:when> + <xsl:when test="self::mml:apply[*[1][self::mml:times] and + *[2][self::mml:apply/*[1][self::mml:minus]]]"> + <mml:mrow> + <xsl:apply-templates mode="c2p" select="./*[2]/*[2]"/> + <xsl:apply-templates mode="c2p" select="."> + <xsl:with-param name="first" select="2"/> + <xsl:with-param name="p" select="2"/> + </xsl:apply-templates> + </mml:mrow> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates mode="c2p" select="."> + <xsl:with-param name="p" select="2"/> + </xsl:apply-templates> + </xsl:otherwise> + </xsl:choose> + </xsl:for-each> + <xsl:if test="$p > 2"><mml:mo>)</mml:mo></xsl:if> + </mml:mrow> +</xsl:template> + + +<!-- 4.4.3.7 power --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:power]]"> +<mml:msup> +<xsl:apply-templates mode="c2p" select="*[2]"> + <xsl:with-param name="p" select="5"/> +</xsl:apply-templates> +<xsl:apply-templates mode="c2p" select="*[3]"> + <xsl:with-param name="p" select="5"/> +</xsl:apply-templates> +</mml:msup> +</xsl:template> + +<!-- 4.4.3.8 remainder --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:rem]]"> + <xsl:param name="p" select="0"/> +<xsl:call-template name="binary"> + <xsl:with-param name="mo"><mml:mo>mod</mml:mo></xsl:with-param> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="this-p" select="3"/> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.3.9 times--> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:times]]" name="times"> + <xsl:param name="p" select="0"/> + <xsl:param name="first" select="1"/> + <mml:mrow> + <xsl:if test="$p > 3"><mml:mo>(</mml:mo></xsl:if> + <xsl:for-each select="*[position()>1]"> + <xsl:if test="position() > 1"> + <mml:mo> + <xsl:choose> + <xsl:when test="self::mml:cn">×<!-- times --></xsl:when> + <xsl:otherwise><!--⁢--><!--invisible times--></xsl:otherwise> + </xsl:choose> + </mml:mo> + </xsl:if> + <xsl:if test="position()>= $first"> + <xsl:apply-templates mode="c2p" select="."> + <xsl:with-param name="p" select="3"/> + </xsl:apply-templates> + </xsl:if> + </xsl:for-each> + <xsl:if test="$p > 3"><mml:mo>)</mml:mo></xsl:if> + </mml:mrow> +</xsl:template> + + +<!-- 4.4.3.10 root --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:root] and not(mml:degree) or mml:degree=2]" priority="4"> +<mml:msqrt> +<xsl:apply-templates mode="c2p" select="*[position()>1]"/> +</mml:msqrt> +</xsl:template> + +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:root]]"> +<mml:mroot> +<xsl:apply-templates mode="c2p" select="*[position()>1 and not(self::mml:degree)]"/> +<mml:mrow><xsl:apply-templates mode="c2p" select="mml:degree/*"/></mml:mrow> +</mml:mroot> +</xsl:template> + +<!-- 4.4.3.11 gcd --> +<xsl:template mode="c2p" match="mml:gcd"> +<mml:mo>gcd</mml:mo> +</xsl:template> + +<!-- 4.4.3.12 and --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:and]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="2"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>∧<!-- and --></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + + +<!-- 4.4.3.13 or --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:or]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="3"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>∨<!-- or --></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.3.14 xor --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:xor]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="3"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>xor</mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + + +<!-- 4.4.3.15 not --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:not]]"> +<mml:mrow> +<mml:mo>¬<!-- not --></mml:mo> +<xsl:apply-templates mode="c2p" select="*[2]"> + <xsl:with-param name="p" select="7"/> +</xsl:apply-templates> +</mml:mrow> +</xsl:template> + + + + +<!-- 4.4.3.16 implies --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:implies]]"> + <xsl:param name="p" select="0"/> +<xsl:call-template name="binary"> + <xsl:with-param name="mo"><mml:mo>⇒<!-- Rightarrow --></mml:mo></xsl:with-param> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="this-p" select="3"/> +</xsl:call-template> +</xsl:template> + + +<!-- 4.4.3.17 forall --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:forall]]"> + <mml:mrow> + <mml:mi>∀<!--forall--></mml:mi> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:bvar[not(current()/mml:condition)]/*|mml:condition/*"/></mml:mrow> + <mml:mo>.</mml:mo> + <mml:mfenced> + <xsl:apply-templates mode="c2p" select="*[last()]"/> + </mml:mfenced> +</mml:mrow> +</xsl:template> + + + +<!-- 4.4.3.18 exists --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:exists]]"> + <mml:mrow> + <mml:mi>∃<!--exists--></mml:mi> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:bvar[not(current()/mml:condition)]/*|mml:condition/*"/></mml:mrow> + <mml:mo>.</mml:mo> + <mml:mfenced> + <xsl:apply-templates mode="c2p" select="*[last()]"/> + </mml:mfenced> +</mml:mrow> +</xsl:template> + + +<!-- 4.4.3.19 abs --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:abs]]"> +<mml:mrow> +<mml:mo>|</mml:mo> +<xsl:apply-templates mode="c2p" select="*[2]"/> +<mml:mo>|</mml:mo> +</mml:mrow> +</xsl:template> + + + +<!-- 4.4.3.20 conjugate --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:conjugate]]"> +<mml:mover> +<xsl:apply-templates mode="c2p" select="*[2]"/> +<mml:mo>¯<!-- overline --></mml:mo> +</mml:mover> +</xsl:template> + +<!-- 4.4.3.21 arg --> +<xsl:template mode="c2p" match="mml:arg"> + <mml:mo>arg</mml:mo> +</xsl:template> + + +<!-- 4.4.3.22 real --> +<xsl:template mode="c2p" match="mml:real"> + <mml:mo>ℛ<!-- real --></mml:mo> +</xsl:template> + +<!-- 4.4.3.23 imaginary --> +<xsl:template mode="c2p" match="mml:imaginary"> + <mml:mo>ℑ<!-- imaginary --></mml:mo> +</xsl:template> + +<!-- 4.4.3.24 lcm --> +<xsl:template mode="c2p" match="mml:lcm"> + <mml:mo>lcm</mml:mo> +</xsl:template> + + +<!-- 4.4.3.25 floor --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:floor]]"> +<mml:mrow> +<mml:mo>⌊<!-- lfloor--></mml:mo> +<xsl:apply-templates mode="c2p" select="*[2]"/> +<mml:mo>⌋<!-- rfloor--></mml:mo> +</mml:mrow> +</xsl:template> + + +<!-- 4.4.3.25 ceiling --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:ceiling]]"> +<mml:mrow> +<mml:mo>⌈<!-- lceil--></mml:mo> +<xsl:apply-templates mode="c2p" select="*[2]"/> +<mml:mo>⌉<!-- rceil--></mml:mo> +</mml:mrow> +</xsl:template> + +<!-- 4.4.4.1 eq --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:eq]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="1"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>=</mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.4.2 neq --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:neq]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="1"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>≠<!-- neq --></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.4.3 eq --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:gt]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="1"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.4.4 lt --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:lt]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="1"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo><</mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.4.5 geq --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:geq]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="1"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>≥</mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.4.6 geq --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:leq]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="1"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>≤</mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.4.7 equivalent --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:equivalent]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="1"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>≡</mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.4.8 approx --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:approx]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="1"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>≃</mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + + +<!-- 4.4.4.9 factorof --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:factorof]]"> + <xsl:param name="p" select="0"/> +<xsl:call-template name="binary"> + <xsl:with-param name="mo"><mml:mo>|</mml:mo></xsl:with-param> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="this-p" select="3"/> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.5.1 int --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:int]]"> + <mml:mrow> + <mml:msubsup> + <mml:mi>∫<!--int--></mml:mi> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:lowlimit/*|mml:interval/*[1]|mml:condition/*"/></mml:mrow> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:uplimit/*|mml:interval/*[2]"/></mml:mrow> + </mml:msubsup> + <xsl:apply-templates mode="c2p" select="*[last()]"/> + <mml:mo>d</mml:mo><xsl:apply-templates mode="c2p" select="mml:bvar"/> +</mml:mrow> +</xsl:template> + +<!-- 4.4.5.2 diff --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:diff] and mml:ci and count(*)=2]" priority="2"> + <mml:msup> + <mml:mrow><xsl:apply-templates mode="c2p" select="*[2]"/></mml:mrow> + <mml:mo>′<!--prime--></mml:mo> + </mml:msup> +</xsl:template> + +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:diff]]" priority="1"> + <mml:mfrac> + <xsl:choose> + <xsl:when test="mml:bvar/mml:degree"> + <mml:mrow><mml:msup><mml:mo>d</mml:mo><xsl:apply-templates mode="c2p" select="mml:bvar/mml:degree/node()"/></mml:msup> + <xsl:apply-templates mode="c2p" select="*[last()]"/></mml:mrow> + <mml:mrow><mml:mo>d</mml:mo><mml:msup><xsl:apply-templates mode="c2p" + select="mml:bvar/node()"/><xsl:apply-templates mode="c2p" + select="mml:bvar/mml:degree/node()"/></mml:msup> +</mml:mrow> +</xsl:when> +<xsl:otherwise> + <mml:mrow><mml:mo>d</mml:mo><xsl:apply-templates mode="c2p" select="*[last()]"/></mml:mrow> + <mml:mrow><mml:mo>d</mml:mo><xsl:apply-templates mode="c2p" select="mml:bvar"/></mml:mrow> +</xsl:otherwise> + </xsl:choose> + </mml:mfrac> +</xsl:template> + + +<!-- 4.4.5.3 partialdiff --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:partialdiff] and mml:list and mml:ci and count(*)=3]" priority="2"> +<mml:mrow> + <mml:msub><mml:mo>D</mml:mo><mml:mrow> +<xsl:for-each select="mml:list[1]/*"> +<xsl:apply-templates mode="c2p" select="."/> +<xsl:if test="position()<last()"><mml:mo>,</mml:mo></xsl:if> +</xsl:for-each> +</mml:mrow></mml:msub> + <mml:mrow><xsl:apply-templates mode="c2p" select="*[3]"/></mml:mrow> +</mml:mrow> +</xsl:template> + +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:partialdiff]]" priority="1"> + <mml:mfrac> + <mml:mrow><mml:msup><mml:mo>∂<!-- partial --></mml:mo> +<mml:mrow> + <xsl:choose> + <xsl:when test="mml:degree"> +<xsl:apply-templates mode="c2p" select="mml:degree/node()"/> +</xsl:when> +<xsl:when test="mml:bvar/mml:degree[string(number(.))='NaN']"> +<xsl:for-each select="mml:bvar/mml:degree"> +<xsl:apply-templates mode="c2p" select="node()"/> +<xsl:if test="position()<last()"><mml:mo>+</mml:mo></xsl:if> +</xsl:for-each> +<xsl:if test="count(mml:bvar[not(mml:degree)])>0"> +<mml:mo>+</mml:mo><mml:mn><xsl:value-of select="count(mml:bvar[not(mml:degree)])"/></mml:mn> +</xsl:if> +</xsl:when> +<xsl:otherwise> +<mml:mn><xsl:value-of select="sum(mml:bvar/mml:degree)+count(mml:bvar[not(mml:degree)])"/></mml:mn> +</xsl:otherwise> + </xsl:choose> +</mml:mrow> +</mml:msup> + <xsl:apply-templates mode="c2p" select="*[last()]"/></mml:mrow> +<mml:mrow> +<xsl:for-each select="mml:bvar"> +<mml:mrow> +<mml:mo>∂<!-- partial --></mml:mo><mml:msup><xsl:apply-templates mode="c2p" select="node()"/> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:degree/node()"/></mml:mrow> +</mml:msup> +</mml:mrow> +</xsl:for-each> +</mml:mrow> + </mml:mfrac> +</xsl:template> + +<!-- 4.4.5.4 lowlimit--> +<xsl:template mode="c2p" match="mml:lowlimit"/> + +<!-- 4.4.5.5 uplimit--> +<xsl:template mode="c2p" match="mml:uplimit"/> + +<!-- 4.4.5.6 bvar--> +<xsl:template mode="c2p" match="mml:bvar"> + <mml:mi><xsl:apply-templates mode="c2p"/></mml:mi> + <xsl:if test="following-sibling::mml:bvar"><mml:mo>,</mml:mo></xsl:if> +</xsl:template> + +<!-- 4.4.5.7 degree--> +<xsl:template mode="c2p" match="mml:degree"/> + +<!-- 4.4.5.8 divergence--> +<xsl:template mode="c2p" match="mml:divergence"> +<mml:mo>div</mml:mo> +</xsl:template> + +<!-- 4.4.5.9 grad--> +<xsl:template mode="c2p" match="mml:grad"> +<mml:mo>grad</mml:mo> +</xsl:template> + +<!-- 4.4.5.10 curl --> +<xsl:template mode="c2p" match="mml:curl"> +<mml:mo>curl</mml:mo> +</xsl:template> + + +<!-- 4.4.5.11 laplacian--> +<xsl:template mode="c2p" match="mml:laplacian"> +<mml:msup><mml:mo>∇<!-- nabla --></mml:mo><mml:mn>2</mml:mn></mml:msup> +</xsl:template> + +<!-- 4.4.6.1 set --> + +<xsl:template mode="c2p" match="mml:set"> + <xsl:call-template name="set"/> +</xsl:template> + +<!-- 4.4.6.2 list --> + +<xsl:template mode="c2p" match="mml:list"> + <xsl:call-template name="set"> + <xsl:with-param name="o" select="'('"/> + <xsl:with-param name="c" select="')'"/> + </xsl:call-template> +</xsl:template> + +<!-- 4.4.6.3 union --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:union]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="2"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>∪<!-- union --></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.6.4 intersect --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:intersect]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="3"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>∩<!-- intersect --></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.6.5 in --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:in]]"> + <xsl:param name="p" select="0"/> +<xsl:call-template name="binary"> + <xsl:with-param name="mo"><mml:mo>∈<!-- in --></mml:mo></xsl:with-param> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="this-p" select="3"/> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.6.5 notin --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:notin]]"> + <xsl:param name="p" select="0"/> +<xsl:call-template name="binary"> + <xsl:with-param name="mo"><mml:mo>∉<!-- not in --></mml:mo></xsl:with-param> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="this-p" select="3"/> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.6.7 subset --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:subset]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="2"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>⊆<!-- subseteq --></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.6.8 prsubset --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:prsubset]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="2"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>⊂<!-- prsubset --></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.6.9 notsubset --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:notsubset]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="binary"> + <xsl:with-param name="this-p" select="2"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>⊈<!-- notsubseteq --></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.6.10 notprsubset --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:notprsubset]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="binary"> + <xsl:with-param name="this-p" select="2"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>⊄<!-- prsubset --></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.6.11 setdiff --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:setdiff]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="binary"> + <xsl:with-param name="this-p" select="2"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>∖<!-- setminus --></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.6.12 card --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:card]]"> +<mml:mrow> +<mml:mo>|</mml:mo> +<xsl:apply-templates mode="c2p" select="*[2]"/> +<mml:mo>|</mml:mo> +</mml:mrow> +</xsl:template> + +<!-- 4.4.6.13 cartesianproduct --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:cartesianproduct or self::mml:vectorproduct]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="2"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>×<!-- times --></mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<xsl:template +match="mml:apply[*[1][self::mml:cartesianproduct][count(following-sibling::mml:reals)=count(following-sibling::*)]]" +priority="2"> +<mml:msup> +<xsl:apply-templates mode="c2p" select="*[2]"> + <xsl:with-param name="p" select="5"/> +</xsl:apply-templates> +<mml:mn><xsl:value-of select="count(*)-1"/></mml:mn> +</mml:msup> +</xsl:template> + + +<!-- 4.4.7.1 sum --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:sum]]"> + <mml:mrow> + <mml:msubsup> + <mml:mo>∑<!--sum--></mml:mo> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:lowlimit/*|mml:interval/*[1]|mml:condition/*"/></mml:mrow> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:uplimit/*|mml:interval/*[2]"/></mml:mrow> + </mml:msubsup> + <xsl:apply-templates mode="c2p" select="*[last()]"/> +</mml:mrow> +</xsl:template> + +<!-- 4.4.7.2 product --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:product]]"> + <mml:mrow> + <mml:msubsup> + <mml:mo>∏<!--product--></mml:mo> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:lowlimit/*|mml:interval/*[1]|mml:condition/*"/></mml:mrow> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:uplimit/*|mml:interval/*[2]"/></mml:mrow> + </mml:msubsup> + <xsl:apply-templates mode="c2p" select="*[last()]"/> +</mml:mrow> +</xsl:template> + +<!-- 4.4.7.3 limit --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:limit]]"> + <mml:mrow> + <mml:munder> + <mml:mi>limit</mml:mi> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:lowlimit|mml:condition/*"/></mml:mrow> + </mml:munder> + <xsl:apply-templates mode="c2p" select="*[last()]"/> +</mml:mrow> +</xsl:template> + +<xsl:template mode="c2p" match="mml:apply[mml:limit]/mml:lowlimit" priority="3"> +<mml:mrow> +<xsl:apply-templates mode="c2p" select="../mml:bvar/node()"/> +<mml:mo>→<!--rightarrow--></mml:mo> +<xsl:apply-templates mode="c2p"/> +</mml:mrow> +</xsl:template> + + +<!-- 4.4.7.4 tendsto --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:tendsto]]"> + <xsl:param name="p"/> +<xsl:call-template name="binary"> + <xsl:with-param name="this-p" select="2"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo> + <xsl:choose> + <xsl:when test="@type='above'">↘<!--searrow--></xsl:when> + <xsl:when test="@type='below'">↗<!--nearrow--></xsl:when> + <xsl:when test="@type='two-sided'">→<!--rightarrow--></xsl:when> + <xsl:otherwise>→<!--rightarrow--></xsl:otherwise> + </xsl:choose> + </mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.8.1 trig --> +<xsl:template mode="c2p" match="mml:apply[*[1][ + self::mml:sin or self::mml:cos or self::mml:tan or self::mml:sec or + self::mml:csc or self::mml:cot or self::mml:sinh or self::mml:cosh or + self::mml:tanh or self::mml:sech or self::mml:csch or self::mml:coth or + self::mml:arcsin or self::mml:arccos or self::mml:arctan or self::mml:arccosh + or self::mml:arccot or self::mml:arccoth or self::mml:arccsc or + self::mml:arccsch or self::mml:arcsec or self::mml:arcsech or + self::mml:arcsinh or self::mml:arctanh or self::mml:ln]]"> +<mml:mrow> +<mml:mi><xsl:value-of select="local-name(*[1])"/></mml:mi> +<xsl:apply-templates mode="c2p" select="*[2]"> + <xsl:with-param name="p" select="7"/> +</xsl:apply-templates> +</mml:mrow> +</xsl:template> + + + + +<!-- 4.4.8.2 exp --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:exp]]"> +<mml:msup> +<mml:mi>e<!-- exponential e--></mml:mi> +<mml:mrow><xsl:apply-templates mode="c2p" select="*[2]"/></mml:mrow> +</mml:msup> +</xsl:template> + +<!-- 4.4.8.3 ln --> +<!-- with trig --> + +<!-- 4.4.8.4 log --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:log]]"> +<mml:mrow> +<xsl:choose> +<xsl:when test="not(mml:logbase) or mml:logbase=10"> +<mml:mi>log</mml:mi> +</xsl:when> +<xsl:otherwise> +<mml:msub> +<mml:mi>log</mml:mi> +<mml:mrow><xsl:apply-templates mode="c2p" select="mml:logbase/node()"/></mml:mrow> +</mml:msub> +</xsl:otherwise> +</xsl:choose> +<xsl:apply-templates mode="c2p" select="*[last()]"> + <xsl:with-param name="p" select="7"/> +</xsl:apply-templates> +</mml:mrow> +</xsl:template> + + +<!-- 4.4.9.1 mean --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:mean]]"> +<mml:mrow> + <mml:mo>〈<!--langle--></mml:mo> + <xsl:for-each select="*[position()>1]"> + <xsl:apply-templates mode="c2p" select="."/> + <xsl:if test="position() !=last()"><mml:mo>,</mml:mo></xsl:if> + </xsl:for-each> +<mml:mo>〉<!--rangle--></mml:mo> +</mml:mrow> +</xsl:template> + + +<!-- 4.4.9.2 sdef --> +<xsl:template mode="c2p" match="mml:sdev"> +<mml:mo>σ<!--sigma--></mml:mo> +</xsl:template> + +<!-- 4.4.9.3 variance --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:variance]]"> +<mml:msup> +<mml:mrow> +<mml:mo>σ<!--sigma--></mml:mo> +<mml:mo>(</mml:mo> +<xsl:apply-templates mode="c2p" select="*[2]"/> +<mml:mo>)</mml:mo> +</mml:mrow> +<mml:mn>2</mml:mn> +</mml:msup> +</xsl:template> + + +<!-- 4.4.9.4 median --> +<xsl:template mode="c2p" match="mml:median"> +<mml:mo>median</mml:mo> +</xsl:template> + + +<!-- 4.4.9.5 mode --> +<xsl:template mode="c2p" match="mml:mode"> +<mml:mo>mode</mml:mo> +</xsl:template> + +<!-- 4.4.9.5 moment --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:moment]]"> +<mml:mrow> + <mml:mo>〈<!--langle--></mml:mo> + <mml:msup> + <xsl:apply-templates mode="c2p" select="*[last()]"/> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:degree/node()"/></mml:mrow> + </mml:msup> +<mml:mo>〉<!--rangle--></mml:mo> +</mml:mrow> +</xsl:template> + +<!-- 4.4.9.5 momentabout --> +<xsl:template mode="c2p" match="mml:momentabout"/> + +<!-- 4.4.10.1 vector --> +<xsl:template mode="c2p" match="mml:vector"> +<mml:mrow> +<mml:mo>(</mml:mo> +<mml:mtable> +<xsl:for-each select="*"> +<mml:mtr><mml:mtd><xsl:apply-templates mode="c2p" select="."/></mml:mtd></mml:mtr> +</xsl:for-each> +</mml:mtable> +<mml:mo>)</mml:mo> +</mml:mrow> +</xsl:template> + +<!-- 4.4.10.2 matrix --> +<xsl:template mode="c2p" match="mml:matrix"> +<mml:mrow> +<mml:mo>(</mml:mo> +<mml:mtable> +<xsl:apply-templates mode="c2p"/> +</mml:mtable> +<mml:mo>)</mml:mo> +</mml:mrow> +</xsl:template> + +<!-- 4.4.10.3 matrixrow --> +<xsl:template mode="c2p" match="mml:matrixrow"> +<mml:mtr> +<xsl:for-each select="*"> +<mml:mtd><xsl:apply-templates mode="c2p" select="."/></mml:mtd> +</xsl:for-each> +</mml:mtr> +</xsl:template> + +<!-- 4.4.10.4 determinant --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:determinant]]"> +<mml:mrow> +<mml:mi>det</mml:mi> +<xsl:apply-templates mode="c2p" select="*[2]"> + <xsl:with-param name="p" select="7"/> +</xsl:apply-templates> +</mml:mrow> +</xsl:template> + +<xsl:template +match="mml:apply[*[1][self::mml:determinant]][*[2][self::mml:matrix]]" priority="2"> +<mml:mrow> +<mml:mo>|</mml:mo> +<mml:mtable> +<xsl:apply-templates mode="c2p" select="mml:matrix/*"/> +</mml:mtable> +<mml:mo>|</mml:mo> +</mml:mrow> +</xsl:template> + +<!-- 4.4.10.5 transpose --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:transpose]]"> +<mml:msup> +<xsl:apply-templates mode="c2p" select="*[2]"> + <xsl:with-param name="p" select="7"/> +</xsl:apply-templates> +<mml:mi>T</mml:mi> +</mml:msup> +</xsl:template> + +<!-- 4.4.10.5 selector --> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:selector]]"> +<mml:msub> +<xsl:apply-templates mode="c2p" select="*[2]"> + <xsl:with-param name="p" select="7"/> +</xsl:apply-templates> +<mml:mrow> + <xsl:for-each select="*[position()>2]"> + <xsl:apply-templates mode="c2p" select="."/> + <xsl:if test="position() !=last()"><mml:mo>,</mml:mo></xsl:if> + </xsl:for-each> +</mml:mrow> +</mml:msub> +</xsl:template> + +<!-- *** --> +<!-- 4.4.10.6 vectorproduct see cartesianproduct --> + + +<!-- 4.4.10.7 scalarproduct--> +<xsl:template mode="c2p" match="mml:apply[*[1][self::mml:scalarproduct or self::mml:outerproduct]]"> +<xsl:param name="p" select="0"/> +<xsl:call-template name="infix"> + <xsl:with-param name="this-p" select="2"/> + <xsl:with-param name="p" select="$p"/> + <xsl:with-param name="mo"><mml:mo>.</mml:mo></xsl:with-param> +</xsl:call-template> +</xsl:template> + +<!-- 4.4.10.8 outerproduct--> + +<!-- 4.4.11.2 semantics --> +<xsl:template mode="c2p" match="mml:semantics"> + <xsl:apply-templates mode="c2p" select="*[1]"/> +</xsl:template> +<xsl:template mode="c2p" match="mml:semantics[mml:annotation-xml/@encoding='MathML-Presentation']"> + <xsl:apply-templates mode="c2p" select="mml:annotation-xml[@encoding='MathML-Presentation']/node()"/> +</xsl:template> + +<!-- 4.4.12.1 integers --> +<xsl:template mode="c2p" match="mml:integers"> +<mml:mi mathvariant="double-struck">Z</mml:mi> +</xsl:template> + +<!-- 4.4.12.2 reals --> +<xsl:template mode="c2p" match="mml:reals"> +<mml:mi mathvariant="double-struck">R</mml:mi> +</xsl:template> + +<!-- 4.4.12.3 rationals --> +<xsl:template mode="c2p" match="mml:rationals"> +<mml:mi mathvariant="double-struck">Q</mml:mi> +</xsl:template> + +<!-- 4.4.12.4 naturalnumbers --> +<xsl:template mode="c2p" match="mml:naturalnumbers"> +<mml:mi mathvariant="double-struck">N</mml:mi> +</xsl:template> + +<!-- 4.4.12.5 complexes --> +<xsl:template mode="c2p" match="mml:complexes"> +<mml:mi mathvariant="double-struck">C</mml:mi> +</xsl:template> + +<!-- 4.4.12.6 primes --> +<xsl:template mode="c2p" match="mml:primes"> +<mml:mi mathvariant="double-struck">P</mml:mi> +</xsl:template> + +<!-- 4.4.12.7 exponentiale --> +<xsl:template mode="c2p" match="mml:exponentiale"> + <mml:mi>e<!-- exponential e--></mml:mi> +</xsl:template> + +<!-- 4.4.12.8 imaginaryi --> +<xsl:template mode="c2p" match="mml:imaginaryi"> + <mml:mi>i<!-- imaginary i--></mml:mi> +</xsl:template> + +<!-- 4.4.12.9 notanumber --> +<xsl:template mode="c2p" match="mml:notanumber"> + <mml:mi>NaN</mml:mi> +</xsl:template> + +<!-- 4.4.12.10 true --> +<xsl:template mode="c2p" match="mml:true"> + <mml:mi>true</mml:mi> +</xsl:template> + +<!-- 4.4.12.11 false --> +<xsl:template mode="c2p" match="mml:false"> + <mml:mi>false</mml:mi> +</xsl:template> + +<!-- 4.4.12.12 emptyset --> +<xsl:template mode="c2p" match="mml:emptyset"> + <mml:mi>∅<!-- emptyset --></mml:mi> +</xsl:template> + + +<!-- 4.4.12.13 pi --> +<xsl:template mode="c2p" match="mml:pi"> + <mml:mi>π<!-- pi --></mml:mi> +</xsl:template> + +<!-- 4.4.12.14 eulergamma --> +<xsl:template mode="c2p" match="mml:eulergamma"> + <mml:mi>γ<!-- gamma --></mml:mi> +</xsl:template> + +<!-- 4.4.12.15 infinity --> +<xsl:template mode="c2p" match="mml:infinity"> + <mml:mi>∞<!-- infinity --></mml:mi> +</xsl:template> + + +<!-- ****************************** --> +<xsl:template name="infix" > + <xsl:param name="mo"/> + <xsl:param name="p" select="0"/> + <xsl:param name="this-p" select="0"/> + <mml:mrow> + <xsl:if test="$this-p < $p"><mml:mo>(</mml:mo></xsl:if> + <xsl:for-each select="*[position()>1]"> + <xsl:if test="position() > 1"> + <xsl:copy-of select="$mo"/> + </xsl:if> + <xsl:apply-templates mode="c2p" select="."> + <xsl:with-param name="p" select="$this-p"/> + </xsl:apply-templates> + </xsl:for-each> + <xsl:if test="$this-p < $p"><mml:mo>)</mml:mo></xsl:if> + </mml:mrow> +</xsl:template> + +<xsl:template name="binary" > + <xsl:param name="mo"/> + <xsl:param name="p" select="0"/> + <xsl:param name="this-p" select="0"/> + <mml:mrow> + <xsl:if test="$this-p < $p"><mml:mo>(</mml:mo></xsl:if> + <xsl:apply-templates mode="c2p" select="*[2]"> + <xsl:with-param name="p" select="$this-p"/> + </xsl:apply-templates> + <xsl:copy-of select="$mo"/> + <xsl:apply-templates mode="c2p" select="*[3]"> + <xsl:with-param name="p" select="$this-p"/> + </xsl:apply-templates> + <xsl:if test="$this-p < $p"><mml:mo>)</mml:mo></xsl:if> + </mml:mrow> +</xsl:template> + +<xsl:template name="set" > + <xsl:param name="o" select="'{'"/> + <xsl:param name="c" select="'}'"/> + <mml:mrow> + <mml:mo><xsl:value-of select="$o"/></mml:mo> + <xsl:choose> + <xsl:when test="mml:condition"> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:bvar/*[not(self::bvar or self::condition)]"/></mml:mrow> + <mml:mo>|</mml:mo> + <mml:mrow><xsl:apply-templates mode="c2p" select="mml:condition/node()"/></mml:mrow> + </xsl:when> + <xsl:otherwise> + <xsl:for-each select="*"> + <xsl:apply-templates mode="c2p" select="."/> + <xsl:if test="position() !=last()"><mml:mo>,</mml:mo></xsl:if> + </xsl:for-each> + </xsl:otherwise> + </xsl:choose> + <mml:mo><xsl:value-of select="$c"/></mml:mo> + </mml:mrow> +</xsl:template> + +</xsl:stylesheet> + diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/egl-man.xsl b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/egl-man.xsl new file mode 100644 index 0000000..7c73965 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/egl-man.xsl @@ -0,0 +1,274 @@ +<?xml version='1.0'?> + + +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:xlink="http://www.w3.org/1999/xlink" + version="1.0"> + + + <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"/> + +<!-- This file contains the "customization layer" for the Docbook system. When a Docbook rule +doesn't do exactly what we need, we override the rule in this file with a modified rule. --> + +<!-- Inserts the file style-css.xsl. This is embeddd into the <head /> tag of each resulting html file --> + <xsl:include href="styles-css.xsl" /> + <xsl:include href="copyright.inc.xsl" /> + <xsl:param name="funcsynopsis.style">ansi</xsl:param> + <xsl:param name="citerefentry.link" select="'1'"></xsl:param> + <xsl:output indent="yes"/> + +<!-- Set this param to a placeholder for the base URL of the external specification document. Include +the beginning of the 'namedest' function as well. See the script pageNumberLookup.rb to see +how this placeholder gets replaced by the actual spec URL and target page number. This placeholder +can be any string, and only needs to match the same placeholder string in pageNumberLookup.rb. --> + <xsl:param name="SpecBaseUrl">http://www.khronos.org/registry/cl/specs/opencl-1.x-latest.pdf#namedest=</xsl:param> + +<!-- This generates a URL based on the contents of Refentry title. However if there is a value +specified for the href attribute in Citerefentry, then it will create the URL out if that content instead --> + <xsl:template name="generate.citerefentry.link"> + <xsl:choose> + <xsl:when test="@href"> + <xsl:value-of select="@href"/> + <xsl:text>.html</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="refentrytitle"/> + <xsl:text>.html</xsl:text> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + +<!-- The following template creates the link for the Specification section --> + <xsl:template match="olink"> + <xsl:text disable-output-escaping="yes"><a href="</xsl:text> + <xsl:value-of select="$SpecBaseUrl" /> + <xsl:value-of select="@uri" /> + <xsl:text disable-output-escaping="yes">" target="OpenCL Spec"></xsl:text> + <xsl:value-of select="." /> + <xsl:text disable-output-escaping="yes"></a></xsl:text> + </xsl:template> + +<!-- The following enables use of ulink for regular URLs on the pages--> +<xsl:template match="ulink"> + <xsl:text disable-output-escaping="yes"><a href="</xsl:text> + <xsl:value-of select="@url" /> + <xsl:text disable-output-escaping="yes">"></xsl:text> + <xsl:value-of select="." /> + <xsl:text disable-output-escaping="yes"></a></xsl:text> +</xsl:template> + + +<!-- The following is the main set of templates for generating the web pages --> + <xsl:template match="*" mode="process.root"> + <xsl:variable name="doc" select="self::*"/> + <xsl:call-template name="user.preroot"/> + <xsl:call-template name="root.messages"/> + + <html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"> + + <head> + <xsl:call-template name="system.head.content"> + <xsl:with-param name="node" select="$doc"/> + </xsl:call-template> + + <xsl:call-template name="head.content"> + <xsl:with-param name="node" select="$doc"/> + </xsl:call-template> + + <xsl:call-template name="user.head.content"> + <xsl:with-param name="node" select="$doc"/> + </xsl:call-template> + </head> + + <body> + <xsl:call-template name="body.attributes"/> + <xsl:call-template name="user.header.content"> + <xsl:with-param name="node" select="$doc"/> + </xsl:call-template> + <xsl:apply-templates select="."/> <!-- This line performs the magic! --> + <xsl:call-template name="user.footer.content"> + <xsl:with-param name="node" select="$doc"/> + </xsl:call-template> + + </body> + </html> + </xsl:template> + + +<xsl:template match="/"> + <xsl:processing-instruction name="xml-stylesheet"> + <xsl:text>type="text/xsl" href="mathml.xsl"</xsl:text> + </xsl:processing-instruction> + <xsl:apply-imports/> +</xsl:template> + + +<xsl:template match="funcdef/replaceable"> + <xsl:call-template name="inline.italicseq"/> +</xsl:template> + + +<!-- This inserts the style-css.xsl file into the HTML file --> +<xsl:template name="system.head.content"> + <xsl:param name="node" select="."/> + <style type="text/css"> + <xsl:value-of select="$annotation.css"/> + </style> +</xsl:template> + + +<!-- The templates gentext-refname and refnamediv are inserted here so +we can have the refname displayed as the H1 header on the page --> +<xsl:template name="gentext-refname"> + <xsl:param name="key" select="local-name(.)"/> + <xsl:param name="lang"> + <xsl:call-template name="l10n.language"/> + </xsl:param> + <xsl:value-of select="refname"/> +</xsl:template> + +<xsl:template match="refnamediv"> + <div class="{name(.)}"> + <xsl:call-template name="anchor"/> + <xsl:choose> + <xsl:when test="preceding-sibling::refnamediv"> + <!-- no title on secondary refnamedivs! --> + </xsl:when> + <xsl:when test="$refentry.generate.name != 0"> + <h1> + <xsl:call-template name="gentext-refname"> + <xsl:with-param name="key" select="'RefName'"/> + </xsl:call-template> + </h1> + </xsl:when> + <xsl:when test="$refentry.generate.title != 0"> + <h2> + <xsl:choose> + <xsl:when test="../refmeta/refentrytitle"> + <xsl:apply-templates select="../refmeta/refentrytitle"/> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="refname[1]"/> + </xsl:otherwise> + </xsl:choose> + </h2> + </xsl:when> + </xsl:choose> + <p> + <xsl:apply-templates/> + </p> + </div> +</xsl:template> + + +<!-- The templates refname and refpurpose are inserted here so that we can +modify the layout of these values on the HTML page --> +<xsl:template match="refname" /> +<xsl:template match="refpurpose"> +<xsl:apply-templates/> +</xsl:template> + + +<!-- The Link template allows us to embed links in the <funcprototype>, +even though this is not valid DocBook markup --> +<xsl:template match="link" mode="ansi-tabular"> + <xsl:apply-templates select="."/> +</xsl:template> + + +<!-- The following template enables the <replaceable> tag inside + <funcdef>, <paramdef>, and <function> to generate <em> in the HTML output --> +<xsl:template match="funcdef/replaceable" mode="ansi-tabular"> + <xsl:call-template name="inline.italicseq"/> +</xsl:template> + +<xsl:template match="paramdef/replaceable" mode="ansi-tabular"> + <xsl:call-template name="inline.italicseq"/> +</xsl:template> + +<xsl:template match="function/replaceable" mode="ansi-nontabular"> + <xsl:call-template name="inline.italicseq"/> +</xsl:template> + +<xsl:template match="refname/replaceable" mode="kr-nontabular"> + <xsl:call-template name="inline.italicseq"/> +</xsl:template> + +<!-- The templates funcprototype and paramdef are here so we can modify the layout +of the synopsis so that it is not broken into so many columns in the table, control indenting, and more. --> + +<!-- funcprototype: ansi, tabular --> + +<xsl:template match="funcprototype" mode="ansi-tabular"> + <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <xsl:if test="following-sibling::funcprototype"> + <xsl:attribute name="style">padding-bottom: 1em</xsl:attribute> + </xsl:if> + <tr valign="bottom"> + <td> + <xsl:apply-templates select="funcdef" mode="ansi-tabular"/> + <xsl:apply-templates select="(void|varargs|paramdef)[1]" mode="ansi-tabular"/> + </td> + </tr> + <xsl:for-each select="(void|varargs|paramdef)[position() > 1]"> + <tr valign="top"> + <td> </td> + <xsl:apply-templates select="." mode="ansi-tabular"/> + </tr> + </xsl:for-each> + </table> +</xsl:template> + + +<xsl:template match="paramdef" mode="ansi-tabular"> + <xsl:choose> + <xsl:when test="type and funcparams"> + <td> + <xsl:apply-templates select="type" mode="kr-tabular-funcsynopsis-mode"/> + <xsl:text> </xsl:text> + </td> + <td> + <xsl:apply-templates select="type/following-sibling::node()" mode="kr-tabular-funcsynopsis-mode"/> + </td> + </xsl:when> + <xsl:otherwise> + <td> + <xsl:apply-templates select="parameter/preceding-sibling::node()[not(self::parameter)]" mode="ansi-tabular"/> + <xsl:text> </xsl:text> +<!-- </td> + <td>--> + <xsl:apply-templates select="parameter" mode="ansi-tabular"/> + <xsl:apply-templates select="parameter/following-sibling::node()[not(self::parameter)]" mode="ansi-tabular"/> + <xsl:choose> + <xsl:when test="following-sibling::*"> + <xsl:text>, </xsl:text> + </xsl:when> + <xsl:otherwise> + <code>)</code> +<!-- OpenCL functions do not end with a semi-colon. + <xsl:text>;</xsl:text> --> + </xsl:otherwise> + </xsl:choose> + </td> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + + +<!-- The template refsect3 is inserted here to deal with the copyright. This +adds in the text from the include file copyright.inc.xsl --> +<xsl:template match="refsect3"> + <div class="{name(.)}"> + <xsl:call-template name="language.attribute"/> + <xsl:call-template name="anchor"> + <xsl:with-param name="conditional" select="0"/> + </xsl:call-template> + <xsl:apply-templates/> + <xsl:value-of select="$copyright"/> + </div> +</xsl:template> +</xsl:stylesheet> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglBindAPI.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglBindAPI.html new file mode 100644 index 0000000..e3ad8b3 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglBindAPI.html @@ -0,0 +1,365 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglBindAPI</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglBindAPI"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglBindAPI</h1> + <p>Set the current rendering API</p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglBindAPI</strong>(</code> + <td>EGLenum <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">api</var><code>)</code></td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>api</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the client API to bind, one of + <code class="constant">EGL_OPENGL_API</code>, + <code class="constant">EGL_OPENGL_ES_API</code>, or + <code class="constant">EGL_OPENVG_API</code>. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglBindAPI</code> 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 + <code class="function">eglCreateContext</code>, + <code class="function">eglGetCurrentContext</code>, + <code class="function">eglGetCurrentDisplay</code>, + <code class="function">eglGetCurrentSurface</code>, + <code class="function">eglMakeCurrent</code>, + <code class="function">eglWaitClient</code>, and + <code class="function">eglWaitNative</code>. + </p> + <p> + If <em class="parameter"><code>api</code></em> is + <code class="constant">EGL_OPENGL_API</code>, the current rendering + API is set to the OpenGL API. + </p> + <p> + If <em class="parameter"><code>api</code></em> is + <code class="constant">EGL_OPENGL_ES_API</code>, the current + rendering API is set to the OpenGL ES API. + </p> + <p> + If <em class="parameter"><code>api</code></em> is + <code class="constant">EGL_OPENVG_API</code>, the current rendering + API is set to the OpenVG API. + </p> + <p> + If an error occurs, the current rendering API is unchanged. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + <code class="function">eglBindAPI</code> and the corresponding + <code class="constant">EGL_OPENGL_ES_API</code> and + <code class="constant">EGL_OPENVG_API</code> + <em class="parameter"><code>api</code></em> parameters are supported only if + the EGL version is 1.2 or greater. The + <code class="constant">EGL_OPENGL_API</code> parameter is supported + only if the EGL version is 1.4 or greater. + </p> + <p> + The initial value of the current rendering API is + <code class="constant">EGL_OPENGL_ES_API</code> unless OpenGL ES is + not supported by an implementation, in which case the + initial value is <code class="constant">EGL_NONE</code> (however, + <code class="constant">EGL_NONE</code> is not a valid + <em class="parameter"><code>api</code></em> parameter to + <code class="function">eglBindAPI</code>). + </p> + <p> + The current rendering API can be queried by calling + <code class="function">eglQueryAPI</code>. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure. + </p> + <p> + <code class="constant">EGL_BAD_PARAMETER</code> is generated if + <em class="parameter"><code>api</code></em> is not one of the accepted + tokens, or if the specified client API is not supported by + the EGL implementation. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentContext.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentDisplay.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentDisplay</span></span></a>, + <a class="citerefentry" href="eglGetCurrentSurface.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentSurface</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQueryAPI.html"><span class="citerefentry"><span class="refentrytitle">eglQueryAPI</span></span></a>, + <a class="citerefentry" href="eglWaitClient.html"><span class="citerefentry"><span class="refentrytitle">eglWaitClient</span></span></a>, + <a class="citerefentry" href="eglWaitNative.html"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglBindTexImage.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglBindTexImage.html new file mode 100644 index 0000000..e0e96c2 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglBindTexImage.html @@ -0,0 +1,435 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglBindTexImage</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglBindTexImage"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglBindTexImage</h1> + <p> + Defines a two-dimensional texture image + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglBindTexImage</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLSurface <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">surface</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">buffer</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>buffer</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the texture image data.</p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + The texture image consists of the image data in <em class="parameter"><code>buffer</code></em> for the specified surface, and need not be copied. + </p> + <p> + 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 + <code class="constant">EGL_BIND_TO_TEXTURE_RGB</code> or <code class="constant">EGL_BIND_TO_TEXTURE_RGBA</code> attributes. + </p> + <p> + The pbuffer attribute <code class="constant">EGL_TEXTURE_FORMAT</code> determines the base internal format + of the texture. + </p> + <p> + The texture target is derived from the <code class="constant">EGL_TEXTURE_TARGET</code> attribute of surface. + If the attribute value is <code class="constant">EGL_TEXTURE_2D</code>, then <em class="parameter"><code>buffer</code></em> defines a texture for + the two-dimensional texture object which is bound to the current context (hereafter + referred to as the current texture object). + </p> + <p> + If <em class="parameter"><code>display</code></em> and <em class="parameter"><code>surface</code></em> are the display and surface for the calling thread's current + context, <code class="function">eglBindTexImage</code> performs an implicit <a class="citerefentry" href="glFlush.html"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a>. + For other surfaces, <code class="function">eglBindTexImage</code> waits for all effects from previously issued OpenGL ES commands + drawing to the surface to complete before defining the texture image, as + though <a class="citerefentry" href="glFinish.html"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a> were called on the last context to which that surface were bound. + </p> + <p> + After <code class="function">eglBindTexImage</code> is called, the specified surface is no longer available + for reading or writing. Any read operation, such as <a class="citerefentry" href="glReadPixels.html"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a> or + <a class="citerefentry" href="eglCopyBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglCopyBuffers</span></span></a>, 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. + </p> + <p> + Texture mipmap levels are automatically generated when all of the following + conditions are met while calling <code class="function">eglBindTexImage</code>: + </p> + <div class="itemizedlist"> + <ul class="itemizedlist" style="list-style-type: disc; "> + <li class="listitem"> + <p> + The <code class="constant">EGL_MIPMAP_TEXTURE</code> attribute of the pbuffer being bound is + <code class="constant">EGL_TRUE</code>. + </p> + </li> + <li class="listitem"> + <p> + The OpenGL ES texture parameter <code class="constant">GL_GENERATE_MIPMAP</code> is <code class="constant">GL_TRUE</code> for + the currently bound texture. + </p> + </li> + <li class="listitem"> + <p> + The value of the <code class="constant">EGL_MIPMAP_LEVEL</code> attribute of the pbuffer being bound is + equal to the value of the texture parameter <code class="constant">GL_TEXTURE_BASE_LEVEL</code>. + In this case, additional mipmap levels are generated as described in section 3.8 + of the OpenGL ES 1.1 Specification. + </p> + </li> + </ul> + </div> + <p> + In this case, additional mipmap levels are generated as described in section 3.8 + of the OpenGL ES 1.1 Specification. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + <a class="citerefentry" href="eglSwapBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a> has no effect if it is + called on a bound surface. + </p> + <p> + Any existing images associated with the different mipmap levels of the texture object + are freed (it is as if <a class="citerefentry" href="glTexImage.html"><span class="citerefentry"><span class="refentrytitle">glTexImage</span></span></a> + was called with an image of zero width). + </p> + <p> + 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 <a class="citerefentry" href="eglReleaseTexImage.html"><span class="citerefentry"><span class="refentrytitle">eglReleaseTexImage</span></span></a> is called, then the color buffer is released and + the surface is made available for reading and writing. + </p> + <p> + It is not an error to call <a class="citerefentry" href="glTexImage2D.html"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a> or + <a class="citerefentry" href="glCopyTexImage2D.html"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a> 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. + </p> + <p> + <code class="function">eglBindTexImage</code> is ignored if there is no current rendering context. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_BAD_ACCESS</code> is generated if + <em class="parameter"><code>buffer</code></em> is already bound to a texture. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the + surface attribute <code class="constant">EGL_TEXTURE_FORMAT</code> is + set to <code class="constant">EGL_NO_TEXTURE</code>. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>buffer</code></em> is not a valid buffer + (currently only <code class="constant">EGL_BACK_BUFFER</code> may be + specified). + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL surface, or is + not a pbuffer surface supporting texture binding. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglReleaseTexImage.html"><span class="citerefentry"><span class="refentrytitle">eglReleaseTexImage</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglChooseConfig.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglChooseConfig.html new file mode 100644 index 0000000..8a6f251 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglChooseConfig.html @@ -0,0 +1,1361 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglChooseConfig</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglChooseConfig"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglChooseConfig</h1> + <p> + return a list of EGL frame buffer configurations that match specified attributes + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglChooseConfig</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint const * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attrib_list</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLConfig * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">configs</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">config_size</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_config</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p>Specifies attributes required to match by configs.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>configs</code> + </em> + </span> + </dt> + <dd> + <p>Returns an array of frame buffer configurations.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config_size</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the size of the array of frame buffer configurations.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>num_config</code> + </em> + </span> + </dt> + <dd> + <p>Returns the number of frame buffer configurations returned.</p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglChooseConfig</code> returns in + <em class="parameter"><code>configs</code></em> a list of all + <acronym class="acronym">EGL</acronym> frame buffer configurations that + match the attributes specified in + <em class="parameter"><code>attrib_list</code></em>. The returned + <span class="type">EGLConfig</span>s can be used in any + <acronym class="acronym">EGL</acronym> function that requires an + <acronym class="acronym">EGL</acronym> frame buffer configuration. + </p> + <p> + If <em class="parameter"><code>configs</code></em> is not + <code class="constant">NULL</code>, up to + <em class="parameter"><code>config_size</code></em> configs will be returned + in the array pointed to by <em class="parameter"><code>configs</code></em>. + The number of configs actually returned will be returned in + *<em class="parameter"><code>num_config</code></em>. + </p> + <p> + If <em class="parameter"><code>configs</code></em> is + <code class="constant">NULL</code>, no configs will be returned in + <em class="parameter"><code>configs</code></em>. Instead, the total number of + configs matching <em class="parameter"><code>attrib_list</code></em> will be + returned in *<em class="parameter"><code>num_config</code></em>. In this case + <em class="parameter"><code>config_size</code></em> is ignored. This form of + <code class="function">eglChooseConfig</code> is used to determine + the number of matching frame buffer configurations, followed + by allocating an array of <span class="type">EGLConfig</span> to pass + into another call to <code class="function">eglChooseConfig</code> + with all other parameters unchanged. + </p> + <p> + All attributes in <em class="parameter"><code>attrib_list</code></em>, + including boolean attributes, are immediately followed by + the corresponding desired value. The list is terminated with + <code class="constant">EGL_NONE</code>. If an attribute is not + specified in <em class="parameter"><code>attrib_list</code></em> then the + default value (see below) is used (and the attribute is said + to be specified implicitly). For example, if + <code class="constant">EGL_DEPTH_SIZE</code> is not specified then it + is assumed to be zero. For some attributes, the default is + <code class="constant">EGL_DONT_CARE</code> meaning that any value is + OK for this attribute, so the attribute will not be checked. + </p> + <p> + Attributes are matched in an attribute-specific manner. Some + of the attributes, such as <code class="constant">EGL_LEVEL</code>, + must match the specified value exactly. Others, such as, + <code class="constant">EGL_RED_SIZE</code> 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. + </p> + <p> + For the bitmask attributes + <code class="constant">EGL_CONFORMANT</code>, + <code class="constant">EGL_RENDERABLE_TYPE</code>, and + <code class="constant">EGL_SURFACE_TYPE</code>, 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. + </p> + <p> + Attributes which may appear in + <em class="parameter"><code>attrib_list</code></em>, and their descriptions + and allowed values, are: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_ALPHA_MASK_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + <p> + The alpha mask buffer is used only by OpenGL and + OpenGL ES client APIs. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_ALPHA_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BIND_TO_TEXTURE_RGB</code> + </span> + </dt> + <dd> + <p> + Must be followed by + <code class="constant">EGL_DONT_CARE</code>, + <code class="constant">EGL_TRUE</code>, or + <code class="constant">EGL_FALSE</code>. + If <code class="constant">EGL_TRUE</code> 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 <code class="constant">EGL_DONT_CARE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BIND_TO_TEXTURE_RGBA</code> + </span> + </dt> + <dd> + <p> + Must be followed by one of + <code class="constant">EGL_DONT_CARE</code>, + <code class="constant">EGL_TRUE</code>, or + <code class="constant">EGL_FALSE</code>. + If <code class="constant">EGL_TRUE</code> 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 + <code class="constant">EGL_DONT_CARE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BLUE_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BUFFER_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + <p> + The color buffer size is the sum of + <code class="constant">EGL_RED_SIZE</code>, + <code class="constant">EGL_GREEN_SIZE</code>, + <code class="constant">EGL_BLUE_SIZE</code>, and + <code class="constant">EGL_ALPHA_SIZE</code>, 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_COLOR_BUFFER_TYPE</code> + </span> + </dt> + <dd> + <p> + Must be followed by one of + <code class="constant">EGL_RGB_BUFFER</code> or + <code class="constant">EGL_LUMINANCE_BUFFER</code>. + </p> + <p> + <code class="constant">EGL_RGB_BUFFER</code> indicates + an RGB color buffer; in this case, + attributes <code class="constant">EGL_RED_SIZE</code>, + <code class="constant">EGL_GREEN_SIZE</code> and + <code class="constant">EGL_BLUE_SIZE</code> must be non-zero, and + <code class="constant">EGL_LUMINANCE_SIZE</code> must be zero. + </p> + <p> + <code class="constant">EGL_LUMINANCE_BUFFER</code> indicates a luminance color + buffer. In this case <code class="constant">EGL_RED_SIZE</code>, + <code class="constant">EGL_GREEN_SIZE</code>, + <code class="constant">EGL_BLUE_SIZE</code> must be zero, and + <code class="constant">EGL_LUMINANCE_SIZE</code> must be non-zero. + </p> + <p> + For both RGB and luminance color buffers, + <code class="constant">EGL_ALPHA_SIZE</code> may be zero or + non-zero. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_CAVEAT</code> + </span> + </dt> + <dd> + <p> + Must be followed by + <code class="constant">EGL_DONT_CARE</code>, + <code class="constant">EGL_NONE</code>, + <code class="constant">EGL_SLOW_CONFIG</code>, or + <code class="constant">EGL_NON_CONFORMANT_CONFIG</code>. + </p> + <p> + If <code class="constant">EGL_DONT_CARE</code> is specified, + then configs are not matched for this attribute. The + default value is <code class="constant">EGL_DONT_CARE</code>. + </p> + <p> + If <code class="constant">EGL_NONE</code> is specified, then + configs are matched for this attribute, but only + configs with no caveats (neither + <code class="constant">EGL_SLOW_CONFIG</code> or + <code class="constant">EGL_NON_CONFORMANT_CONFIG</code>) will + be considered. + </p> + <p> + If <code class="constant">EGL_SLOW_CONFIG</code> 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. + </p> + <p> + If <code class="constant">EGL_NON_CONFORMANT_CONFIG</code> is + specified, then only configs supporting + non-conformant OpenGL ES contexts will be + considered. + </p> + <p> + If the EGL version is 1.3 or later, caveat + <code class="constant">EGL_NON_CONFORMANT_CONFIG</code> is + obsolete, since the same information can be + specified via the + <code class="constant">EGL_CONFORMANT</code> attribute on a + per-client-API basis, not just for OpenGL ES. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_ID</code> + </span> + </dt> + <dd> + <p> + Must be followed by a valid integer ID that + indicates the desired EGL frame buffer + configuration. When a + <code class="constant">EGL_CONFIG_ID</code> is specified, all + other attributes are ignored. The default value is + <code class="constant">EGL_DONT_CARE</code>. + </p> + <p> + The meaning of config IDs is + implementation-dependent. They are used only to + uniquely identify different frame buffer + configurations. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONFORMANT</code> + </span> + </dt> + <dd> + <p> + 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: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_OPENGL_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating OpenGL contexts. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_OPENGL_ES_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating OpenGL ES 1.0 + and/or 1.1 contexts. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_OPENGL_ES2_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating OpenGL ES 2.0 contexts. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_OPENVG_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating OpenVG contexts. + </p> + </dd> + </dl> + </div> + <p> + For example, if the bitmask is set to + <code class="constant">EGL_OPENGL_ES_BIT</code>, only frame + buffer configurations that support creating + conformant OpenGL ES contexts will match. The + default value is zero. + </p> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_DEPTH_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + <p> + The depth buffer is used only by OpenGL and OpenGL + ES client APIs. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_GREEN_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LEVEL</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + <p> + Most imlementations do not support overlay or + underlay planes (buffer levels other than zero). + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LUMINANCE_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code> + </span> + </dt> + <dd> + <p> + Must be followed by the handle of a valid native + pixmap, cast to <span class="type">EGLint</span>, or + <code class="constant">EGL_NONE</code>. If the value is not + <code class="constant">EGL_NONE</code>, only configs which + support creating pixmap surfaces with this pixmap + using + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a> + will match this attribute. If the value is + <code class="constant">EGL_NONE</code>, then configs are not + matched for this attribute. The default value is + <code class="constant">EGL_NONE</code>. + </p> + <p> + <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code> was + introduced due to the difficulty of determining an + <span class="type">EGLConfig</span> compatibile with a native + pixmap using only color component sizes. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_NATIVE_RENDERABLE</code> + </span> + </dt> + <dd> + <p> + Must be followed by + <code class="constant">EGL_DONT_CARE</code>, + <code class="constant">EGL_TRUE</code>, or + <code class="constant">EGL_FALSE</code>. + If <code class="constant">EGL_TRUE</code> is specified, then + only frame buffer configurations that allow native + rendering into the surface will be considered. The + default value is <code class="constant">EGL_DONT_CARE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MAX_SWAP_INTERVAL</code> + </span> + </dt> + <dd> + <p> + Must be followed by a integer that indicates the + maximum value that can be passed to + <a class="citerefentry" href="eglSwapInterval.html"><span class="citerefentry"><span class="refentrytitle">eglSwapInterval</span></span></a>. + The default value is + <code class="constant">EGL_DONT_CARE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MIN_SWAP_INTERVAL</code> + </span> + </dt> + <dd> + <p> + Must be followed by a integer that indicates the + minimum value that can be passed to eglSwapInterval. + The default value is <code class="constant">EGL_DONT_CARE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RED_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SAMPLE_BUFFERS</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SAMPLES</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_STENCIL_SIZE</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + <p> + The stencil buffer is used only by OpenGL and + OpenGL ES client APIs. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RENDERABLE_TYPE</code> + </span> + </dt> + <dd> + <p> + Must be followed by a bitmask indicating which types + of client API contexts the frame buffer + configuration must support creating with + <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>). + Mask bits are the same as for attribute + <code class="constant">EGL_CONFORMANT</code>. The default + value is <code class="constant">EGL_OPENGL_ES_BIT</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SURFACE_TYPE</code> + </span> + </dt> + <dd> + <p> + Must be followed by a bitmask indicating which EGL + surface types and capabilities the frame buffer + configuration must support. Mask bits include: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX_BIT</code> + </span> + </dt> + <dd> + <p> + Config allows specifying box filtered + multisample resolve behavior with + <a class="citerefentry" href="eglSurfaceAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_PBUFFER_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating pixel buffer surfaces. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_PIXMAP_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating pixmap surfaces. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SWAP_BEHAVIOR_PRESERVED_BIT</code> + </span> + </dt> + <dd> + <p> + Config allows setting swap behavior for + color buffers with + <a class="citerefentry" href="eglSurfaceAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE_BIT</code> + </span> + </dt> + <dd> + <p> + Config allows specifying OpenVG rendering + with premultiplied alpha values at surface + creation time (see + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + and + <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>). + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_COLORSPACE_LINEAR_BIT</code> + </span> + </dt> + <dd> + <p> + Config allows specifying OpenVG rendering in + a linear colorspace at surface creation time + (see + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + and + <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>). + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_WINDOW_BIT</code> + </span> + </dt> + <dd> + <p> + Config supports creating window surfaces. + </p> + </dd> + </dl> + </div> + <p> + For example, if the bitmask is set to + <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"> + <mml:mi><code class="constant">EGL_WINDOW_BIT</code></mml:mi> + <mml:mo>|</mml:mo> + <mml:mi><code class="constant">EGL_PIXMAP_BIT</code></mml:mi> + </mml:math>, + only frame buffer configurations that support both + windows and pixmaps will be considered. The default + value is <code class="constant">EGL_WINDOW_BIT</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_TYPE</code> + </span> + </dt> + <dd> + <p> + Must be followed by one of + <code class="constant">EGL_NONE</code> or + <code class="constant">EGL_TRANSPARENT_RGB</code>. If + <code class="constant">EGL_NONE</code> is specified, then + only opaque frame buffer configurations will be + considered. If + <code class="constant">EGL_TRANSPARENT_RGB</code> is + specified, then only transparent frame buffer + configurations will be considered. The default value + is <code class="constant">EGL_NONE</code>. + </p> + <p> + Most implementations support only opaque frame + buffer configurations. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_RED_VALUE</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_DONT_CARE</code>. + </p> + <p> + This attribute is ignored unless + <code class="constant">EGL_TRANSPARENT_TYPE</code> is included in + <em class="parameter"><code>attrib_list</code></em> and specified as + <code class="constant">EGL_TRANSPARENT_RGB</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_GREEN_VALUE</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_DONT_CARE</code>. + </p> + <p> + This attribute is ignored unless + <code class="constant">EGL_TRANSPARENT_TYPE</code> is included in + <em class="parameter"><code>attrib_list</code></em> and specified as + <code class="constant">EGL_TRANSPARENT_RGB</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_BLUE_VALUE</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_DONT_CARE</code>. + </p> + <p> + This attribute is ignored unless + <code class="constant">EGL_TRANSPARENT_TYPE</code> is included in + <em class="parameter"><code>attrib_list</code></em> and specified as + <code class="constant">EGL_TRANSPARENT_RGB</code>. + </p> + </dd> + </dl> + </div> + <p> + 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): + </p> + <div class="orderedlist"> + <ol class="orderedlist" type="1"> + <li class="listitem"> + <p> + Special: by <code class="constant">EGL_CONFIG_CAVEAT</code>, + where the precedence is <code class="constant">EGL_NONE</code>, + <code class="constant">EGL_SLOW_CONFIG</code>, and + <code class="constant">EGL_NON_CONFORMANT_CONFIG</code>. + </p> + </li> + <li class="listitem"> + <p> + Special: by <code class="constant">EGL_COLOR_BUFFER_TYPE</code>, + where the precedence is + <code class="constant">EGL_RGB_BUFFER</code>, + <code class="constant">EGL_LUMINANCE_BUFFER</code>. + </p> + </li> + <li class="listitem"> + <p> + Special: by larger total number of color bits (for an + RGB color buffer, this is the sum of + <code class="constant">EGL_RED_SIZE</code>, + <code class="constant">EGL_GREEN_SIZE</code>, + <code class="constant">EGL_BLUE_SIZE</code>, and + <code class="constant">EGL_ALPHA_SIZE</code>; for a luminance + color buffer, the sum of + <code class="constant">EGL_LUMINANCE_SIZE</code> and + <code class="constant">EGL_ALPHA_SIZE</code>). If the requested + number of bits in <em class="parameter"><code>attrib_list</code></em> is + <code class="constant">0</code> or + <code class="constant">EGL_DONT_CARE</code> for a particular + color component, then the number of bits for that + component is not considered. + </p> + <p> + This sort rule places configs with deeper color buffers + before configs with shallower color buffers, which may + be counterintuitive. + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_BUFFER_SIZE</code>. + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_SAMPLE_BUFFERS</code>. + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_SAMPLES</code>. + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_DEPTH_SIZE</code>. + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_STENCIL_SIZE</code>. + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_ALPHA_MASK_SIZE</code>. + </p> + </li> + <li class="listitem"> + <p> + Special: <code class="constant">EGL_NATIVE_VISUAL_TYPE</code> + (the actual sort order is implementation-defined, + depending on the meaning of native visual types). + </p> + </li> + <li class="listitem"> + <p> + Smaller <code class="constant">EGL_CONFIG_ID</code> (this is + always the last sorting rule, and guarantees a unique + ordering). + </p> + </li> + </ol> + </div> + <p> + <span class="type">EGLConfigs</span> are not sorted with respect to the + attributes <code class="constant">EGL_BIND_TO_TEXTURE_RGB</code>, + <code class="constant">EGL_BIND_TO_TEXTURE_RGBA</code>, + <code class="constant">EGL_CONFORMANT</code>, + <code class="constant">EGL_LEVEL</code>, + <code class="constant">EGL_NATIVE_RENDERABLE</code>, + <code class="constant">EGL_MAX_SWAP_INTERVAL</code>, + <code class="constant">EGL_MIN_SWAP_INTERVAL</code>, + <code class="constant">EGL_RENDERABLE_TYPE</code>, + <code class="constant">EGL_SURFACE_TYPE</code>, + <code class="constant">EGL_TRANSPARENT_TYPE</code>, + <code class="constant">EGL_TRANSPARENT_RED_VALUE</code>, + <code class="constant">EGL_TRANSPARENT_GREEN_VALUE</code>, and + <code class="constant">EGL_TRANSPARENT_BLUE_VALUE</code>. + </p> + </div> + <div class="refsect1"> + <a id="examples"></a> + <h2>Examples</h2> + <p> + 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. + </p> + <pre class="programlisting">EGLint const attrib_list[] = { + EGL_RED_SIZE, 4, + EGL_GREEN_SIZE, 4, + EGL_BLUE_SIZE, 4, + EGL_NONE +};</pre> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + <code class="constant">EGL_RENDERABLE_TYPE</code> bit + <code class="constant">EGL_OPENGL_BIT</code>, and + <code class="constant">EGL_SURFACE_TYPE</code> bits + <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX_BIT</code> and + <code class="constant">EGL_SWAP_BEHAVIOR_PRESERVED_BIT</code> are + supported only if the EGL version is 1.4 or greater. + </p> + <p> + <code class="constant">EGL_CONFORMANT</code>, + <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code>, + <code class="constant">EGL_RENDERABLE_TYPE</code> bit + <code class="constant">EGL_OPENGL_ES2_BIT</code>, and + <code class="constant">EGL_SURFACE_TYPE</code> bits + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE_BIT</code> and + <code class="constant">EGL_VG_COLORSPACE_LINEAR_BIT</code> are + supported only if the EGL version is 1.3 or greater. + </p> + <p> + <code class="constant">EGL_ALPHA_MASK_SIZE</code>, + <code class="constant">EGL_COLOR_BUFFER_TYPE</code>, + <code class="constant">EGL_LUMINANCE_SIZE</code>, + <code class="constant">EGL_RENDERABLE_TYPE</code>, and + <code class="constant">EGL_RENDERABLE_TYPE</code> bits + <code class="constant">EGL_OPENGL_ES_BIT</code> and + <code class="constant">EGL_OPENVG_BIT</code> are supported only if + the EGL version is 1.2 or greater. + </p> + <p> + If OpenGL or OpenGL ES rendering is supported for a + luminance color buffer, it is treated as RGB rendering with + the value of <code class="constant">GL_RED_BITS</code> equal to + <code class="constant">EGL_LUMINANCE_SIZE</code> and the values of + <code class="constant">GL_GREEN_BITS</code> and + <code class="constant">GL_BLUE_BITS</code> 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. + </p> + <p> + <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a> + and + <a class="citerefentry" href="eglGetConfigAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a> + can be used to implement selection algorithms other than the + generic one implemented by + <code class="function">eglChooseConfig</code>. Call + <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a> + to retrieve all the frame buffer configurations, or + alternatively, all the frame buffer configurations with a + particular set of attributes. Next call + <a class="citerefentry" href="eglGetConfigAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a> + to retrieve additional attributes for the frame buffer + configurations and then select between them. + </p> + <p> + EGL implementors are strongly discouraged, but not + proscribed, from changing the selection algorithm used by + <code class="function">eglChooseConfig</code>. Therefore, selections + may change from release to release of the client-side + library. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>configs</code></em> and + <em class="parameter"><code>num_config</code></em> are not modified when + <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attribute_list</code></em> contains an invalid frame buffer + configuration attribute or an + attribute value that is unrecognized or out of range. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_PARAMETER</code> is generated if + <em class="parameter"><code>num_config</code></em> is <code class="constant">NULL</code>. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglGetConfigAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a>, + <a class="citerefentry" href="eglSurfaceAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>, + <a class="citerefentry" href="eglSwapInterval.html"><span class="citerefentry"><span class="refentrytitle">eglSwapInterval</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCopyBuffers.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCopyBuffers.html new file mode 100644 index 0000000..e24ff15 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCopyBuffers.html @@ -0,0 +1,377 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglCopyBuffers</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglCopyBuffers"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglCopyBuffers</h1> + <p> + copy <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> surface color buffer to a native pixmap + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglCopyBuffers</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLSurface <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">surface</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>NativePixmapType <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">native_pixmap</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface whose color buffer is to be copied. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>native_pixmap</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the native pixmap as target of the copy. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglCopyBuffers</code> copies the color buffer of + <em class="parameter"><code>surface</code></em> to <em class="parameter"><code>native_pixmap</code></em>. + </p> + <p> + <code class="function">eglCopyBuffers</code> performs an implicit + <a class="citerefentry" href="glFlush.html"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a> + before it returns. Subsequent + GL commands may be issued immediately after calling + <code class="function">eglCopyBuffers</code>, + but are not executed until copying of the color buffer is completed. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + The color buffer of <em class="parameter"><code>surface</code></em> is left unchanged + after calling <code class="function">eglCopyBuffers</code>. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if swapping of the + surface buffers fails, <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL drawing surface. + </p> + <p> + <code class="constant">EGL_BAD_NATIVE_PIXMAP</code> is generated if + the implementation does not support native pixmaps. + </p> + <p> + <code class="constant">EGL_BAD_NATIVE_PIXMAP</code> may be generated if + <em class="parameter"><code>native_pixmap</code></em> is not a valid native pixmap. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + the format of <em class="parameter"><code>native_pixmap</code></em> is not compatible + with the color buffer of <em class="parameter"><code>surface</code></em>. + </p> + <p> + <code class="constant">EGL_CONTEXT_LOST</code> 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. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="glFlush.html"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a>, + <a class="citerefentry" href="eglSwapBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreateContext.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreateContext.html new file mode 100644 index 0000000..55c317c --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreateContext.html @@ -0,0 +1,488 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglCreateContext</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglCreateContext"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglCreateContext</h1> + <p> + create a new <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> rendering context + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLContext <strong class="fsfunc">eglCreateContext</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLConfig <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">config</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLContext <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">share_context</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint const * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attrib_list</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the + <acronym class="acronym">EGL</acronym> + display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL frame buffer configuration that + defines the frame buffer resource available to the rendering context. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>share_context</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies another + <acronym class="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 + <em class="parameter"><code>share_context</code></em> shares data. + <code class="constant">EGL_NO_CONTEXT</code> indicates that + no sharing is to take place. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies attributes and attribute values for the + context being created. Only the attribute + <code class="constant">EGL_CONTEXT_CLIENT_VERSION</code> may + be specified. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglCreateContext</code> creates an EGL + rendering context for the current rendering API (as set with + <code class="function">eglBindAPI</code>) and returns a handle to the + context. The context can then be used to render into an EGL + drawing surface. If <code class="function">eglCreateContext</code> + fails to create a rendering context, + <code class="constant">EGL_NO_CONTEXT</code> is returned. + </p> + <p> + If <em class="parameter"><code>share_context</code></em> is not + <code class="constant">EGL_NO_CONTEXT</code>, then all shareable data + in the context (as defined by the client API specification + for the current rendering API) are shared by context + <em class="parameter"><code>share_context</code></em>, all other contexts + <em class="parameter"><code>share_context</code></em> 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. + </p> + <p> + <em class="parameter"><code>attrib_list</code></em> specifies a list of + attributes for the context. The list has the same structure + as described for <code class="function">eglChooseConfig</code>. The + attributes and attribute values which may be specified are + as follows: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_CLIENT_VERSION</code> + </span> + </dt> + <dd> + <p> + 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 <code class="constant">EGL_OPENGL_ES_API</code>). + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + 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. + </p> + <p> + The <code class="constant">EGL_CONTEXT_CLIENT_VERSION</code> + attribute is only supported if the EGL version is 1.3 or + greater. + </p> + <p> + A <em class="firstterm">process</em> is a single execution environment, + implemented in a single address space, consisting of one or more threads. + </p> + <p> + A <em class="firstterm">thread</em> 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. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_NO_CONTEXT</code> is returned if creation of + the context fails. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the + current rendering API is <code class="constant">EGL_NONE</code> (this + can only arise in an EGL implementation which does not + support OpenGL ES, prior to the first call to + <code class="function">eglBindAPI</code>). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the + server context state for + <em class="parameter"><code>share_context</code></em> exists in an address + space which cannot be shared with the newly created context, + if <em class="parameter"><code>share_context</code></em> was created on a + different display than the one referenced by + <em class="parameter"><code>config</code></em>, or if the contexts are + otherwise incompatible. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONFIG</code> is generated if + <em class="parameter"><code>config</code></em> 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 <code class="constant">EGL_RENDERABLE_TYPE</code> + attribute of <em class="parameter"><code>config</code></em> does not contain + <code class="constant">EGL_OPENGL_ES_BIT</code>, or creation of an + OpenGL ES 2.x context when the attribute does not contain + <code class="constant">EGL_OPENGL_ES2_BIT</code>. + </p> + <p> + <code class="constant">EGL_BAD_CONTEXT</code> is generated if + <em class="parameter"><code>share_context</code></em> is not an EGL rendering + context of the same client API type as the newly created + context and is not <code class="constant">EGL_NO_CONTEXT</code>. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains an invalid + context attribute or if an attribute is not recognized or + out of range. Note that attribute + <code class="constant">EGL_CONTEXT_CLIENT_VERSION</code> is + only valid when the current rendering API is + <code class="constant">EGL_OPENGL_ES_API</code>. + </p> + <p> + <code class="constant">EGL_BAD_ALLOC</code> is generated if there are not + enough resources to allocate the new context. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglDestroyContext.html"><span class="citerefentry"><span class="refentrytitle">eglDestroyContext</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreatePbufferFromClientBuffer.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreatePbufferFromClientBuffer.html new file mode 100644 index 0000000..29fadf5 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreatePbufferFromClientBuffer.html @@ -0,0 +1,669 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglCreatePbufferFromClientBuffer</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglCreatePbufferFromClientBuffer"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglCreatePbufferFromClientBuffer</h1> + <p> + create a new <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> pixel buffer surface + bound to an OpenVG image + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLSurface <strong class="fsfunc">eglCreatePbufferFromClientBuffer</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLenum <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">buftype</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLClientBuffer <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">buffer</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLConfig <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">config</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint const * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attrib_list</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>buftype</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the type of client API buffer to be bound. + Must be <code class="constant">EGL_OPENVG_IMAGE</code>, + corresponding to an OpenVG <span class="type">VGImage</span> + buffer. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>buffer</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the OpenVG <span class="type">VGImage</span> handle of + the buffer to be bound. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies pixel buffer surface attributes. + May be <code class="constant">NULL</code> or empty + (first attribute is <code class="constant">EGL_NONE</code>). + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglCreatePbufferFromClientBuffer</code> creates an + off-screen pixel buffer surface and returns its handle. If + <code class="function">eglCreatePbufferFromClientBuffer</code> fails to create + a pixel buffer surface, <code class="constant">EGL_NO_SURFACE</code> + is returned. + </p> + <p> + The new pixel buffer surface is similar to a pixel buffer + created with + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + but storage for the color buffer is provided by a client API + buffer. Other buffer required by + <em class="parameter"><code>config</code></em>, such as depth, stencil, and + alpha mask, are allocated by EGL. + </p> + <p> + <em class="parameter"><code>buftype</code></em> must be + <code class="constant">EGL_OPENVG_IMAGE</code>, corresponding to an + OpenVG <span class="type">VGImage</span> buffer. + <em class="parameter"><code>buffer</code></em> must be a valid + <span class="type">VGImage</span> handle in the current OpenVG context, + cast into the type <span class="type">EGLClientBuffer</span>. + </p> + <p> + The height, width,, OpenVG alpha format, and OpenVG + colorspace (surface attributes + <code class="constant">EGL_HEIGHT</code>, + <code class="constant">EGL_WIDTH</code>, + <code class="constant">EGL_VG_ALPHA_FORMAT</code>, and + <code class="constant">EGL_VG_COLORSPACE</code>, respectively) of the + resulting surface are determined by the size and format of + <em class="parameter"><code>buffer</code></em>. + </p> + <p> + Surface attributes are specified as a list of + attribute-value pairs, terminated with + <code class="constant">EGL_NONE</code>. Accepted attributes are: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_MIPMAP_TEXTURE</code> + </span> + </dt> + <dd> + <p> + Specifies whether storage for mipmaps should be + allocated. Space for mipmaps will be set aside if + the attribute value is <code class="constant">EGL_TRUE</code> + and <code class="constant">EGL_TEXTURE_FORMAT</code> is not + <code class="constant">EGL_NO_TEXTURE</code>. The default + value is <code class="constant">EGL_FALSE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_FORMAT</code> + </span> + </dt> + <dd> + <p> + Specifies the format of the texture that will be + created when a pbuffer is bound to a texture map. + Possible values are + <code class="constant">EGL_NO_TEXTURE</code>, + <code class="constant">EGL_TEXTURE_RGB</code>, and + <code class="constant">EGL_TEXTURE_RGBA</code>. The default + value is <code class="constant">EGL_NO_TEXTURE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_TARGET</code> + </span> + </dt> + <dd> + <p> + Specifies the target for the texture that will be + created when the pbuffer is created with a texture + format of <code class="constant">EGL_TEXTURE_RGB</code> or + <code class="constant">EGL_TEXTURE_RGBA</code>. Possible + values are <code class="constant">EGL_NO_TEXTURE</code>, or + <code class="constant">EGL_TEXTURE_2D</code>. The default + value is <code class="constant">EGL_NO_TEXTURE</code>. + </p> + </dd> + </dl> + </div> + <p> + Any EGL rendering context that was created with respect to + <em class="parameter"><code>config</code></em> can be used to render into the + surface. Use + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + to attach an EGL rendering context to the surface. + </p> + <p> + Use + <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + to retrieve the dimensions of the allocated pixel buffer + surface or the ID of <em class="parameter"><code>config</code></em>. + </p> + <p> + Use <a class="citerefentry" href="eglDestroySurface.html"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a> + to destroy the surface. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + <code class="function">eglCreatePbufferFromClientBuffer</code> is + supported only if the EGL version is 1.2 or greater, and if + the EGL implementation supports the OpenVG client API. + </p> + <p> + Currently + <code class="function">eglCreatePbufferFromClientBuffer</code> only + supports binding OpenVG <span class="type">VGImage</span> 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 <span class="type">EGLImageKHR</span> + images, are a more flexible and general framework to satisfy + most of the same needs. + </p> + <p> + If the value of <em class="parameter"><code>config</code></em> attribute + <code class="constant">EGL_TEXTURE_FORMAT</code> is not + <code class="constant">EGL_NO_TEXTURE</code>, then the pbuffer width + and height specify the size of the level zero texture image + </p> + <p> + If <code class="constant">EGL_LARGEST_PBUFFER</code> is specified and + if the pbuffer will be used as a texture (i.e. the value of + <code class="constant">EGL_TEXTURE_TARGET</code> is + <code class="constant">EGL_TEXTURE_2D</code>, and the value of + <code class="constant">EGL_TEXTURE FORMAT</code> is + <code class="constant">EGL_TEXTURE_RGB</code> or + <code class="constant">EGL_TEXTURE_RGBA</code>), 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). + </p> + <p> + 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). + </p> + <p> + 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: + </p> + <div class="orderedlist"> + <ol class="orderedlist" type="1"> + <li class="listitem"> + <p> + Bound buffers may be used exclusively by either EGL, + or the client API that originally created them. For + example, if a <span class="type">VGImage</span> is bound to a + pbuffer, and that pbuffer is bound to any client API + rendering context, then the <span class="type">VGImage</span> 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 <span class="type">VGImage</span> is in use by + OpenVG, the pbuffer it is bound to may not be made + current to any client API context using + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>. + </p> + </li> + <li class="listitem"> + <p> + Binding a buffer creates an additional reference to + it, and implementations must respect outstanding + references when destroying objects. For example, if + a <span class="type">VGImage</span> is bound to a pbuffer, + destroying the image with + <code class="function">vgDestroyImage</code> will not free + the underlying buffer, because it is still in use by + EGL. However, following + <code class="function">vgDestroyImage</code> 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 + <code class="function">eglDestroySurface</code> will not free + the underlying buffer, because it is still in use by + OpenVG . However, following + <code class="function">eglDestroySurface</code> the buffer + may only be referred to via the OpenVG + <span class="type">VGImage</span> handle, since the EGL pbuffer + handle no longer exists. + </p> + </li> + </ol> + </div> + <p> + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_NO_SURFACE</code> is returned if creation of + the context fails. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONFIG</code> is generated if + <em class="parameter"><code>config</code></em> is not an EGL frame buffer configuration. + </p> + <p> + <code class="constant">EGL_BAD_PARAMETER</code> is generated if + <em class="parameter"><code>buftype</code></em> is not + <code class="constant">EGL_OPENVG_IMAGE</code>, or if + <em class="parameter"><code>buffer</code></em> is not a valid handle to a + <span class="type">VGImage</span> object in the currently bound OpenVG + context. + </p> + <p> + <code class="constant">EGL_BAD_ACCESS</code> is generated if there is + no current OpenVG context, or if + <em class="parameter"><code>buffer</code></em> is already bound to another + pixel buffer or in use by OpenVG as discussed in the Notes + section above. + </p> + <p> + <code class="constant">EGL_BAD_ALLOC</code> is generated if there are not + enough resources to allocate the new surface. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains an invalid pixel + buffer attribute or if an attribute value is not recognized + or out of range. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains any of the + attributes <code class="constant">EGL_MIPMAP_TEXTURE</code>, + <code class="constant">EGL_TEXTURE_FORMAT</code>, or + <code class="constant">EGL_TEXTURE_TARGET</code>, and + <em class="parameter"><code>config</code></em> does not support OpenGL ES + rendering (e.g. the EGL version is 1.2 or later, and the + <code class="constant">EGL_RENDERABLE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em> does not include at least one + of <code class="constant">EGL_OPENGL_ES_BIT</code> or + <code class="constant">EGL_OPENGL_ES2_BIT</code>). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>config</code></em> does not support rendering to pixel buffers + (the <code class="constant">EGL_SURFACE_TYPE</code> attribute does not contain + <code class="constant">EGL_PBUFFER_BIT</code>). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the + buffers contained in <em class="parameter"><code>buffer</code></em> do not + match the bit depths for those buffers specified by + <em class="parameter"><code>config</code></em>. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the + <code class="constant">EGL_TEXTURE_FORMAT</code> attribute is not + <code class="constant">EGL_NO_TEXTURE</code>, and + <code class="constant">EGL_WIDTH</code> and/or + <code class="constant">EGL_HEIGHT</code> 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). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + the <code class="constant">EGL_TEXTURE_FORMAT</code> attribute is + <code class="constant">EGL_NO_TEXTURE</code>, and + <code class="constant">EGL_TEXTURE_TARGET</code> is something other + than <code class="constant">EGL_NO_TEXTURE</code>; or, + <code class="constant">EGL_TEXTURE_FORMAT</code> is something other + than <code class="constant">EGL_NO_TEXTURE</code>, and + <code class="constant">EGL_TEXTURE_TARGET</code> is + <code class="constant">EGL_NO_TEXTURE</code>. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> 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 <span class="type">VGImage</span> being bound to a + pixel buffer which will be used as a mipmapped OpenGL ES + texture (e.g. whose <code class="constant">EGL_MIPMAP_TEXTURE</code> + attribute is <code class="constant">TRUE</code>). Any such + constraints should be documented by the implementation + release notes. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglDestroySurface.html"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreatePbufferSurface.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreatePbufferSurface.html new file mode 100644 index 0000000..c99115a --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreatePbufferSurface.html @@ -0,0 +1,605 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglCreatePbufferSurface</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglCreatePbufferSurface"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglCreatePbufferSurface</h1> + <p> + create a new <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> pixel buffer surface + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLSurface <strong class="fsfunc">eglCreatePbufferSurface</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLConfig <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">config</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint const * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attrib_list</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies pixel buffer surface attributes. + May be <code class="constant">NULL</code> or empty + (first attribute is <code class="constant">EGL_NONE</code>). + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglCreatePbufferSurface</code> creates an + off-screen pixel buffer surface and returns its handle. If + <code class="function">eglCreatePbufferSurface</code> fails to create + a pixel buffer surface, <code class="constant">EGL_NO_SURFACE</code> + is returned. + </p> + <p> + Surface attributes are specified as a list of + attribute-value pairs, terminated with + <code class="constant">EGL_NONE</code>. Accepted attributes + are: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_HEIGHT</code> + </span> + </dt> + <dd> + <p> + Specifies the required height of the pixel buffer + surface. The default value is + <code class="constant">0</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LARGEST_PBUFFER</code> + </span> + </dt> + <dd> + <p> + Requests the largest available pixel buffer surface + when the allocation would otherwise fail. Use + <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + to retrieve the dimensions of the allocated pixel + buffer. The default value is + <code class="constant">EGL_FALSE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MIPMAP_TEXTURE</code> + </span> + </dt> + <dd> + <p> + Specifies whether storage for mipmaps should be + allocated. Space for mipmaps will be set aside if + the attribute value is <code class="constant">EGL_TRUE</code> + and <code class="constant">EGL_TEXTURE_FORMAT</code> is not + <code class="constant">EGL_NO_TEXTURE</code>. The default + value is <code class="constant">EGL_FALSE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_FORMAT</code> + </span> + </dt> + <dd> + <p> + Specifies the format of the texture that will be + created when a pbuffer is bound to a texture map. + Possible values are + <code class="constant">EGL_NO_TEXTURE</code>, + <code class="constant">EGL_TEXTURE_RGB</code>, and + <code class="constant">EGL_TEXTURE_RGBA</code>. The default + value is <code class="constant">EGL_NO_TEXTURE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_TARGET</code> + </span> + </dt> + <dd> + <p> + Specifies the target for the texture that will be + created when the pbuffer is created with a texture + format of <code class="constant">EGL_TEXTURE_RGB</code> or + <code class="constant">EGL_TEXTURE_RGBA</code>. Possible + values are <code class="constant">EGL_NO_TEXTURE</code>, or + <code class="constant">EGL_TEXTURE_2D</code>. The default + value is <code class="constant">EGL_NO_TEXTURE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_ALPHA_FORMAT</code> + </span> + </dt> + <dd> + <p> + Specifies how alpha values are interpreted by OpenVG + when rendering to the surface. If its value is + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>, + then alpha values are not premultipled. If its value + is <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code>, + then alpha values are premultiplied. The default + value of <code class="constant">EGL_VG_ALPHA_FORMAT</code> is + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_COLORSPACE</code> + </span> + </dt> + <dd> + <p> + Specifies the color space used by OpenVG when + rendering to the surface. If its value is + <code class="constant">EGL_VG_COLORSPACE_sRGB</code>, then a + non-linear, perceptually uniform color space is + assumed, with a corresponding + <span class="type">VGImageFormat</span> of form + <code class="constant">VG_s*</code>. If its value is + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code>, then + a linear color space is assumed, with a + corresponding <span class="type">VGImageFormat</span> of form + <code class="constant">VG_l*</code>. The default value of + <code class="constant">EGL_VG_COLORSPACE</code> is + <code class="constant">EGL_VG_COLORSPACE_sRGB</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_WIDTH</code> + </span> + </dt> + <dd> + <p> + Specifies the required width of the pixel buffer + surface. The default value is + <code class="constant">0</code>. + </p> + </dd> + </dl> + </div> + <p> + Any EGL rendering context that was created with respect to + <em class="parameter"><code>config</code></em> can be used to render into the + surface. Use + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + to attach an EGL rendering context to the surface. + </p> + <p> + Use + <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + to retrieve the dimensions of the allocated pixel buffer + surface or the ID of <em class="parameter"><code>config</code></em>. + </p> + <p> + Use <a class="citerefentry" href="eglDestroySurface.html"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a> + to destroy the surface. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + Attributes + <code class="constant">EGL_RENDERABLE_TYPE</code>, + <code class="constant">EGL_VG_ALPHA_FORMAT</code>, and + <code class="constant">EGL_VG_COLORSPACE</code>, and the + corresponding attribute values, are supported only if the + EGL version is 1.2 or greater. + </p> + <p> + If the value of <em class="parameter"><code>config</code></em> attribute + <code class="constant">EGL_TEXTURE_FORMAT</code> is not + <code class="constant">EGL_NO_TEXTURE</code>, then the pbuffer width + and height specify the size of the level zero texture image + </p> + <p> + If <code class="constant">EGL_LARGEST_PBUFFER</code> is specified and + if the pbuffer will be used as a texture (i.e. the value of + <code class="constant">EGL_TEXTURE_TARGET</code> is + <code class="constant">EGL_TEXTURE_2D</code>, and the value of + <code class="constant">EGL_TEXTURE FORMAT</code> is + <code class="constant">EGL_TEXTURE_RGB</code> or + <code class="constant">EGL_TEXTURE_RGBA</code>), 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). + </p> + <p> + 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). + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_NO_SURFACE</code> is returned if creation of + the context fails. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONFIG</code> is generated if + <em class="parameter"><code>config</code></em> is not an EGL frame buffer configuration. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains an invalid pixel + buffer attribute or if an attribute value is not recognized + or out of range. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains any of the + attributes <code class="constant">EGL_MIPMAP_TEXTURE</code>, + <code class="constant">EGL_TEXTURE_FORMAT</code>, or + <code class="constant">EGL_TEXTURE_TARGET</code>, and + <em class="parameter"><code>config</code></em> does not support OpenGL ES + rendering (e.g. the EGL version is 1.2 or later, and the + <code class="constant">EGL_RENDERABLE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em> does not include at least one + of <code class="constant">EGL_OPENGL_ES_BIT</code> or + <code class="constant">EGL_OPENGL_ES2_BIT</code>). + </p> + <p> + <code class="constant">EGL_BAD_ALLOC</code> is generated if there are not + enough resources to allocate the new surface. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>config</code></em> does not support rendering to pixel buffers + (the <code class="constant">EGL_SURFACE_TYPE</code> attribute does not contain + <code class="constant">EGL_PBUFFER_BIT</code>). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the + <code class="constant">EGL_TEXTURE_FORMAT</code> attribute is not + <code class="constant">EGL_NO_TEXTURE</code>, and + <code class="constant">EGL_WIDTH</code> and/or + <code class="constant">EGL_HEIGHT</code> 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). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + the <code class="constant">EGL_TEXTURE_FORMAT</code> attribute is + <code class="constant">EGL_NO_TEXTURE</code>, and + <code class="constant">EGL_TEXTURE_TARGET</code> is something other + than <code class="constant">EGL_NO_TEXTURE</code>; or, + <code class="constant">EGL_TEXTURE_FORMAT</code> is something other + than <code class="constant">EGL_NO_TEXTURE</code>, and + <code class="constant">EGL_TEXTURE_TARGET</code> is + <code class="constant">EGL_NO_TEXTURE</code>. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>config</code></em> does not support the specified + OpenVG alpha format attribute (the value of + <code class="constant">EGL_VG_ALPHA_FORMAT</code> is + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code> and the + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE_BIT</code> is not set + in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em>) or colorspace attribute (the + value of <code class="constant">EGL_VG_COLORSPACE</code> is + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code> and the + <code class="constant">EGL_VG_COLORSPACE_LINEAR_IT</code> is not set + in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em>). + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglDestroySurface.html"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreatePixmapSurface.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreatePixmapSurface.html new file mode 100644 index 0000000..5f35de9 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreatePixmapSurface.html @@ -0,0 +1,494 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglCreatePixmapSurface</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglCreatePixmapSurface"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglCreatePixmapSurface</h1> + <p> + create a new <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> pixmap surface + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLSurface <strong class="fsfunc">eglCreatePixmapSurface</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLConfig <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">config</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>NativePixmapType <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">native_pixmap</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint const * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attrib_list</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>native_pixmap</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the native pixmap.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies pixmap surface attributes. + May be <code class="constant">NULL</code> or empty + (first attribute is <code class="constant">EGL_NONE</code>). + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglCreatePixmapSurface</code> creates an + off-screen <acronym class="acronym">EGL</acronym> pixmap surface and returns + its handle. If <code class="function">eglCreatePixmapSurface</code> + fails to create a pixmap surface, + <code class="constant">EGL_NO_SURFACE</code> is returned. + </p> + <p> + Surface attributes are specified as a list of + attribute-value pairs, terminated with + <code class="constant">EGL_NONE</code>. Accepted attributes + are: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_VG_ALPHA_FORMAT</code> + </span> + </dt> + <dd> + <p> + Specifies how alpha values are interpreted by OpenVG + when rendering to the surface. If its value is + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>, + then alpha values are not premultipled. If its value + is <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code>, + then alpha values are premultiplied. The default + value of <code class="constant">EGL_VG_ALPHA_FORMAT</code> is + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_COLORSPACE</code> + </span> + </dt> + <dd> + <p> + Specifies the color space used by OpenVG when + rendering to the surface. If its value is + <code class="constant">EGL_VG_COLORSPACE_sRGB</code>, then a + non-linear, perceptually uniform color space is + assumed, with a corresponding + <span class="type">VGImageFormat</span> of form + <code class="constant">VG_s*</code>. If its value is + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code>, then + a linear color space is assumed, with a + corresponding <span class="type">VGImageFormat</span> of form + <code class="constant">VG_l*</code>. The default value of + <code class="constant">EGL_VG_COLORSPACE</code> is + <code class="constant">EGL_VG_COLORSPACE_sRGB</code>. + </p> + </dd> + </dl> + </div> + <p> + Any EGL rendering context that was created with respect to + <em class="parameter"><code>config</code></em> can be used to render into the + surface. Use + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + to attach an EGL rendering context to the surface. + </p> + <p> + Use + <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + to retrieve the ID of <em class="parameter"><code>config</code></em>. + </p> + <p> + Use <a class="citerefentry" href="eglDestroySurface.html"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a> + to destroy the surface. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + The <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code> attribute + of + <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a> + can be used to select a frame buffer configuration matching + a specified native pixmap. + </p> + <p> + Attributes + <code class="constant">EGL_VG_ALPHA_FORMAT</code> and + <code class="constant">EGL_VG_COLORSPACE</code>, and the + corresponding attribute values, are supported only if the + EGL version is 1.2 or greater. + </p> + <p> + The <code class="constant">EGL_VG_ALPHA_FORMAT</code> and + <code class="constant">EGL_VG_COLORSPACE</code> 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 + <code class="constant">EGL_VG_ALPHA_FORMAT</code>. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_NO_SURFACE</code> is returned if creation of + the context fails. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONFIG</code> is generated if + <em class="parameter"><code>config</code></em> is not an EGL config. + </p> + <p> + <code class="constant">EGL_BAD_NATIVE_PIXMAP</code> may be generated if + <em class="parameter"><code>native_pixmap</code></em> is not a valid native pixmap. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains an invalid pixmap attribute + or if an attribute value is not recognized or out of range. + </p> + <p> + <code class="constant">EGL_BAD_ALLOC</code> is generated if there are not + enough resources to allocate the new surface. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the attributes of + <em class="parameter"><code>native_pixmap</code></em> do not correspond to + <em class="parameter"><code>config</code></em> or if + <em class="parameter"><code>config</code></em> does not support rendering to pixmaps + (the <code class="constant">EGL_SURFACE_TYPE</code> attribute does not contain + <code class="constant">EGL_PIXMAP_BIT</code>). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>config</code></em> does not support the specified + OpenVG alpha format attribute (the value of + <code class="constant">EGL_VG_ALPHA_FORMAT</code> is + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code> and the + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE_BIT</code> is not set + in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em>) or colorspace attribute (the + value of <code class="constant">EGL_VG_COLORSPACE</code> is + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code> and the + <code class="constant">EGL_VG_COLORSPACE_LINEAR_IT</code> is not set + in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em>). + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglDestroySurface.html"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreateWindowSurface.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreateWindowSurface.html new file mode 100644 index 0000000..12daff3 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglCreateWindowSurface.html @@ -0,0 +1,512 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglCreateWindowSurface</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglCreateWindowSurface"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglCreateWindowSurface</h1> + <p> + create a new <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> window surface + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLSurface <strong class="fsfunc">eglCreateWindowSurface</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLConfig <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">config</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>NativeWindowType <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">native_window</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint const * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attrib_list</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL frame buffer configuration that defines the + frame buffer resource available to the surface.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>native_window</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the native window.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attrib_list</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies window surface attributes. + May be <code class="constant">NULL</code> or empty + (first attribute is <code class="constant">EGL_NONE</code>). + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglCreateWindowSurface</code> creates an EGL + window surface and returns its handle. If + <code class="function">eglCreateWindowSurface</code> fails to create + a window surface, <code class="constant">EGL_NO_SURFACE</code> is + returned. + </p> + <p> + Surface attributes are specified as a list of + attribute-value pairs, terminated with + <code class="constant">EGL_NONE</code>. Accepted attributes + are: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_RENDER_BUFFER</code> + </span> + </dt> + <dd> + <p> + Specifies which buffer should be used for client API + rendering to the window. If its value is + <code class="constant">EGL_SINGLE_BUFFER</code>, then client + APIs should render directly into the visible window. + If its value is + <code class="constant">EGL_BACK_BUFFER</code>, then client + APIs should render into the back buffer. The default + value of <code class="constant">EGL_RENDER_BUFFER</code> is + <code class="constant">EGL_BACK_BUFFER</code>. + </p> + <p> + Client APIs may not be able to respect the requested + rendering buffer. To determine the actual buffer + being rendered to by a context, call + <a class="citerefentry" href="eglQueryContext.html"><span class="citerefentry"><span class="refentrytitle">eglQueryContext</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_ALPHA_FORMAT</code> + </span> + </dt> + <dd> + <p> + Specifies how alpha values are interpreted by OpenVG + when rendering to the surface. If its value is + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>, + then alpha values are not premultipled. If its value + is <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code>, + then alpha values are premultiplied. The default + value of <code class="constant">EGL_VG_ALPHA_FORMAT</code> is + <code class="constant">EGL_VG_ALPHA_FORMAT_NONPRE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VG_COLORSPACE</code> + </span> + </dt> + <dd> + <p> + Specifies the color space used by OpenVG when + rendering to the surface. If its value is + <code class="constant">EGL_VG_COLORSPACE_sRGB</code>, then a + non-linear, perceptually uniform color space is + assumed, with a corresponding + <span class="type">VGImageFormat</span> of form + <code class="constant">VG_s*</code>. If its value is + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code>, then + a linear color space is assumed, with a + corresponding <span class="type">VGImageFormat</span> of form + <code class="constant">VG_l*</code>. The default value of + <code class="constant">EGL_VG_COLORSPACE</code> is + <code class="constant">EGL_VG_COLORSPACE_sRGB</code>. + </p> + </dd> + </dl> + </div> + <p> + Any EGL rendering context that was created with respect to + <em class="parameter"><code>config</code></em> can be used to render into the + surface. Use + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + to attach an EGL rendering context to the surface. + </p> + <p> + Use + <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + to retrieve the ID of <em class="parameter"><code>config</code></em>. + </p> + <p> + Use + <a class="citerefentry" href="eglDestroySurface.html"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a> + to destroy the surface. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + Attributes <code class="constant">EGL_RENDER_BUFFER</code>, + <code class="constant">EGL_VG_ALPHA_FORMAT</code>, and + <code class="constant">EGL_VG_COLORSPACE</code>, and the + corresponding attribute values, are supported only if the + EGL version is 1.2 or greater. + </p> + <p> + The <code class="constant">EGL_VG_ALPHA_FORMAT</code> and + <code class="constant">EGL_VG_COLORSPACE</code> 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 + <code class="constant">EGL_VG_ALPHA_FORMAT</code> when compositing + window surfaces. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_NO_SURFACE</code> is returned if creation of + the context fails. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONFIG</code> is generated if + <em class="parameter"><code>config</code></em> is not an EGL frame buffer configuration. + </p> + <p> + <code class="constant">EGL_BAD_NATIVE_WINDOW</code> may be generated if + <em class="parameter"><code>native_window</code></em> is not a valid native window. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attrib_list</code></em> contains an invalid window attribute + or if an attribute value is not recognized or is out of range. + </p> + <p> + <code class="constant">EGL_BAD_ALLOC</code> is generated if there are not + enough resources to allocate the new surface. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the attributes of + <em class="parameter"><code>native_window</code></em> do not correspond to + <em class="parameter"><code>config</code></em> or if + <em class="parameter"><code>config</code></em> does not support rendering to windows + (the <code class="constant">EGL_SURFACE_TYPE</code> attribute does not contain + <code class="constant">EGL_WINDOW_BIT</code>). + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>config</code></em> does not support the specified + OpenVG alpha format attribute (the value of + <code class="constant">EGL_VG_ALPHA_FORMAT</code> is + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE</code> and the + <code class="constant">EGL_VG_ALPHA_FORMAT_PRE_BIT</code> is not set + in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em>) or colorspace attribute (the + value of <code class="constant">EGL_VG_COLORSPACE</code> is + <code class="constant">EGL_VG_COLORSPACE_LINEAR</code> and the + <code class="constant">EGL_VG_COLORSPACE_LINEAR_IT</code> is not set + in the <code class="constant">EGL_SURFACE_TYPE</code> attribute of + <em class="parameter"><code>config</code></em>). + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglDestroySurface.html"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglDestroyContext.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglDestroyContext.html new file mode 100644 index 0000000..b7be78e --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglDestroyContext.html @@ -0,0 +1,327 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglDestroyContext</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglDestroyContext"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglDestroyContext</h1> + <p> + destroy an <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> rendering context + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglDestroyContext</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLContext <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">context</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>context</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL rendering context to be destroyed. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + If the EGL rendering context <em class="parameter"><code>context</code></em> is not + current to any thread, + <code class="function">eglDestroyContext</code> destroys it immediately. + Otherwise, <em class="parameter"><code>context</code></em> is destroyed when it becomes + not current to any thread. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if destruction of + the context fails, <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONTEXT</code> is generated if + <em class="parameter"><code>context</code></em> is not an EGL rendering context. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglDestroySurface.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglDestroySurface.html new file mode 100644 index 0000000..c2b6a96 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglDestroySurface.html @@ -0,0 +1,329 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglDestroySurface</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglDestroySurface"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglDestroySurface</h1> + <p> + destroy an <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> surface + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglDestroySurface</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLSurface <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">surface</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL surface to be destroyed. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + If the EGL surface <em class="parameter"><code>surface</code></em> is not current to any + thread, <code class="function">eglDestroySurface</code> destroys it immediately. + Otherwise, <em class="parameter"><code>surface</code></em> 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. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if destruction of + the surface fails, <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL surface. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetConfigAttrib.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetConfigAttrib.html new file mode 100644 index 0000000..376550a --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetConfigAttrib.html @@ -0,0 +1,715 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglGetConfigAttrib</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglGetConfigAttrib"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglGetConfigAttrib</h1> + <p> + return information about an <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> frame buffer + configuration + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglGetConfigAttrib</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLConfig <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">config</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attribute</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">value</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL frame buffer configuration to be + queried. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attribute</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL rendering context attribute to be + returned.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>value</code> + </em> + </span> + </dt> + <dd> + <p>Returns the requested value.</p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglGetConfigAttrib</code> returns in + <em class="parameter"><code>value</code></em> the value of + <em class="parameter"><code>attribute</code></em> for + <em class="parameter"><code>config</code></em> + (config attributes are described in more detail in the + <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a> + reference page). + <em class="parameter"><code>attribute</code></em> can be one of the following: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_ALPHA_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the number of bits of alpha stored in the + color buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_ALPHA_MASK_SIZE</code> + </span> + </dt> + <dd> + <p> + Returns the number of bits in the alpha mask buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BIND_TO_TEXTURE_RGB</code> + </span> + </dt> + <dd> + <p>Returns <code class="constant">EGL_TRUE</code> if color buffers can be + bound to an RGB texture, + <code class="constant">EGL_FALSE</code> otherwise. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BIND_TO_TEXTURE_RGBA</code> + </span> + </dt> + <dd> + <p>Returns <code class="constant">EGL_TRUE</code> if color buffers can be + bound to an RGBA texture, + <code class="constant">EGL_FALSE</code> otherwise. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BLUE_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the number of bits of blue stored in the + color buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BUFFER_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the depth of the color buffer. + It is the sum of + <code class="constant">EGL_RED_SIZE</code>, + <code class="constant">EGL_GREEN_SIZE</code>, + <code class="constant">EGL_BLUE_SIZE</code>, and + <code class="constant">EGL_ALPHA_SIZE</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_COLOR_BUFFER_TYPE</code> + </span> + </dt> + <dd> + <p> + Returns the color buffer type. Possible types are + <code class="constant">EGL_RGB_BUFFER</code> and + <code class="constant">EGL_LUMINANCE_BUFFER</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_CAVEAT</code> + </span> + </dt> + <dd> + <p>Returns the caveats for the frame buffer configuration. + Possible caveat values are + <code class="constant">EGL_NONE</code>, + <code class="constant">EGL_SLOW_CONFIG</code>, and + <code class="constant">EGL_NON_CONFORMANT</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_ID</code> + </span> + </dt> + <dd> + <p>Returns the ID of the frame buffer configuration. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONFORMANT</code> + </span> + </dt> + <dd> + <p> + Returns a bitmask indicating which client API contexts + created with respect to this config are conformant. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_DEPTH_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the number of bits in the depth buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_GREEN_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the number of bits of green stored in the + color buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LEVEL</code> + </span> + </dt> + <dd> + <p>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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LUMINANCE_SIZE</code> + </span> + </dt> + <dd> + <p> + Returns the number of bits of luminance stored in the luminance buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MAX_PBUFFER_WIDTH</code> + </span> + </dt> + <dd> + <p>Returns the maximum width of a pixel buffer surface in pixels. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MAX_PBUFFER_HEIGHT</code> + </span> + </dt> + <dd> + <p>Returns the maximum height of a pixel buffer surface in pixels. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MAX_PBUFFER_PIXELS</code> + </span> + </dt> + <dd> + <p>Returns the maximum size of a pixel buffer surface in pixels. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MAX_SWAP_INTERVAL</code> + </span> + </dt> + <dd> + <p>Returns the maximum value that can be passed to eglSwapInterval. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MIN_SWAP_INTERVAL</code> + </span> + </dt> + <dd> + <p>Returns the minimum value that can be passed to eglSwapInterval. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_NATIVE_RENDERABLE</code> + </span> + </dt> + <dd> + <p>Returns <code class="constant">EGL_TRUE</code> if native rendering + APIs can render into the surface, + <code class="constant">EGL_FALSE</code> otherwise. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_NATIVE_VISUAL_ID</code> + </span> + </dt> + <dd> + <p>Returns the ID of the associated native visual. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_NATIVE_VISUAL_TYPE</code> + </span> + </dt> + <dd> + <p>Returns the type of the associated native visual. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RED_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the number of bits of red stored in the + color buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RENDERABLE_TYPE</code> + </span> + </dt> + <dd> + <p> + Returns a bitmask indicating the types of supported + client API contexts. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SAMPLE_BUFFERS</code> + </span> + </dt> + <dd> + <p>Returns the number of multisample buffers. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SAMPLES</code> + </span> + </dt> + <dd> + <p>Returns the number of samples per pixel.</p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_STENCIL_SIZE</code> + </span> + </dt> + <dd> + <p>Returns the number of bits in the stencil buffer. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SURFACE_TYPE</code> + </span> + </dt> + <dd> + <p> + Returns a bitmask indicating the types of supported EGL + surfaces. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_TYPE</code> + </span> + </dt> + <dd> + <p>Returns the type of supported transparency. + Possible transparency values are: + <code class="constant">EGL_NONE</code>, and + <code class="constant">EGL_TRANSPARENT_RGB</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_RED_VALUE</code> + </span> + </dt> + <dd> + <p>Returns the transparent red value.</p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_GREEN_VALUE</code> + </span> + </dt> + <dd> + <p>Returns the transparent green value.</p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TRANSPARENT_BLUE_VALUE</code> + </span> + </dt> + <dd> + <p>Returns the transparent blue value.</p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + <code class="constant">EGL_CONFORMANT</code> is supported only if the + EGL version is 1.3 or greater. + </p> + <p> + <code class="constant">EGL_ALPHA_MASK_SIZE</code>, + <code class="constant">EGL_COLOR_BUFFER_TYPE</code>, + <code class="constant">EGL_LUMINANCE_SIZE</code>, and + <code class="constant">EGL_RENDERABLE_TYPE</code> are supported only + if the EGL version is 1.2 or greater. + </p> + <p> + While <code class="constant">EGL_MATCH_NATIVE_PIXMAP</code> can be + specified in the attribute list passed to + <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + it is not an attribute of the resulting config and cannot be + queried using <code class="function">eglGetConfigAttrib</code>. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>value</code></em> is not modified when + <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONFIG</code> is generated if + <em class="parameter"><code>config</code></em> is not an EGL frame buffer configuration. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attribute</code></em> is not a valid frame buffer + configuration attribute. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetConfigs.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetConfigs.html new file mode 100644 index 0000000..41967e6 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetConfigs.html @@ -0,0 +1,375 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglGetConfigs</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglGetConfigs"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglGetConfigs</h1> + <p> + return a list of all <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> frame buffer configurations + for a display + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglGetConfigs</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLConfig * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">configs</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">config_size</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_config</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>configs</code> + </em> + </span> + </dt> + <dd> + <p>Returns a list of configs.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>config_size</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the size of the list of configs. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>num_config</code> + </em> + </span> + </dt> + <dd> + <p>Returns the number of configs returned. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglGetConfigs</code> 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. + </p> + <p> + <em class="parameter"><code>configs</code></em> does not return values, if it is specified + as + <code class="constant">NULL</code>. This is useful for querying just the + number of all frame buffer configurations. + </p> + <p> + Use + <a class="citerefentry" href="eglGetConfigAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a> + to retrieve individual attribute values of a frame buffer configuration. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>configs</code></em> and <em class="parameter"><code>num_config</code></em> + are not modified when + <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_PARAMETER</code> is generated if + <em class="parameter"><code>num_config</code></em> is <code class="constant">NULL</code>. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglGetConfigAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetCurrentContext.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetCurrentContext.html new file mode 100644 index 0000000..51f8dac --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetCurrentContext.html @@ -0,0 +1,274 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglGetCurrentContext</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglGetCurrentContext"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglGetCurrentContext</h1> + <p> + return the current <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> rendering context + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLContext <strong class="fsfunc">eglGetCurrentContext</strong>(</code> + <td xmlns="http://www.w3.org/1999/xhtml"><code>void)</code>;</td> + <td xmlns="http://www.w3.org/1999/xhtml"> </td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglGetCurrentContext</code> returns the current + <acronym class="acronym">EGL</acronym> rendering context, as specified by + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>. + If no context is current, <code class="constant">EGL_NO_CONTEXT</code> is returned. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetCurrentDisplay.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetCurrentDisplay.html new file mode 100644 index 0000000..42676c1 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetCurrentDisplay.html @@ -0,0 +1,275 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglGetCurrentDisplay</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglGetCurrentDisplay"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglGetCurrentDisplay</h1> + <p> + return the display for the current <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> rendering context + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLDisplay <strong class="fsfunc">eglGetCurrentDisplay</strong>(</code> + <td xmlns="http://www.w3.org/1999/xhtml"><code>void)</code>;</td> + <td xmlns="http://www.w3.org/1999/xhtml"> </td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglGetCurrentDisplay</code> returns the current + <acronym class="acronym">EGL</acronym> display connection for the current + <acronym class="acronym">EGL</acronym> rendering context, as specified by + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>. + If no context is current, <code class="constant">EGL_NO_DISPLAY</code> is returned. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglGetDisplay.html"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>, + <a class="citerefentry" href="eglInitialize.html"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetCurrentSurface.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetCurrentSurface.html new file mode 100644 index 0000000..feeacf3 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetCurrentSurface.html @@ -0,0 +1,296 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglGetCurrentSurface</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglGetCurrentSurface"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglGetCurrentSurface</h1> + <p> + return the read or draw surface for the current <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> rendering context + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLSurface <strong class="fsfunc">eglGetCurrentSurface</strong>(</code> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">readdraw</var><code>)</code></td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>readdraw</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies whether the <acronym class="acronym">EGL</acronym> read or draw surface + is to be returned. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglGetCurrentSurface</code> returns the read or draw + surface attached to the current + <acronym class="acronym">EGL</acronym> rendering context, as specified by + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>. + If no context is current, <code class="constant">EGL_NO_SURFACE</code> is returned. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetDisplay.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetDisplay.html new file mode 100644 index 0000000..5494aa2 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetDisplay.html @@ -0,0 +1,305 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglGetDisplay</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglGetDisplay"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglGetDisplay</h1> + <p> + return an <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> display connection + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLDisplay <strong class="fsfunc">eglGetDisplay</strong>(</code> + <td>NativeDisplayType <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">native_display</var><code>)</code></td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>native_display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the display to connect to. + <code class="constant">EGL_DEFAULT_DISPLAY</code> indicates the default display. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglGetDisplay</code> obtains the + <acronym class="acronym">EGL</acronym> display connection for the native + display <em class="parameter"><code>native_display</code></em>. + </p> + <p> + If <em class="parameter"><code>display_id</code></em> is + <code class="constant">EGL_DEFAULT_DISPLAY</code>, a default display connection is returned. + </p> + <p> + If no display connection matching <em class="parameter"><code>native_display</code></em> is + available, <code class="constant">EGL_NO_DISPLAY</code> is returned. No + error is generated. + </p> + <p> + Use <a class="citerefentry" href="eglInitialize.html"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a> + to initialize the display connection. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglInitialize.html"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetError.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetError.html new file mode 100644 index 0000000..7d81645 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetError.html @@ -0,0 +1,430 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglGetError</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglGetError"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglGetError</h1> + <p> + return error information + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLint <strong class="fsfunc">eglGetError</strong>(</code> + <td xmlns="http://www.w3.org/1999/xhtml"><code>void)</code>;</td> + <td xmlns="http://www.w3.org/1999/xhtml"> </td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglGetError</code> returns the error of the last + called <acronym class="acronym">EGL</acronym> function in the current thread. + Initially, the error is set to <code class="constant">EGL_SUCCESS</code>. + </p> + <p> + The following errors are currently defined: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_SUCCESS</code> + </span> + </dt> + <dd> + <p>The last function succeeded without error. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_NOT_INITIALIZED</code> + </span> + </dt> + <dd> + <p>EGL is not initialized, or could not be initialized, + for the specified EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_ACCESS</code> + </span> + </dt> + <dd> + <p>EGL cannot access a requested resource + (for example a context is bound in another thread). + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_ALLOC</code> + </span> + </dt> + <dd> + <p>EGL failed to allocate resources for the requested + operation.</p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_ATTRIBUTE</code> + </span> + </dt> + <dd> + <p>An unrecognized attribute or attribute value was + passed in the attribute list. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_CONTEXT</code> + </span> + </dt> + <dd> + <p>An <span class="type">EGLContext</span> argument does not name a + valid EGL rendering context. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_CONFIG</code> + </span> + </dt> + <dd> + <p> + An <span class="type">EGLConfig</span> argument does not name a valid + EGL frame buffer configuration. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_CURRENT_SURFACE</code> + </span> + </dt> + <dd> + <p>The current surface of the calling thread is a window, + pixel buffer or pixmap that is no longer valid. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_DISPLAY</code> + </span> + </dt> + <dd> + <p>An <span class="type">EGLDisplay</span> argument does not name a + valid EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_SURFACE</code> + </span> + </dt> + <dd> + <p>An <span class="type">EGLSurface</span> argument does not name a + valid surface (window, pixel buffer or pixmap) configured for + GL rendering. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_MATCH</code> + </span> + </dt> + <dd> + <p>Arguments are inconsistent (for example, a valid + context requires buffers not supplied by a valid surface). + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_PARAMETER</code> + </span> + </dt> + <dd> + <p>One or more argument values are invalid.</p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_NATIVE_PIXMAP</code> + </span> + </dt> + <dd> + <p> + A <span class="type">NativePixmapType</span> argument does not refer to + a valid native pixmap. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_BAD_NATIVE_WINDOW</code> + </span> + </dt> + <dd> + <p>A <span class="type">NativeWindowType</span> argument does not refer + to a valid native window. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_LOST</code> + </span> + </dt> + <dd> + <p> + A power management event has occurred. The application must destroy all + contexts and reinitialise OpenGL ES state and objects to continue rendering. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + A call to <code class="function">eglGetError</code> sets the error to + <code class="constant">EGL_SUCCESS</code>. + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetProcAddress.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetProcAddress.html new file mode 100644 index 0000000..ab2c27d --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglGetProcAddress.html @@ -0,0 +1,316 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglGetProcAddress</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglGetProcAddress"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglGetProcAddress</h1> + <p> + return a <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">GL</acronym> or an <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> + extension function + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">void (* <strong class="fsfunc">eglGetProcAddress</strong>)()(</code> + <td>char const * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">procname</var><code>)</code></td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>procname</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the name of the function to return. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglGetProcAddress</code> returns the address of + the extension function named by <em class="parameter"><code>procname</code></em>. + <em class="parameter"><code>procname</code></em> + 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 <code class="constant">NULL</code> indicates that the specific + function does not exist for the <acronym class="acronym">EGL</acronym> implementation. + </p> + <p> + A non-<code class="constant">NULL</code> return value does not guarantee + that an extension function is actually supported at runtime. The client + must also query + <a class="citerefentry" href="glGetString.html"><span class="citerefentry"><span class="refentrytitle">glGetString</span></span></a>(<code class="constant">GL_EXTENSIONS</code>) or + <a class="citerefentry" href="eglQueryString.html"><span class="citerefentry"><span class="refentrytitle">eglQueryString</span></span></a>(<em class="parameter"><code>display</code></em>, + <code class="constant">EGL_EXTENSIONS</code>) to determine if an + extension is supported by a particular context or display. + </p> + <p> + Function pointers returned by + <code class="function">eglGetProcAddress</code> are independent of the + display and the currently bound context and may be used by any context + which supports the extension. + </p> + <p> + <code class="function">eglGetProcAddress</code> may be queried for all + <acronym class="acronym">GL</acronym> and <acronym class="acronym">EGL</acronym> extension functions. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="glGetString.html"><span class="citerefentry"><span class="refentrytitle">glGetString</span></span></a>, + <a class="citerefentry" href="eglQueryString.html"><span class="citerefentry"><span class="refentrytitle">eglQueryString</span></span></a> </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglInitialize.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglInitialize.html new file mode 100644 index 0000000..0f6b378 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglInitialize.html @@ -0,0 +1,355 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglInitialize</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglInitialize"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglInitialize</h1> + <p> + initialize an <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> display connection + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglInitialize</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">major</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">minor</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection to initialize. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>major</code> + </em> + </span> + </dt> + <dd> + <p> + Returns the major version number of the EGL implementation. + May be <code class="constant">NULL</code>. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>minor</code> + </em> + </span> + </dt> + <dd> + <p> + Returns the minor version number of the EGL implementation. + May be <code class="constant">NULL</code>. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglInitialize</code> initialized the EGL display + connection obtained with + <a class="citerefentry" href="eglGetDisplay.html"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>. + Initializing an already initialized EGL display connection has no + effect besides returning the version numbers. + </p> + <p> + <em class="parameter"><code>major</code></em> and <em class="parameter"><code>minor</code></em> + do not return values if they are specified as <code class="constant">NULL</code>. + </p> + <p> + Use <a class="citerefentry" href="eglTerminate.html"><span class="citerefentry"><span class="refentrytitle">eglTerminate</span></span></a> + to release resources associated with an EGL display connection. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if + <code class="function">eglInitialize</code> fails, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>major</code></em> and <em class="parameter"><code>minor</code></em> are not + modified when <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> cannot be initialized. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglGetDisplay.html"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>, + <a class="citerefentry" href="eglTerminate.html"><span class="citerefentry"><span class="refentrytitle">eglTerminate</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglIntro.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglIntro.html new file mode 100644 index 0000000..4ef078e --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglIntro.html @@ -0,0 +1,492 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglIntro</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglIntro"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglIntro</h1> + <p> + introduction to managing client API rendering through the + <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> API. + </p> + </div> + <div class="refsect1"> + <a id="overview"></a> + <h2>Overview</h2> + <p> + The <em class="firstterm">Khronos Native Platform Graphics + Interface</em> (EGL) provides a means for rendering + using a <em class="firstterm">client API</em> 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. + </p> + <p> + 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 + <a class="citerefentry" href="eglGetDisplay.html"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a> + and passing in a native display handle or + <code class="constant">EGL_DEFAULT_DISPLAY</code>. To initialize and + query what EGL version is supported on the display + connection, call + <a class="citerefentry" href="eglInitialize.html"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>. + </p> + <p> + 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. + </p> + <p> + An EGL <em class="firstterm">surface</em> extends a native + window or pixmap with additional <em class="firstterm">auxillary + buffers</em>. 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. + </p> + <p> + 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. + </p> + <p> + 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. + <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a> + returns an <span class="type">EGLConfig</span> matching the required + attributes, if any. A complete list of EGL frame buffer + configurations can be obtained by calling + <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>. + Attributes of a particular EGL frame buffer configuration + can be queried by calling + <a class="citerefentry" href="eglGetConfigAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a>. + </p> + <p> + 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 + <a class="citerefentry" href="eglGetConfigAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a>. + For pixel buffers, no underlying native resource is + required. + </p> + <p> + To create an EGL window surface from a native window, call + <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>. + To create an EGL pixmap surface from a native pixmap, call + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>. + To create a pixel buffer (pbuffer) surface (which has no + associated native buffer), call + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a> + To create a pixel buffer (pbuffer) surface whose color + buffer is provided by an OpenVG <span class="type">VGImage</span>, call + <a class="citerefentry" href="eglCreatePbufferFromClientBuffer.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferFromClientBuffer</span></span></a>. + Use + <a class="citerefentry" href="eglDestroySurface.html"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a> + to release previously allocated resources. + </p> + <p> + 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 + <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>. + The type of client API context created (OpenGL ES, OpenVG, + etc.) can be changed by first calling + <a class="citerefentry" href="eglBindAPI.html"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>. + </p> + <p> + An EGL rendering context may be bound to one or two EGL + surfaces by calling + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>. + This context/surface(s) association specifies the + <em class="firstterm">current context</em> and + <em class="firstterm">current surface</em>, and is used by all + client API rendering commands for the bound context until + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + is called with different arguments. + </p> + <p> + 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 + <a class="citerefentry" href="eglWaitCLient.html"><span class="citerefentry"><span class="refentrytitle">eglWaitCLient</span></span></a>, + <a class="citerefentry" href="eglWaitNative.html"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a>, + and possibly by calling other native window system commands. + </p> + </div> + <div class="refsect1"> + <a id="examples"></a> + <h2>Examples</h2> + <p> + 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. + </p> + <pre class="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; +} +</pre> + </div> + <div class="refsect1"> + <a id="usingeglextensions"></a> + <h2>Using EGL Extensions</h2> + <p> + All supported EGL extensions will have a corresponding definition in + <code class="filename">egl.h</code> and a token in the extensions string returned + by + <a class="citerefentry" href="eglQueryString.html"><span class="citerefentry"><span class="refentrytitle">eglQueryString</span></span></a>. + </p> + </div> + <div class="refsect1"> + <a id="futureeglversions"></a> + <h2>Future EGL Versions</h2> + <p> + <a class="citerefentry" href="eglInitialize.html"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a> + and + <a class="citerefentry" href="eglQueryString.html"><span class="citerefentry"><span class="refentrytitle">eglQueryString</span></span></a> + can be used to determine at run-time what version of EGL is available. + To check the EGL version at compile-time, test whether + <code class="constant">EGL_VERSION_<em class="replaceable"><code>x</code></em>_<em class="replaceable"><code>y</code></em></code> + is defined, where <em class="replaceable"><code>x</code></em> and + <em class="replaceable"><code>y</code></em> are the major and minor version + numbers. + </p> + </div> + <div class="refsect1"> + <a id="files"></a> + <h2>Files</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="filename">GLES/egl.h</code> + </span> + </dt> + <dd> + <p> + EGL header file + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + + <a class="citerefentry" href="eglBindAPI.html"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, + <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, + <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferFromClientBuffer.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferFromClientBuffer</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglDestroyContext.html"><span class="citerefentry"><span class="refentrytitle">eglDestroyContext</span></span></a>, + <a class="citerefentry" href="eglDestroySurface.html"><span class="citerefentry"><span class="refentrytitle">eglDestroySurface</span></span></a>, + <a class="citerefentry" href="eglGetConfigs.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigs</span></span></a>, + <a class="citerefentry" href="eglGetDisplay.html"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>, + <a class="citerefentry" href="eglInitialize.html"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglQueryString.html"><span class="citerefentry"><span class="refentrytitle">eglQueryString</span></span></a>, + <a class="citerefentry" href="eglSwapBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a>, + <a class="citerefentry" href="eglTerminate.html"><span class="citerefentry"><span class="refentrytitle">eglTerminate</span></span></a>, + <a class="citerefentry" href="eglWaitGL.html"><span class="citerefentry"><span class="refentrytitle">eglWaitGL</span></span></a>, + <a class="citerefentry" href="eglWaitNative.html"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglMakeCurrent.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglMakeCurrent.html new file mode 100644 index 0000000..e198962 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglMakeCurrent.html @@ -0,0 +1,456 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglMakeCurrent</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglMakeCurrent"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglMakeCurrent</h1> + <p> + attach an EGL rendering context to EGL surfaces + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglMakeCurrent</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLSurface <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">draw</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLSurface <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">read</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLContext <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">context</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the <acronym class="acronym">EGL</acronym> display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>draw</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the <acronym class="acronym">EGL</acronym> draw surface.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>read</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the <acronym class="acronym">EGL</acronym> read surface.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>context</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the <acronym class="acronym">EGL</acronym> rendering context + to be attached to the surfaces. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglMakeCurrent</code> binds <em class="parameter"><code>context</code></em> + to the current rendering thread and to the <em class="parameter"><code>draw</code></em> + and <em class="parameter"><code>read</code></em> surfaces. <em class="parameter"><code>draw</code></em> + is used for all GL operations except for any pixel data read back + (<a class="citerefentry" href="glReadPixels.html"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>, + <a class="citerefentry" href="glCopyTexImage2D.html"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>, and + <a class="citerefentry" href="glCopyTexSubImage2D.html"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>), + which is taken from the frame buffer values of + <em class="parameter"><code>read</code></em>. + </p> + <p> + If the calling thread has already a current rendering context, that + context is flushed and marked as no longer current. + </p> + <p> + The first time that <em class="parameter"><code>context</code></em> is made current, + the viewport and scissor dimensions are set to the size of the + <em class="parameter"><code>draw</code></em> surface. The viewport and + scissor are not modified when <em class="parameter"><code>context</code></em> is + subsequently made current. + </p> + <p> + To release the current context without assigning a new one, call + <code class="function">eglMakeCurrent</code> with <em class="parameter"><code>draw</code></em> + and <em class="parameter"><code>read</code></em> set to + <code class="constant">EGL_NO_SURFACE</code> and <em class="parameter"><code>context</code></em> + set to <code class="constant">EGL_NO_CONTEXT</code>. + </p> + <p> + Use + <a class="citerefentry" href="eglGetCurrentContext.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentDisplay.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentDisplay</span></span></a>, and + <a class="citerefentry" href="eglGetCurrentSurface.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentSurface</span></span></a> + to query the current rendering context and associated display connection and surfaces. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. If <code class="constant">EGL_FALSE</code> + is returned, the previously current rendering context and + surfaces (if any) remain unchanged. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>draw</code></em> or <em class="parameter"><code>read</code></em> is not an + EGL surface. + </p> + <p> + <code class="constant">EGL_BAD_CONTEXT</code> is generated if + <em class="parameter"><code>context</code></em> is not an EGL rendering context. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>draw</code></em> or + <em class="parameter"><code>read</code></em> + are not compatible with + <em class="parameter"><code>context</code></em>, or if + <em class="parameter"><code>context</code></em> is set to + <code class="constant">EGL_NO_CONTEXT</code> and + <em class="parameter"><code>draw</code></em> or + <em class="parameter"><code>read</code></em> + are not set to + <code class="constant">EGL_NO_SURFACE</code>, or if + <em class="parameter"><code>draw</code></em> or + <em class="parameter"><code>read</code></em> are set to + <code class="constant">EGL_NO_SURFACE</code> and + <em class="parameter"><code>context</code></em> is not set to + <code class="constant">EGL_NO_CONTEXT</code>. + </p> + <p> + <code class="constant">EGL_BAD_ACCESS</code> is generated if + <em class="parameter"><code>context</code></em> + is current to some other thread. + </p> + <p> + <code class="constant">EGL_BAD_NATIVE_PIXMAP</code> may be generated if + a native pixmap underlying either + <em class="parameter"><code>draw</code></em> or + <em class="parameter"><code>read</code></em> + is no longer valid. + </p> + <p> + <code class="constant">EGL_BAD_NATIVE_WINDOW</code> may be generated if + a native window underlying either + <em class="parameter"><code>draw</code></em> or + <em class="parameter"><code>read</code></em> + is no longer valid. + </p> + <p> + <code class="constant">EGL_BAD_CURRENT_SURFACE</code> is generated if + the previous context has unflushed commands and the previous surface + is no longer valid. + </p> + <p> + <code class="constant">EGL_BAD_ALLOC</code> may be generated if + allocation of ancillary buffers for <em class="parameter"><code>draw</code></em> or + <em class="parameter"><code>read</code></em> were delayed until + <code class="function">eglMakeCurrent</code> is called, and there are not + enough resources to allocate them. + </p> + <p> + <code class="constant">EGL_CONTEXT_LOST</code> 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. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="glReadPixels.html"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>, + <a class="citerefentry" href="glCopyTexImage2D.html"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>, + <a class="citerefentry" href="glCopyTexSubImage2D.html"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>, + <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglGetCurrentContext.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentDisplay.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentDisplay</span></span></a>, + <a class="citerefentry" href="eglGetCurrentSurface.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentSurface</span></span></a>, + <a class="citerefentry" href="eglGetDisplay.html"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>, + <a class="citerefentry" href="eglInitialize.html"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQueryAPI.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQueryAPI.html new file mode 100644 index 0000000..fd1b923 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQueryAPI.html @@ -0,0 +1,313 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglQueryAPI</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglQueryAPI"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglQueryAPI</h1> + <p>Query the current rendering API</p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLenum <strong class="fsfunc">eglQueryAPI</strong>(</code> + <td xmlns="http://www.w3.org/1999/xhtml"><code>void)</code>;</td> + <td xmlns="http://www.w3.org/1999/xhtml"> </td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglQueryAPI</code> returns the value of the + current rendering API for EGL in the thread it is called + from. The current rendering API is set by + <a class="citerefentry" href="eglBindAPI.html"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, + and affects the behavior of other EGL commands. + </p> + <p> + The value returned will be one of the valid + <em class="parameter"><code>api</code></em> parameters to + <a class="citerefentry" href="eglBindAPI.html"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, or + <code class="constant">EGL_NONE</code>. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + <code class="function">eglQueryAPI</code> is supported only if the + EGL version is 1.2 or greater. + </p> + <p> + The initial value of the current rendering API is + <code class="constant">EGL_OPENGL_ES_API</code> unless OpenGL ES is + not supported by an implementation, in which case the + initial value is <code class="constant">EGL_NONE</code> (however, + <code class="constant">EGL_NONE</code> is not a valid + <em class="parameter"><code>api</code></em> parameter to + <code class="function">eglQueryAPI</code>). + </p> + <p> + The current rendering API can be changed by calling + <a class="citerefentry" href="eglBindAPI.html"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + None. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglBindAPI.html"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, + <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentContext.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentContext</span></span></a>, + <a class="citerefentry" href="eglGetCurrentDisplay.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentDisplay</span></span></a>, + <a class="citerefentry" href="eglGetCurrentSurface.html"><span class="citerefentry"><span class="refentrytitle">eglGetCurrentSurface</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>, + <a class="citerefentry" href="eglWaitClient.html"><span class="citerefentry"><span class="refentrytitle">eglWaitClient</span></span></a>, + <a class="citerefentry" href="eglWaitNative.html"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQueryContext.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQueryContext.html new file mode 100644 index 0000000..d956c53 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQueryContext.html @@ -0,0 +1,474 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglQueryContext</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglQueryContext"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglQueryContext</h1> + <p> + return <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> rendering context information + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglQueryContext</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLContext <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">context</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attribute</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">value</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>context</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL rendering context to query. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attribute</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL rendering context attribute to be returned. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>value</code> + </em> + </span> + </dt> + <dd> + <p> + Returns the requested value. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglQueryContext</code> returns in + <em class="parameter"><code>value</code></em> the value of + <em class="parameter"><code>attribute</code></em> for <em class="parameter"><code>context</code></em>. + <em class="parameter"><code>attribute</code></em> can be one of the following: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_ID</code> + </span> + </dt> + <dd> + <p> + Returns the ID of the EGL frame buffer configuration + with respect to which the context was created. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_CLIENT_TYPE</code> + </span> + </dt> + <dd> + <p> + Returns the type of client API which the context + supports (one of + <code class="constant">EGL_OPENGL_API</code>, + <code class="constant">EGL_OPENGL_ES_API</code>, or + <code class="constant">EGL_OPENVG_API</code>). + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_CONTEXT_CLIENT_VERSION</code> + </span> + </dt> + <dd> + <p> + 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. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RENDER_BUFFER</code> + </span> + </dt> + <dd> + <p> + 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: + </p> + <div class="itemizedlist"> + <ul class="itemizedlist" style="list-style-type: disc; "> + <li class="listitem"> + <p> + If the context is bound to a pixmap surface, + then <code class="constant">EGL_SINGLE_BUFFER</code> will + be returned. + </p> + </li> + <li class="listitem"> + <p> + If the context is bound to a pbuffer surface, + then <code class="constant">EGL_BACK_BUFFER</code> will + be returned. + </p> + </li> + <li class="listitem"> + <p> + If the context is bound to a window surface, + then either <code class="constant">EGL_BACK_BUFFER</code> + or <code class="constant">EGL_SINGLE_BUFFER</code> may be + returned. The value returned depends on both the + buffer requested by the setting of the + <code class="constant">EGL_RENDER_BUFFER</code> property + of the surface (which may be queried by calling + <code class="function">eglQuerySurface</code>), and on + the client API (not all client APIs support + single-buffer rendering to window surfaces). + </p> + </li> + <li class="listitem"> + <p> + If the context is not bound to a surface, such + as an OpenGL ES context bound to a framebuffer + object, then <code class="constant">EGL_NONE</code> will + be returned. + </p> + </li> + </ul> + </div> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + Attributes <code class="constant">EGL_CONTEXT_CLIENT_TYPE</code> and + <code class="constant">EGL_RENDER_BUFFER</code> are supported only if + the EGL version is 1.2 or greater. + </p> + <p> + Attribute <code class="constant">EGL_CONTEXT_CLIENT_VERSION</code> is + supported only if the EGL version is 1.3 or greater. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>value</code></em> is not modified when + <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_CONTEXT</code> is generated if + <em class="parameter"><code>context</code></em> is not an EGL rendering context. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attribute</code></em> is not a valid context attribute. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQueryString.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQueryString.html new file mode 100644 index 0000000..5fdf82b --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQueryString.html @@ -0,0 +1,401 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglQueryString</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglQueryString"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglQueryString</h1> + <p> + return a string describing an <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> display connection + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">char const * <strong class="fsfunc">eglQueryString</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">name</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>name</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies a symbolic constant, one of + <code class="constant">EGL_CLIENT_APIS</code>, + <code class="constant">EGL_VENDOR</code>, + <code class="constant">EGL_VERSION</code>, or + <code class="constant">EGL_EXTENSIONS</code>. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglQueryString</code> returns a pointer to a + static string describing an EGL display connection. + <em class="parameter"><code>name</code></em> can be one of the following: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_CLIENT_APIS</code> + </span> + </dt> + <dd> + <p> + 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 class="code">OpenGL</code>, + <code class="code">OpenGL_ES</code>, or <code class="code">OpenVG</code>. + These strings correspond respectively to values + <code class="constant">EGL_OPENGL_API</code>, + <code class="constant">EGL_OPENGL_ES_API</code>, and + <code class="constant">EGL_OPENVG_API</code> of the + <a class="citerefentry" href="eglBindAPI.html"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, + <em class="parameter"><code>api</code></em> argument. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VENDOR</code> + </span> + </dt> + <dd> + <p> + Returns the company responsible for this EGL implementation. This + name does not change from release to release. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VERSION</code> + </span> + </dt> + <dd> + <p> + Returns a version or release number. + The <code class="constant">EGL_VERSION</code> string is laid out as + follows:</p> + <p> + <em class="replaceable"><code>major_version</code></em>.<em class="replaceable"><code>minor_version</code></em> + space + <em class="replaceable"><code>vendor_specific_info</code></em> + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_EXTENSIONS</code> + </span> + </dt> + <dd> + <p> + Returns a space separated list of supported extensions to EGL. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + <code class="constant">EGL_CLIENT_APIS</code> is supported only if + the EGL version is 1.2 or greater. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">NULL</code> is returned on failure. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_PARAMETER</code> is generated if + <em class="parameter"><code>name</code></em> is not an accepted value. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglBindAPI.html"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, + <a class="citerefentry" href="eglGetDisplay.html"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>, + <a class="citerefentry" href="eglInitialize.html"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQuerySurface.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQuerySurface.html new file mode 100644 index 0000000..c7b3fc9 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQuerySurface.html @@ -0,0 +1,599 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglQuerySurface</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglQuerySurface"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglQuerySurface</h1> + <p> + return <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> surface information + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglQuerySurface</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLSurface <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">surface</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attribute</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">value</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface to query. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attribute</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface attribute to be returned. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>value</code> + </em> + </span> + </dt> + <dd> + <p> + Returns the requested value. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglQuerySurface</code> returns in + <em class="parameter"><code>value</code></em> the value of + <em class="parameter"><code>attribute</code></em> for <em class="parameter"><code>surface</code></em>. + <em class="parameter"><code>attribute</code></em> can be one of the following: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_ID</code> + </span> + </dt> + <dd> + <p> + Returns the ID of the EGL frame buffer configuration + with respect to which the surface was created. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_HEIGHT</code> + </span> + </dt> + <dd> + <p> + Returns the height of the surface in pixels. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_HORIZONTAL_RESOLUTION</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_DISPLAY_SCALING</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LARGEST_PBUFFER</code> + </span> + </dt> + <dd> + <p> + Returns the same attribute value specified when the + surface was created with + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>. + For a window or pixmap surface, + <em class="parameter"><code>value</code></em> is not modified. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MIPMAP_LEVEL</code> + </span> + </dt> + <dd> + <p> + Returns which level of the mipmap to render to, if + texture has mipmaps. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MIPMAP_TEXTURE</code> + </span> + </dt> + <dd> + <p> + Returns <code class="constant">EGL_TRUE</code> if texture has + mipmaps, <code class="constant">EGL_FALSE</code> otherwise. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> + </span> + </dt> + <dd> + <p> + Returns the filter used when resolving the + multisample buffer. The filter may be either + <code class="constant">EGL_MULTISAMPLE_RESOLVE_DEFAULT</code> + or <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX</code>, + as described for + <a class="citerefentry" href="eglSurfaceAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_PIXEL_ASPECT_RATIO</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_DISPLAY_SCALING</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RENDER_BUFFER</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_BACK_BUFFER</code>. For a pixmap + surface, it is always + <code class="constant">EGL_SINGLE_BUFFER</code>. To determine + the actual buffer being rendered to by a context, + call + <a class="citerefentry" href="eglQueryContext.html"><span class="citerefentry"><span class="refentrytitle">eglQueryContext</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SWAP_BEHAVIOR</code> + </span> + </dt> + <dd> + <p> + Returns the effect on the color buffer when posting + a surface with + <a class="citerefentry" href="eglSwapBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a>. + Swap behavior may be either + <code class="constant">EGL_BUFFER_PRESERVED</code> or + <code class="constant">EGL_BUFFER_DESTROYED</code>, as + described for + <a class="citerefentry" href="eglSurfaceAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_FORMAT</code> + </span> + </dt> + <dd> + <p> + Returns format of texture. Possible values are + <code class="constant">EGL_NO_TEXTURE</code>, + <code class="constant">EGL_TEXTURE_RGB</code>, and + <code class="constant">EGL_TEXTURE_RGBA</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_TARGET</code> + </span> + </dt> + <dd> + <p> + Returns type of texture. Possible values are + <code class="constant">EGL_NO_TEXTURE</code>, or + <code class="constant">EGL_TEXTURE_2D</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VERTICAL_RESOLUTION</code> + </span> + </dt> + <dd> + <p> + 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 + <code class="constant">EGL_DISPLAY_SCALING</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_WIDTH</code> + </span> + </dt> + <dd> + <p> + Returns the width of the surface in pixels. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + Attribute <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> is + supported only if the EGL version is 1.4 or greater. + </p> + <p> + Attributes <code class="constant">EGL_DISPLAY_SCALING</code>. + <code class="constant">EGL_HORIZONTAL_RESOLUTION</code>, + <code class="constant">EGL_PIXEL_ASPECT_RATIO</code>, + <code class="constant">EGL_RENDER_BUFFER</code>, + <code class="constant">EGL_SWAP_BEHAVIOR</code>, and + <code class="constant">EGL_VERTICAL_RESOLUTION</code> are supported + only if the EGL version is 1.2 or greater. + </p> + <p> + Querying attributes <code class="constant">EGL_TEXTURE_FORMAT</code>, + <code class="constant">EGL_TEXTURE_TARGET</code>, + <code class="constant">EGL_MIPMAP_TEXTURE</code>, or + <code class="constant">EGL_MIPMAP_LEVEL</code> for a non-pbuffer + surface is not an error, but <em class="parameter"><code>value</code></em> is + not modified. + </p> + <p> + <code class="constant">EGL_DISPLAY_SCALING</code> 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. + </p> + <p> + For an offscreen (pbuffer or pixmap) surface, or a surface + whose pixel dot pitch or aspect ratio are unknown, querying + <code class="constant">EGL_HORIZONTAL_RESOLUTION</code>, + <code class="constant">EGL_PIXEL_ASPECT_RATIO</code>, or + <code class="constant">EGL_VERTICAL_RESOLUTION</code> will return the + constant value <code class="constant">EGL_UNKNOWN</code> (-1). + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>value</code></em> is not modified when + <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL surface. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attribute</code></em> is not a valid surface attribute. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglSurfaceAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>, + <a class="citerefentry" href="eglSwapBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglReleaseTexImage.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglReleaseTexImage.html new file mode 100644 index 0000000..2acf40b --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglReleaseTexImage.html @@ -0,0 +1,362 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglReleaseTexImage</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglReleaseTexImage"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglReleaseTexImage</h1> + <p> + Releases a color buffer that is being used as a texture + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglReleaseTexImage</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLSurface <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">surface</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">buffer</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the EGL display connection.</p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>buffer</code> + </em> + </span> + </dt> + <dd> + <p>Specifies the texture image data.</p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + 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. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + 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. + </p> + <p> + 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 <a class="citerefentry" href="eglBindTexImage.html"><span class="citerefentry"><span class="refentrytitle">eglBindTexImage</span></span></a> + and <code class="function">eglReleaseTexImage</code>. + </p> + <p> + After a color buffer is released from a texture (either explicitly by calling + <code class="function">eglReleaseTexImage</code> or implicitly by calling a routine such as + <a class="citerefentry" href="glTexImage2D.html"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>), + all texture images that were defined by the color buffer become <code class="constant">NULL</code> + (it is as if <a class="citerefentry" href="glTexImage.html"><span class="citerefentry"><span class="refentrytitle">glTexImage</span></span></a> was called with an image of zero width). + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if the + surface attribute <code class="constant">EGL_TEXTURE_FORMAT</code> is + set to <code class="constant">EGL_NO_TEXTURE</code>. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>buffer</code></em> is not a valid buffer + (currently only <code class="constant">EGL_BACK_BUFFER</code> may be + specified). + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL surface, or is + not a bound pbuffer surface. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglBindTexImage.html"><span class="citerefentry"><span class="refentrytitle">eglBindTexImage</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglReleaseThread.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglReleaseThread.html new file mode 100644 index 0000000..4740ef1 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglReleaseThread.html @@ -0,0 +1,364 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglReleaseThread</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglReleaseThread"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglReleaseThread</h1> + <p>Release EGL per-thread state</p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglReleaseThread</strong>(</code> + <td xmlns="http://www.w3.org/1999/xhtml"><code>void)</code>;</td> + <td xmlns="http://www.w3.org/1999/xhtml"> </td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglReleaseThread</code> returns the EGL to its + state at thread initialization, releasing all per-thread + state including the error status returned by + <span class="command"><strong>eglGetError</strong></span>, the currently bound + rendering API defined by <span class="command"><strong>eglBindAPI</strong></span>, 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. + </p> + <p> + <code class="constant">EGL_TRUE</code> is returned on success, and the + following actions are taken: + </p> + <div class="itemizedlist"> + <ul class="itemizedlist" style="list-style-type: disc; "> + <li class="listitem"> + <p> + For each client API supported by EGL, if there is a + currently bound context, that context is released. + This is equivalent to calling + <code class="function">eglMakeCurrent</code> with ctx set to + <code class="constant">EGL_NO_CONTEXT</code> and both draw + and read set to <code class="constant">EGL_NO_SURFACE</code> + (see section 3.7.3). + </p> + </li> + <li class="listitem"> + <p> + The current rendering API is reset to its value at + thread initialization (see + <span class="command"><strong>eglBindAPI</strong></span>). + </p> + </li> + <li class="listitem"> + <p> + Any additional implementation-dependent per-thread + state maintained by EGL is marked for deletion as + soon as possible. + </p> + </li> + </ul> + </div> + <p> + <code class="function">eglReleaseThread</code> 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. + </p> + <p> + Resources explicitly allocated by calls to EGL, such as + contexts, surfaces, and configuration lists, are not + affected by <code class="function">eglReleaseThread</code>. Such + resources belong not to the thread, but to the EGL + implementation as a whole. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + <code class="function">eglReleaseThread</code> is supported only if the + EGL version is 1.2 or greater. + </p> + <p> + Applications may call other EGL routines from a thread + following <code class="function">eglReleaseThread</code>, but any + such call may reallocate the EGL state previously released. + In particular, calling <code class="function">eglGetError</code> + immediately following a successful call to + <code class="function">eglReleaseThread</code> will return + <code class="constant">EGL_SUCCESS</code>, but will also result in + reallocating per-thread state. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. There are no + defined conditions under which failure will occur. Even if + EGL is not initialized on any EGLDisplay, + <code class="function">eglReleaseThread</code> should succeed. + </p> + <p> + However, platform-dependent failures may be signaled through + the value returned from <code class="function">eglGetError</code>. + Unless the platform-dependent behavior is known, a failed + call to <code class="function">eglReleaseThread</code> should be + assumed to leave the current rendering API, and the + currently bound contexts for each supported client API, in + an unknown state. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglBindAPI.html"><span class="citerefentry"><span class="refentrytitle">eglBindAPI</span></span></a>, + <a class="citerefentry" href="eglGetError.html"><span class="citerefentry"><span class="refentrytitle">eglGetError</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglSurfaceAttrib.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglSurfaceAttrib.html new file mode 100644 index 0000000..44dedd7 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglSurfaceAttrib.html @@ -0,0 +1,481 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglSurfaceAttrib</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglSurfaceAttrib"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglSurfaceAttrib</h1> + <p> + set an <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> surface attribute + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglSurfaceAttrib</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLSurface <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">surface</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attribute</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">value</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attribute</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface attribute to set. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>value</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the attributes required value. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglSurfaceAttrib</code> sets the value of + <em class="parameter"><code>attribute</code></em> for + <em class="parameter"><code>surface</code></em> to + <em class="parameter"><code>value</code></em>. + <em class="parameter"><code>attribute</code></em> can be one of the + following: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_MIPMAP_LEVEL</code> + </span> + </dt> + <dd> + <p> + For mipmap textures, the + <code class="constant">EGL_MIPMAP_LEVEL</code> 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 <code class="constant">0</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> + </span> + </dt> + <dd> + <p> + 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 + <em class="parameter"><code>value</code></em> of + <code class="constant">EGL_MULTISAMPLE_RESOLVE_DEFAULT</code> + chooses the default implementation-defined filtering + method, while + <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX</code> + chooses a one-pixel wide box filter placing equal + weighting on all multisample values. + </p> + <p> + The initial value of + <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> is + <code class="constant">EGL_MULTISAMPLE_RESOLVE_DEFAULT</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SWAP_BEHAVIOR</code> + </span> + </dt> + <dd> + <p> + Specifies the effect on the color buffer of posting + a surface with + <a class="citerefentry" href="eglSwapBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a>. + A <em class="parameter"><code>value</code></em> of + <code class="constant">EGL_BUFFER_PRESERVED</code> indicates + that color buffer contents are unaffected, while + <code class="constant">EGL_BUFFER_DESTROYED</code> indicates + that color buffer contents may be destroyed or + changed by the operation. + </p> + <p> + The initial value of + <code class="constant">EGL_SWAP_BEHAVIOR</code> is chosen by + the implementation. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + Attribute <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> is + supported only if the EGL version is 1.4 or greater. + </p> + <p> + Attribute <code class="constant">EGL_SWAP_BEHAVIOR</code> is + supported only if the EGL version is 1.2 or greater. + </p> + <p> + If the value of pbuffer attribute + <code class="constant">EGL_TEXTURE_FORMAT</code> is + <code class="constant">EGL_NO_TEXTURE</code>, the value of attribute + <code class="constant">EGL_TEXTURE_TARGET</code> is + <code class="constant">EGL_NO_TEXTURE</code>, or + <em class="parameter"><code>surface</code></em> is not a pbuffer, then + attribute <code class="constant">EGL_MIPMAP_LEVEL</code> may be set, + but has no effect. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>attribute</code></em> is + <code class="constant">EGL_MULTISAMPLE_RESOLVE</code>, + <em class="parameter"><code>value</code></em> is + <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX</code>, and the + <code class="constant">EGL_SURFACE_TYPE</code> attribute of the + <span class="type">EGLConfig</span> used to create + <em class="parameter"><code>surface</code></em> does not contain + <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX_BIT</code>. + </p> + <p> + <code class="constant">EGL_BAD_MATCH</code> is generated if + <em class="parameter"><code>attribute</code></em> is + <code class="constant">EGL_SWAP_BEHAVIOR</code>, + <em class="parameter"><code>value</code></em> is + <code class="constant">EGL_BUFFER_PRESERVED</code>, and the + <code class="constant">EGL_SURFACE_TYPE</code> attribute of the + <span class="type">EGLConfig</span> used to create + <em class="parameter"><code>surface</code></em> does not contain + <code class="constant">EGL_SWAP_BEHAVIOR_PRESERVED_BIT</code>. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL surface. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attribute</code></em> is not a valid surface attribute. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglSwapBuffers.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglSwapBuffers.html new file mode 100644 index 0000000..c7ff447 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglSwapBuffers.html @@ -0,0 +1,385 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglSwapBuffers</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglSwapBuffers"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglSwapBuffers</h1> + <p> + post <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> surface color buffer to a native window + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglSwapBuffers</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLSurface <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">surface</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL drawing surface whose buffers are to be swapped. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + If <em class="parameter"><code>surface</code></em> is a window surface, + <code class="function">eglSwapBuffers</code> posts its color buffer + to the associated native window. + </p> + <p> + The contents of ancillary buffers are always undefined after + calling <code class="function">eglSwapBuffers</code>. The contents of + the color buffer are left unchanged if the value of the + <code class="constant">EGL_SWAP_BEHAVIOR</code> attribute of + <em class="parameter"><code>surface</code></em> is + <code class="constant">EGL_BUFFER_PRESERVED</code>, and are undefined + if the value is <code class="constant">EGL_BUFFER_DESTROYED</code>. + The value of <code class="constant">EGL_SWAP_BEHAVIOR</code> can be + set for some surfaces using + <a class="citerefentry" href="eglSurfaceAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>. + </p> + <p> + <code class="function">eglSwapBuffers</code> performs an implicit + flush operation on the context (<code class="function">glFlush</code> + for an OpenGL ES or OpenGL context, + <code class="function">vgFlush</code> for an OpenVG context) bound to + <em class="parameter"><code>surface</code></em> before swapping. Subsequent + client API commands may be issued on that context + immediately after calling + <code class="function">eglSwapBuffers</code>, but are not executed + until the buffer exchange is completed. + </p> + <p> + If <em class="parameter"><code>surface</code></em> is a pixel buffer or a pixmap, + <code class="function">eglSwapBuffers</code> + has no effect, and no error is generated. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + Attribute <code class="constant">EGL_SWAP_BEHAVIOR</code> 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 + <code class="constant">EGL_BUFFER_DESTROYED</code>. + </p> + <p> + The EGL 1.4 specification was updated to acknowledge that + ancillary buffers are not necessarily preserved after a + swap, and that the <code class="constant">EGL_SWAP_BEHAVIOR</code> + 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. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if swapping of the + surface buffers fails, <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL drawing surface. + </p> + <p> + <code class="constant">EGL_CONTEXT_LOST</code> 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. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="glFlush.html"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a>, + <a class="citerefentry" href="eglCopyBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglCopyBuffers</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglSwapInterval.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglSwapInterval.html new file mode 100644 index 0000000..fcf9a68 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglSwapInterval.html @@ -0,0 +1,344 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglSwapInterval</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglSwapInterval"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglSwapInterval</h1> + <p> + specifies the minimum number of video frame periods + per buffer swap for the window associated with the current context. + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglSwapInterval</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">interval</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>interval</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the minimum number of video frames that are displayed before + a buffer swap will occur. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + The interval takes effect when <a class="citerefentry" href="eglSwapBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a> is + first called subsequent to the <code class="function">eglSwapInterval</code> call. + </p> + <p> + The <em class="parameter"><code>interval</code></em> specified by the function applies to the draw surface + bound to the context that is current on the calling thread. + </p> + <p> + If <em class="parameter"><code>interval</code></em> is set to a value of <code class="constant">0</code>, 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 <span class="type">EGLConfig</span> attributes + <code class="constant">EGL_MIN_SWAP_INTERVAL</code> and <code class="constant">EGL_MAX_SWAP_INTERVAL</code> respectively. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + The swap interval has no effect on <a class="citerefentry" href="eglCopyBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglCopyBuffers</span></span></a>. + </p> + <p> + The default swap interval is 1. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_CONTEXT</code> is generated if there is no current context + on the calling thread. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if there is no surface + bound to the current context. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglSwapBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglTerminate.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglTerminate.html new file mode 100644 index 0000000..97a1864 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglTerminate.html @@ -0,0 +1,314 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglTerminate</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglTerminate"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglTerminate</h1> + <p> + terminate an <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> display connection + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglTerminate</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var><code>)</code></td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection to terminate. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglTerminate</code> 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 <em class="parameter"><code>display</code></em> is current to any thread, + they are not released until they are no longer current as a result of + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a>. + </p> + <p> + Terminating an already terminated EGL display connection has no effect. + A terminated display may be re-initialized by calling + <a class="citerefentry" href="eglInitialize.html"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a> + again. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if + <code class="function">eglTerminate</code> fails, + <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglInitialize.html"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>, + <a class="citerefentry" href="eglMakeCurrent.html"><span class="citerefentry"><span class="refentrytitle">eglMakeCurrent</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglWaitClient.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglWaitClient.html new file mode 100644 index 0000000..07db379 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglWaitClient.html @@ -0,0 +1,320 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglWaitClient</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglWaitClient"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglWaitClient</h1> + <p> + Complete client API execution prior to subsequent native + rendering calls + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglWaitClient</strong>(</code> + <td xmlns="http://www.w3.org/1999/xhtml"><code>void)</code>;</td> + <td xmlns="http://www.w3.org/1999/xhtml"> </td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + All rendering calls for the currently bound context, for the + current rendering API, made prior to + <code class="function">eglWaitClient</code> are guaranteed to be + executed before native rendering calls made after + <code class="function">eglWaitClient</code>. The same result can be + achieved using client API-specific commands such as + <a class="citerefentry" href="glFinish.html"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a> + or + <a class="citerefentry" href="vgFinish.html"><span class="citerefentry"><span class="refentrytitle">vgFinish</span></span></a>. + </p> + <p> + <code class="function">eglWaitClient</code> is ignored if there is no + current EGL rendering context for the current rendering API. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if + <code class="function">eglWaitClient</code> fails, + <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + If there is no current context for the current rendering + API, the function has no effect but still returns + <code class="constant">EGL_TRUE</code>. + </p> + <p> + <code class="constant">EGL_BAD_CURRENT_SURFACE</code> 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. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + <code class="function">eglWaitClient</code> is supported only if the + EGL version is 1.2 or greater. + </p> + <p> + <code class="function">eglWaitClient</code> is a generalized version + of <code class="function">eglWaitGL</code>, supporting multiple + client APIs. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="glFinish.html"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a>, + <a class="citerefentry" href="glFlush.html"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a>, + <a class="citerefentry" href="eglWaitGL.html"><span class="citerefentry"><span class="refentrytitle">eglWaitGL</span></span></a>, + <a class="citerefentry" href="eglWaitNative.html"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a>, + <a class="citerefentry" href="vgFinish.html"><span class="citerefentry"><span class="refentrytitle">vgFinish</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglWaitGL.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglWaitGL.html new file mode 100644 index 0000000..681937e --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglWaitGL.html @@ -0,0 +1,318 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglWaitGL</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglWaitGL"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglWaitGL</h1> + <p> + Complete GL execution prior to subsequent native rendering + calls + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglWaitGL</strong>(</code> + <td xmlns="http://www.w3.org/1999/xhtml"><code>void)</code>;</td> + <td xmlns="http://www.w3.org/1999/xhtml"> </td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + All OpenGL ES rendering calls for the currently bound OpenGL + ES context made prior to <code class="function">eglWaitGL</code> are + guaranteed to be executed before native rendering calls made + after <code class="function">eglWaitGL</code>. The same result can be + achieved using + <a class="citerefentry" href="glFinish.html"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a>. + </p> + <p> + <code class="function">eglWaitGL</code> is ignored if there is no + current EGL rendering context for OpenGL ES. + </p> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + <code class="function">eglWaitClient</code> is supported only if the + EGL version is 1.2 or greater. + </p> + <p> + <code class="function">eglWaitClient</code> is a generalized version + of <code class="function">eglWaitGL</code>, supporting multiple + client APIs. For backwards compatibility, + <code class="function">eglWaitGL</code> continues to be supported and + is equivalent to the series of commands + </p> + <pre class="programlisting"> + EGLenum api = <code class="function">eglQueryAPI</code>(); + <code class="function">eglBindAPI</code>(<code class="constant">EGL_OPENGL_ES_API</code>); + <code class="function">eglWaitClient</code>(); + <code class="function">eglBindAPI</code>(api); + </pre> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned if + <code class="function">eglWaitGL</code> fails, + <code class="constant">EGL_TRUE</code> otherwise. + </p> + <p> + <code class="constant">EGL_BAD_CURRENT_SURFACE</code> 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. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="glFinish.html"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a>, + <a class="citerefentry" href="eglWaitClient.html"><span class="citerefentry"><span class="refentrytitle">eglWaitClient</span></span></a> + <a class="citerefentry" href="eglWaitNative.html"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglWaitNative.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglWaitNative.html new file mode 100644 index 0000000..a7f7b44 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglWaitNative.html @@ -0,0 +1,314 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglWaitNative</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglWaitNative"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglWaitNative</h1> + <p> + complete native execution prior to subsequent GL rendering calls + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglWaitNative</strong>(</code> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">engine</var><code>)</code></td> + </td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>engine</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies a particular marking engine to be waited on. + Must be <code class="constant">EGL_CORE_NATIVE_ENGINE</code>. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + Native rendering calls made prior to <code class="function">eglWaitNative</code> + are guaranteed to be executed before GL rendering calls made after + <code class="function">eglWaitNative</code>. + </p> + <p> + <code class="function">eglWaitNative</code> + is ignored if there is no current + <acronym class="acronym">EGL</acronym> + rendering context. + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_BAD_PARAMETER</code> is generated if + <em class="parameter"><code>engine</code></em> is not a recognized marking engine. + </p> + <p> + <code class="constant">EGL_BAD_CURRENT_SURFACE</code> + 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. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="glFinish.html"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a>, + <a class="citerefentry" href="glFlush.html"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a>, + <a class="citerefentry" href="eglWaitClient.html"><span class="citerefentry"><span class="refentrytitle">eglWaitClient</span></span></a>, + <a class="citerefentry" href="eglWaitGL.html"><span class="citerefentry"><span class="refentrytitle">eglWaitGL</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/headBackground.jpg b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/headBackground.jpg Binary files differnew file mode 100644 index 0000000..9ae0c2f --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/headBackground.jpg diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/index.html b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/index.html new file mode 100644 index 0000000..43984e9 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/index.html @@ -0,0 +1,15 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>EGL Reference Pages</title> +<link rel="Shortcut Icon" href="http://www.khronos.org/favicon.ico" type="image/x-icon" /> +</head> +<frameset rows="85,*"> + <frame src="Header.html" scrolling="no" noresize frameborder="0" marginwidth="0" marginheight="0"> + <frameset cols="25%,75%"> + <frame src="TOC.html" scrolling="yes"> + <frame src="Intro.html" name="pagedisplay" frameborder="0" marginwidth="0" marginheight="0"> + </frameset> + +</frameset> +</html> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/maketoc.pl b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/maketoc.pl new file mode 100644 index 0000000..3011d21 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/maketoc.pl @@ -0,0 +1,354 @@ +# This script is obsolete. It would need to change to generate TOC.html +# in the new format and link to .html instead of .xml files. + +#!/usr/bin/perl + +sub Usage { +print +"Usage: maketoc xhtmldir xmldir + where xhtmldir contains a directory full of OpenGL .xml XHTML man pages -AND- + where xmldir contains a directory full of OpenGL .xml source XML man pages + + probably want to redirect output into a file like + ./maketoc.pl . .. > ./toc.html +" +} + +sub PrintHeader { +print '<html> +<head> +<title>EGL Reference Pages</title> +<style type="text/css"> + +html, body, table +{ color: #000; + padding: 4px 4px; + margin: 0px 0 0 0; + text-align: center; + font-family: Arial, Lucida, sans-serif; + font-size: 10pt; + +} + +#container { + margin: 10px; + font-size: 14pt; + text-decoration:none; +} + +table.sample { + border-width: 1px; + border-spacing: 5px; + border-style: dotted; + border-color: black; + border-collapse: separate; + background-color: #F0F0F0; +} +table.sample th { + border-width: 1px; + padding: 5px; + border-style: none; +} +table.sample td { + border-width: 1px; + padding: 1px; + border-style: none; +} +</style> + +</head> +<body> +<a name="top"></a> +<h1>EGL Reference Pages</h1> +<br/><br/> + +'; +} + +sub PrintFooter { +print ' +</body> +</html> +'; +} + +sub TableElementForFilename { + my $name = shift; + + my $strippedname = $name; + $strippedname =~ s/\.xml//; + print "\t"; + print '<tr><td><a target="pagedisp" href="' , $name , '">'; + print "$strippedname"; + print "</a></td></tr>\n"; +} + +sub BeginTable { + my $letter = shift; + print "<a name=\"$letter\"></a><br/><br/>\n"; + print '<table width="220" align="center" class="sample">'; + print "\t<th>"; + print "$letter</th>\n"; +} + +sub EndTable { + print "\t"; + print '<tr><td><center><a href="#top">Top</a></center></td></tr>'; + print "\n</table>\n\n"; +} + + + +############## +# main +############## + +if (@ARGV != 2) +{ + Usage(); + die; +} + +# grab list of generated XHTML files +opendir(DIR,$ARGV[0]) or die "couldn't open directory"; + +@files = readdir(DIR); +close(DIR); +@files = sort @files; + +PrintHeader(); + +my @glX; +my @glut; +my @glu; +my @egl; +my @gl; + +my @realEntrypoints; +my @pageNames; + +#pre-create list of all true entrypoint names + +foreach (@files) +{ + if (/xml/) + { + $parentName = $ARGV[1] . '/' . $_; + if (open(PARENT, $parentName)) + { + @funcs = <PARENT>; + @funcs = grep(/<funcdef>/, @funcs); + foreach (@funcs) + { + $func = $_; + $func =~ s/.*<function>//; + $func =~ s/<\/function>.*\n//; + + push (@realEntrypoints, $func); + } + close(PARENT); + } + } +} + +#pre-create list of page names + +foreach (@files) +{ + if (/xml/) + { + $parentName = $ARGV[1] . '/' . $_; + if (open(PARENT, $parentName)) + { + my $entrypoint = $_; + $entrypoint =~ s/\.xml//; + + push (@pageNames, $entrypoint); + + close(PARENT); + } + } +} + +#sort the files into gl, glut, glu, EGL, and glX + +foreach (@files) +{ + if (/xml/) + { + # filter out entrypoint variations that don't have their own man pages + my $needIndexEntry = 0; + + # continue only if parent page exists (e.g. glColor) OR + # different parent page exists with matching entrypoint (e.g. glEnd) + my $entrypoint = $_; + $entrypoint =~ s/\.xml//; + + foreach (@pageNames) + { + if ($_ eq $entrypoint) + { + # it has its own man page + $needIndexEntry = 1; + } + } + + if ($needIndexEntry == 0) + { + foreach (@realEntrypoints) + { + if ($_ eq $entrypoint) + { + # it's a real entrypoint, but make sure not a variation + $needIndexEntry = 1; + + foreach (@pageNames) + { + my $alteredEntrypoint = $entrypoint; + $alteredEntrypoint =~ s/$_//; + + if (!($alteredEntrypoint eq $entrypoint)) + { + $needIndexEntry = 0; + } + } + } + } + } + + if ($needIndexEntry) + { + if (/^glX/) + { + push (@glX, $_); + } + elsif (/^glut/) + { + push (@glut, $_); + } + elsif (/^glu/) + { + push (@glu, $_); + } + elsif (/^egl/) + { + push (@egl, $_); + } + elsif (/^gl/) + { + push (@gl, $_); + } + } + } +} + + +#output the table of contents + +my @toc; + +if ($#gl > 0) +{ + $currentletter = ""; + $opentable = 0; + + foreach (@gl) + { + $name = $_; + $name =~ s/^gl//; + $firstletter = substr($name, 0, 1); + if ($firstletter ne $currentletter) + { + push (@toc, $firstletter); + $currentletter = $firstletter; + } + } + if ($#egl > 0) { push (@toc, "egl"); } + if ($#glu > 0) { push (@toc, "glu"); } + if ($#glut > 0) { push (@toc, "glut"); } + if ($#glX > 0) { push (@toc, "glX"); } +} + + +print '<div id="container">'; +foreach (@toc) +{ + print '<b><a href="#'; + print $_; + print '" style="text-decoration:none"> '; + print $_; + print " </a></b> "; +} +print "</div>\n\n\n"; + +# output the tables + +if ($#gl > 0) +{ + $currentletter = ""; + $opentable = 0; + + foreach (@gl) + { + $name = $_; + $name =~ s/^gl//; + $firstletter = substr($name, 0, 1); + if ($firstletter ne $currentletter) + { + if ($opentable == 1) + { + EndTable(); + } + BeginTable($firstletter); + $opentable =1; + $currentletter = $firstletter; + } + TableElementForFilename($_); + } + if ($opentable) + { + EndTable(); + } +} + +if ($#egl > 0) +{ + BeginTable("egl"); + foreach (@egl) + { + TableElementForFilename($_); + } + EndTable(); +} + +if ($#glu > 0) +{ + BeginTable("glu"); + foreach (@glu) + { + TableElementForFilename($_); + } + EndTable(); +} + +if ($#glut > 0) +{ + BeginTable("glut"); + foreach (@glut) + { + TableElementForFilename($_); + } + EndTable(); +} + +if ($#glX > 0) +{ + BeginTable("glX"); + foreach (@glX) + { + TableElementForFilename($_); + } + EndTable(); +} + +PrintFooter(); diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/opengl-man.xsl b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/opengl-man.xsl new file mode 100644 index 0000000..1e725bc --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/opengl-man.xsl @@ -0,0 +1,49 @@ +<?xml version='1.0'?> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> + +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/profile-docbook.xsl"/> + +<xsl:param name="funcsynopsis.style">ansi</xsl:param> +<xsl:param name="citerefentry.link" select="'1'"></xsl:param> +<xsl:template name="generate.citerefentry.link"><xsl:value-of select="refentrytitle"/>.xml</xsl:template> + +<xsl:template match="*" mode="process.root"> + <xsl:variable name="doc" select="self::*"/> + + <xsl:call-template name="user.preroot"/> + <xsl:call-template name="root.messages"/> + + <html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"> + <head> + <xsl:call-template name="system.head.content"> + <xsl:with-param name="node" select="$doc"/> + </xsl:call-template> + <xsl:call-template name="head.content"> + <xsl:with-param name="node" select="$doc"/> + </xsl:call-template> + <xsl:call-template name="user.head.content"> + <xsl:with-param name="node" select="$doc"/> + </xsl:call-template> + </head> + <body> + <xsl:call-template name="body.attributes"/> + <xsl:call-template name="user.header.content"> + <xsl:with-param name="node" select="$doc"/> + </xsl:call-template> + <xsl:apply-templates select="."/> + <xsl:call-template name="user.footer.content"> + <xsl:with-param name="node" select="$doc"/> + </xsl:call-template> + </body> + </html> +</xsl:template> + +<xsl:template match="/"> + <xsl:processing-instruction name="xml-stylesheet"> + <xsl:text>type="text/xsl" href="mathml.xsl"</xsl:text> + </xsl:processing-instruction> + <xsl:apply-imports/> +</xsl:template> + +</xsl:stylesheet> diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/present.css b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/present.css new file mode 100644 index 0000000..7868f93 --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/present.css @@ -0,0 +1,47 @@ +@charset "utf-8"; +/* CSS Document */ + li { font: normal 14px verdana, sans-serif; line-height: 14px; } + ul { font: normal 14px verdana, sans-serif; line-height: 14px; } + a:link, a:visited {color:blue; text-decoration:none;} + a:hover {color:blue; text-decoration:none; background-color:FFFF99; } + + #navwrap { + width: 320px; + margin:0 0 0 4px; + padding:0; + } + + #containerul, #containerul ul{ + text-align:left; + margin:0 0 0 4px; /* Removes browser default margins applied to the lists. */ + padding:0; /* Removes browser default padding applied to the lists. */ + } + + #containerul li{ + margin:0 0 0 15px; /* A left margin to indent the list items and give the menu a sense of structure. */ + padding:4px 0 0 2px; + list-style-type:none; /* Removes the bullet point that usually goes next to each item in a list. */ + font: normal 12px verdana, sans-serif; + } + + #containerul li.lev1 { + margin:0 0 0 0; + padding:4px 0 0 2px; + list-style-type:none; /* Removes the bullet point that usually goes next to each item in a list. */ + font: normal 14px verdana, sans-serif; + } + + #containerul .symbols{ /* Various styles to position the symbols next to the items in the menu. */ + background-repeat:no-repeat; + float:left; + height:14px; + margin-right:5px; + margin-top:1px; + width:14px; + } + +#containerul ul.Level2 { + margin:0; + padding: 0; + } + diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/style.css b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/style.css new file mode 100644 index 0000000..00fd1ed --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/style.css @@ -0,0 +1,2 @@ +@import url("undohtml.css"); +@import url("present.css"); diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/styles-css.xsl b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/styles-css.xsl new file mode 100644 index 0000000..498654e --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/styles-css.xsl @@ -0,0 +1,214 @@ +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> +<xsl:param name="annotation.css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</xsl:param> +</xsl:stylesheet> + + diff --git a/glew/auto/EGL-Registry/sdk/docs/man/xhtml/undohtml.css b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/undohtml.css new file mode 100644 index 0000000..a2d510f --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/xhtml/undohtml.css @@ -0,0 +1,9 @@ +/* -- undo browser HTML defaults -- */ +/* -- Global resets of all default items -- */ + +:link,:visited {text-decoration: none;} +ul,ol {list-style: none;} +h1,h2,h3,h4,h5,h6,pre,code,p {font-size: 1em;} +ul,ol,dl,li,dt,dd,h1,h2,h3,h4,h5,h6,pre,form,body,html,p,blockquote,fieldset,input {margin: 0; padding: 0;} +a img,:link img,:visited img {border: none;} +address {font-style: normal;} |
