| Flutter Impeller |

Public Member Functions | List of all members
impeller::TextureVK Class Referencefinal

`#include <texture_vk.h>`

Inheritance diagram for impeller::TextureVK:

## Public Member Functions
| TextureVK (std::weak_ptr< Context > context, std::shared_ptr< TextureSourceVK > source)
| ~TextureVK () override
vk::Image | GetImage () const
vk::ImageView | GetImageView () const
vk::ImageView | GetRenderTargetView () const
bool | SetLayout (const BarrierVK &barrier) const
vk::ImageLayout | SetLayoutWithoutEncoding (vk::ImageLayout layout) const
vk::ImageLayout | GetLayout () const
std::shared_ptr< const TextureSourceVK > | GetTextureSource () const
ISize | GetSize () const override
void | SetMipMapGenerated ()
bool | IsSwapchainImage () const
std::shared_ptr< SamplerVK > | GetImmutableSamplerVariant (const SamplerVK &sampler) const
void | SetCachedFramebuffer (const SharedHandleVK< vk::Framebuffer > &framebuffer)
void | SetCachedRenderPass (const SharedHandleVK< vk::RenderPass > &render_pass)
SharedHandleVK< vk::Framebuffer > | GetCachedFramebuffer () const
SharedHandleVK< vk::RenderPass > | GetCachedRenderPass () const
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

## Additional Inherited Members
Static Public Member Functions inherited from impeller::BackendCast< TextureVK, Texture >
static TextureVK & | Cast (Texture &base)
static const TextureVK & | Cast (const Texture &base)
static TextureVK * | Cast (Texture *base)
static const TextureVK * | Cast (const Texture *base)
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 19 of file texture_vk.h.

## Constructor & Destructor Documentation

## ◆ TextureVK()

impeller::TextureVK::TextureVK | ( | std::weak_ptr< Context > | context,
|  | std::shared_ptr< TextureSourceVK > | source
| ) |  |

Definition at line 13 of file texture_vk.cc.

15 : Texture(source->GetTextureDescriptor()),
16 context_(std::move(context)),
17 source_(std::move(source)) {}

## ◆ ~TextureVK()

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

## Member Function Documentation

## ◆ GetCachedFramebuffer()

SharedHandleVK< vk::Framebuffer > impeller::TextureVK::GetCachedFramebuffer | ( |  | ) | const

Retrieve the last framebuffer object used with this texture.

May be nullptr if no previous framebuffer existed.

Definition at line 186 of file texture_vk.cc.

186 {
187 return source_->GetCachedFramebuffer();
188 }

## ◆ GetCachedRenderPass()

SharedHandleVK< vk::RenderPass > impeller::TextureVK::GetCachedRenderPass | ( |  | ) | const

Retrieve the last render pass object used with this texture.

May be nullptr if no previous render pass existed.

Definition at line 190 of file texture_vk.cc.

190 {
191 return source_->GetCachedRenderPass();
192 }

## ◆ GetImage()

vk::Image impeller::TextureVK::GetImage | ( |  | ) | const

Definition at line 146 of file texture_vk.cc.

146 {
147 return source_->GetImage();
148 }

## ◆ GetImageView()

vk::ImageView impeller::TextureVK::GetImageView | ( |  | ) | const

Definition at line 150 of file texture_vk.cc.

150 {
151 return source_->GetImageView();
152 }

## ◆ GetImmutableSamplerVariant()

std::shared_ptr< SamplerVK > impeller::TextureVK::GetImmutableSamplerVariant | ( | const SamplerVK & | sampler | ) | const

Definition at line 202 of file texture_vk.cc.

203 {
204 if (!source_) {
205 return nullptr;
206 }
207 auto conversion = source_->GetYUVConversion();
208 if (!conversion) {
209 // Most textures don't need a sampler conversion and will go down this path.
210 // Only needed for YUV sampling from external textures.
211 return nullptr;
212 }
213 return sampler.CreateVariantForConversion(std::move(conversion));
214 }

