GLAPI/glCopyTexSubImage1D: Difference between revisions
m Bot: Adding better formatting. |
JeffKhronos (talk | contribs) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 11: | Line 11: | ||
; target | ; target | ||
: Specifies the target texture. Must be {{ | : Specifies the target texture. Must be {{enum|GL_TEXTURE_1D}}. | ||
; level | ; level | ||
: Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image. | : Specifies the level-of-detail number. Level 0 is the base image level. Level ''n'' is the ''n''th mipmap reduction image. | ||
| Line 23: | Line 23: | ||
== Description == | == Description == | ||
'''glCopyTexSubImage1D''' replaces a portion of a one-dimensional texture image with pixels from the current {{ | '''glCopyTexSubImage1D''' replaces a portion of a one-dimensional texture image with pixels from the current {{enum|GL_READ_BUFFER}} (rather than from main memory, as is the case for {{apifunc|glTexSubImage1D}}). | ||
The screen-aligned pixel row with left corner at ({{param|x}},\ {{param|y}}), and with length {{param|width}} replaces the portion of the texture array with x indices {{param|xoffset}} through ''xoffset + width - 1'', inclusive. The destination in the texture array may not include any texels outside the texture array as it was originally specified. | The screen-aligned pixel row with left corner at ({{param|x}},\ {{param|y}}), and with length {{param|width}} replaces the portion of the texture array with x indices {{param|xoffset}} through ''xoffset + width - 1'', inclusive. The destination in the texture array may not include any texels outside the texture array as it was originally specified. | ||
| Line 29: | Line 29: | ||
The pixels in the row are processed exactly as if {{apifunc|glReadPixels}} had been called, but the process stops just before final conversion. At this point, all pixel component values are clamped to the range [0, 1] and then converted to the texture's internal format for storage in the texel array. | The pixels in the row are processed exactly as if {{apifunc|glReadPixels}} had been called, but the process stops just before final conversion. At this point, all pixel component values are clamped to the range [0, 1] and then converted to the texture's internal format for storage in the texel array. | ||
It is not an error to specify a subtexture with zero width, but such a specification has no effect. If any of the pixels within the specified row of the current {{ | It is not an error to specify a subtexture with zero width, but such a specification has no effect. If any of the pixels within the specified row of the current {{enum|GL_READ_BUFFER}} are outside the read window associated with the current rendering context, then the values obtained for those pixels are undefined. | ||
No change is made to the ''internalformat'' | No change is made to the ''internalformat'' or ''width'' parameters of the specified texture array or to texel values outside the specified subregion. | ||
== Notes == | == Notes == | ||
| Line 39: | Line 39: | ||
== Errors == | == Errors == | ||
{{ | {{enum|GL_INVALID_ENUM}} is generated if /{{param|target}} is not {{enum|GL_TEXTURE_1D}}. | ||
{{ | {{enum|GL_INVALID_OPERATION}} is generated if the texture array has not been defined by a previous {{apifunc|glTexImage1D}} or {{apifunc|glCopyTexImage1D}} operation. | ||
{{ | {{enum|GL_INVALID_VALUE}} is generated if {{param|level}} is less than 0. | ||
{{ | {{enum|GL_INVALID_VALUE}} may be generated if ''level'' is greater than log<sub>2</sub>(max), where ''max'' is the returned value of {{enum|GL_MAX_TEXTURE_SIZE}}. | ||
{{ | {{enum|GL_INVALID_VALUE}} is generated if xoffset < 0 or xoffset + width > w, where w is the {{enum|GL_TEXTURE_WIDTH}}. | ||
== Associated Gets == | == Associated Gets == | ||
| Line 55: | Line 55: | ||
== See Also == | == See Also == | ||
{{apifunc| | {{apifunc|glActiveTexture}}, {{apifunc|glBindTexture}}, {{apifunc|glBindFramebuffer}}, {{apifunc|glCopyImageSubData}}, {{apifunc|glCopyTexSubImage2D}}, {{apifunc|glCopyTexSubImage3D}}, {{apifunc|glCopyTexImage1D}}, {{apifunc|glReadBuffer}} | ||
== Copyright == | == Copyright == | ||
Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [ | Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2012-2013 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [https://khronos.org/registry/OpenGL-Refpages/LICENSES/LicenseRef-FreeB.txt LicenseRef-FreeB]. | ||
[[Category:Core API Reference|CopyTexSubImage1D]] | [[Category:Core API Reference|CopyTexSubImage1D]] | ||
[[Category:Core API Ref Texturing|CopyTexSubImage1D]] | [[Category:Core API Ref Texturing|CopyTexSubImage1D]] | ||
[[Category:Texture Object API State Functions|CopyTexSubImage1D]] | |||
Latest revision as of 22:14, 5 February 2021
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 1.0 | |
glCopyTexSubImage1D: copy a one-dimensional texture subimage
Function Definition
void glCopyTexSubImage1D(GLenum target, GLint level, GLint xoffset, GLint x, GLint y, GLsizei width);
- target
- Specifies the target texture. Must be GL_TEXTURE_1D.
- level
- Specifies the level-of-detail number. Level 0 is the base image level. Level n is the nth mipmap reduction image.
- xoffset
- Specifies the texel offset within the texture array.
- x, y
- Specify the window coordinates of the left corner of the row of pixels to be copied.
- width
- Specifies the width of the texture subimage.
Description
glCopyTexSubImage1D replaces a portion of a one-dimensional texture image with pixels from the current GL_READ_BUFFER (rather than from main memory, as is the case for glTexSubImage1D).
The screen-aligned pixel row with left corner at (x,\ y), and with length width replaces the portion of the texture array with x indices xoffset through xoffset + width - 1, inclusive. The destination in the texture array may not include any texels outside the texture array as it was originally specified.
The pixels in the row are processed exactly as if glReadPixels had been called, but the process stops just before final conversion. At this point, all pixel component values are clamped to the range [0, 1] and then converted to the texture's internal format for storage in the texel array.
It is not an error to specify a subtexture with zero width, but such a specification has no effect. If any of the pixels within the specified row of the current GL_READ_BUFFER are outside the read window associated with the current rendering context, then the values obtained for those pixels are undefined.
No change is made to the internalformat or width parameters of the specified texture array or to texel values outside the specified subregion.
Notes
The glPixelStore mode affects texture images.
Errors
GL_INVALID_ENUM is generated if /target is not GL_TEXTURE_1D.
GL_INVALID_OPERATION is generated if the texture array has not been defined by a previous glTexImage1D or glCopyTexImage1D operation.
GL_INVALID_VALUE is generated if level is less than 0.
GL_INVALID_VALUE may be generated if level is greater than log2(max), where max is the returned value of GL_MAX_TEXTURE_SIZE.
GL_INVALID_VALUE is generated if xoffset < 0 or xoffset + width > w, where w is the GL_TEXTURE_WIDTH.
Associated Gets
See Also
glActiveTexture, glBindTexture, glBindFramebuffer, glCopyImageSubData, glCopyTexSubImage2D, glCopyTexSubImage3D, glCopyTexImage1D, glReadBuffer
Copyright
Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2012-2013 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see LicenseRef-FreeB.