| 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" |
| 3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> |
| 4 | <refentry id="glCopyTexSubImage1D"> |
| 5 | <refmeta> |
| 6 | <refmetainfo> |
| 7 | <copyright> |
| 8 | <year>2013</year> |
| 9 | <holder>Khronos Group</holder> |
| 10 | </copyright> |
| 11 | </refmetainfo> |
| 12 | <refentrytitle>glCopyTexSubImage1D</refentrytitle> |
| 13 | <manvolnum>3G</manvolnum> |
| 14 | </refmeta> |
| 15 | <refnamediv> |
| 16 | <refname>glCopyTexSubImage1D</refname> |
| 17 | <refpurpose>copy a one-dimensional texture subimage</refpurpose> |
| 18 | </refnamediv> |
| 19 | <refsynopsisdiv><title>C Specification</title> |
| 20 | <funcsynopsis> |
| 21 | <funcprototype> |
| 22 | <funcdef>void <function>glCopyTexSubImage1D</function></funcdef> |
| 23 | <paramdef>GLenum <parameter>target</parameter></paramdef> |
| 24 | <paramdef>GLint <parameter>level</parameter></paramdef> |
| 25 | <paramdef>GLint <parameter>xoffset</parameter></paramdef> |
| 26 | <paramdef>GLint <parameter>x</parameter></paramdef> |
| 27 | <paramdef>GLint <parameter>y</parameter></paramdef> |
| 28 | <paramdef>GLsizei <parameter>width</parameter></paramdef> |
| 29 | </funcprototype> |
| 30 | </funcsynopsis> |
| 31 | </refsynopsisdiv> |
| 32 | <!-- eqn: ignoring delim $$ --> |
| 33 | <para> |
| 34 | </para> |
| 35 | <refsect1 id="parameters"><title>Parameters</title> |
| 36 | <variablelist> |
| 37 | <varlistentry> |
| 38 | <term><parameter>target</parameter></term> |
| 39 | <listitem> |
| 40 | <para> |
| 41 | Specifies the target texture. |
| 42 | Must be <constant>GL_TEXTURE_1D</constant>. |
| 43 | </para> |
| 44 | </listitem> |
| 45 | </varlistentry> |
| 46 | <varlistentry> |
| 47 | <term><parameter>level</parameter></term> |
| 48 | <listitem> |
| 49 | <para> |
| 50 | Specifies the level-of-detail number. |
| 51 | Level 0 is the base image level. |
| 52 | Level <emphasis>n</emphasis> is the <emphasis>n</emphasis>th mipmap reduction image. |
| 53 | </para> |
| 54 | </listitem> |
| 55 | </varlistentry> |
| 56 | <varlistentry> |
| 57 | <term><parameter>xoffset</parameter></term> |
| 58 | <listitem> |
| 59 | <para> |
| 60 | Specifies the texel offset within the texture array. |
| 61 | </para> |
| 62 | </listitem> |
| 63 | </varlistentry> |
| 64 | <varlistentry> |
| 65 | <term><parameter>x</parameter></term> |
| 66 | <term><parameter>y</parameter></term> |
| 67 | <listitem> |
| 68 | <para> |
| 69 | Specify the window coordinates of the left corner |
| 70 | of the row of pixels to be copied. |
| 71 | </para> |
| 72 | </listitem> |
| 73 | </varlistentry> |
| 74 | <varlistentry> |
| 75 | <term><parameter>width</parameter></term> |
| 76 | <listitem> |
| 77 | <para> |
| 78 | Specifies the width of the texture subimage. |
| 79 | </para> |
| 80 | </listitem> |
| 81 | </varlistentry> |
| 82 | </variablelist> |
| 83 | </refsect1> |
| 84 | <refsect1 id="description"><title>Description</title> |
| 85 | <para> |
| 86 | <function>glCopyTexSubImage1D</function> replaces a portion of a one-dimensional |
| 87 | texture image with pixels from the current <constant>GL_READ_BUFFER</constant> (rather |
| 88 | than from main memory, as is the case for <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>). |
| 89 | </para> |
| 90 | <para> |
| 91 | The screen-aligned pixel row with left corner at (<parameter>x</parameter>,\ <parameter>y</parameter>), and with |
| 92 | length <parameter>width</parameter> replaces the portion of the |
| 93 | texture array with x indices <parameter>xoffset</parameter> through |
| 94 | <inlineequation><mml:math> |
| 95 | <!-- eqn: xoffset + width - 1: --> |
| 96 | <mml:mrow> |
| 97 | <mml:mi mathvariant="italic">xoffset</mml:mi> |
| 98 | <mml:mo>+</mml:mo> |
| 99 | <mml:mi mathvariant="italic">width</mml:mi> |
| 100 | <mml:mo>-</mml:mo> |
| 101 | <mml:mn>1</mml:mn> |
| 102 | </mml:mrow> |
| 103 | </mml:math></inlineequation>, |
| 104 | inclusive. The destination in the texture array may not |
| 105 | include any texels outside the texture array as it was |
| 106 | originally specified. |
| 107 | </para> |
| 108 | <para> |
| 109 | The pixels in the row are processed exactly as if |
| 110 | <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry> had been called, but the process stops just before |
| 111 | final conversion. |
| 112 | At this point, all pixel component values are clamped to the range |
| 113 | <inlineequation><mml:math> |
| 114 | <!-- eqn: [0,1]: --> |
| 115 | <mml:mfenced open="[" close="]"> |
| 116 | <mml:mn>0</mml:mn> |
| 117 | <mml:mn>1</mml:mn> |
| 118 | </mml:mfenced> |
| 119 | </mml:math></inlineequation> |
| 120 | and then converted to the texture's internal format for storage in the texel |
| 121 | array. |
| 122 | </para> |
| 123 | <para> |
| 124 | It is not an error to specify a subtexture with zero width, but |
| 125 | such a specification has no effect. |
| 126 | If any of the pixels within the specified row of the current |
| 127 | <constant>GL_READ_BUFFER</constant> are outside the read window associated with the current |
| 128 | rendering context, then the values obtained for those pixels are undefined. |
| 129 | </para> |
| 130 | <para> |
| 131 | No change is made to the <emphasis>internalformat</emphasis> or <emphasis>width</emphasis> parameters of the specified texture |
| 132 | array or to texel values outside the specified subregion. |
| 133 | </para> |
| 134 | </refsect1> |
| 135 | <refsect1 id="notes"><title>Notes</title> |
| 136 | <para> |
| 137 | The <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry> mode affects texture images. |
| 138 | </para> |
| 139 | </refsect1> |
| 140 | <refsect1 id="errors"><title>Errors</title> |
| 141 | <para> |
| 142 | <constant>GL_INVALID_ENUM</constant> is generated if /<parameter>target</parameter> is not <constant>GL_TEXTURE_1D</constant>. |
| 143 | </para> |
| 144 | <para> |
| 145 | <constant>GL_INVALID_OPERATION</constant> is generated if the texture array has not |
| 146 | been defined by a previous <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry> or <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry> operation. |
| 147 | </para> |
| 148 | <para> |
| 149 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>level</parameter> is less than 0. |
| 150 | </para> |
| 151 | <para> |
| 152 | <constant>GL_INVALID_VALUE</constant> may be generated if |
| 153 | <inlineequation><mml:math> |
| 154 | <!-- eqn: level > log sub 2(max): --> |
| 155 | <mml:mrow> |
| 156 | <mml:mi mathvariant="italic">level</mml:mi> |
| 157 | <mml:mo>></mml:mo> |
| 158 | <mml:mrow> |
| 159 | <mml:msub><mml:mi mathvariant="italic">log</mml:mi> |
| 160 | <mml:mn>2</mml:mn> |
| 161 | </mml:msub> |
| 162 | <mml:mo>⁡</mml:mo> |
| 163 | <mml:mfenced open="(" close=")"> |
| 164 | <mml:mi mathvariant="italic">max</mml:mi> |
| 165 | </mml:mfenced> |
| 166 | </mml:mrow> |
| 167 | </mml:mrow> |
| 168 | </mml:math></inlineequation>, |
| 169 | where <emphasis>max</emphasis> is the returned value of <constant>GL_MAX_TEXTURE_SIZE</constant>. |
| 170 | </para> |
| 171 | <para> |
| 172 | <constant>GL_INVALID_VALUE</constant> is generated if |
| 173 | <inlineequation><mml:math> |
| 174 | <!-- eqn: xoffset < -b: --> |
| 175 | <mml:mrow> |
| 176 | <mml:mi mathvariant="italic">xoffset</mml:mi> |
| 177 | <mml:mo><</mml:mo> |
| 178 | <mml:mn>0</mml:mn> |
| 179 | </mml:mrow> |
| 180 | </mml:math></inlineequation>, |
| 181 | or |
| 182 | <inlineequation><mml:math> |
| 183 | <!-- eqn: (xoffset + width) > (w-b): --> |
| 184 | <mml:mrow> |
| 185 | <mml:mfenced open="(" close=")"> |
| 186 | <mml:mrow> |
| 187 | <mml:mi mathvariant="italic">xoffset</mml:mi> |
| 188 | <mml:mo>+</mml:mo> |
| 189 | <mml:mi mathvariant="italic">width</mml:mi> |
| 190 | </mml:mrow> |
| 191 | </mml:mfenced> |
| 192 | <mml:mo>></mml:mo> |
| 193 | <mml:mi mathvariant="italic">w</mml:mi> |
| 194 | </mml:mrow> |
| 195 | </mml:math></inlineequation>, |
| 196 | where |
| 197 | <inlineequation><mml:math><mml:mi mathvariant="italic">w</mml:mi></mml:math></inlineequation> |
| 198 | is the <constant>GL_TEXTURE_WIDTH</constant> |
| 199 | of the texture image being modified. |
| 200 | </para> |
| 201 | <para> |
| 202 | </para> |
| 203 | </refsect1> |
| 204 | <refsect1 id="associatedgets"><title>Associated Gets</title> |
| 205 | <para> |
| 206 | <citerefentry><refentrytitle>glGetTexImage</refentrytitle></citerefentry> |
| 207 | </para> |
| 208 | </refsect1> |
| 209 | <refsect1 id="seealso"><title>See Also</title> |
| 210 | <para> |
| 211 | <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>, |
| 212 | <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>, |
| 213 | <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>, |
| 214 | <citerefentry><refentrytitle>glCopyTexSubImage3D</refentrytitle></citerefentry>, |
| 215 | <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>, |
| 216 | <citerefentry><refentrytitle>glReadBuffer</refentrytitle></citerefentry>, |
| 217 | <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>, |
| 218 | <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>, |
| 219 | <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>, |
| 220 | <citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>, |
| 221 | <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>, |
| 222 | <citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>, |
| 223 | <citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry> |
| 224 | </para> |
| 225 | </refsect1> |
| 226 | <refsect1 id="Copyright"><title>Copyright</title> |
| 227 | <para> |
| 228 | Copyright <trademark class="copyright"></trademark> 1991-2006 |
| 229 | Silicon Graphics, Inc. |
| 230 | Copyright <trademark class="copyright"></trademark> 2012-2013 Khronos Group. |
| 231 | This document is licensed under the SGI |
| 232 | Free Software B License. For details, see |
| 233 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. |
| 234 | </para> |
| 235 | </refsect1> |
| 236 | </refentry> |