2009-03-08 00:46:58 +00:00
<?xml version="1.0" encoding="UTF-8"?>
< !DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id= "glTexSubImage3D" >
2013-11-03 11:43:50 +00:00
<refentryinfo >
<copyright >
<year > 1991-2006</year>
<holder > Silicon Graphics, Inc.</holder>
</copyright>
2013-12-15 21:32:32 +00:00
<copyright >
<year > 2010-2013</year>
<holder > Khronos Group</holder>
</copyright>
2013-11-03 11:43:50 +00:00
</refentryinfo>
2009-03-08 00:46:58 +00:00
<refmeta >
<refentrytitle > glTexSubImage3D</refentrytitle>
<manvolnum > 3G</manvolnum>
</refmeta>
<refnamediv >
<refname > glTexSubImage3D</refname>
<refpurpose > specify a three-dimensional texture subimage</refpurpose>
</refnamediv>
<refsynopsisdiv > <title > C Specification</title>
<funcsynopsis >
<funcprototype >
<funcdef > void <function > glTexSubImage3D</function> </funcdef>
<paramdef > GLenum <parameter > target</parameter> </paramdef>
<paramdef > GLint <parameter > level</parameter> </paramdef>
<paramdef > GLint <parameter > xoffset</parameter> </paramdef>
<paramdef > GLint <parameter > yoffset</parameter> </paramdef>
<paramdef > GLint <parameter > zoffset</parameter> </paramdef>
<paramdef > GLsizei <parameter > width</parameter> </paramdef>
<paramdef > GLsizei <parameter > height</parameter> </paramdef>
<paramdef > GLsizei <parameter > depth</parameter> </paramdef>
<paramdef > GLenum <parameter > format</parameter> </paramdef>
<paramdef > GLenum <parameter > type</parameter> </paramdef>
<paramdef > const GLvoid * <parameter > data</parameter> </paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id= "parameters" > <title > Parameters</title>
<variablelist >
<varlistentry >
<term > <parameter > target</parameter> </term>
<listitem >
<para >
Specifies the target texture.
2013-10-23 18:17:08 +00:00
Must be <constant > GL_TEXTURE_3D</constant> or <constant > GL_TEXTURE_2D_ARRAY</constant> .
2009-03-08 00:46:58 +00:00
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > level</parameter> </term>
<listitem >
<para >
Specifies the level-of-detail number.
Level 0 is the base image level.
Level <emphasis > n</emphasis> is the <emphasis > n</emphasis> th mipmap reduction image.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > xoffset</parameter> </term>
<listitem >
<para >
Specifies a texel offset in the x direction within the texture array.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > yoffset</parameter> </term>
<listitem >
<para >
Specifies a texel offset in the y direction within the texture array.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > zoffset</parameter> </term>
<listitem >
<para >
Specifies a texel offset in the z direction within the texture array.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > width</parameter> </term>
<listitem >
<para >
Specifies the width of the texture subimage.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > height</parameter> </term>
<listitem >
<para >
Specifies the height of the texture subimage.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > depth</parameter> </term>
<listitem >
<para >
Specifies the depth of the texture subimage.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > format</parameter> </term>
<listitem >
<para >
Specifies the format of the pixel data.
The following symbolic values are accepted:
<constant > GL_RED</constant> ,
2010-11-21 14:34:29 +00:00
<constant > GL_RG</constant> ,
2009-03-08 00:46:58 +00:00
<constant > GL_RGB</constant> ,
<constant > GL_BGR</constant> ,
2013-10-23 18:17:08 +00:00
<constant > GL_RGBA</constant> ,
<constant > GL_DEPTH_COMPONENT</constant> , and
<constant > GL_STENCIL_INDEX</constant> .
2009-03-08 00:46:58 +00:00
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > type</parameter> </term>
<listitem >
<para >
Specifies the data type of the pixel data.
The following symbolic values are accepted:
<constant > GL_UNSIGNED_BYTE</constant> ,
<constant > GL_BYTE</constant> ,
<constant > GL_UNSIGNED_SHORT</constant> ,
<constant > GL_SHORT</constant> ,
<constant > GL_UNSIGNED_INT</constant> ,
<constant > GL_INT</constant> ,
<constant > GL_FLOAT</constant> ,
<constant > GL_UNSIGNED_BYTE_3_3_2</constant> ,
<constant > GL_UNSIGNED_BYTE_2_3_3_REV</constant> ,
<constant > GL_UNSIGNED_SHORT_5_6_5</constant> ,
<constant > GL_UNSIGNED_SHORT_5_6_5_REV</constant> ,
<constant > GL_UNSIGNED_SHORT_4_4_4_4</constant> ,
<constant > GL_UNSIGNED_SHORT_4_4_4_4_REV</constant> ,
<constant > GL_UNSIGNED_SHORT_5_5_5_1</constant> ,
<constant > GL_UNSIGNED_SHORT_1_5_5_5_REV</constant> ,
<constant > GL_UNSIGNED_INT_8_8_8_8</constant> ,
<constant > GL_UNSIGNED_INT_8_8_8_8_REV</constant> ,
<constant > GL_UNSIGNED_INT_10_10_10_2</constant> , and
<constant > GL_UNSIGNED_INT_2_10_10_10_REV</constant> .
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <parameter > data</parameter> </term>
<listitem >
<para >
Specifies a pointer to the image data in memory.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id= "description" > <title > Description</title>
<para >
Texturing maps a portion of a specified texture image
onto each graphical primitive for which texturing is enabled.
</para>
<para >
<function > glTexSubImage3D</function> redefines a contiguous subregion of an existing three-dimensional
2013-10-23 18:17:08 +00:00
or two-dimensioanl array texture image.
2009-03-08 00:46:58 +00:00
The texels referenced by <parameter > data</parameter> replace the portion of the
existing texture array with x indices <parameter > xoffset</parameter> and
<inlineequation > <mml:math >
2010-11-21 14:34:29 +00:00
<!-- eqn: xoffset + width - 1: -->
2009-03-08 00:46:58 +00:00
<mml:mrow >
<mml:mi mathvariant= "italic" > xoffset</mml:mi>
<mml:mo > +</mml:mo>
<mml:mi mathvariant= "italic" > width</mml:mi>
<mml:mo > -</mml:mo>
<mml:mn > 1</mml:mn>
</mml:mrow>
</mml:math> </inlineequation> ,
inclusive,
2013-11-03 11:43:50 +00:00
y indices <parameter > yoffset</parameter> and
2009-03-08 00:46:58 +00:00
<inlineequation > <mml:math >
2010-11-21 14:34:29 +00:00
<!-- eqn: yoffset + height - 1: -->
2009-03-08 00:46:58 +00:00
<mml:mrow >
<mml:mi mathvariant= "italic" > yoffset</mml:mi>
<mml:mo > +</mml:mo>
<mml:mi mathvariant= "italic" > height</mml:mi>
<mml:mo > -</mml:mo>
<mml:mn > 1</mml:mn>
</mml:mrow>
</mml:math> </inlineequation> ,
inclusive,
2013-11-03 11:43:50 +00:00
and z indices <parameter > zoffset</parameter> and
2009-03-08 00:46:58 +00:00
<inlineequation > <mml:math >
2010-11-21 14:34:29 +00:00
<!-- eqn: zoffset + depth - 1: -->
2009-03-08 00:46:58 +00:00
<mml:mrow >
<mml:mi mathvariant= "italic" > zoffset</mml:mi>
<mml:mo > +</mml:mo>
<mml:mi mathvariant= "italic" > depth</mml:mi>
<mml:mo > -</mml:mo>
<mml:mn > 1</mml:mn>
</mml:mrow>
</mml:math> </inlineequation> ,
inclusive.
2013-10-23 18:17:08 +00:00
For three-dimensional textures, the z index refers to the third
dimension. For two-dimensional array textures, the z index refers to
the slice index.
2009-03-08 00:46:58 +00:00
This region may not include any texels outside the range of the
texture array as it was originally specified.
It is not an error to specify a subtexture with zero width, height, or
depth but such a specification has no effect.
</para>
<para >
2013-11-03 11:43:50 +00:00
If a non-zero named buffer object is bound to the <constant > GL_PIXEL_UNPACK_BUFFER</constant> target
2009-03-08 00:46:58 +00:00
(see <citerefentry > <refentrytitle > glBindBuffer</refentrytitle> </citerefentry> ) while a texture image is
specified, <parameter > data</parameter> is treated as a byte offset into the buffer object's data store.
</para>
</refsect1>
<refsect1 id= "notes" > <title > Notes</title>
<para >
2010-11-21 14:34:29 +00:00
The <citerefentry > <refentrytitle > glPixelStore</refentrytitle> </citerefentry> modes affect texture images.
2009-03-08 00:46:58 +00:00
</para>
<para >
2013-10-23 18:17:08 +00:00
<function > glTexSubImage3D</function> specifies a three-dimensional or two-dimenaional array subtexture for the current texture unit,
2009-03-08 00:46:58 +00:00
specified with <citerefentry > <refentrytitle > glActiveTexture</refentrytitle> </citerefentry> .
</para>
2013-10-23 18:17:08 +00:00
<para >
<constant > GL_STENCIL_INDEX</constant> is accepted for <parameter > format</parameter> only if the GL version
is 4.4 or higher.
</para>
2009-03-08 00:46:58 +00:00
</refsect1>
<refsect1 id= "errors" > <title > Errors</title>
<para >
2013-10-23 18:17:08 +00:00
<constant > GL_INVALID_ENUM</constant> is generated if /<parameter > target</parameter> is not <constant > GL_TEXTURE_3D</constant> or <constant > GL_TEXTURE_2D_ARRAY</constant> .
2009-03-08 00:46:58 +00:00
</para>
<para >
<constant > GL_INVALID_ENUM</constant> is generated if <parameter > format</parameter> is not an accepted
format constant.
</para>
<para >
<constant > GL_INVALID_ENUM</constant> is generated if <parameter > type</parameter> is not a type constant.
</para>
<para >
<constant > GL_INVALID_VALUE</constant> is generated if <parameter > level</parameter> is less than 0.
</para>
<para >
<constant > GL_INVALID_VALUE</constant> may be generated if <parameter > level</parameter> is greater
2013-11-03 11:43:50 +00:00
than
2009-03-08 00:46:58 +00:00
<inlineequation > <mml:math >
2010-11-21 14:34:29 +00:00
<!-- eqn: log sub 2: -->
2009-03-08 00:46:58 +00:00
<mml:msub > <mml:mi mathvariant= "italic" > log</mml:mi>
<mml:mn > 2</mml:mn>
</mml:msub>
</mml:math> </inlineequation>
<emphasis > max</emphasis> ,
where <emphasis > max</emphasis> is the returned value of <constant > GL_MAX_TEXTURE_SIZE</constant> .
</para>
<para >
2013-11-03 11:43:50 +00:00
<constant > GL_INVALID_VALUE</constant> is generated if
2009-03-08 00:46:58 +00:00
<inlineequation > <mml:math >
2010-11-21 14:34:29 +00:00
<!-- eqn: xoffset < - b: -->
2009-03-08 00:46:58 +00:00
<mml:mrow >
<mml:mi mathvariant= "italic" > xoffset</mml:mi>
<mml:mo > < </mml:mo>
<mml:mrow >
<mml:mo > -</mml:mo>
<mml:mi mathvariant= "italic" > b</mml:mi>
</mml:mrow>
</mml:mrow>
</mml:math> </inlineequation> ,
<inlineequation > <mml:math >
2010-11-21 14:34:29 +00:00
<!-- eqn: (xoffset + width) > (w - b): -->
2009-03-08 00:46:58 +00:00
<mml:mrow >
<mml:mfenced open= "(" close= ")" >
<mml:mrow >
<mml:mi mathvariant= "italic" > xoffset</mml:mi>
<mml:mo > +</mml:mo>
<mml:mi mathvariant= "italic" > width</mml:mi>
</mml:mrow>
</mml:mfenced>
<mml:mo > > </mml:mo>
<mml:mfenced open= "(" close= ")" >
<mml:mrow >
<mml:mi mathvariant= "italic" > w</mml:mi>
<mml:mo > -</mml:mo>
<mml:mi mathvariant= "italic" > b</mml:mi>
</mml:mrow>
</mml:mfenced>
</mml:mrow>
</mml:math> </inlineequation> ,
<inlineequation > <mml:math >
2010-11-21 14:34:29 +00:00
<!-- eqn: yoffset < - b: -->
2009-03-08 00:46:58 +00:00
<mml:mrow >
<mml:mi mathvariant= "italic" > yoffset</mml:mi>
<mml:mo > < </mml:mo>
<mml:mrow >
<mml:mo > -</mml:mo>
<mml:mi mathvariant= "italic" > b</mml:mi>
</mml:mrow>
</mml:mrow>
</mml:math> </inlineequation> ,
2013-11-03 11:43:50 +00:00
or
2009-03-08 00:46:58 +00:00
<inlineequation > <mml:math >
2010-11-21 14:34:29 +00:00
<!-- eqn: (yoffset + height) > (h - b): -->
2009-03-08 00:46:58 +00:00
<mml:mrow >
<mml:mfenced open= "(" close= ")" >
<mml:mrow >
<mml:mi mathvariant= "italic" > yoffset</mml:mi>
<mml:mo > +</mml:mo>
<mml:mi mathvariant= "italic" > height</mml:mi>
</mml:mrow>
</mml:mfenced>
<mml:mo > > </mml:mo>
<mml:mfenced open= "(" close= ")" >
<mml:mrow >
<mml:mi mathvariant= "italic" > h</mml:mi>
<mml:mo > -</mml:mo>
<mml:mi mathvariant= "italic" > b</mml:mi>
</mml:mrow>
</mml:mfenced>
</mml:mrow>
</mml:math> </inlineequation> ,
2013-11-03 11:43:50 +00:00
or
2009-03-08 00:46:58 +00:00
<inlineequation > <mml:math >
2010-11-21 14:34:29 +00:00
<!-- eqn: zoffset < - b: -->
2009-03-08 00:46:58 +00:00
<mml:mrow >
<mml:mi mathvariant= "italic" > zoffset</mml:mi>
<mml:mo > < </mml:mo>
<mml:mrow >
<mml:mo > -</mml:mo>
<mml:mi mathvariant= "italic" > b</mml:mi>
</mml:mrow>
</mml:mrow>
</mml:math> </inlineequation> ,
2013-11-03 11:43:50 +00:00
or
2009-03-08 00:46:58 +00:00
<inlineequation > <mml:math >
2010-11-21 14:34:29 +00:00
<!-- eqn: (zoffset + depth) > (d - b): -->
2009-03-08 00:46:58 +00:00
<mml:mrow >
<mml:mfenced open= "(" close= ")" >
<mml:mrow >
<mml:mi mathvariant= "italic" > zoffset</mml:mi>
<mml:mo > +</mml:mo>
<mml:mi mathvariant= "italic" > depth</mml:mi>
</mml:mrow>
</mml:mfenced>
<mml:mo > > </mml:mo>
<mml:mfenced open= "(" close= ")" >
<mml:mrow >
<mml:mi mathvariant= "italic" > d</mml:mi>
<mml:mo > -</mml:mo>
<mml:mi mathvariant= "italic" > b</mml:mi>
</mml:mrow>
</mml:mfenced>
</mml:mrow>
</mml:math> </inlineequation> ,
2013-11-03 11:43:50 +00:00
where
2009-03-08 00:46:58 +00:00
<inlineequation > <mml:math > <mml:mi mathvariant= "italic" > w</mml:mi> </mml:math> </inlineequation>
is the <constant > GL_TEXTURE_WIDTH</constant> ,
<inlineequation > <mml:math > <mml:mi mathvariant= "italic" > h</mml:mi> </mml:math> </inlineequation>
2013-11-03 11:43:50 +00:00
is the <constant > GL_TEXTURE_HEIGHT</constant> ,
2009-03-08 00:46:58 +00:00
<inlineequation > <mml:math > <mml:mi mathvariant= "italic" > d</mml:mi> </mml:math> </inlineequation>
2013-11-03 11:43:50 +00:00
is the <constant > GL_TEXTURE_DEPTH</constant>
and
2009-03-08 00:46:58 +00:00
<inlineequation > <mml:math > <mml:mi mathvariant= "italic" > b</mml:mi> </mml:math> </inlineequation>
is the border width of the texture image being modified.
2013-11-03 11:43:50 +00:00
Note that
2009-03-08 00:46:58 +00:00
<inlineequation > <mml:math > <mml:mi mathvariant= "italic" > w</mml:mi> </mml:math> </inlineequation> ,
<inlineequation > <mml:math > <mml:mi mathvariant= "italic" > h</mml:mi> </mml:math> </inlineequation> ,
2013-11-03 11:43:50 +00:00
and
2009-03-08 00:46:58 +00:00
<inlineequation > <mml:math > <mml:mi mathvariant= "italic" > d</mml:mi> </mml:math> </inlineequation>
include twice the border width.
</para>
<para >
<constant > GL_INVALID_VALUE</constant> is generated if <parameter > width</parameter> , <parameter > height</parameter> , or <parameter > depth</parameter>
is less than 0.
</para>
<para >
<constant > GL_INVALID_OPERATION</constant> is generated if the texture array has not
2013-11-03 11:43:50 +00:00
been defined by a previous <citerefentry > <refentrytitle > glTexImage3D</refentrytitle> </citerefentry>
2013-10-23 18:17:08 +00:00
or <citerefentry > <refentrytitle > glTexStorage3D</refentrytitle> </citerefentry> operation.
2009-03-08 00:46:58 +00:00
</para>
<para >
<constant > GL_INVALID_OPERATION</constant> is generated if <parameter > type</parameter> is one of
<constant > GL_UNSIGNED_BYTE_3_3_2</constant> ,
<constant > GL_UNSIGNED_BYTE_2_3_3_REV</constant> ,
<constant > GL_UNSIGNED_SHORT_5_6_5</constant> , or
<constant > GL_UNSIGNED_SHORT_5_6_5_REV</constant>
and <parameter > format</parameter> is not <constant > GL_RGB</constant> .
</para>
<para >
<constant > GL_INVALID_OPERATION</constant> is generated if <parameter > type</parameter> is one of
<constant > GL_UNSIGNED_SHORT_4_4_4_4</constant> ,
<constant > GL_UNSIGNED_SHORT_4_4_4_4_REV</constant> ,
<constant > GL_UNSIGNED_SHORT_5_5_5_1</constant> ,
<constant > GL_UNSIGNED_SHORT_1_5_5_5_REV</constant> ,
<constant > GL_UNSIGNED_INT_8_8_8_8</constant> ,
<constant > GL_UNSIGNED_INT_8_8_8_8_REV</constant> ,
<constant > GL_UNSIGNED_INT_10_10_10_2</constant> , or
<constant > GL_UNSIGNED_INT_2_10_10_10_REV</constant>
and <parameter > format</parameter> is neither <constant > GL_RGBA</constant> nor <constant > GL_BGRA</constant> .
</para>
2013-10-23 18:17:08 +00:00
<para >
<constant > GL_INVALID_OPERATION</constant> is generated if <parameter > format</parameter> is <constant > GL_STENCIL_INDEX</constant>
and the base internal format is not <constant > GL_STENCIL_INDEX</constant> .
</para>
2009-03-08 00:46:58 +00:00
<para >
<constant > GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
<constant > GL_PIXEL_UNPACK_BUFFER</constant> target and the buffer object's data store is currently mapped.
</para>
<para >
<constant > GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
2013-11-03 11:43:50 +00:00
<constant > GL_PIXEL_UNPACK_BUFFER</constant> target and the data would be unpacked from the buffer
2009-03-08 00:46:58 +00:00
object such that the memory reads required would exceed the data store size.
</para>
<para >
<constant > GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
2013-11-03 11:43:50 +00:00
<constant > GL_PIXEL_UNPACK_BUFFER</constant> target and <parameter > data</parameter> is not evenly divisible
2009-03-08 00:46:58 +00:00
into the number of bytes needed to store in memory a datum indicated by <parameter > type</parameter> .
</para>
</refsect1>
<refsect1 id= "associatedgets" > <title > Associated Gets</title>
<para >
<citerefentry > <refentrytitle > glGetTexImage</refentrytitle> </citerefentry>
</para>
<para >
<citerefentry > <refentrytitle > glGet</refentrytitle> </citerefentry> with argument <constant > GL_PIXEL_UNPACK_BUFFER_BINDING</constant>
</para>
</refsect1>
<refsect1 id= "seealso" > <title > See Also</title>
<para >
<citerefentry > <refentrytitle > glActiveTexture</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCopyTexImage1D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCopyTexImage2D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCopyTexSubImage1D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCopyTexSubImage2D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glCopyTexSubImage3D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glPixelStore</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexImage1D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexImage2D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexImage3D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexSubImage1D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexSubImage2D</refentrytitle> </citerefentry> ,
<citerefentry > <refentrytitle > glTexParameter</refentrytitle> </citerefentry>
</para>
</refsect1>
<refsect1 id= "Copyright" > <title > Copyright</title>
<para >
2013-12-15 21:32:32 +00:00
Copyright <trademark class= "copyright" > </trademark> 1991-2006 Silicon Graphics, Inc.
Copyright <trademark class= "copyright" > </trademark> 2010-2013 Khronos Group.
This document is licensed under the SGI Free Software B License.
For details, see
2009-03-08 00:46:58 +00:00
<ulink url= "http://oss.sgi.com/projects/FreeB/" > http://oss.sgi.com/projects/FreeB/</ulink> .
</para>
</refsect1>
</refentry>
