impeller::KHRSwapchainImageVK Class Reference

#include <khr_swapchain_image_vk.h>

Inheritance diagram for impeller::KHRSwapchainImageVK:

Public Member Functions
	KHRSwapchainImageVK (TextureDescriptor desc, const vk::Device &device, vk::Image image)
	~KHRSwapchainImageVK () override
bool	IsValid () const
vk::Image	GetImage () const override
	Get the image handle for this texture source. More...
vk::ImageView	GetImageView () const override
	Retrieve the image view used for sampling/blitting/compute with this texture source. More...
vk::ImageView	GetRenderTargetView () const override
	Retrieve the image view used for render target attachments with this texture source. More...
bool	IsSwapchainImage () const override
	Determines if swapchain image. That is, an image used as the root render target. More...
Public Member Functions inherited from impeller::TextureSourceVK
virtual	~TextureSourceVK ()
const TextureDescriptor &	GetTextureDescriptor () const
	Gets the texture descriptor for this image source. More...
virtual vk::Image	GetImage () const =0
	Get the image handle for this texture source. More...
virtual vk::ImageView	GetImageView () const =0
	Retrieve the image view used for sampling/blitting/compute with this texture source. More...
virtual vk::ImageView	GetRenderTargetView () const =0
	Retrieve the image view used for render target attachments with this texture source. More...
fml::Status	SetLayout (const BarrierVK &barrier) const
	Encodes the layout transition barrier to barrier.cmd_buffer for the image. More...
vk::ImageLayout	SetLayoutWithoutEncoding (vk::ImageLayout layout) const
	Store the layout of the image. More...
vk::ImageLayout	GetLayout () const
	Get the last layout assigned to the TextureSourceVK. More...
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. More...
virtual bool	IsSwapchainImage () const =0
	Determines if swapchain image. That is, an image used as the root render target. More...
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

Additional Inherited Members
Protected Member Functions inherited from impeller::TextureSourceVK
	TextureSourceVK (TextureDescriptor desc)
Protected Attributes inherited from impeller::TextureSourceVK
const TextureDescriptor	desc_

Detailed Description

Definition at line 15 of file khr_swapchain_image_vk.h.

Constructor & Destructor Documentation

KHRSwapchainImageVK()

impeller::KHRSwapchainImageVK::KHRSwapchainImageVK	(	TextureDescriptor	desc,
		const vk::Device &	device,
		vk::Image	image
	)

Definition at line 9 of file khr_swapchain_image_vk.cc.

    : TextureSourceVK(desc), image_(image) {
  vk::ImageViewCreateInfo view_info;
  view_info.image = image_;
  view_info.viewType = vk::ImageViewType::e2D;
  view_info.format = ToVKImageFormat(desc.format);
  view_info.subresourceRange.aspectMask = vk::ImageAspectFlagBits::eColor;
  view_info.subresourceRange.baseMipLevel = 0u;
  view_info.subresourceRange.baseArrayLayer = 0u;
  view_info.subresourceRange.levelCount = desc.mip_count;
  view_info.subresourceRange.layerCount = ToArrayLayerCount(desc.type);
 
  auto [view_result, view] = device.createImageViewUnique(view_info);
  if (view_result != vk::Result::eSuccess) {
    return;
  }
 
  image_view_ = std::move(view);
  is_valid_ = true;
}

~KHRSwapchainImageVK()

impeller::KHRSwapchainImageVK::~KHRSwapchainImageVK ( )

overridedefault

Member Function Documentation

GetImage()

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

overridevirtual

Get the image handle for this texture source.

Returns

The image.

Implements impeller::TextureSourceVK.

Definition at line 39 of file khr_swapchain_image_vk.cc.

                                            {
  return image_;
}

GetImageView()

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

overridevirtual

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

Returns

The image view.

Implements impeller::TextureSourceVK.

Definition at line 44 of file khr_swapchain_image_vk.cc.

                                                    {
  return image_view_.get();
}

GetRenderTargetView()

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

overridevirtual

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.

Implements impeller::TextureSourceVK.

Definition at line 49 of file khr_swapchain_image_vk.cc.

                                                           {
  return image_view_.get();
}

IsSwapchainImage()

bool impeller::KHRSwapchainImageVK::IsSwapchainImage ( ) const

overridevirtual

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

Returns

Whether or not this is a swapchain image.

Implements impeller::TextureSourceVK.

Definition at line 54 of file khr_swapchain_image_vk.cc.

                                                 {
  return true;
}

IsValid()

bool impeller::KHRSwapchainImageVK::IsValid

(

)

const

Definition at line 34 of file khr_swapchain_image_vk.cc.

                                        {
  return is_valid_;
}

---

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

• impeller/renderer/backend/vulkan/swapchain/khr/khr_swapchain_image_vk.h
• impeller/renderer/backend/vulkan/swapchain/khr/khr_swapchain_image_vk.cc