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	GetByteSizeOfAllMipLevels () const

constexpr size_t	GetBytesPerRow () const

constexpr bool	SamplingOptionsAreValid () const

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

constexpr bool	IsValid () const

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 38 of file texture_descriptor.h.

Member Function Documentation

◆ GetByteSizeOfAllMipLevels()

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

inlineconstexpr

Definition at line 55 of file texture_descriptor.h.

                                                     {
    if (!IsValid()) {
      return 0u;
    }
    size_t result = 0u;
    int64_t width = size.width;
    int64_t height = size.height;
    for (auto i = 0u; i < mip_count; i++) {
      result +=
          ISize(width, height).Area() * BytesPerPixelForPixelFormat(format);
      width /= 2;
      height /= 2;
    }
    return result;
  }

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

◆ GetByteSizeOfBaseMipLevel()

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

inlineconstexpr

Definition at line 48 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 ImGui_ImplImpeller_Init(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), flutter::ImageDecoderImpeller::UploadTextureToStorage(), and impeller::TextureMTL::~TextureMTL().

◆ GetBytesPerRow()

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

inlineconstexpr

Definition at line 71 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 85 of file texture_descriptor.h.

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

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

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

◆ operator==()

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

constexprdefault

◆ SamplingOptionsAreValid()

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

inlineconstexpr

Definition at line 78 of file texture_descriptor.h.

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

References impeller::IsMultisampleCapable(), sample_count, and type.

Referenced by IsValid().

Member Data Documentation

◆ compression_type

CompressionType impeller::TextureDescriptor::compression_type = CompressionType::kLossless

Definition at line 46 of file texture_descriptor.h.

