| Flutter Impeller |

Public Types | Public Member Functions | Static Public Member Functions | List of all members
impeller::TextureMTL Class Referencefinal

`#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. More...

## 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. More...
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)

## 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.

24 : Texture(p_desc), aquire_proc_(aquire_proc), is_drawable_(drawable) {
25 const auto& desc = GetTextureDescriptor();
26
27 if (!desc.IsValid() || !aquire_proc) {
28 return;
29 }
30
31 if (desc.size != GetSize()) {
32 VALIDATION_LOG << "The texture and its descriptor disagree about its size.";
33 return;
34 }
35
36 is_wrapped_ = wrapped;
37 is_valid_ = true;
38 }

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

Referenced by Wrapper().

## ◆ ~TextureMTL()

impeller::TextureMTL::~TextureMTL | ( |  | ) |
| override default

## 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.

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

Referenced by impeller::WrapTextureWithRenderTarget().

## ◆ GenerateMipmap()

bool impeller::TextureMTL::GenerateMipmap | ( | id< MTLBlitCommandEncoder > | encoder | ) |

Definition at line 132 of file texture_mtl.mm.

132 {
133 if (is_drawable_) {
134 return false;
135 }
136
137 auto texture = aquire_proc_();
138 if (!texture) {
139 return false;
140 }
141
142 [encoder generateMipmapsForTexture:texture];
143 mipmap_generated_ = true;
144
145 return true;
146 }

References impeller::Texture::mipmap_generated_.

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

## ◆ GetMTLTexture()

id< MTLTexture > impeller::TextureMTL::GetMTLTexture | ( |  | ) | const

Definition at line 116 of file texture_mtl.mm.

116 {
117 return aquire_proc_();
118 }

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

## ◆ 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.

128 {
129 return is_drawable_;
130 }

## ◆ IsValid()

bool impeller::TextureMTL::IsValid | ( |  | ) | const
| override virtual

Implements impeller::Texture.

Definition at line 120 of file texture_mtl.mm.

120 {
121 return is_valid_;
122 }

## ◆ IsWrapped()

bool impeller::TextureMTL::IsWrapped | ( |  | ) | const

Definition at line 124 of file texture_mtl.mm.

124 {
125 return is_wrapped_;
126 }

## ◆ 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.

43 {
44 if (deletion_proc) {
45 return std::shared_ptr<TextureMTL>(
46 new TextureMTL(
47 desc, [texture]() { return texture; }, true),
48 [deletion_proc = std::move(deletion_proc)](TextureMTL* t) {
49 deletion_proc();
50 delete t;
51 });
52 }
53 return std::shared_ptr<TextureMTL>(
54 new TextureMTL(desc, [texture]() { return texture; }, true));
55 }

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

impeller::Texture::GetTextureDescriptor
const TextureDescriptor & GetTextureDescriptor() const
Definition: texture.cc:57
impeller::TextureMTL::TextureMTL
TextureMTL(TextureDescriptor desc, const AcquireTextureProc &aquire_proc, bool wrapped=false, bool drawable=false)
Definition: texture_mtl.mm:20
impeller::Texture::mipmap_generated_
bool mipmap_generated_
Definition: texture.h:64
VALIDATION_LOG
#define VALIDATION_LOG
Definition: validation.h:73
impeller::Texture::Texture
Texture(TextureDescriptor desc)
Definition: texture.cc:11