impeller::TextureSourceVK Class Reference

Abstract base class that represents a vkImage and an vkImageView. More...

#include <texture_source_vk.h>

Inheritance diagram for impeller::TextureSourceVK:

Public Member Functions
virtual	~TextureSourceVK ()
const TextureDescriptor &	GetTextureDescriptor () const
	Gets the texture descriptor for this image source.
virtual vk::Image	GetImage () const =0
	Get the image handle for this texture source.
virtual vk::ImageView	GetImageView () const =0
	Retrieve the image view used for sampling/blitting/compute with this texture source.
virtual vk::ImageView	GetRenderTargetView () const =0
	Retrieve the image view used for render target attachments with this texture source.
fml::Status	SetLayout (const BarrierVK &barrier) const
	Encodes the layout transition barrier to barrier.cmd_buffer for the image.
vk::ImageLayout	SetLayoutWithoutEncoding (vk::ImageLayout layout) const
	Store the layout of the image.
vk::ImageLayout	GetLayout () const
	Get the last layout assigned to the TextureSourceVK.
virtual std::shared_ptr< YUVConversionVK >	GetYUVConversion () const
	When sampling from textures whose formats are not known to Vulkan, a custom conversion is necessary to setup custom samplers. This accessor provides this conversion if one is present. Most texture source have none.
virtual bool	IsSwapchainImage () const =0
	Determines if swapchain image. That is, an image used as the root render target.
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

Protected Member Functions
	TextureSourceVK (TextureDescriptor desc)

Protected Attributes
const TextureDescriptor	desc_

Detailed Description

Abstract base class that represents a vkImage and an vkImageView.

This is intended to be used with an impeller::TextureVK. Example implementations represent swapchain images, uploaded textures, Android Hardware Buffer backend textures, etc...

Definition at line 28 of file texture_source_vk.h.

Constructor & Destructor Documentation

~TextureSourceVK()

impeller::TextureSourceVK::~TextureSourceVK ( )

virtualdefault

TextureSourceVK()

impeller::TextureSourceVK::TextureSourceVK ( TextureDescriptor  desc )

explicitprotected

Definition at line 9 of file texture_source_vk.cc.

: desc_(desc) {}

Member Function Documentation

GetCachedFramebuffer()

SharedHandleVK< vk::Framebuffer > impeller::TextureSourceVK::GetCachedFramebuffer

(

)

const

Retrieve the last framebuffer object used with this texture.

May be nullptr if no previous framebuffer existed.

Definition at line 75 of file texture_source_vk.cc.

                                                                          {
  return framebuffer_;
}

GetCachedRenderPass()

SharedHandleVK< vk::RenderPass > impeller::TextureSourceVK::GetCachedRenderPass

(

)

const

Retrieve the last render pass object used with this texture.

May be nullptr if no previous render pass existed.

Definition at line 79 of file texture_source_vk.cc.

                                                                        {
  return render_pass_;
}

GetImage()

virtual vk::Image impeller::TextureSourceVK::GetImage ( ) const

pure virtual

Get the image handle for this texture source.

Returns

The image.

Implemented in impeller::AllocatedTextureSourceVK, impeller::AHBTextureSourceVK, and impeller::KHRSwapchainImageVK.

GetImageView()

virtual vk::ImageView impeller::TextureSourceVK::GetImageView ( ) const

pure virtual

Retrieve the image view used for sampling/blitting/compute with this texture source.

Returns

The image view.

Implemented in impeller::AllocatedTextureSourceVK, impeller::AHBTextureSourceVK, and impeller::KHRSwapchainImageVK.

GetLayout()

vk::ImageLayout impeller::TextureSourceVK::GetLayout

(

)

const

Get the last layout assigned to the TextureSourceVK.

        This value is synchronized with the GPU via SetLayout so it
        may not reflect the actual layout.

Returns

The last known layout of the texture source.

Definition at line 21 of file texture_source_vk.cc.

                                               {
  ReaderLock lock(layout_mutex_);
  return layout_;
}

GetRenderTargetView()

virtual vk::ImageView impeller::TextureSourceVK::GetRenderTargetView ( ) const

pure virtual

Retrieve the image view used for render target attachments with this texture source.

ImageViews used as render target attachments cannot have any mip levels. In cases where we want to generate mipmaps with the result of this texture, we need to create multiple image views.

Returns

The render target view.

Implemented in impeller::AllocatedTextureSourceVK, impeller::AHBTextureSourceVK, and impeller::KHRSwapchainImageVK.