Referenced by impeller::AllocatedTextureSourceVK::AllocatedTextureSourceVK(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::SwapchainTransientsMTL::GetResolveTexture(), impeller::interop::ImpellerTextureCreateWithContentsNew(), impeller::interop::ImpellerTextureCreateWithOpenGLTextureHandleNew(), impeller::testing::TEST(), impeller::TextureDescriptorToString(), and impeller::ToSwapchainTextureDescriptor().

◆ format

PixelFormat impeller::TextureDescriptor::format = PixelFormat::kUnknown

Definition at line 41 of file texture_descriptor.h.

◆ mip_count

size_t impeller::TextureDescriptor::mip_count = 1u

Definition at line 43 of file texture_descriptor.h.

Referenced by impeller::AllocatedTextureSourceVK::AllocatedTextureSourceVK(), impeller::RenderTargetAllocator::CreateOffscreen(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::Allocator::CreateTexture(), impeller::Playground::CreateTextureCubeForFixture(), impeller::CreateTextureForDecompressedImage(), GetByteSizeOfAllMipLevels(), impeller::Texture::GetMipCount(), ImGui_ImplImpeller_Init(), impeller::interop::ImpellerTextureCreateWithContentsNew(), impeller::interop::ImpellerTextureCreateWithOpenGLTextureHandleNew(), IsValid(), impeller::KHRSwapchainImageVK::KHRSwapchainImageVK(), impeller::Texture::NeedsMipmapGeneration(), impeller::TextureSourceVK::SetLayout(), impeller::testing::TEST(), impeller::TEST(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::TextureDescriptorToString(), impeller::ToMTLTextureDescriptor(), impeller::ToSwapchainTextureDescriptor(), and flutter::ImageDecoderImpeller::UploadTextureToStorage().

◆ sample_count

SampleCount impeller::TextureDescriptor::sample_count = SampleCount::kCount1

Definition at line 45 of file texture_descriptor.h.

Referenced by impeller::AllocatedTextureSourceVK::AllocatedTextureSourceVK(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::testing::CreateTestCanvas(), impeller::SwapchainTransientsMTL::GetDepthStencilTexture(), impeller::SwapchainTransientsMTL::GetMSAATexture(), impeller::SwapchainTransientsMTL::GetResolveTexture(), InternalFlutterGpu_Texture_Initialize(), MakeRenderTargetFromBackingStoreImpeller(), MakeRenderTargetFromBackingStoreImpeller(), SamplingOptionsAreValid(), impeller::RenderTarget::SetupDepthStencilAttachments(), impeller::testing::TEST(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::TextureDescriptorToString(), impeller::ToMTLTextureDescriptor(), impeller::ToSwapchainTextureDescriptor(), impeller::SurfaceGLES::WrapFBO(), impeller::SurfaceVK::WrapSwapchainImage(), and impeller::WrapTextureWithRenderTarget().

◆ size

ISize impeller::TextureDescriptor::size

Definition at line 42 of file texture_descriptor.h.

◆ storage_mode

StorageMode impeller::TextureDescriptor::storage_mode = StorageMode::kDeviceTransient

Definition at line 39 of file texture_descriptor.h.

◆ type

TextureType impeller::TextureDescriptor::type = TextureType::kTexture2D

Definition at line 40 of file texture_descriptor.h.

Referenced by impeller::AllocatedTextureSourceVK::AllocatedTextureSourceVK(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::testing::CreateTestCanvas(), impeller::Playground::CreateTextureCubeForFixture(), impeller::TextureGLES::GenerateMipmap(), impeller::SwapchainTransientsMTL::GetDepthStencilTexture(), impeller::SwapchainTransientsMTL::GetMSAATexture(), impeller::SwapchainTransientsMTL::GetResolveTexture(), impeller::interop::ImpellerTextureCreateWithContentsNew(), impeller::interop::ImpellerTextureCreateWithOpenGLTextureHandleNew(), InternalFlutterGpu_Texture_Initialize(), impeller::KHRSwapchainImageVK::KHRSwapchainImageVK(), MakeRenderTargetFromBackingStoreImpeller(), MakeRenderTargetFromBackingStoreImpeller(), SamplingOptionsAreValid(), impeller::TextureSourceVK::SetLayout(), impeller::RenderTarget::SetupDepthStencilAttachments(), impeller::testing::TEST(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::TextureDescriptorToString(), impeller::ToMTLTextureDescriptor(), impeller::ToSwapchainTextureDescriptor(), impeller::SurfaceGLES::WrapFBO(), and impeller::SurfaceVK::WrapSwapchainImage().

◆ usage

TextureUsageMask impeller::TextureDescriptor::usage = TextureUsage::kShaderRead

Definition at line 44 of file texture_descriptor.h.

Referenced by impeller::AllocatedTextureSourceVK::AllocatedTextureSourceVK(), impeller::TypographerContextSkia::CreateGlyphAtlas(), impeller::RenderTargetAllocator::CreateOffscreen(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::testing::CreateTestCanvas(), impeller::SwapchainTransientsMTL::GetDepthStencilTexture(), impeller::SwapchainTransientsMTL::GetMSAATexture(), impeller::SwapchainTransientsMTL::GetResolveTexture(), impeller::interop::ImpellerTextureCreateWithContentsNew(), impeller::interop::ImpellerTextureCreateWithOpenGLTextureHandleNew(), InternalFlutterGpu_Texture_Initialize(), MakeRenderTargetFromBackingStoreImpeller(), MakeRenderTargetFromBackingStoreImpeller(), impeller::RenderTarget::SetupDepthStencilAttachments(), impeller::testing::TEST(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::ToMTLTextureDescriptor(), impeller::ToSwapchainTextureDescriptor(), impeller::SurfaceGLES::WrapFBO(), impeller::SurfaceVK::WrapSwapchainImage(), and impeller::WrapTextureWithRenderTarget().

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

impeller/core/texture_descriptor.h

Public Attributes
StorageMode	storage_mode = StorageMode::kDeviceTransient

TextureType	type = TextureType::kTexture2D

PixelFormat	format = PixelFormat::kUnknown

ISize	size

size_t	mip_count = 1u

TextureUsageMask	usage = TextureUsage::kShaderRead

SampleCount	sample_count = SampleCount::kCount1

CompressionType	compression_type = CompressionType::kLossless

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ GetByteSizeOfAllMipLevels()

◆ GetByteSizeOfBaseMipLevel()

◆ GetBytesPerRow()

◆ IsValid()

◆ operator==()

◆ SamplingOptionsAreValid()

Member Data Documentation

◆ compression_type

◆ format

◆ mip_count

◆ sample_count

◆ size

◆ storage_mode

◆ type

◆ usage