glCopyTexSubImage3D(3gl)

1GLCOPYTEXSUBIMAGE3D(3G)                                GLCOPYTEXSUBIMAGE3D(3G)
2
3
4

NAME

6       glCopyTexSubImage3D - copy a three-dimensional texture subimage
7
8

C SPECIFICATION

10       void glCopyTexSubImage3D( GLenum target,
11                                 GLint level,
12                                 GLint xoffset,
13                                 GLint yoffset,
14                                 GLint zoffset,
15                                 GLint x,
16                                 GLint y,
17                                 GLsizei width,
18                                 GLsizei height )
19
20

PARAMETERS

22       target   Specifies the target texture.  Must be GL_TEXTURE_3D
23
24       level    Specifies  the  level-of-detail  number.   Level 0 is the base
25                image level.  Level n is the nth mipmap reduction image.
26
27       xoffset  Specifies a texel offset in the x direction within the texture
28                array.
29
30       yoffset  Specifies a texel offset in the y direction within the texture
31                array.
32
33       zoffset  Specifies a texel offset in the z direction within the texture
34                array.
35
36       x, y     Specify the window coordinates of the lower left corner of the
37                rectangular region of pixels to be copied.
38
39       width    Specifies the width of the texture subimage.
40
41       height   Specifies the height of the texture subimage.
42

DESCRIPTION

44       glCopyTexSubImage3D replaces a rectangular portion  of  a  three-dimen‐
45       sional  texture  image  with  pixels  from  the  current GL_READ_BUFFER
46       (rather than from main memory, as is the case for glTexSubImage3D).
47
48       The screen-aligned pixel rectangle with lower left corner at (x, y) and
49       with  width width and height height replaces the portion of the texture
50       array with x indices xoffset through xoffset+width−1, inclusive, and  y
51       indices yoffset through yoffset+height−1, inclusive, at z index zoffset
52       and at the mipmap level specified by level.
53
54       The pixels in the rectangle are processed exactly  as  if  glCopyPixels
55       had  been  called,  but the process stops just before final conversion.
56       At this point, all pixel component values  are  clamped  to  the  range
57       [0, 1] and then converted to the texture's internal  for storage in the
58       texel array.
59
60       The destination rectangle in the texture array may not include any tex‐
61       els  outside  the  texture array as it was originally specified.  It is
62       not an error to specify a subtexture with zero  width  or  height,  but
63       such a specification has no effect.
64
65       If  any  of  the  pixels  within the specified rectangle of the current
66       GL_READ_BUFFER are outside the read window associated with the  current
67       rendering  context, then the values obtained for those pixels are unde‐
68       fined.
69
70       No change is made to the internalformat, width, height, depth, or  bor‐
71       der  parameters  of the specified texture array or to texel values out‐
72       side the specified subregion.
73

NOTES

75       glCopyTexSubImage3D is available only if  the  GL  version  is  1.2  or
76       greater.
77
78       Texturing has no effect in color index mode.
79
80       glPixelStore and glPixelTransfer modes affect texture images in exactly
81       the way they affect glDrawPixels.
82
83       When the GL_ARB_imaging extension is  supported,  the  RGBA  components
84       copied  from  the framebuffer may be processed by the imaging pipeline,
85       as if they were a two-dimensional texture.  See glTexImage2D  for  spe‐
86       cific details.
87

ERRORS

89       GL_INVALID_ENUM is generated if target is not GL_TEXTURE_3D.
90
91       GL_INVALID_OPERATION  is  generated  if  the texture array has not been
92       defined by a previous glTexImage3D or glCopyTexImage3D operation.
93
94       GL_INVALID_VALUE is generated if level is less than 0.
95
96       GL_INVALID_VALUE may be generated if level  is  greater  than  log2max,
97       where max is the returned value of GL_MAX_3D_TEXTURE_SIZE.
98
99       GL_INVALID_VALUE is generated if x<−b or if y<−b, where b is the border
100       width of the texture array.
101
102       GL_INVALID_VALUE is  generated  if  xoffset<−b,  (xoffset+width)>(w−b),
103       yoffset<−b, (yoffset+height)>(h−b), zoffset<−b, or zoffset>(d−b), where
104       w is the GL_TEXTURE_WIDTH,  h  is  the   GL_TEXTURE_HEIGHT,  d  is  the
105       GL_TEXTURE_DEPTH,  and  b is the GL_TEXTURE_BORDER of the texture image
106       being modified.  Note that w, h, and d include twice the border width.
107
108       GL_INVALID_OPERATION is generated if  glCopyTexSubImage3D  is  executed
109       between  the  execution  of  glBegin and the corresponding execution of
110       glEnd.
111

ASSOCIATED GETS

113       glGetTexImage
114       glIsEnabled with argument GL_TEXTURE_3D
115