A lightweight object that describes the attributes of a texture that can then used an allocator to create that texture. More...

#include <texture_descriptor.h>

Public Member Functions
constexpr size_t	GetByteSizeOfBaseMipLevel () const

constexpr size_t	GetBytesPerRow () const

constexpr bool	SamplingOptionsAreValid () const

constexpr bool	operator== (const TextureDescriptor &other) const

constexpr bool	operator!= (const TextureDescriptor &other) const

constexpr bool	IsValid () const

Public Attributes
StorageMode	storage_mode = StorageMode::kDeviceTransient

TextureType	type = TextureType::kTexture2D

PixelFormat	format = PixelFormat::kUnknown

ISize	size

size_t	mip_count = 1u

TextureUsageMask	usage

SampleCount	sample_count = SampleCount::kCount1

CompressionType	compression_type = CompressionType::kLossless

Detailed Description

A lightweight object that describes the attributes of a texture that can then used an allocator to create that texture.

Definition at line 39 of file texture_descriptor.h.

Member Function Documentation

◆ GetByteSizeOfBaseMipLevel()

constexpr size_t impeller::TextureDescriptor::GetByteSizeOfBaseMipLevel ( ) const

inlineconstexpr

Definition at line 50 of file texture_descriptor.h.

                                                      {
     if (!IsValid()) {
       return 0u;
     }
     return size.Area() * BytesPerPixelForPixelFormat(format);
   }

References impeller::TSize< T >::Area(), impeller::BytesPerPixelForPixelFormat(), format, IsValid(), and size.

Referenced by impeller::UploadGlyphTextureAtlas().

◆ GetBytesPerRow()

constexpr size_t impeller::TextureDescriptor::GetBytesPerRow ( ) const

inlineconstexpr

Definition at line 57 of file texture_descriptor.h.

                                           {
     if (!IsValid()) {
       return 0u;
     }
     return size.width * BytesPerPixelForPixelFormat(format);
   }

References impeller::BytesPerPixelForPixelFormat(), format, IsValid(), size, and impeller::TSize< T >::width.

◆ IsValid()

constexpr bool impeller::TextureDescriptor::IsValid ( ) const

inlineconstexpr

Definition at line 84 of file texture_descriptor.h.

                                  {
     return format != PixelFormat::kUnknown &&  //
            size.IsPositive() &&                //
            mip_count >= 1u &&                  //
            SamplingOptionsAreValid();
   }

References format, impeller::TSize< T >::IsPositive(), impeller::kUnknown, mip_count, SamplingOptionsAreValid(), and size.

Referenced by GetByteSizeOfBaseMipLevel(), GetBytesPerRow(), impeller::TextureMTL::TextureMTL(), and impeller::ToMTLTextureDescriptor().

◆ operator!=()

constexpr bool impeller::TextureDescriptor::operator!= ( const TextureDescriptor & other ) const

inlineconstexpr

Definition at line 80 of file texture_descriptor.h.

                                                                   {
     return !(*this == other);
   }

◆ operator==()

constexpr bool impeller::TextureDescriptor::operator== ( const TextureDescriptor & other ) const

inlineconstexpr

Definition at line 69 of file texture_descriptor.h.

                                                                   {
     return size == other.size &&                          //
            storage_mode == other.storage_mode &&          //
            format == other.format &&                      //
            usage == other.usage &&                        //
            sample_count == other.sample_count &&          //
            type == other.type &&                          //
            compression_type == other.compression_type &&  //
            mip_count == other.mip_count;
   }

References compression_type, format, mip_count, sample_count, size, storage_mode, type, and usage.

◆ SamplingOptionsAreValid()

constexpr bool impeller::TextureDescriptor::SamplingOptionsAreValid ( ) const

inlineconstexpr

Definition at line 64 of file texture_descriptor.h.

                                                  {
     const auto count = static_cast<uint64_t>(sample_count);
     return IsMultisampleCapable(type) ? count > 1 : count == 1;
   }