#include <Magnum/ImageView.h>

template<UnsignedInt dimensions, class T>

Magnum::CompressedImageView class

Basic usage

Usually, the view is created on some pre-existing data array in order to describe its layout, with pixel format being one of the values from the generic CompressedPixelFormat:

CompressedImageView2D image{CompressedPixelFormat::Bc1RGBUnorm,
    {512, 256}, data};

It's also possible to create an empty view and assign the memory later. That is useful for example in case of multi-buffered video streaming, where each frame has the same properties but a different memory location:

CompressedImageView2D frame{CompressedPixelFormat::Bc1RGBUnorm, {512, 256}};

frame.setData(evenFrameData);
// Use even frame data ...

frame.setData(oddFrameData);
// Use odd frame data ...

It's possible to have views on image sub-rectangles, 3D texture slices or images with over-aligned rows by passing a particular CompressedPixelStorage as first parameter. In the following snippet, the view is the bottom-right 32x32 sub-rectangle of a 64x64 image:

CompressedImageView2D image{
    CompressedPixelStorage{}
        .setRowLength(64)
        .setCompressedBlockSize({4, 4, 1})
        .setCompressedBlockDataSize(8)
        .setSkip({32, 32, 0}),
    CompressedPixelFormat::Bc1RGBUnorm, {32, 32}, data};

Data mutability

When using types derived from BasicCompressedImageView (e.g. CompressedImageView2D), the viewed data are immutable. This is the most common use case. In order to be able to mutate the underlying data (for example in order to read into a pre-allocated memory), use BasicMutableCompressedImageView (e.g. MutableCompressedImageView2D) instead. CompressedImage and Trade::ImageData are convertible to either of these. Similarly to Corrade::Containers::ArrayView etc., a mutable view is also implicitly convertible to a const one.

CompressedImageView2D image{GL::CompressedPixelFormat::SignedRGRgtc2,
    {512, 256}, data};

auto format = compressedPixelFormatUnwrap<GLenum>(image.format());

Public types

enum (anonymous): UnsignedInt { Dimensions = dimensions }

using Type = T

Raw data type.

using ErasedType = std::conditional<std::is_const<T>::value, const void, void>::type

Erased data type.

Constructors, destructors, conversion operators

CompressedImageView(CompressedPixelStorage storage, CompressedPixelFormat format, const VectorTypeFor<dimensions, Int>& size, Containers::ArrayView<ErasedType> data) explicit noexcept

Constructor.

CompressedImageView(CompressedPixelFormat format, const VectorTypeFor<dimensions, Int>& size, Containers::ArrayView<ErasedType> data) explicit noexcept

Constructor.

CompressedImageView(CompressedPixelStorage storage, CompressedPixelFormat format, const VectorTypeFor<dimensions, Int>& size) explicit noexcept

Construct an empty view.

CompressedImageView(CompressedPixelFormat format, const VectorTypeFor<dimensions, Int>& size) explicit noexcept

Construct an empty view.

template<class U>

CompressedImageView(CompressedPixelStorage storage, U format, const VectorTypeFor<dimensions, Int>& size, Containers::ArrayView<ErasedType> data) explicit noexcept

Construct an image view with implementation-specific format.

template<class U>

CompressedImageView(U format, const VectorTypeFor<dimensions, Int>& size, Containers::ArrayView<ErasedType> data) explicit noexcept

Construct an image view with implementation-specific format.

template<class U>

CompressedImageView(CompressedPixelStorage storage, U format, const VectorTypeFor<dimensions, Int>& size) explicit noexcept

Construct an empty view with implementation-specific format.

template<class U>

CompressedImageView(U format, const VectorTypeFor<dimensions, Int>& size) explicit noexcept

Construct an empty view with implementation-specific format.

template<UnsignedInt otherDimensions, class = typename std::enable_if<(otherDimensions <dimensions)>::type>

CompressedImageView(const CompressedImageView<otherDimensions, T>& other) noexcept new in 2019.10

Construct from a view of lower dimension count.

template<class U, class = typename std::enable_if<std::is_const<T>::value&& !std::is_const<U>::value>::type>

CompressedImageView(const CompressedImageView<dimensions, U>& other) noexcept new in 2019.10

Convert a mutable view to a const one.

Public functions

auto storage() const -> CompressedPixelStorage

Storage of compressed pixel data.

auto format() const -> CompressedPixelFormat

Format of compressed pixel data.

auto size() const -> VectorTypeFor<dimensions, Int> constexpr

Image size.

auto dataProperties() const -> std::pair<VectorTypeFor<dimensions, std::size_t>, VectorTypeFor<dimensions, std::size_t>>

Compressed image data properties.

auto data() const -> Containers::ArrayView<Type>

Image data.

template<class U>

auto data() const -> const U* deprecated in 2019.10

Image data in a particular type.

void setData(Containers::ArrayView<ErasedType> data)

Set image data.

Enum documentation

Typedef documentation

Function documentation