diff options
Diffstat (limited to 'glew/auto/EGL-Registry/sdk/docs/man/html')
62 files changed, 12567 insertions, 0 deletions
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 |