GetTextureDescriptor()

const TextureDescriptor & impeller::TextureSourceVK::GetTextureDescriptor

(

)

const

Gets the texture descriptor for this image source.

Warning

Texture descriptors from texture sources whose capabilities are a superset of those that can be expressed with Vulkan (like Android Hardware Buffer) are inferred. Stuff like size, mip-counts, types is reliable. So use these descriptors as advisory. Creating copies of texture sources from these descriptors is usually not possible and depends on the allocator used.

Returns

The texture descriptor.

Definition at line 13 of file texture_source_vk.cc.

                                                                     {
  return desc_;
}

GetYUVConversion()

std::shared_ptr< YUVConversionVK > impeller::TextureSourceVK::GetYUVConversion ( ) const

virtual

When sampling from textures whose formats are not known to Vulkan, a custom conversion is necessary to setup custom samplers. This accessor provides this conversion if one is present. Most texture source have none.

Returns

The sampler conversion.

Reimplemented in impeller::AHBTextureSourceVK.

Definition at line 17 of file texture_source_vk.cc.

                                                                       {
  return nullptr;
}

IsSwapchainImage()

virtual bool impeller::TextureSourceVK::IsSwapchainImage ( ) const

pure virtual

Determines if swapchain image. That is, an image used as the root render target.

Returns

Whether or not this is a swapchain image.

Implemented in impeller::AllocatedTextureSourceVK, impeller::AHBTextureSourceVK, and impeller::KHRSwapchainImageVK.

SetCachedFramebuffer()

void impeller::TextureSourceVK::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 65 of file texture_source_vk.cc.

                                                      {
  framebuffer_ = framebuffer;
}

SetCachedRenderPass()

void impeller::TextureSourceVK::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 70 of file texture_source_vk.cc.

                                                     {
  render_pass_ = render_pass;
}

SetLayout()

fml::Status impeller::TextureSourceVK::SetLayout

(

const BarrierVK &

barrier

)

const

Encodes the layout transition barrier to barrier.cmd_buffer for the image.

The transition is from the layout stored via SetLayoutWithoutEncoding to barrier.new_layout.

Parameters

[in]

barrier

The barrier.

Returns

If the layout transition was successfully made.

Definition at line 34 of file texture_source_vk.cc.

                                                                   {
  const auto old_layout = SetLayoutWithoutEncoding(barrier.new_layout);
  if (barrier.new_layout == old_layout) {
    return {};
  }
 
  vk::ImageMemoryBarrier image_barrier;
  image_barrier.srcAccessMask = barrier.src_access;
  image_barrier.dstAccessMask = barrier.dst_access;
  image_barrier.oldLayout = old_layout;
  image_barrier.newLayout = barrier.new_layout;
  image_barrier.image = GetImage();
  image_barrier.srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  image_barrier.dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  image_barrier.subresourceRange.aspectMask = ToImageAspectFlags(desc_.format);
  image_barrier.subresourceRange.baseMipLevel = 0u;
  image_barrier.subresourceRange.levelCount = desc_.mip_count;
  image_barrier.subresourceRange.baseArrayLayer = 0u;
  image_barrier.subresourceRange.layerCount = ToArrayLayerCount(desc_.type);
 
  barrier.cmd_buffer.pipelineBarrier(barrier.src_stage,  // src stage
                                     barrier.dst_stage,  // dst stage
                                     {},                 // dependency flags
                                     nullptr,            // memory barriers
                                     nullptr,            // buffer barriers
                                     image_barrier       // image barriers
  );
 
  return {};
}

SetLayoutWithoutEncoding()

vk::ImageLayout impeller::TextureSourceVK::SetLayoutWithoutEncoding

(

vk::ImageLayout

layout

)

const

Store the layout of the image.

        This just is bookkeeping on the CPU, to actually set the
        layout use `SetLayout`.

Parameters

[in]

layout

The new layout.

Returns

The old layout.

Definition at line 26 of file texture_source_vk.cc.

                                {
  WriterLock lock(layout_mutex_);
  const auto old_layout = layout_;
  layout_ = layout;
  return old_layout;
}

Member Data Documentation

desc_

const TextureDescriptor impeller::TextureSourceVK::desc_

protected

Definition at line 155 of file texture_source_vk.h.

---

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

• impeller/renderer/backend/vulkan/texture_source_vk.h
• impeller/renderer/backend/vulkan/texture_source_vk.cc