impeller::TextureMTL Class Reference

#include <texture_mtl.h>

Inheritance diagram for impeller::TextureMTL:

Public Types
using	AcquireTextureProc = std::function< id< MTLTexture >()>
	This callback needs to always return the same texture when called multiple times.

Public Member Functions
	TextureMTL (TextureDescriptor desc, const AcquireTextureProc &aquire_proc, bool wrapped=false, bool drawable=false)
	~TextureMTL () override
id< MTLTexture >	GetMTLTexture () const
bool	IsWrapped () const
bool	IsDrawable () const
	Whether or not this texture is wrapping a Metal drawable.
bool	IsValid () const override
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 std::shared_ptr< TextureMTL >	Create (TextureDescriptor desc, id< MTLTexture > texture)
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)

Private Member Functions
void	SetLabel (std::string_view label) override
bool	OnSetContents (const uint8_t *contents, size_t length, size_t slice) override
bool	OnSetContents (std::shared_ptr< const fml::Mapping > mapping, size_t slice) override
ISize	GetSize () const override

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 16 of file texture_mtl.h.

Member Typedef Documentation

AcquireTextureProc

using impeller::TextureMTL::AcquireTextureProc = std::function<id<MTLTexture>()>

This callback needs to always return the same texture when called multiple times.

Definition at line 21 of file texture_mtl.h.

Constructor & Destructor Documentation

TextureMTL()

impeller::TextureMTL::TextureMTL	(	TextureDescriptor	desc,
		const AcquireTextureProc &	aquire_proc,
		bool	wrapped = false,
		bool	drawable = false
	)

Definition at line 20 of file texture_mtl.mm.

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

~TextureMTL()

impeller::TextureMTL::~TextureMTL ( )

overridedefault

Member Function Documentation

Create()

std::shared_ptr< TextureMTL > impeller::TextureMTL::Create ( TextureDescriptor  desc, id< MTLTexture >  texture  )

static

Definition at line 57 of file texture_mtl.mm.

                                                                       {
  return std::make_shared<TextureMTL>(desc, [texture]() { return texture; });
}

GenerateMipmap()

bool impeller::TextureMTL::GenerateMipmap

(

id< MTLBlitCommandEncoder >

encoder

)

Definition at line 132 of file texture_mtl.mm.

                                                                 {
  if (is_drawable_) {
    return false;
  }
 
  auto texture = aquire_proc_();
  if (!texture) {
    return false;
  }
 
  [encoder generateMipmapsForTexture:texture];
  mipmap_generated_ = true;
 
  return true;
}

GetMTLTexture()

id< MTLTexture > impeller::TextureMTL::GetMTLTexture

(

)

const

Definition at line 116 of file texture_mtl.mm.

                                               {
  return aquire_proc_();
}

GetSize()

ISize impeller::TextureMTL::GetSize ( ) const

overrideprivatevirtual

Implements impeller::Texture.

Definition at line 107 of file texture_mtl.mm.

                                {
  if (is_drawable_) {
    return GetTextureDescriptor().size;
  }
  const auto& texture = aquire_proc_();
  return {static_cast<ISize::Type>(texture.width),
          static_cast<ISize::Type>(texture.height)};
}

IsDrawable()

bool impeller::TextureMTL::IsDrawable

(

)

const

Whether or not this texture is wrapping a Metal drawable.

Definition at line 128 of file texture_mtl.mm.

                                  {
  return is_drawable_;
}

IsValid()

bool impeller::TextureMTL::IsValid ( ) const

overridevirtual

Implements impeller::Texture.

Definition at line 120 of file texture_mtl.mm.

                               {
  return is_valid_;
}

IsWrapped()

bool impeller::TextureMTL::IsWrapped

(

)

const

Definition at line 124 of file texture_mtl.mm.

                                 {
  return is_wrapped_;
}

OnSetContents() [1/2]

bool impeller::TextureMTL::OnSetContents ( const uint8_t *  contents, size_t  length, size_t  slice  )

overrideprivatevirtual

Implements impeller::Texture.

Definition at line 80 of file texture_mtl.mm.

                                             {
  if (!IsValid() || !contents || is_wrapped_ || is_drawable_) {
    return false;
  }
 
  const auto& desc = GetTextureDescriptor();
 
  // Out of bounds access.
  if (length != desc.GetByteSizeOfBaseMipLevel()) {
    return false;
  }
 
  const auto region =
      MTLRegionMake2D(0u, 0u, desc.size.width, desc.size.height);
  [aquire_proc_() replaceRegion:region                            //
                    mipmapLevel:0u                                //
                          slice:slice                             //
                      withBytes:contents                          //
                    bytesPerRow:desc.GetBytesPerRow()             //
                  bytesPerImage:desc.GetByteSizeOfBaseMipLevel()  //
  ];
 
  return true;
}

OnSetContents() [2/2]

bool impeller::TextureMTL::OnSetContents ( std::shared_ptr< const fml::Mapping >  mapping, size_t  slice  )

overrideprivatevirtual

Implements impeller::Texture.

Definition at line 72 of file texture_mtl.mm.

                                             {
  // Metal has no threading restrictions. So we can pass this data along to the
  // client rendering API immediately.
  return OnSetContents(mapping->GetMapping(), mapping->GetSize(), slice);
}

SetLabel()

void impeller::TextureMTL::SetLabel ( std::string_view  label )

overrideprivatevirtual

Implements impeller::Texture.

Definition at line 64 of file texture_mtl.mm.

                                              {
  if (is_drawable_) {
    return;
  }
  [aquire_proc_() setLabel:@(label.data())];
}

Wrapper()

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

static

Definition at line 40 of file texture_mtl.mm.

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

---

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