diff options
Diffstat (limited to 'engine-ocean/External/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQuerySurface.html')
| -rw-r--r-- | engine-ocean/External/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQuerySurface.html | 599 |
1 files changed, 599 insertions, 0 deletions
diff --git a/engine-ocean/External/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQuerySurface.html b/engine-ocean/External/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQuerySurface.html new file mode 100644 index 0000000..c7b3fc9 --- /dev/null +++ b/engine-ocean/External/glew/auto/EGL-Registry/sdk/docs/man/xhtml/eglQuerySurface.html @@ -0,0 +1,599 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> +<!-- saved from url=(0013)about:internet --> +<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <style xmlns="" type="text/css"> + /* This style sets a margin around the entire page */ + html, body { + margin: 10px; + } + + p { + font: normal 16px verdana, sans-serif; + margin: 0; + padding-bottom:12px; + } + + h1 { + font: bold 25px verdana, sans-serif; + margin-top: 0; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h2 { + font: bold 19px verdana, sans-serif; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + h3 { + font: bold 19px verdana, sans-serif !important; + margin-top: 28px; + margin-bottom: 3px; + padding-top: 0; + padding-bottom: 0; + } + + li { + font: normal 16px verdana, sans-serif; + margin-top: 0; + margin-bottom: 18px; + padding-top: 0; + padding-bottom: 0; + } + + .pdparam { + font: italic 16px verdana, sans-serif; + } + + .term { + font: italic 16px verdana, sans-serif; + font-weight: normal; + } + + .type { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + a:link, a:visited { + color: blue; + text-decoration: none; + font: normal 16px; + } + + a:hover { + background-color: #FFFF99; + font: normal 16px; + } + + div.funcsynopsis { + text-align: left; + background-color: #e6e6e6; + font: normal 16px verdana, sans-serif; + padding-top: 10px; + padding-bottom: 10px; + } + + div.funcsynopsis table { + border-collapse: separate; + font: normal 16px verdana, sans-serif; + } + + div.funcsynopsis td { + background-color: #e6e6e6; + border: 0 solid #000; + padding: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 { + font-family: verdana, sans-serif; + font-size: 16px; + } + + code.constant { + font: normal 16px courier new, monospace !important; + } + + span.errorname { + font: normal 16px verdana, sans-serif !important; + } + + code.function { + font: bold 16px verdana, sans-serif !important; + } + + b.fsfunc { + font: bold 16px verdana, sans-serif !important; + } + + code.varname { + font: italic 16px verdana, sans-serif; + } + + code.replaceable { + font: italic 16px courier new, monospace; + } + + code.funcdef { + font: normal 16px verdana, sans-serif !important; + } + + .citerefentry { + font: normal 16px verdana, sans-serif !important; + } + + .parameter { + font-style: italic; + } + + code.fsfunc { + font: normal 16px verdana, sans-serif !important; + } + + /* PARAMETER: This style controls spacing between the terms in Parameter section */ + dt { + margin-top: 15px; + } + + /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ + div.refsect1 table { + width: 100%; + margin-top: 10px; + background-color: #FFF; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 th { + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: bold 16px verdana, sans-serif; + } + + div.refsect1 td { + background-color: #FFF; + padding: 5px; + vertical-align: text-top; + border-collapse: collapse; + border-color: #000; + border-width: 1px; + font: normal 16px verdana, sans-serif; + } + + div.refsect1 p{ + font: normal 16px verdana, sans-serif; + margin-top: 8px; + margin-bottom: 8px; + padding-top: 0; + padding-bottom: 0; + } + + + /* EXAMPLE: These styles apply only to the Example section */ + div.refsect2 { + font: normal 16px courier new, monospace !important; + } + + div.refsect2 table { + margin-top: 0; + background-color: #e6e6e6; + width: 100%; + border: 0 solid #000; + padding: 2px; + font: normal 16px courier new, monospace !important; + } + + div.refsect2 td { + background-color: #e6e6e6; + font: normal 16px courier new, monospace !important; + white-space:pre; + } + + /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ + div.refsect3 { + font: normal 11px verdana, sans-serif; + margin-top: 50px; + margin-bottom: 20px; + padding-top: 0; + padding-bottom: 0; + } + +</style> + <title>eglQuerySurface</title> + <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> + </head> + <body> + <div class="refentry"> + <a id="eglQuerySurface"></a> + <div class="titlepage"></div> + <div xmlns="" class="refnamediv"> + <h1>eglQuerySurface</h1> + <p> + return <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> surface information + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> + <tr valign="bottom"> + <td> + <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglQuerySurface</strong>(</code> + <td>EGLDisplay <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td> + </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLSurface <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">surface</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attribute</var>, </td> + </tr> + <tr valign="top"> + <td> </td> + <td>EGLint * <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">value</var><code>)</code></td> + </tr> + </table> + </div> + </div> + <div class="refsect1"> + <a id="parameters"></a> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>surface</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface to query. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>attribute</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the EGL surface attribute to be returned. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>value</code> + </em> + </span> + </dt> + <dd> + <p> + Returns the requested value. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="description"></a> + <h2>Description</h2> + <p> + <code class="function">eglQuerySurface</code> returns in + <em class="parameter"><code>value</code></em> the value of + <em class="parameter"><code>attribute</code></em> for <em class="parameter"><code>surface</code></em>. + <em class="parameter"><code>attribute</code></em> can be one of the following: + </p> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <code class="constant">EGL_CONFIG_ID</code> + </span> + </dt> + <dd> + <p> + Returns the ID of the EGL frame buffer configuration + with respect to which the surface was created. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_HEIGHT</code> + </span> + </dt> + <dd> + <p> + Returns the height of the surface in pixels. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_HORIZONTAL_RESOLUTION</code> + </span> + </dt> + <dd> + <p> + Returns the horizontal dot pitch of the display on + which a window surface is visible. The value + returned is equal to the actual dot pitch, in + pixels/meter, multiplied by the constant value + <code class="constant">EGL_DISPLAY_SCALING</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_LARGEST_PBUFFER</code> + </span> + </dt> + <dd> + <p> + Returns the same attribute value specified when the + surface was created with + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>. + For a window or pixmap surface, + <em class="parameter"><code>value</code></em> is not modified. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MIPMAP_LEVEL</code> + </span> + </dt> + <dd> + <p> + Returns which level of the mipmap to render to, if + texture has mipmaps. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MIPMAP_TEXTURE</code> + </span> + </dt> + <dd> + <p> + Returns <code class="constant">EGL_TRUE</code> if texture has + mipmaps, <code class="constant">EGL_FALSE</code> otherwise. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> + </span> + </dt> + <dd> + <p> + Returns the filter used when resolving the + multisample buffer. The filter may be either + <code class="constant">EGL_MULTISAMPLE_RESOLVE_DEFAULT</code> + or <code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX</code>, + as described for + <a class="citerefentry" href="eglSurfaceAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_PIXEL_ASPECT_RATIO</code> + </span> + </dt> + <dd> + <p> + Returns the aspect ratio of an individual pixel (the + ratio of a pixel's width to its height). The value + returned is equal to the actual aspect ratio + multiplied by the constant value + <code class="constant">EGL_DISPLAY_SCALING</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_RENDER_BUFFER</code> + </span> + </dt> + <dd> + <p> + Returns the buffer which client API rendering is + requested to use. For a window surface, this is the + same attribute value specified when the surface was + created. For a pbuffer surface, it is always + <code class="constant">EGL_BACK_BUFFER</code>. For a pixmap + surface, it is always + <code class="constant">EGL_SINGLE_BUFFER</code>. To determine + the actual buffer being rendered to by a context, + call + <a class="citerefentry" href="eglQueryContext.html"><span class="citerefentry"><span class="refentrytitle">eglQueryContext</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_SWAP_BEHAVIOR</code> + </span> + </dt> + <dd> + <p> + Returns the effect on the color buffer when posting + a surface with + <a class="citerefentry" href="eglSwapBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a>. + Swap behavior may be either + <code class="constant">EGL_BUFFER_PRESERVED</code> or + <code class="constant">EGL_BUFFER_DESTROYED</code>, as + described for + <a class="citerefentry" href="eglSurfaceAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_FORMAT</code> + </span> + </dt> + <dd> + <p> + Returns format of texture. Possible values are + <code class="constant">EGL_NO_TEXTURE</code>, + <code class="constant">EGL_TEXTURE_RGB</code>, and + <code class="constant">EGL_TEXTURE_RGBA</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_TEXTURE_TARGET</code> + </span> + </dt> + <dd> + <p> + Returns type of texture. Possible values are + <code class="constant">EGL_NO_TEXTURE</code>, or + <code class="constant">EGL_TEXTURE_2D</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_VERTICAL_RESOLUTION</code> + </span> + </dt> + <dd> + <p> + Returns the vertical dot pitch of the display on + which a window surface is visible. The value + returned is equal to the actual dot pitch, in + pixels/meter, multiplied by the constant value + <code class="constant">EGL_DISPLAY_SCALING</code>. + </p> + </dd> + <dt> + <span class="term"> + <code class="constant">EGL_WIDTH</code> + </span> + </dt> + <dd> + <p> + Returns the width of the surface in pixels. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1"> + <a id="notes"></a> + <h2>Notes</h2> + <p> + Attribute <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> is + supported only if the EGL version is 1.4 or greater. + </p> + <p> + Attributes <code class="constant">EGL_DISPLAY_SCALING</code>. + <code class="constant">EGL_HORIZONTAL_RESOLUTION</code>, + <code class="constant">EGL_PIXEL_ASPECT_RATIO</code>, + <code class="constant">EGL_RENDER_BUFFER</code>, + <code class="constant">EGL_SWAP_BEHAVIOR</code>, and + <code class="constant">EGL_VERTICAL_RESOLUTION</code> are supported + only if the EGL version is 1.2 or greater. + </p> + <p> + Querying attributes <code class="constant">EGL_TEXTURE_FORMAT</code>, + <code class="constant">EGL_TEXTURE_TARGET</code>, + <code class="constant">EGL_MIPMAP_TEXTURE</code>, or + <code class="constant">EGL_MIPMAP_LEVEL</code> for a non-pbuffer + surface is not an error, but <em class="parameter"><code>value</code></em> is + not modified. + </p> + <p> + <code class="constant">EGL_DISPLAY_SCALING</code> is the constant + value 10000. Floating-point values such as resolution and + pixel aspect ratio are scaled by this value before being + returned as integers so that sufficient precision to be + meaningful will be retained in the returned value. + </p> + <p> + For an offscreen (pbuffer or pixmap) surface, or a surface + whose pixel dot pitch or aspect ratio are unknown, querying + <code class="constant">EGL_HORIZONTAL_RESOLUTION</code>, + <code class="constant">EGL_PIXEL_ASPECT_RATIO</code>, or + <code class="constant">EGL_VERTICAL_RESOLUTION</code> will return the + constant value <code class="constant">EGL_UNKNOWN</code> (-1). + </p> + </div> + <div class="refsect1"> + <a id="errors"></a> + <h2>Errors</h2> + <p> + <code class="constant">EGL_FALSE</code> is returned on failure, + <code class="constant">EGL_TRUE</code> otherwise. + <em class="parameter"><code>value</code></em> is not modified when + <code class="constant">EGL_FALSE</code> is returned. + </p> + <p> + <code class="constant">EGL_BAD_DISPLAY</code> is generated if + <em class="parameter"><code>display</code></em> is not an EGL display connection. + </p> + <p> + <code class="constant">EGL_NOT_INITIALIZED</code> is generated if + <em class="parameter"><code>display</code></em> has not been initialized. + </p> + <p> + <code class="constant">EGL_BAD_SURFACE</code> is generated if + <em class="parameter"><code>surface</code></em> is not an EGL surface. + </p> + <p> + <code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if + <em class="parameter"><code>attribute</code></em> is not a valid surface attribute. + </p> + </div> + <div class="refsect1"> + <a id="seealso"></a> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, + <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, + <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, + <a class="citerefentry" href="eglSurfaceAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglSurfaceAttrib</span></span></a>, + <a class="citerefentry" href="eglSwapBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a> + </p> + </div> + <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p> +Copyright © 2003-2014 The Khronos Group Inc. +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and/or associated documentation files (the +"Materials"), to deal in the Materials without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Materials, and to +permit persons to whom the Materials are furnished to do so, subject to +the condition that this copyright notice and permission notice shall be included +in all copies or substantial portions of the Materials. +</div> + </div> + </body> +</html> |