GLINVALIDATETEXSUBIM(3G)

Hey bestie 💖 you just opened GLINVALIDATETEXSUBIM(3G) — the manual page for glInvalidateTexSubImage — and we are gonna make texture-region invalidation make sense, no cap.

✨ NAME ✨

glInvalidateTexSubImage — invalidate a region of a texture image. Iconic behavior, honestly. 🦋

💅 C SPECIFICATION 💅

void glInvalidateTexSubImage(GLuint texture, GLint level, GLint xoffset,
                             GLint yoffset, GLint zoffset,
                             GLsizei width, GLsizei height,
                             GLsizei depth);

🎀 PARAMETERS 🎀

• texture — the name of a texture object, and you're invalidating a subregion of it. Name the texture, bestie.
• level — the level of detail of the texture object where the region lives.
• xoffset — the X offset of the region you're invalidating.
• yoffset — the Y offset of the region you're invalidating.
• zoffset — the Z offset of the region you're invalidating.
• width — the width of the region you're invalidating.
• height — the height of the region you're invalidating.
• depth — the depth of the region you're invalidating.

🦋 DESCRIPTION 🦋

Okay so glInvalidateTexSubImage invalidates all or part of a texture image. texture and level indicate which texture image is being invalidated. After this command, the data in that subregion have undefined values — yes, undefined, that's the whole vibe. 😭

xoffset, yoffset, zoffset, width, height, and depth are interpreted as they are in glTexSubImage3D(). For texture targets that don't have certain dimensions, this command treats those dimensions as having a size of 1. For example, to invalidate a portion of a two-dimensional texture, the application would use zoffset equal to zero and depth equal to one. Little dimension hack, love that for us. ✨

Cube map textures are treated as an array of six slices in the z-dimension, where a value of zoffset is interpreted as specifying face GL_TEXTURE_CUBE_MAP_POSITIVE_X + zoffset. Six slices, cube-map main character energy. 🧊

level must be greater than or equal to zero and be less than the base 2 logarithm of the maximum texture width, height, or depth. xoffset, yoffset and zoffset must be greater than or equal to zero and be less than the width, height or depth of the image, respectively. Furthermore, xoffset + width, yoffset + height, and zoffset + depth must be less than or equal to the width, height or depth of the image, respectively. Math check, bestie — don't skip it. 💅

For textures of targets GL_TEXTURE_RECTANGLE, GL_TEXTURE_BUFFER, GL_TEXTURE_2D_MULTISAMPLE, or GL_TEXTURE_2D_MULTISAMPLE_ARRAY, level must be zero. Zero. Not one, not two. Zero. 👑

💀 ERRORS 💀

• GL_INVALID_VALUE is generated if xoffset, yoffset or zoffset is less than zero, or if any of them is greater than the size of the image in the corresponding dimension.
• GL_INVALID_VALUE is generated if level is less than zero or if it is greater or equal to the base 2 logarithm of the maximum texture width, height, or depth.
• GL_INVALID_VALUE is generated if the target of texture is any of GL_TEXTURE_RECTANGLE, GL_TEXTURE_BUFFER, GL_TEXTURE_2D_MULTISAMPLE, or GL_TEXTURE_2D_MULTISAMPLE_ARRAY and level is not zero.
• GL_INVALID_VALUE is generated if texture is not the name of an existing texture object.

No cap, these are the exact error conditions. Read them before you come crying to the group chat. 🫶

🔥 ASSOCIATED GETS 🔥

glGet() with argument GL_MAX_TEXTURE_SIZE. That's the get, bestie. ⭐

🌈 VERSION SUPPORT 🌈

OpenGL Version check, with Function / Feature Name: glInvalidateTexSubImage.

• 2.0: -
• 2.1: -
• 3.0: -
• 3.1: -
• 3.2: -
• 3.3: -
• 4.0: -
• 4.1: -
• 4.2: -
• 4.3: ✔
• 4.4: ✔
• 4.5: ✔

So it's giving 4.3 and up, and that's periodt. 🌸

👑 SEE ALSO 👑

Go peek at these too, iykyk:

• glInvalidateTexImage(),,
• glInvalidateBufferSubData()
• glInvalidateBufferData()
• glInvalidateFramebuffer()
• glInvalidateSubFramebuffer()

💖 COPYRIGHT 💖

Copyright © 2013-2014 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

💖 COPYRIGHT (the sequel) 💖

Copyright © 2013-2014 Khronos Group

---

Signing off with the footer vibe, bestie: source/version is [FIXME: source], the date is 08/09/2021, and that's the whole GLINVALIDATETEXSUBIM(3G) moment. Bye bestie, go invalidate responsibly! 🫶✨