impeller::TextureVK Class Reference

#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

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
bool	IsValid () const override

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

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

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

                                                                    {
  return source_->GetCachedFramebuffer();
}

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.

                                                                  {
  return source_->GetCachedRenderPass();
}

GetImage()

vk::Image impeller::TextureVK::GetImage

(

)

const

Definition at line 147 of file texture_vk.cc.

                                  {
  return source_->GetImage();
}

GetImageView()

vk::ImageView impeller::TextureVK::GetImageView

(

)

const

Definition at line 151 of file texture_vk.cc.

                                          {
  return source_->GetImageView();
}

GetImmutableSamplerVariant()

std::shared_ptr< SamplerVK > impeller::TextureVK::GetImmutableSamplerVariant

(

const SamplerVK &

sampler

)

const

Definition at line 203 of file texture_vk.cc.

                                    {
  if (!source_) {
    return nullptr;
  }
  auto conversion = source_->GetYUVConversion();
  if (!conversion) {
    // Most textures don't need a sampler conversion and will go down this path.
    // Only needed for YUV sampling from external textures.
    return nullptr;
  }
  return sampler.CreateVariantForConversion(std::move(conversion));
}

GetLayout()

vk::ImageLayout impeller::TextureVK::GetLayout

(

)

const

Definition at line 169 of file texture_vk.cc.

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

GetRenderTargetView()

vk::ImageView impeller::TextureVK::GetRenderTargetView

(

)

const

Definition at line 173 of file texture_vk.cc.

                                                 {
  return source_->GetRenderTargetView();
}

GetSize()

ISize impeller::TextureVK::GetSize ( ) const

overridevirtual

Implements impeller::Texture.

Definition at line 143 of file texture_vk.cc.

                               {
  return GetTextureDescriptor().size;
}

GetTextureSource()

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

(

)

const

Definition at line 155 of file texture_vk.cc.

                                                                       {
  return source_;
}

IsSwapchainImage()

bool impeller::TextureVK::IsSwapchainImage

(

)

const

Definition at line 199 of file texture_vk.cc.

                                       {
  return source_->IsSwapchainImage();
}

IsValid()

bool impeller::TextureVK::IsValid ( ) const

overrideprivatevirtual

Implements impeller::Texture.

Definition at line 139 of file texture_vk.cc.

                              {
  return !!source_;
}

OnSetContents() [1/2]

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

overrideprivatevirtual

Implements impeller::Texture.

Definition at line 32 of file texture_vk.cc.

                                            {
  if (!IsValid() || !contents) {
    return false;
  }
 
  const auto& desc = GetTextureDescriptor();
 
  // Out of bounds access.
  if (length != desc.GetByteSizeOfBaseMipLevel()) {
    VALIDATION_LOG << "Illegal to set contents for invalid size.";
    return false;
  }
 
  auto context = context_.lock();
  if (!context) {
    VALIDATION_LOG << "Context died before setting contents on texture.";
    return false;
  }
 
  auto staging_buffer =
      context->GetResourceAllocator()->CreateBufferWithCopy(contents, length);
 
  if (!staging_buffer) {
    VALIDATION_LOG << "Could not create staging buffer.";
    return false;
  }
 
  auto cmd_buffer = context->CreateCommandBuffer();
 
  if (!cmd_buffer) {
    return false;
  }
 
  const auto encoder = CommandBufferVK::Cast(*cmd_buffer).GetEncoder();
 
  if (!encoder->Track(staging_buffer) || !encoder->Track(source_)) {
    return false;
  }
 
  const auto& vk_cmd_buffer = encoder->GetCommandBuffer();
 
  BarrierVK barrier;
  barrier.cmd_buffer = vk_cmd_buffer;
  barrier.new_layout = vk::ImageLayout::eTransferDstOptimal;
  barrier.src_access = {};
  barrier.src_stage = vk::PipelineStageFlagBits::eTopOfPipe;
  barrier.dst_access = vk::AccessFlagBits::eTransferWrite;
  barrier.dst_stage = vk::PipelineStageFlagBits::eTransfer;
 
  if (!SetLayout(barrier)) {
    return false;
  }
 
  vk::BufferImageCopy copy;
  copy.bufferOffset = 0u;
  copy.bufferRowLength = 0u;    // 0u means tightly packed per spec.
  copy.bufferImageHeight = 0u;  // 0u means tightly packed per spec.
  copy.imageOffset.x = 0u;
  copy.imageOffset.y = 0u;
  copy.imageOffset.z = 0u;
  copy.imageExtent.width = desc.size.width;
  copy.imageExtent.height = desc.size.height;
  copy.imageExtent.depth = 1u;
  copy.imageSubresource.aspectMask =
      ToImageAspectFlags(GetTextureDescriptor().format);
  copy.imageSubresource.mipLevel = 0u;
  copy.imageSubresource.baseArrayLayer = slice;
  copy.imageSubresource.layerCount = 1u;
 
  vk_cmd_buffer.copyBufferToImage(
      DeviceBufferVK::Cast(*staging_buffer).GetBuffer(),  // src buffer
      GetImage(),                                         // dst image
      barrier.new_layout,                                 // dst image layout
      1u,                                                 // region count
      &copy                                               // regions
  );
 
  // Transition to shader-read.
  {
    BarrierVK barrier;
    barrier.cmd_buffer = vk_cmd_buffer;
    barrier.src_access = vk::AccessFlagBits::eColorAttachmentWrite |
                         vk::AccessFlagBits::eTransferWrite;
    barrier.src_stage = vk::PipelineStageFlagBits::eColorAttachmentOutput |
                        vk::PipelineStageFlagBits::eTransfer;
    barrier.dst_access = vk::AccessFlagBits::eShaderRead;
    barrier.dst_stage = vk::PipelineStageFlagBits::eFragmentShader;
 
    barrier.new_layout = vk::ImageLayout::eShaderReadOnlyOptimal;
 
    if (!SetLayout(barrier)) {
      return false;
    }
  }
 
  return context->GetCommandQueue()->Submit({cmd_buffer}).ok();
}

OnSetContents() [2/2]

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

overrideprivatevirtual

Implements impeller::Texture.

Definition at line 132 of file texture_vk.cc.

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

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.

                                                      {
  source_->SetCachedFramebuffer(framebuffer);
}

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.

                                                     {
  source_->SetCachedRenderPass(render_pass);
}

SetLabel()

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

overrideprivatevirtual

Implements impeller::Texture.

Definition at line 22 of file texture_vk.cc.

                                             {
  auto context = context_.lock();
  if (!context) {
    // The context may have died.
    return;
  }
  ContextVK::Cast(*context).SetDebugName(GetImage(), label);
  ContextVK::Cast(*context).SetDebugName(GetImageView(), label);
}

SetLayout()

bool impeller::TextureVK::SetLayout

(

const BarrierVK &

barrier

)

const

Definition at line 159 of file texture_vk.cc.

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

SetLayoutWithoutEncoding()

vk::ImageLayout impeller::TextureVK::SetLayoutWithoutEncoding

(

vk::ImageLayout

layout

)

const

Definition at line 163 of file texture_vk.cc.

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

SetMipMapGenerated()

void impeller::TextureVK::SetMipMapGenerated

(

)

Definition at line 195 of file texture_vk.cc.

                                   {
  mipmap_generated_ = true;
}

---

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