References impeller::SamplerVK::CreateVariantForConversion().

## ◆ GetLayout()

vk::ImageLayout impeller::TextureVK::GetLayout | ( |  | ) | const

Definition at line 168 of file texture_vk.cc.

168 {
169 return source_ ? source_->GetLayout() : vk::ImageLayout::eUndefined;
170 }

## ◆ GetRenderTargetView()

vk::ImageView impeller::TextureVK::GetRenderTargetView | ( |  | ) | const

Definition at line 172 of file texture_vk.cc.

172 {
173 return source_->GetRenderTargetView();
174 }

## ◆ GetSize()

ISize impeller::TextureVK::GetSize | ( |  | ) | const
| override virtual

Implements impeller::Texture.

Definition at line 142 of file texture_vk.cc.

142 {
143 return GetTextureDescriptor().size;
144 }

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

## ◆ GetTextureSource()

std::shared_ptr< const TextureSourceVK > impeller::TextureVK::GetTextureSource | ( |  | ) | const

Definition at line 154 of file texture_vk.cc.

154 {
155 return source_;
156 }

Referenced by impeller::CommandBufferVK::IsTracking(), and impeller::CommandBufferVK::Track().

## ◆ IsSwapchainImage()

bool impeller::TextureVK::IsSwapchainImage | ( |  | ) | const

Definition at line 198 of file texture_vk.cc.

198 {
199 return source_->IsSwapchainImage();
200 }

## ◆ SetCachedFramebuffer()

void impeller::TextureVK::SetCachedFramebuffer | ( | const SharedHandleVK< vk::Framebuffer > & | framebuffer | ) |

Store the last framebuffer object used with this texture.

This field is only set if this texture is used as the resolve texture of a render pass. By construction, this framebuffer should be compatible with any future render passes.

Definition at line 176 of file texture_vk.cc.

177 {
178 source_->SetCachedFramebuffer(framebuffer);
179 }

## ◆ SetCachedRenderPass()

void impeller::TextureVK::SetCachedRenderPass | ( | const SharedHandleVK< vk::RenderPass > & | render_pass | ) |

Store the last render pass object used with this texture.

This field is only set if this texture is used as the resolve texture of a render pass. By construction, this framebuffer should be compatible with any future render passes.

Definition at line 181 of file texture_vk.cc.

182 {
183 source_->SetCachedRenderPass(render_pass);
184 }

## ◆ SetLayout()

bool impeller::TextureVK::SetLayout | ( | const BarrierVK & | barrier | ) | const

Definition at line 158 of file texture_vk.cc.

158 {
159 return source_ ? source_->SetLayout(barrier).ok() : false;
160 }

## ◆ SetLayoutWithoutEncoding()

vk::ImageLayout impeller::TextureVK::SetLayoutWithoutEncoding | ( | vk::ImageLayout | layout | ) | const

Definition at line 162 of file texture_vk.cc.

163 {
164 return source_ ? source_->SetLayoutWithoutEncoding(layout)
165 : vk::ImageLayout::eUndefined;
166 }

## ◆ SetMipMapGenerated()

void impeller::TextureVK::SetMipMapGenerated | ( |  | ) |

Definition at line 194 of file texture_vk.cc.

194 {
195 mipmap_generated_ = true;
196 }

References impeller::Texture::mipmap_generated_.

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

- impeller/renderer/backend/vulkan/texture_vk.h
- impeller/renderer/backend/vulkan/texture_vk.cc

impeller::Texture::GetTextureDescriptor
const TextureDescriptor & GetTextureDescriptor() const
Definition: texture.cc:57
impeller::Texture::mipmap_generated_
bool mipmap_generated_
Definition: texture.h:70
impeller::TextureDescriptor::size
ISize size
Definition: texture_descriptor.h:42
impeller::Texture::Texture
Texture(TextureDescriptor desc)
Definition: texture.cc:11