mirror of
https://github.com/Ryujinx/Opentk.git
synced 2024-12-26 19:45:32 +00:00
177 lines
9.1 KiB
XML
177 lines
9.1 KiB
XML
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
|
|
|
|
<!-- Converted by db4-upgrade version 1.1 -->
|
|
|
|
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glFramebufferParameteri">
|
|
<info>
|
|
<copyright>
|
|
<year>2012-2014</year>
|
|
<holder>Khronos Group</holder>
|
|
</copyright>
|
|
</info>
|
|
<refmeta>
|
|
<refentrytitle>glFramebufferParameteri</refentrytitle>
|
|
<manvolnum>3G</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>glFramebufferParameteri</refname>
|
|
<refpurpose>set a named parameter of a framebuffer</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<title>C Specification</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>glFramebufferParameteri</function></funcdef>
|
|
<paramdef>GLenum <parameter>target</parameter></paramdef>
|
|
<paramdef>GLenum <parameter>pname</parameter></paramdef>
|
|
<paramdef>GLint <parameter>param</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1 xml:id="parameters"><title>Parameters</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>target</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The target of the operation, which must be <constant>GL_READ_FRAMEBUFFER</constant>,
|
|
<constant>GL_DRAW_FRAMEBUFFER</constant> or <constant>GL_FRAMEBUFFER</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>pname</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A token indicating the parameter to be modified.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>param</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The new value for the parameter named <parameter>pname</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 xml:id="description"><title>Description</title>
|
|
<para>
|
|
<function>glFramebufferParameteri</function> modifies the current value of the parameter
|
|
named <parameter>pname</parameter> in the framebuffer bound to <parameter>target</parameter>.
|
|
<parameter>target</parameter> must be <constant>GL_READ_FRAMEBFUFFER</constant>,
|
|
<constant>GL_DRAW_FRAMEBUFFER</constant> or <constant>GL_FRAMEBUFFER</constant>. The
|
|
token <constant>GL_FRAMEBUFFER</constant> is treated as <constant>GL_DRAW_FRAMEBUFFER</constant>.
|
|
A non-default framebuffer must be bound to <parameter>target</parameter>.
|
|
</para>
|
|
<para>
|
|
<parameter>pname</parameter> specifies the parameter to be modified. The following symbols
|
|
are accepted in <parameter>pname</parameter>:
|
|
</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>param</parameter> specifies the assumed with for a framebuffer object with no attachments. If a
|
|
framebuffer has attachments then the width of those attachments is used, otherwise
|
|
the value of <constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant> is used for the
|
|
framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than
|
|
or equal to the value of <constant>GL_MAX_FRAMEBUFFER_WIDTH</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>param</parameter> specifies the assumed height for a framebuffer object with no attachments. If a
|
|
framebuffer has attachments then the height of those attachments is used, otherwise
|
|
the value of <constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant> is used for the
|
|
framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than
|
|
or equal to the value of <constant>GL_MAX_FRAMEBUFFER_HEIGHT</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>param</parameter> specifies the assumed number of samples in a framebuffer object with no attachments. If a
|
|
framebuffer has attachments then the sample count of those attachments is used, otherwise
|
|
the value of <constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant> is used for the
|
|
framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than
|
|
or equal to the value of <constant>GL_MAX_FRAMEBUFFER_SAMPLE</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><constant>GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</constant></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>param</parameter> specifies whether the framebuffer should assume identical sample locations and
|
|
the same number of samples for all texels in the virtual image. If <parameter>param</parameter> is zero,
|
|
then the implementation may vary the position or the count of samples within the virtual image from
|
|
pixel to pixel, otherwise it will use the same sample position and count for all pixels in the virtual image.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 xml:id="errors"><title>Errors</title>
|
|
<para>
|
|
<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the accepted
|
|
framebuffer targets.
|
|
</para>
|
|
<para>
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant>
|
|
and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_WIDTH</constant>.
|
|
</para>
|
|
<para>
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant>
|
|
and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_HEIGHT</constant>.
|
|
</para>
|
|
<para>
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant>
|
|
and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_SAMPLES</constant>.
|
|
</para>
|
|
<para>
|
|
<constant>GL_INVALID_OPERATION</constant> is generated if the default framebuffer is bound to <parameter>target</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 xml:id="associatedgets"><title>Associated Gets</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glGetFramebufferParameteriv</refentrytitle></citerefentry>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 xml:id="versions">
|
|
<title>API Version Support</title>
|
|
<informaltable>
|
|
<tgroup cols="4" align="left">
|
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
|
|
<tbody>
|
|
<row>
|
|
<entry><function>glFramebufferParameteri</function></entry>
|
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='es31']/*)"/>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
<refsect1 xml:id="seealso"><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>,
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 xml:id="Copyright"><title>Copyright</title>
|
|
<para>
|
|
Copyright <trademark class="copyright"/> 2012-2014 Khronos Group.
|
|
This material may be distributed subject to the terms and conditions set forth in
|
|
the Open Publication License, v 1.0, 8 June 1999.
|
|
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|