impeller::TextureMTL Class Reference

#include <texture_mtl.h>

Inheritance diagram for impeller::TextureMTL:

Public Member Functions
	TextureMTL (TextureDescriptor desc, id< MTLTexture > texture, bool wrapped=false)
	~TextureMTL () override
id< MTLTexture >	GetMTLTexture () const
bool	IsWrapped () const
bool	GenerateMipmap (id< MTLBlitCommandEncoder > encoder)
Public Member Functions inherited from impeller::Texture
virtual	~Texture ()
bool	SetContents (const uint8_t *contents, size_t length, size_t slice=0, bool is_opaque=false)
bool	SetContents (std::shared_ptr< const fml::Mapping > mapping, size_t slice=0, bool is_opaque=false)
bool	IsOpaque () const
size_t	GetMipCount () const
const TextureDescriptor &	GetTextureDescriptor () const
void	SetCoordinateSystem (TextureCoordinateSystem coordinate_system)
TextureCoordinateSystem	GetCoordinateSystem () const
virtual Scalar	GetYCoordScale () const
bool	NeedsMipmapGeneration () const

Static Public Member Functions
static std::shared_ptr< TextureMTL >	Wrapper (TextureDescriptor desc, id< MTLTexture > texture, std::function< void()> deletion_proc=nullptr)
Static Public Member Functions inherited from impeller::BackendCast< TextureMTL, Texture >
static TextureMTL &	Cast (Texture &base)
static const TextureMTL &	Cast (const Texture &base)
static TextureMTL *	Cast (Texture *base)
static const TextureMTL *	Cast (const Texture *base)

Additional Inherited Members
Protected Member Functions inherited from impeller::Texture
	Texture (TextureDescriptor desc)
Protected Attributes inherited from impeller::Texture
bool	mipmap_generated_ = false

Detailed Description

Definition at line 15 of file texture_mtl.h.

Constructor & Destructor Documentation

TextureMTL()

impeller::TextureMTL::TextureMTL	(	TextureDescriptor	desc,
		id< MTLTexture >	texture,
		bool	wrapped = false
	)

Definition at line 19 of file texture_mtl.mm.

    : Texture(p_desc), texture_(texture) {
  const auto& desc = GetTextureDescriptor();
 
  if (!desc.IsValid() || !texture_) {
    return;
  }
 
  if (desc.size != GetSize()) {
    VALIDATION_LOG << "The texture and its descriptor disagree about its size.";
    return;
  }
 
  is_wrapped_ = wrapped;
  is_valid_ = true;
}

References impeller::Texture::GetTextureDescriptor(), impeller::TextureDescriptor::IsValid(), impeller::TextureDescriptor::size, and VALIDATION_LOG.

Referenced by Wrapper().

~TextureMTL()

impeller::TextureMTL::~TextureMTL ( )

overridedefault

Member Function Documentation

GenerateMipmap()

bool impeller::TextureMTL::GenerateMipmap

(

id< MTLBlitCommandEncoder >

encoder

)

Definition at line 112 of file texture_mtl.mm.

                                                                 {
  if (!texture_) {
    return false;
  }
 
  [encoder generateMipmapsForTexture:texture_];
  mipmap_generated_ = true;
 
  return true;
}

References impeller::Texture::mipmap_generated_.

Referenced by impeller::BlitGenerateMipmapCommandMTL::Encode().

GetMTLTexture()

id< MTLTexture > impeller::TextureMTL::GetMTLTexture

(

)

const

Definition at line 100 of file texture_mtl.mm.

                                               {
  return texture_;
}

Referenced by impeller::ConfigureAttachment(), impeller::ConfigureResolveTextureAttachment(), impeller::BlitCopyTextureToTextureCommandMTL::Encode(), impeller::BlitCopyTextureToBufferCommandMTL::Encode(), and impeller::BlitCopyBufferToTextureCommandMTL::Encode().

IsWrapped()

bool impeller::TextureMTL::IsWrapped

(

)

const

Definition at line 108 of file texture_mtl.mm.

                                 {
  return is_wrapped_;
}

Wrapper()

std::shared_ptr< TextureMTL > impeller::TextureMTL::Wrapper ( TextureDescriptor  desc, id< MTLTexture >  texture, std::function< void()>  deletion_proc = nullptr  )

static

Definition at line 38 of file texture_mtl.mm.

                                       {
  if (deletion_proc) {
    return std::shared_ptr<TextureMTL>(
        new TextureMTL(desc, texture, true),
        [deletion_proc = std::move(deletion_proc)](TextureMTL* t) {
          deletion_proc();
          delete t;
        });
  }
  return std::shared_ptr<TextureMTL>(new TextureMTL(desc, texture, true));
}

References TextureMTL().

Referenced by impeller::SurfaceMTL::MakeFromTexture(), impeller::WrapperMTL(), and impeller::WrapTextureMTL().

---

The documentation for this class was generated from the following files:

• impeller/renderer/backend/metal/texture_mtl.h
• impeller/renderer/backend/metal/texture_mtl.mm