+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>\r
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
- "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
-<refentry id="glFramebufferTexture">\r
- <refmeta>\r
- <refmetainfo>\r
- <copyright>\r
- <year>2010</year>\r
- <holder>Khronos Group</holder>\r
- </copyright>\r
- </refmetainfo>\r
- <refentrytitle>glFramebufferTexture</refentrytitle>\r
- <manvolnum>3G</manvolnum>\r
- </refmeta>\r
- <refnamediv>\r
- <refname>glFramebufferTexture</refname>\r
- <refpurpose>attach a level of a texture object as a logical buffer to the currently bound framebuffer object</refpurpose>\r
- </refnamediv>\r
- <refsynopsisdiv><title>C Specification</title>\r
- <funcsynopsis>\r
- <funcprototype>\r
- <funcdef>void <function>glFramebufferTexture</function></funcdef>\r
- <paramdef>GLenum <parameter>target</parameter></paramdef>\r
- <paramdef>GLenum <parameter>attachment</parameter></paramdef>\r
- <paramdef>GLuint <parameter>texture</parameter></paramdef>\r
- <paramdef>GLint <parameter>level</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>void <function>glFramebufferTexture1D</function></funcdef>\r
- <paramdef>GLenum <parameter>target</parameter></paramdef>\r
- <paramdef>GLenum <parameter>attachment</parameter></paramdef>\r
- <paramdef>GLenum <parameter>textarget</parameter></paramdef>\r
- <paramdef>GLuint <parameter>texture</parameter></paramdef>\r
- <paramdef>GLint <parameter>level</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>void <function>glFramebufferTexture2D</function></funcdef>\r
- <paramdef>GLenum <parameter>target</parameter></paramdef>\r
- <paramdef>GLenum <parameter>attachment</parameter></paramdef>\r
- <paramdef>GLenum <parameter>textarget</parameter></paramdef>\r
- <paramdef>GLuint <parameter>texture</parameter></paramdef>\r
- <paramdef>GLint <parameter>level</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>void <function>glFramebufferTexture3D</function></funcdef>\r
- <paramdef>GLenum <parameter>target</parameter></paramdef>\r
- <paramdef>GLenum <parameter>attachment</parameter></paramdef>\r
- <paramdef>GLenum <parameter>textarget</parameter></paramdef>\r
- <paramdef>GLuint <parameter>texture</parameter></paramdef>\r
- <paramdef>GLint <parameter>level</parameter></paramdef>\r
- <paramdef>GLint <parameter>layer</parameter></paramdef>\r
- </funcprototype>\r
- </funcsynopsis>\r
- </refsynopsisdiv>\r
- <!-- eqn: ignoring delim $$ -->\r
- <refsect1 id="parameters"><title>Parameters</title>\r
- <variablelist>\r
- <varlistentry>\r
- <term><parameter>target</parameter></term>\r
- <listitem>\r
- <para>\r
- Specifies the framebuffer target. <parameter>target</parameter> must be <constant>GL_DRAW_FRAMEBUFFER</constant>,\r
- <constant>GL_READ_FRAMEBUFFER</constant>, or <constant>GL_FRAMEBUFFER</constant>. <constant>GL_FRAMEBUFFER</constant>\r
- is equivalent to <constant>GL_DRAW_FRAMEBUFFER</constant>.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>attachment</parameter></term>\r
- <listitem>\r
- <para>\r
- Specifies the attachment point of the framebuffer. <parameter>attachment</parameter> must be\r
- <constant>GL_COLOR_ATTACHMENT<emphasis>i</emphasis></constant>, <constant>GL_DEPTH_ATTACHMENT</constant>,\r
- <constant>GL_STENCIL_ATTACHMENT</constant> or <constant>GL_DEPTH_STENCIL_ATTACHMMENT</constant>.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>textarget</parameter></term>\r
- <listitem>\r
- <para>\r
- For <function>glFramebufferTexture1D</function>, <function>glFramebufferTexture2D</function> and\r
- <function>glFramebufferTexture3D</function>, specifies what type of texture is expected\r
- in the <parameter>texture</parameter> parameter, or for cube map textures, which face is to be attached.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>texture</parameter></term>\r
- <listitem>\r
- <para>\r
- Specifies the texture object to attach to the framebuffer attachment point named by <parameter>attachment</parameter>.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>level</parameter></term>\r
- <listitem>\r
- <para>\r
- Specifies the mipmap level of <parameter>texture</parameter> to attach.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
- </refsect1>\r
- <refsect1 id="description"><title>Description</title>\r
- <para>\r
- <function>glFramebufferTexture</function>, <function>glFramebufferTexture1D</function>, <function>glFramebufferTexture2D</function>,\r
- and <function>glFramebufferTexture</function> attach a selected mipmap level or image of a texture object as one of the\r
- logical buffers of the framebuffer object currently bound to <parameter>target</parameter>. <parameter>target</parameter> must\r
- be <constant>GL_DRAW_FRAMEBUFFER</constant>, <constant>GL_READ_FRAMEBUFFER</constant>, or <constant>GL_FRAMEBUFFER</constant>.\r
- <constant>GL_FRAMEBUFFER</constant> is equivalent to <constant>GL_DRAW_FRAMEBUFFER</constant>.\r
- </para>\r
- <para>\r
- <parameter>attachment</parameter> specifies the logical attachment of the framebuffer and must be\r
- <constant>GL_COLOR_ATTACHMENT<emphasis>i</emphasis></constant>, <constant>GL_DEPTH_ATTACHMENT</constant>,\r
- <constant>GL_STENCIL_ATTACHMENT</constant> or <constant>GL_DEPTH_STENCIL_ATTACHMMENT</constant>.\r
- <emphasis>i</emphasis> in <constant>GL_COLOR_ATTACHMENT<emphasis>i</emphasis></constant> may range from zero to\r
- the value of <constant>GL_MAX_COLOR_ATTACHMENTS</constant> - 1. Attaching a level of a texture to\r
- <constant>GL_DEPTH_STENCIL_ATTACHMENT</constant> is equivalent to attaching that level to both the\r
- <constant>GL_DEPTH_ATTACHMENT</constant> <emphasis>and</emphasis> the <constant>GL_STENCIL_ATTACHMENT</constant>\r
- attachment points simultaneously.\r
- </para>\r
- <para>\r
- <parameter>textarget</parameter> specifies what type of texture is named by <parameter>texture</parameter>, and for\r
- cube map textures, specifies the face that is to be attached. If <parameter>texture</parameter> is not zero, it\r
- must be the name of an existing texture with type <parameter>textarget</parameter>, unless it is a cube map\r
- texture, in which case <parameter>textarget</parameter> must be <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>\r
- <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>, <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>,\r
- <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>, <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>, or\r
- <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>.\r
- </para>\r
- <para>\r
- If <parameter>texture</parameter> is non-zero, the specified <parameter>level</parameter> of the texture object named\r
- <parameter>texture</parameter> is attached to the framebfufer attachment point named by <parameter>attachment</parameter>.\r
- For <function>glFramebufferTexture1D</function>, <function>glFramebufferTexture2D</function>, and\r
- <function>glFramebufferTexture3D</function>, <parameter>texture</parameter> must be zero or the name of an existing\r
- texture with a target of <parameter>textarget</parameter>, or <parameter>texture</parameter> must be the name\r
- of an existing cube-map texture and <parameter>textarget</parameter> must be one of <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>,\r
- <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>, <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>,\r
- <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>, <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>, or\r
- <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>.\r
- </para>\r
- <para>\r
- If <parameter>textarget</parameter> is <constant>GL_TEXTURE_RECTANGLE</constant>, <constant>GL_TEXTURE_2D_MULTISAMPLE</constant>,\r
- or <constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant>, then <parameter>level</parameter> must be zero. If <parameter>textarget</parameter>\r
- is <constant>GL_TEXTURE_3D</constant>, then level must be greater than or equal to zero and less than or equal to log<subscript>2</subscript>\r
- of the value of <constant>GL_MAX_3D_TEXTURE_SIZE</constant>. If <parameter>textarget</parameter> is one of <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>,\r
- <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>, <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>, <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>,\r
- <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>, or <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>, then <parameter>level</parameter> must be greater\r
- than or equal to zero and less than or equal to log<subscript>2</subscript> of the value of <constant>GL_MAX_CUBE_MAP_TEXTURE_SIZE</constant>. For all other\r
- values of <parameter>textarget</parameter>, <parameter>level</parameter> must be greater than or equal to zero and no larger than log<subscript>2</subscript>\r
- of the value of <constant>GL_MAX_TEXTURE_SIZE</constant>.\r
- </para>\r
- <para>\r
- <parameter>layer</parameter> specifies the layer of a 2-dimensional image within a 3-dimensional texture.\r
- </para>\r
- <para>\r
- For <function>glFramebufferTexture1D</function>, if <parameter>texture</parameter> is not zero, then <parameter>textarget</parameter> must\r
- be <constant>GL_TEXTURE_1D</constant>. For <function>glFramebufferTexture2D</function>, if <parameter>texture</parameter> is not zero,\r
- <parameter>textarget</parameter> must be one of <constant>GL_TEXTURE_2D</constant>, <constant>GL_TEXTURE_RECTANGLE</constant>,\r
- <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>, <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>, <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>,\r
- <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>, <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>, <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>, or\r
- <constant>GL_TEXTURE_2D_MULTISAMPLE</constant>. For <function>glFramebufferTexture3D</function>, if <parameter>texture</parameter> is\r
- not zero, then <parameter>textarget</parameter> must be <constant>GL_TEXTURE_3D</constant>.\r
- </para>\r
- </refsect1>\r
- <refsect1 id="notes"><title>Notes</title>\r
- <para>\r
- <function>glFramebufferTexture</function> is available only if the GL version is 3.2 or greater.\r
- </para>\r
- </refsect1>\r
- <refsect1 id="errors"><title>Errors</title>\r
- <para>\r
- <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the accepted tokens.\r
- </para>\r
- <para>\r
- <constant>GL_INVALID_ENUM</constant> is generated if <parameter>renderbuffertarget</parameter> is not <constant>GL_RENDERBUFFER</constant>.\r
- </para>\r
- <para>\r
- <constant>GL_INVALID_OPERATION</constant> is generated if zero is bound to <parameter>target</parameter>.\r
- </para>\r
- <para>\r
- <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>textarget</parameter> and <parameter>texture</parameter>\r
- are not compatible.\r
- </para>\r
- </refsect1>\r
- <refsect1 id="seealso"><title>See Also</title>\r
- <para>\r
- <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>glFramebufferTexture</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>glFramebufferTexture1D</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>glFramebufferTexture2D</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>glFramebufferTexture3D</refentrytitle></citerefentry>\r
- </para>\r
- </refsect1>\r
- <refsect1 id="Copyright"><title>Copyright</title>\r
- <para>\r
- Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
- This material may be distributed subject to the terms and conditions set forth in \r
- the Open Publication License, v 1.0, 8 June 1999.\r
- <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
- </para>\r
- </refsect1>\r
-</refentry>\r
HCoop / clinton / guile-figl.git / blobdiff