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.
vk::ImageView	GetImageView () const override
	Retrieve the image view used for sampling/blitting/compute with this texture source.
vk::ImageView	GetRenderTargetView (uint32_t mip_level, uint32_t array_layer) const override
	Retrieve the image view used to attach a specific subresource of this texture as a render target.
bool	IsSwapchainImage () const override
	Determines if swapchain image. That is, an image used as the root render target.
Public Member Functions inherited from impeller::TextureSourceVK
virtual	~TextureSourceVK ()
const TextureDescriptor &	GetTextureDescriptor () const
	Gets the texture descriptor for this image 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.
void	SetCachedFrameData (const FramebufferAndRenderPass &data, SampleCount sample_count, uint32_t mip_level=0u, uint32_t slice=0u)
FramebufferAndRenderPass	GetCachedFrameData (SampleCount sample_count, uint32_t mip_level=0u, uint32_t slice=0u) 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;
}

References device, impeller::TextureDescriptor::format, impeller::TextureDescriptor::mip_count, impeller::ToArrayLayerCount(), impeller::ToVKImageFormat(), impeller::TextureDescriptor::type, and view.

~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 ( uint32_t  mip_level, uint32_t  array_layer  ) const

overridevirtual

Retrieve the image view used to attach a specific subresource of this texture as a render target.

The returned view covers a single mip level and a single array layer (or cube map face), since attachment views cannot span multiple levels or layers.

Parameters

[in]	mip_level	The mip level to attach.
[in]	array_layer	The array layer or cube map face to attach.

Returns

The render target view.

Implements impeller::TextureSourceVK.

Definition at line 49 of file khr_swapchain_image_vk.cc.

                                {
  // Swapchain images are always a single 2D mip and layer.
  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 57 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