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

#include <texture_vk.h>

Inheritance diagram for impeller::TextureVK:
impeller::Texture impeller::BackendCast< TextureVK, Texture >

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 TextureSourceVKGetTextureSource () const
 
ISize GetSize () const override
 
void SetMipMapGenerated ()
 
bool IsSwapchainImage () const
 
std::shared_ptr< SamplerVKGetImmutableSamplerVariant (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 ()
 
virtual void SetLabel (std::string_view label)=0
 
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)
 
virtual bool IsValid () const =0
 
virtual ISize GetSize () const =0
 
bool IsOpaque () const
 
size_t GetMipCount () const
 
const TextureDescriptorGetTextureDescriptor () 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 TextureVKCast (Texture &base)
 
static const TextureVKCast (const Texture &base)
 
static TextureVKCast (Texture *base)
 
static const TextureVKCast (const Texture *base)
 
- Protected Member Functions inherited from impeller::Texture
 Texture (TextureDescriptor desc)
 
virtual bool OnSetContents (const uint8_t *contents, size_t length, size_t slice)=0
 
virtual bool OnSetContents (std::shared_ptr< const fml::Mapping > mapping, size_t slice)=0
 
- 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 14 of file texture_vk.cc.

16 : Texture(source->GetTextureDescriptor()),
17 context_(std::move(context)),
18 source_(std::move(source)) {}
Texture(TextureDescriptor desc)
Definition: texture.cc:11
SkBitmap source
Definition: examples.cpp:28

◆ ~TextureVK()

impeller::TextureVK::~TextureVK ( )
overridedefault

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 187 of file texture_vk.cc.

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

◆ 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 191 of file texture_vk.cc.

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

◆ GetImage()

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

Definition at line 147 of file texture_vk.cc.

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

◆ GetImageView()

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

Definition at line 151 of file texture_vk.cc.

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

◆ GetImmutableSamplerVariant()

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

Definition at line 203 of file texture_vk.cc.

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

◆ GetLayout()

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

Definition at line 169 of file texture_vk.cc.

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

◆ GetRenderTargetView()

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

Definition at line 173 of file texture_vk.cc.

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

◆ GetSize()

ISize impeller::TextureVK::GetSize ( ) const
overridevirtual

Implements impeller::Texture.

Definition at line 143 of file texture_vk.cc.

143 {
144 return GetTextureDescriptor().size;
145}
const TextureDescriptor & GetTextureDescriptor() const
Definition: texture.cc:57

◆ GetTextureSource()

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

Definition at line 155 of file texture_vk.cc.

155 {
156 return source_;
157}

◆ IsSwapchainImage()

bool impeller::TextureVK::IsSwapchainImage ( ) const

Definition at line 199 of file texture_vk.cc.

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

◆ 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 177 of file texture_vk.cc.

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

◆ 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 182 of file texture_vk.cc.

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

◆ SetLayout()

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

Definition at line 159 of file texture_vk.cc.

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

◆ SetLayoutWithoutEncoding()

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

Definition at line 163 of file texture_vk.cc.

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

◆ SetMipMapGenerated()

void impeller::TextureVK::SetMipMapGenerated ( )

Definition at line 195 of file texture_vk.cc.

195 {
196 mipmap_generated_ = true;
197}
bool mipmap_generated_
Definition: texture.h:70

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