blob: 44dedd78e389b10a676ff9d11be3e3cb4e70e667 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<style xmlns="" type="text/css">
/* This style sets a margin around the entire page */
html, body {
margin: 10px;
}
p {
font: normal 16px verdana, sans-serif;
margin: 0;
padding-bottom:12px;
}
h1 {
font: bold 25px verdana, sans-serif;
margin-top: 0;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
h2 {
font: bold 19px verdana, sans-serif;
margin-top: 28px;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
h3 {
font: bold 19px verdana, sans-serif !important;
margin-top: 28px;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
li {
font: normal 16px verdana, sans-serif;
margin-top: 0;
margin-bottom: 18px;
padding-top: 0;
padding-bottom: 0;
}
.pdparam {
font: italic 16px verdana, sans-serif;
}
.term {
font: italic 16px verdana, sans-serif;
font-weight: normal;
}
.type {
font: normal 16px verdana, sans-serif !important;
}
.parameter {
font-style: italic;
}
a:link, a:visited {
color: blue;
text-decoration: none;
font: normal 16px;
}
a:hover {
background-color: #FFFF99;
font: normal 16px;
}
div.funcsynopsis {
text-align: left;
background-color: #e6e6e6;
font: normal 16px verdana, sans-serif;
padding-top: 10px;
padding-bottom: 10px;
}
div.funcsynopsis table {
border-collapse: separate;
font: normal 16px verdana, sans-serif;
}
div.funcsynopsis td {
background-color: #e6e6e6;
border: 0 solid #000;
padding: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 {
font-family: verdana, sans-serif;
font-size: 16px;
}
code.constant {
font: normal 16px courier new, monospace !important;
}
span.errorname {
font: normal 16px verdana, sans-serif !important;
}
code.function {
font: bold 16px verdana, sans-serif !important;
}
b.fsfunc {
font: bold 16px verdana, sans-serif !important;
}
code.varname {
font: italic 16px verdana, sans-serif;
}
code.replaceable {
font: italic 16px courier new, monospace;
}
code.funcdef {
font: normal 16px verdana, sans-serif !important;
}
.citerefentry {
font: normal 16px verdana, sans-serif !important;
}
.parameter {
font-style: italic;
}
code.fsfunc {
font: normal 16px verdana, sans-serif !important;
}
/* PARAMETER: This style controls spacing between the terms in Parameter section */
dt {
margin-top: 15px;
}
/* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
div.refsect1 table {
width: 100%;
margin-top: 10px;
background-color: #FFF;
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 th {
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: bold 16px verdana, sans-serif;
}
div.refsect1 td {
background-color: #FFF;
padding: 5px;
vertical-align: text-top;
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 p{
font: normal 16px verdana, sans-serif;
margin-top: 8px;
margin-bottom: 8px;
padding-top: 0;
padding-bottom: 0;
}
/* EXAMPLE: These styles apply only to the Example section */
div.refsect2 {
font: normal 16px courier new, monospace !important;
}
div.refsect2 table {
margin-top: 0;
background-color: #e6e6e6;
width: 100%;
border: 0 solid #000;
padding: 2px;
font: normal 16px courier new, monospace !important;
}
div.refsect2 td {
background-color: #e6e6e6;
font: normal 16px courier new, monospace !important;
white-space:pre;
}
/* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
div.refsect3 {
font: normal 11px verdana, sans-serif;
margin-top: 50px;
margin-bottom: 20px;
padding-top: 0;
padding-bottom: 0;
}
</style>
<title>eglSurfaceAttrib</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
</head>
<body>
<div class="refentry">
<a id="eglSurfaceAttrib"></a>
<div class="titlepage"></div>
<div xmlns="" class="refnamediv">
<h1>eglSurfaceAttrib</h1>
<p>
set an <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> surface attribute
</p>
</div>
<div class="refsynopsisdiv">
<h2>C Specification</h2>
<div class="funcsynopsis">
<table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
<tr valign="bottom">
<td>
<code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglSurfaceAttrib</strong>(</code>
<td>EGLDisplay  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td>
</td>
</tr>
<tr valign="top">
<td> </td>
<td>EGLSurface  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">surface</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td>EGLint  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">attribute</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td>EGLint  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">value</var><code>)</code></td>
</tr>
</table>
</div>
</div>
<div class="refsect1">
<a id="parameters"></a>
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<em class="parameter">
<code>display</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the EGL display connection.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>surface</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the EGL surface.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>attribute</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the EGL surface attribute to set.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>value</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the attributes required value.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1">
<a id="description"></a>
<h2>Description</h2>
<p>
<code class="function">eglSurfaceAttrib</code> sets the value of
<em class="parameter"><code>attribute</code></em> for
<em class="parameter"><code>surface</code></em> to
<em class="parameter"><code>value</code></em>.
<em class="parameter"><code>attribute</code></em> can be one of the
following:
</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="constant">EGL_MIPMAP_LEVEL</code>
</span>
</dt>
<dd>
<p>
For mipmap textures, the
<code class="constant">EGL_MIPMAP_LEVEL</code> attribute
indicates which level of the mipmap should be
rendered. If the value of this attribute is outside
the range of supported mipmap levels, the closest
valid mipmap level is selected for rendering. The
default value is <code class="constant">0</code>.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">EGL_MULTISAMPLE_RESOLVE</code>
</span>
</dt>
<dd>
<p>
Specifies the filter to use when resolving the
multisample buffer (this may occur when swapping or
copying the surface, or when changing the client API
context bound to the surface). A
<em class="parameter"><code>value</code></em> of
<code class="constant">EGL_MULTISAMPLE_RESOLVE_DEFAULT</code>
chooses the default implementation-defined filtering
method, while
<code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX</code>
chooses a one-pixel wide box filter placing equal
weighting on all multisample values.
</p>
<p>
The initial value of
<code class="constant">EGL_MULTISAMPLE_RESOLVE</code> is
<code class="constant">EGL_MULTISAMPLE_RESOLVE_DEFAULT</code>.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">EGL_SWAP_BEHAVIOR</code>
</span>
</dt>
<dd>
<p>
Specifies the effect on the color buffer of posting
a surface with
<a class="citerefentry" href="eglSwapBuffers.html"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a>.
A <em class="parameter"><code>value</code></em> of
<code class="constant">EGL_BUFFER_PRESERVED</code> indicates
that color buffer contents are unaffected, while
<code class="constant">EGL_BUFFER_DESTROYED</code> indicates
that color buffer contents may be destroyed or
changed by the operation.
</p>
<p>
The initial value of
<code class="constant">EGL_SWAP_BEHAVIOR</code> is chosen by
the implementation.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1">
<a id="notes"></a>
<h2>Notes</h2>
<p>
Attribute <code class="constant">EGL_MULTISAMPLE_RESOLVE</code> is
supported only if the EGL version is 1.4 or greater.
</p>
<p>
Attribute <code class="constant">EGL_SWAP_BEHAVIOR</code> is
supported only if the EGL version is 1.2 or greater.
</p>
<p>
If the value of pbuffer attribute
<code class="constant">EGL_TEXTURE_FORMAT</code> is
<code class="constant">EGL_NO_TEXTURE</code>, the value of attribute
<code class="constant">EGL_TEXTURE_TARGET</code> is
<code class="constant">EGL_NO_TEXTURE</code>, or
<em class="parameter"><code>surface</code></em> is not a pbuffer, then
attribute <code class="constant">EGL_MIPMAP_LEVEL</code> may be set,
but has no effect.
</p>
</div>
<div class="refsect1">
<a id="errors"></a>
<h2>Errors</h2>
<p>
<code class="constant">EGL_FALSE</code> is returned on failure,
<code class="constant">EGL_TRUE</code> otherwise.
</p>
<p>
<code class="constant">EGL_BAD_DISPLAY</code> is generated if
<em class="parameter"><code>display</code></em> is not an EGL display connection.
</p>
<p>
<code class="constant">EGL_BAD_MATCH</code> is generated if
<em class="parameter"><code>attribute</code></em> is
<code class="constant">EGL_MULTISAMPLE_RESOLVE</code>,
<em class="parameter"><code>value</code></em> is
<code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX</code>, and the
<code class="constant">EGL_SURFACE_TYPE</code> attribute of the
<span class="type">EGLConfig</span> used to create
<em class="parameter"><code>surface</code></em> does not contain
<code class="constant">EGL_MULTISAMPLE_RESOLVE_BOX_BIT</code>.
</p>
<p>
<code class="constant">EGL_BAD_MATCH</code> is generated if
<em class="parameter"><code>attribute</code></em> is
<code class="constant">EGL_SWAP_BEHAVIOR</code>,
<em class="parameter"><code>value</code></em> is
<code class="constant">EGL_BUFFER_PRESERVED</code>, and the
<code class="constant">EGL_SURFACE_TYPE</code> attribute of the
<span class="type">EGLConfig</span> used to create
<em class="parameter"><code>surface</code></em> does not contain
<code class="constant">EGL_SWAP_BEHAVIOR_PRESERVED_BIT</code>.
</p>
<p>
<code class="constant">EGL_NOT_INITIALIZED</code> is generated if
<em class="parameter"><code>display</code></em> has not been initialized.
</p>
<p>
<code class="constant">EGL_BAD_SURFACE</code> is generated if
<em class="parameter"><code>surface</code></em> is not an EGL surface.
</p>
<p>
<code class="constant">EGL_BAD_ATTRIBUTE</code> is generated if
<em class="parameter"><code>attribute</code></em> is not a valid surface attribute.
</p>
</div>
<div class="refsect1">
<a id="seealso"></a>
<h2>See Also</h2>
<p>
<a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>,
<a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>,
<a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>,
<a class="citerefentry" href="eglQuerySurface.html"><span class="citerefentry"><span class="refentrytitle">eglQuerySurface</span></span></a>
</p>
</div>
<div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>
Copyright © 2003-2014 The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.
</div>
</div>
</body>
</html>