RectangleTexture class
#include <Magnum/GL/RectangleTexture.h>
Rectangle texture.
See also AbstractTexture documentation for more information.
Usage
Common usage is to fully configure all texture parameters and then set the data from e.g. Image2D. Example configuration:
ImageView2D image{PixelFormat::RGBA8Unorm, {526, 137}, data}; GL::RectangleTexture texture; texture.setMagnificationFilter(GL::SamplerFilter::Linear) .setMinificationFilter(GL::SamplerFilter::Linear) .setWrapping(GL::SamplerWrapping::ClampToEdge) .setMaxAnisotropy(GL::Sampler::maxMaxAnisotropy()) .setStorage(GL::TextureFormat::RGBA8, {526, 137}) .setSubImage({}, image);
In a shader, the texture is used via sampler2DRect, sampler2DRectShadow, isampler2DRect or usampler2DRect. See AbstractShaderProgram documentation for more information about usage in shaders.
Base classes
- class AbstractTexture
- Base for textures.
Public static functions
- static auto maxSize() -> Vector2i
- Max supported rectangle texture size.
- static auto compressedBlockSize(TextureFormat format) -> Vector2i
- Compressed block size.
- static auto compressedBlockDataSize(TextureFormat format) -> Int
- Compressed block data size.
- static auto view(RectangleTexture& original, TextureFormat internalFormat) -> RectangleTexture new in Git master
- Create a view on another rectangle texture.
- static auto wrap(GLuint id, ObjectFlags flags = {}) -> RectangleTexture
- Wrap existing OpenGL rectangle texture object.
Constructors, destructors, conversion operators
- RectangleTexture() explicit
- Constructor.
- RectangleTexture(NoCreateT) explicit noexcept
- Construct without creating the underlying OpenGL object.
- RectangleTexture(const RectangleTexture&) deleted
- Copying is not allowed.
- RectangleTexture(RectangleTexture&&) defaulted noexcept
- Move constructor.
Public functions
- auto operator=(const RectangleTexture&) -> RectangleTexture& deleted
- Copying is not allowed.
- auto operator=(RectangleTexture&&) -> RectangleTexture& defaulted noexcept
- Move assignment.
- void bindImage(Int imageUnit, ImageAccess access, ImageFormat format)
- Bind texture to given image unit.
- auto setMinificationFilter(SamplerFilter filter) -> RectangleTexture&
- Set minification filter.
-
auto setMinificationFilter(Magnum::
SamplerFilter filter) -> RectangleTexture& - auto setMagnificationFilter(SamplerFilter filter) -> RectangleTexture&
- Set magnification filter.
-
auto setMagnificationFilter(Magnum::
SamplerFilter filter) -> RectangleTexture& -
auto setWrapping(const Math::
Vector2<SamplerWrapping>& wrapping) -> RectangleTexture& - Set wrapping.
-
auto setWrapping(const Math::
Vector2<Magnum:: SamplerWrapping>& wrapping) -> RectangleTexture& - auto setWrapping(SamplerWrapping wrapping) -> RectangleTexture&
- Set the same wrapping for all dimensions.
-
auto setWrapping(Magnum::
SamplerWrapping wrapping) -> RectangleTexture& - auto setBorderColor(const Color4& color) -> RectangleTexture&
- Set border color.
- auto setBorderColor(const Vector4ui& color) -> RectangleTexture&
- Set border color for integer texture.
- auto setBorderColor(const Vector4i& color) -> RectangleTexture&
- auto setMaxAnisotropy(Float anisotropy) -> RectangleTexture&
- Set max anisotropy.
- auto setSrgbDecode(bool decode) -> RectangleTexture&
- Set sRGB decoding.
-
template<char r, char g, char b, char a>auto setSwizzle() -> RectangleTexture&
- Set component swizzle.
- auto setCompareMode(SamplerCompareMode mode) -> RectangleTexture&
- Set depth texture comparison mode.
- auto setCompareFunction(SamplerCompareFunction function) -> RectangleTexture&
- Set depth texture comparison function.
- auto setDepthStencilMode(SamplerDepthStencilMode mode) -> RectangleTexture&
- Set depth/stencil texture mode.
- auto setStorage(TextureFormat internalFormat, const Vector2i& size) -> RectangleTexture&
- Set storage.
- auto imageSize() -> Vector2i
- Texture image size.
- void image(Image2D& image)
- Read texture to an image.
- auto image(Image2D&& image) -> Image2D
- void image(const MutableImageView2D& image) new in 2019.10
- Read texture to an image view.
- void image(BufferImage2D& image, BufferUsage usage)
- Read texture to a buffer image.
- auto image(BufferImage2D&& image, BufferUsage usage) -> BufferImage2D
- void compressedImage(CompressedImage2D& image)
- Read compressed texture to an image.
- auto compressedImage(CompressedImage2D&& image) -> CompressedImage2D
- void compressedImage(const MutableCompressedImageView2D& image) new in 2019.10
- Read compressed texture to an image view.
- void compressedImage(CompressedBufferImage2D& image, BufferUsage usage)
- Read compressed texture to a buffer image.
- auto compressedImage(CompressedBufferImage2D&& image, BufferUsage usage) -> CompressedBufferImage2D
- void subImage(const Range2Di& range, Image2D& image)
- Read a texture range to an image.
- auto subImage(const Range2Di& range, Image2D&& image) -> Image2D
- void subImage(const Range2Di& range, const MutableImageView2D& image) new in 2019.10
- Read a range of given texture mip level to an image view.
- void subImage(const Range2Di& range, BufferImage2D& image, BufferUsage usage)
- Read a texture range to a buffer image.
- auto subImage(const Range2Di& range, BufferImage2D&& image, BufferUsage usage) -> BufferImage2D
- void compressedSubImage(const Range2Di& range, CompressedImage2D& image)
- Read a compressed texture range to an image.
- auto compressedSubImage(const Range2Di& range, CompressedImage2D&& image) -> CompressedImage2D
- void compressedSubImage(const Range2Di& range, const MutableCompressedImageView2D& image) new in 2019.10
- Read a compressed texture range to an image view.
- void compressedSubImage(const Range2Di& range, CompressedBufferImage2D& image, BufferUsage usage)
- Read a compressed texture range to a buffer image.
- auto compressedSubImage(const Range2Di& range, CompressedBufferImage2D&& image, BufferUsage usage) -> CompressedBufferImage2D
- auto setImage(TextureFormat internalFormat, const ImageView2D& image) -> RectangleTexture&
- Set image data.
- auto setImage(TextureFormat internalFormat, BufferImage2D& image) -> RectangleTexture&
- auto setImage(TextureFormat internalFormat, BufferImage2D&& image) -> RectangleTexture&
- auto setCompressedImage(const CompressedImageView2D& image) -> RectangleTexture&
- Set compressed image data.
- auto setCompressedImage(CompressedBufferImage2D& image) -> RectangleTexture&
- auto setCompressedImage(CompressedBufferImage2D&& image) -> RectangleTexture&
- auto setSubImage(const Vector2i& offset, const ImageView2D& image) -> RectangleTexture&
- Set image subdata.
- auto setSubImage(const Vector2i& offset, BufferImage2D& image) -> RectangleTexture&
- auto setSubImage(const Vector2i& offset, BufferImage2D&& image) -> RectangleTexture&
- auto setCompressedSubImage(const Vector2i& offset, const CompressedImageView2D& image) -> RectangleTexture&
- Set compressed image subdata.
- auto setCompressedSubImage(const Vector2i& offset, CompressedBufferImage2D& image) -> RectangleTexture&
- auto setCompressedSubImage(const Vector2i& offset, CompressedBufferImage2D&& image) -> RectangleTexture&
- void invalidateImage()
- Invalidate texture.
- void invalidateSubImage(const Vector2i& offset, const Vector2i& size)
- Invalidate subtexture.
Function documentation
static Vector2i Magnum::
Max supported rectangle texture size.
The result is cached, repeated queries don't result in repeated OpenGL calls. If ARB_
static Vector2i Magnum::
Compressed block size.
See Texture::
static Int Magnum::
Compressed block data size.
See Texture::
static RectangleTexture Magnum::
Create a view on another rectangle texture.
The internalFormat has to either match the format of original, or be compatible with it, such as having the same pixel size and other restrictions described in the OpenGL specification.
static RectangleTexture Magnum::
Wrap existing OpenGL rectangle texture object.
| Parameters | |
|---|---|
| id | OpenGL rectangle texture ID |
| flags | Object creation flags |
The id is expected to be of an existing OpenGL texture object with target GL_TEXTURE_RECTANGLE. Unlike texture created using constructor, the OpenGL object is by default not deleted on destruction, use flags for different behavior.
Magnum::
Constructor.
Creates new OpenGL texture object. If ARB_
Magnum::
Construct without creating the underlying OpenGL object.
The constructed instance is equivalent to moved-from state. Useful in cases where you will overwrite the instance later anyway. Move another object over it to make it useful.
This function can be safely used for constructing (and later destructing) objects even without any OpenGL context being active. However note that this is a low-level and a potentially dangerous API, see the documentation of NoCreate for alternatives.
void Magnum::
Bind texture to given image unit.
| Parameters | |
|---|---|
| imageUnit | Image unit |
| access | Image access |
| format | Image format |
RectangleTexture& Magnum::
Set minification filter.
| Returns | Reference to self (for method chaining) |
|---|
See Texture::
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
RectangleTexture& Magnum::
Set magnification filter.
| Returns | Reference to self (for method chaining) |
|---|
See Texture::
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
RectangleTexture& Magnum::
Set wrapping.
| Returns | Reference to self (for method chaining) |
|---|
Sets wrapping type for coordinates out of range. See Texture::
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
RectangleTexture& Magnum::
Set the same wrapping for all dimensions.
| Returns | Reference to self (for method chaining) |
|---|
Same as calling setWrapping(const Math::
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
RectangleTexture& Magnum::
Set border color.
| Returns | Reference to self (for method chaining) |
|---|
See Texture::
RectangleTexture& Magnum::
Set border color for integer texture.
| Returns | Reference to self (for method chaining) |
|---|
See Texture::
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
RectangleTexture& Magnum::
Set max anisotropy.
| Returns | Reference to self (for method chaining) |
|---|
See Texture::
RectangleTexture& Magnum::
Set sRGB decoding.
| Returns | Reference to self (for method chaining) |
|---|
See Texture::
template<char r, char g, char b, char a>
RectangleTexture& Magnum::
Set component swizzle.
| Returns | Reference to self (for method chaining) |
|---|
See Texture::
RectangleTexture& Magnum::
Set depth texture comparison mode.
| Returns | Reference to self (for method chaining) |
|---|
See Texture::
RectangleTexture& Magnum::
Set depth texture comparison function.
| Returns | Reference to self (for method chaining) |
|---|
See Texture::
RectangleTexture& Magnum::
Set depth/stencil texture mode.
| Returns | Reference to self (for method chaining) |
|---|
See Texture::
RectangleTexture& Magnum::
Set storage.
| Returns | Reference to self (for method chaining) |
|---|
See Texture::
Vector2i Magnum::
Texture image size.
See Texture::
void Magnum::
Read texture to an image.
Behavior equivalent to Texture::
Image2D Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Convenience alternative to the above, example usage:
Image2D image = texture.image({PixelFormat::RGBA8Unorm});
void Magnum::
Read texture to an image view.
Compared to image(Image2D&) the function reads the pixels into the memory provided by image, expecting it's not nullptr and its size is the same as texture size. Any set of ImageFlags is allowed in image — e.g., it's possible to read a rectangle texture to an image marked as 1D array.
void Magnum::
Read texture to a buffer image.
See Texture::
BufferImage2D Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Convenience alternative to the above, example usage:
GL::BufferImage2D image = texture.image( {PixelFormat::RGBA8Unorm}, GL::BufferUsage::StaticRead);
void Magnum::
Read compressed texture to an image.
Behavior equivalent to Texture::
CompressedImage2D Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Convenience alternative to the above, example usage:
CompressedImage2D image = texture.compressedImage({});
void Magnum::
Read compressed texture to an image view.
Compared to compressedImage(CompressedImage2D&) the function reads the pixels into the memory provided by image, expecting it's not nullptr, its format is the same as texture format and its size is the same as texture size. Any set of ImageFlags is allowed in image — e.g., it's possible to read a rectangle texture to an image marked as 1D array.
void Magnum::
Read compressed texture to a buffer image.
See Texture::
CompressedBufferImage2D Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Convenience alternative to the above, example usage:
GL::CompressedBufferImage2D image = texture.compressedImage({}, GL::BufferUsage::StaticRead);
void Magnum::
Read a texture range to an image.
Behavior equivalent to Texture::
Image2D Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Convenience alternative to the above, example usage:
Image2D image = texture.subImage(range, {PixelFormat::RGBA8Unorm});
void Magnum::
Read a range of given texture mip level to an image view.
Compared to subImage(const Range2Di&, Image2D&) the function reads the pixels into the memory provided by image, expecting it's not nullptr and its size is the same as range size. Any set of ImageFlags is allowed in image — e.g., it's possible to read a rectangle texture to an image marked as 1D array.
void Magnum::
Read a texture range to a buffer image.
See Texture::
BufferImage2D Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Convenience alternative to the above, example usage:
GL::BufferImage2D image = texture.subImage(range, {PixelFormat::RGBA8Unorm}, GL::BufferUsage::StaticRead);
void Magnum::
Read a compressed texture range to an image.
Behavior equivalent to Texture::
CompressedImage2D Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Convenience alternative to the above, example usage:
CompressedImage2D image = texture.compressedSubImage(range, {});
void Magnum::
Read a compressed texture range to an image view.
Compared to compressedSubImage(const Range2Di&, CompressedImage2D&) the function reads the pixels into the memory provided by image, expecting it's not nullptr, its format is the same as texture format and its size is the same as range size. Any set of ImageFlags is allowed in image — e.g., it's possible to read a rectangle texture to an image marked as 1D array.
void Magnum::
Read a compressed texture range to a buffer image.
See Texture::
CompressedBufferImage2D Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Convenience alternative to the above, example usage:
GL::CompressedBufferImage2D image = texture.compressedSubImage(range, {}, GL::BufferUsage::StaticRead);
RectangleTexture& Magnum::
Set image data.
| Returns | Reference to self (for method chaining) |
|---|
Behavior equivalent to Texture::image — e.g., it's possible to upload an image not marked as an array to an array texture.
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
RectangleTexture& Magnum::
Set compressed image data.
| Returns | Reference to self (for method chaining) |
|---|
Behavior equivalent to Texture::image — e.g., it's possible to upload an image not marked as an array to an array texture.
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
RectangleTexture& Magnum::
Set image subdata.
| Returns | Reference to self (for method chaining) |
|---|
Behavior equivalent to Texture::image — e.g., it's possible to upload an image not marked as an array to an array texture.
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
RectangleTexture& Magnum::
Set compressed image subdata.
| Returns | Reference to self (for method chaining) |
|---|
Behavior equivalent to Texture::image — e.g., it's possible to upload an image not marked as an array to an array texture.
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
RectangleTexture& Magnum::
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void Magnum::
Invalidate texture.
See Texture::
void Magnum::
Invalidate subtexture.
| Parameters | |
|---|---|
| offset | Offset into the texture |
| size | Size of invalidated data |
See Texture::