--- /dev/null
+<?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" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glTexSubImage3D - OpenGL 3.3 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glTexSubImage3D"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glTexSubImage3D — specify a three-dimensional texture subimage</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glTexSubImage3D</b>(</code></td><td>GLenum </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">level</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">xoffset</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">yoffset</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">zoffset</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">width</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">height</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">depth</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">format</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">type</var>, </td></tr><tr><td> </td><td>const GLvoid * </td><td><var class="pdparam">data</var><code>)</code>;</td></tr></table></div></div><p>
+ </p><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p>
+ Specifies the target texture.
+ Must be <code class="constant">GL_TEXTURE_3D</code> or <code class="constant">GL_TEXTURE_2D_ARRAY</code>.
+ </p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
+ Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level <span class="emphasis"><em>n</em></span> is the <span class="emphasis"><em>n</em></span>th mipmap reduction image.
+ </p></dd><dt><span class="term"><em class="parameter"><code>xoffset</code></em></span></dt><dd><p>
+ Specifies a texel offset in the x direction within the texture array.
+ </p></dd><dt><span class="term"><em class="parameter"><code>yoffset</code></em></span></dt><dd><p>
+ Specifies a texel offset in the y direction within the texture array.
+ </p></dd><dt><span class="term"><em class="parameter"><code>zoffset</code></em></span></dt><dd><p>
+ Specifies a texel offset in the z direction within the texture array.
+ </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p>
+ Specifies the width of the texture subimage.
+ </p></dd><dt><span class="term"><em class="parameter"><code>height</code></em></span></dt><dd><p>
+ Specifies the height of the texture subimage.
+ </p></dd><dt><span class="term"><em class="parameter"><code>depth</code></em></span></dt><dd><p>
+ Specifies the depth of the texture subimage.
+ </p></dd><dt><span class="term"><em class="parameter"><code>format</code></em></span></dt><dd><p>
+ Specifies the format of the pixel data.
+ The following symbolic values are accepted:
+ <code class="constant">GL_RED</code>,
+ <code class="constant">GL_RG</code>,
+ <code class="constant">GL_RGB</code>,
+ <code class="constant">GL_BGR</code>,
+ <code class="constant">GL_RGBA</code>, and
+ <code class="constant">GL_BGRA</code>.
+ </p></dd><dt><span class="term"><em class="parameter"><code>type</code></em></span></dt><dd><p>
+ Specifies the data type of the pixel data.
+ The following symbolic values are accepted:
+ <code class="constant">GL_UNSIGNED_BYTE</code>,
+ <code class="constant">GL_BYTE</code>,
+ <code class="constant">GL_UNSIGNED_SHORT</code>,
+ <code class="constant">GL_SHORT</code>,
+ <code class="constant">GL_UNSIGNED_INT</code>,
+ <code class="constant">GL_INT</code>,
+ <code class="constant">GL_FLOAT</code>,
+ <code class="constant">GL_UNSIGNED_BYTE_3_3_2</code>,
+ <code class="constant">GL_UNSIGNED_BYTE_2_3_3_REV</code>,
+ <code class="constant">GL_UNSIGNED_SHORT_5_6_5</code>,
+ <code class="constant">GL_UNSIGNED_SHORT_5_6_5_REV</code>,
+ <code class="constant">GL_UNSIGNED_SHORT_4_4_4_4</code>,
+ <code class="constant">GL_UNSIGNED_SHORT_4_4_4_4_REV</code>,
+ <code class="constant">GL_UNSIGNED_SHORT_5_5_5_1</code>,
+ <code class="constant">GL_UNSIGNED_SHORT_1_5_5_5_REV</code>,
+ <code class="constant">GL_UNSIGNED_INT_8_8_8_8</code>,
+ <code class="constant">GL_UNSIGNED_INT_8_8_8_8_REV</code>,
+ <code class="constant">GL_UNSIGNED_INT_10_10_10_2</code>, and
+ <code class="constant">GL_UNSIGNED_INT_2_10_10_10_REV</code>.
+ </p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p>
+ Specifies a pointer to the image data in memory.
+ </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
+ Texturing maps a portion of a specified texture image
+ onto each graphical primitive for which texturing is enabled.
+ </p><p>
+ <code class="function">glTexSubImage3D</code> redefines a contiguous subregion of an existing three-dimensional
+ or two-dimensioanl array texture image.
+ The texels referenced by <em class="parameter"><code>data</code></em> replace the portion of the
+ existing texture array with x indices <em class="parameter"><code>xoffset</code></em> and
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <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>,
+ inclusive,
+ y indices <em class="parameter"><code>yoffset</code></em> and
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <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>,
+ inclusive,
+ and z indices <em class="parameter"><code>zoffset</code></em> and
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <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>,
+ inclusive.
+ 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.
+ 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.
+ </p><p>
+ If a non-zero named buffer object is bound to the <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target
+ (see <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>) while a texture image is
+ specified, <em class="parameter"><code>data</code></em> is treated as a byte offset into the buffer object's data store.
+ </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
+ The <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a> modes affect texture images.
+ </p><p>
+ <code class="function">glTexSubImage3D</code> specifies a three-dimensional or two-dimenaional array subtexture for the current texture unit,
+ specified with <a href="glActiveTexture.xml"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>.
+ </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
+ <code class="constant">GL_INVALID_ENUM</code> is generated if /<em class="parameter"><code>target</code></em> is not <code class="constant">GL_TEXTURE_3D</code> or <code class="constant">GL_TEXTURE_2D_ARRAY</code>.
+ </p><p>
+ <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>format</code></em> is not an accepted
+ format constant.
+ </p><p>
+ <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>type</code></em> is not a type constant.
+ </p><p>
+ <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>level</code></em> is less than 0.
+ </p><p>
+ <code class="constant">GL_INVALID_VALUE</code> may be generated if <em class="parameter"><code>level</code></em> is greater
+ than
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <mml:msub><mml:mi mathvariant="italic">log</mml:mi>
+ <mml:mn>2</mml:mn>
+ </mml:msub>
+ </mml:math>
+ <span class="emphasis"><em>max</em></span>,
+ where <span class="emphasis"><em>max</em></span> is the returned value of <code class="constant">GL_MAX_TEXTURE_SIZE</code>.
+ </p><p>
+ <code class="constant">GL_INVALID_VALUE</code> is generated if
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <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>,
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <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>,
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <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>,
+ or
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <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>,
+ or
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <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>,
+ or
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+
+ <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>,
+ where
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">w</mml:mi></mml:math>
+ is the <code class="constant">GL_TEXTURE_WIDTH</code>,
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">h</mml:mi></mml:math>
+ is the <code class="constant">GL_TEXTURE_HEIGHT</code>,
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">d</mml:mi></mml:math>
+ is the <code class="constant">GL_TEXTURE_DEPTH</code>
+ and
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">b</mml:mi></mml:math>
+ is the border width of the texture image being modified.
+ Note that
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">w</mml:mi></mml:math>,
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">h</mml:mi></mml:math>,
+ and
+ <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">d</mml:mi></mml:math>
+ include twice the border width.
+ </p><p>
+ <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>width</code></em>, <em class="parameter"><code>height</code></em>, or <em class="parameter"><code>depth</code></em>
+ is less than 0.
+ </p><p>
+ <code class="constant">GL_INVALID_OPERATION</code> is generated if the texture array has not
+ been defined by a previous <a href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a> operation.
+ </p><p>
+ <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>type</code></em> is one of
+ <code class="constant">GL_UNSIGNED_BYTE_3_3_2</code>,
+ <code class="constant">GL_UNSIGNED_BYTE_2_3_3_REV</code>,
+ <code class="constant">GL_UNSIGNED_SHORT_5_6_5</code>, or
+ <code class="constant">GL_UNSIGNED_SHORT_5_6_5_REV</code>
+ and <em class="parameter"><code>format</code></em> is not <code class="constant">GL_RGB</code>.
+ </p><p>
+ <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>type</code></em> is one of
+ <code class="constant">GL_UNSIGNED_SHORT_4_4_4_4</code>,
+ <code class="constant">GL_UNSIGNED_SHORT_4_4_4_4_REV</code>,
+ <code class="constant">GL_UNSIGNED_SHORT_5_5_5_1</code>,
+ <code class="constant">GL_UNSIGNED_SHORT_1_5_5_5_REV</code>,
+ <code class="constant">GL_UNSIGNED_INT_8_8_8_8</code>,
+ <code class="constant">GL_UNSIGNED_INT_8_8_8_8_REV</code>,
+ <code class="constant">GL_UNSIGNED_INT_10_10_10_2</code>, or
+ <code class="constant">GL_UNSIGNED_INT_2_10_10_10_REV</code>
+ and <em class="parameter"><code>format</code></em> is neither <code class="constant">GL_RGBA</code> nor <code class="constant">GL_BGRA</code>.
+ </p><p>
+ <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
+ <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the buffer object's data store is currently mapped.
+ </p><p>
+ <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
+ <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size.
+ </p><p>
+ <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
+ <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and <em class="parameter"><code>data</code></em> is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by <em class="parameter"><code>type</code></em>.
+ </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
+ <a href="glGetTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexImage</span></span></a>
+ </p><p>
+ <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_PIXEL_UNPACK_BUFFER_BINDING</code>
+ </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
+ <a href="glActiveTexture.xml"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>,
+ <a href="glCopyTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage1D</span></span></a>,
+ <a href="glCopyTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>,
+ <a href="glCopyTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage1D</span></span></a>,
+ <a href="glCopyTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>,
+ <a href="glCopyTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage3D</span></span></a>,
+ <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>,
+ <a href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>,
+ <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
+ <a href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>,
+ <a href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
+ <a href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>,
+ <a href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>
+ </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
+ Copyright <span class="trademark"></span>© 1991-2006
+ Silicon Graphics, Inc. This document is licensed under the SGI
+ Free Software B License. For details, see
+ <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
+ </p></div></div></body></html>
HCoop / clinton / guile-figl.git / blobdiff