LLGL 0.05 Beta
Loading...
Searching...
No Matches
LLGL::MutableImageView Struct Reference

Mutable image view structure used as destination when reading the image data from a hardware texture. More...

#include <ImageFlags.h>

Public Member Functions

 MutableImageView ()=default
 MutableImageView (ImageFormat format, DataType dataType, void *data, std::size_t dataSize)
 Constructor to initialize all attributes.

Public Attributes

ImageFormat format = ImageFormat::RGBA
 Specifies the image format. By default ImageFormat::RGBA.
DataType dataType = DataType::UInt8
 Specifies the image data type. This must be DataType::UInt8 for compressed images. By default DataType::UInt8.
void * data = nullptr
 Mutable pointer to the image data.
std::size_t dataSize = 0
 Specifies the size (in bytes) of the image data. This is primarily used for compressed images and serves for robustness.

Detailed Description

Mutable image view structure used as destination when reading the image data from a hardware texture.

Remarks
This kind of image is mainly used to fill the image data of a hardware texture.
See also
ImageView
ConvertImageBuffer
RenderSystem::ReadTexture

Constructor & Destructor Documentation

◆ MutableImageView() [1/2]

LLGL::MutableImageView::MutableImageView ( )
default

◆ MutableImageView() [2/2]

LLGL::MutableImageView::MutableImageView ( ImageFormat format,
DataType dataType,
void * data,
std::size_t dataSize )
inline

Constructor to initialize all attributes.

Member Data Documentation

◆ data

void* LLGL::MutableImageView::data = nullptr

Mutable pointer to the image data.

◆ dataSize

std::size_t LLGL::MutableImageView::dataSize = 0

Specifies the size (in bytes) of the image data. This is primarily used for compressed images and serves for robustness.

◆ dataType

DataType LLGL::MutableImageView::dataType = DataType::UInt8

Specifies the image data type. This must be DataType::UInt8 for compressed images. By default DataType::UInt8.

◆ format

ImageFormat LLGL::MutableImageView::format = ImageFormat::RGBA

Specifies the image format. By default ImageFormat::RGBA.


The documentation for this struct was generated from the following file: