A texture source that wraps an instance of AHardwareBuffer. More...

#include <ahb_texture_source_vk.h>

Inheritance diagram for impeller::AHBTextureSourceVK:

Public Types
using	AHBProperties = vk::StructureChain< vk::AndroidHardwareBufferPropertiesANDROID, vk::AndroidHardwareBufferFormatPropertiesANDROID >

using	ImageViewInfo = vk::StructureChain< vk::ImageViewCreateInfo, vk::SamplerYcbcrConversionInfo >

Public Member Functions
	AHBTextureSourceVK (const std::shared_ptr< Context > &context, struct AHardwareBuffer *hardware_buffer, const AHardwareBuffer_Desc &hardware_buffer_desc)

	AHBTextureSourceVK (const std::shared_ptr< Context > &context, std::unique_ptr< android::HardwareBuffer > backing_store, bool is_swapchain_image)

	~AHBTextureSourceVK () override

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

bool	IsSwapchainImage () const override
	Determines if swapchain image. That is, an image used as the root render target.

std::shared_ptr< YUVConversionVK >	GetYUVConversion () const override
	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.

const android::HardwareBuffer *	GetBackingStore () const

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.

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

Static Public Member Functions
static vk::UniqueImage	CreateVKImageWrapperForAndroidHarwareBuffer (const vk::Device &device, const AHBProperties &ahb_props, const AHardwareBuffer_Desc &ahb_desc)
	Create a VkImage that wraps an Android hardware buffer.

static ImageViewInfo	CreateImageViewInfo (const vk::Image &image, const std::shared_ptr< YUVConversionVK > &yuv_conversion_wrapper, const AHBProperties &ahb_props, const AHardwareBuffer_Desc &ahb_desc)

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

Protected Attributes inherited from impeller::TextureSourceVK
const TextureDescriptor	desc_

Detailed Description

A texture source that wraps an instance of AHardwareBuffer.

        The formats and conversions supported by Android Hardware
        Buffers are a superset of those supported by Impeller (and
        Vulkan for that matter). Impeller and Vulkan descriptors
        obtained from the these texture sources are advisory and it
        usually isn't possible to create copies of images and image
        views held in these texture sources using the inferred
        descriptors. The objects are meant to be used directly (either
        as render targets or sources for sampling), not copied.

Definition at line 32 of file ahb_texture_source_vk.h.

Member Typedef Documentation

◆ AHBProperties

using impeller::AHBTextureSourceVK::AHBProperties = vk::StructureChain< vk::AndroidHardwareBufferPropertiesANDROID, vk::AndroidHardwareBufferFormatPropertiesANDROID>

Definition at line 65 of file ahb_texture_source_vk.h.

◆ ImageViewInfo

using impeller::AHBTextureSourceVK::ImageViewInfo = vk::StructureChain<vk::ImageViewCreateInfo, vk::SamplerYcbcrConversionInfo>

Definition at line 71 of file ahb_texture_source_vk.h.

Constructor & Destructor Documentation

◆ AHBTextureSourceVK() [1/2]

impeller::AHBTextureSourceVK::AHBTextureSourceVK	(	const std::shared_ptr< Context > &	context,
		struct AHardwareBuffer *	hardware_buffer,
		const AHardwareBuffer_Desc &	hardware_buffer_desc
	)

Definition at line 193 of file ahb_texture_source_vk.cc.

    : TextureSourceVK(ToTextureDescriptor(ahb_desc)) {
  if (!p_context) {
    return;
  }
 
  const auto& context = ContextVK::Cast(*p_context);
  const auto& device = context.GetDevice();
  const auto& physical_device = context.GetPhysicalDevice();
 
  AHBProperties ahb_props;
 
  if (device.getAndroidHardwareBufferPropertiesANDROID(ahb, &ahb_props.get()) !=
      vk::Result::eSuccess) {
    VALIDATION_LOG << "Could not determine properties of the Android hardware "
                      "buffer.";
    return;
  }
 
  const auto& ahb_format =
      ahb_props.get<vk::AndroidHardwareBufferFormatPropertiesANDROID>();
 
  // Create an image to refer to our external image.
  auto image =
      CreateVKImageWrapperForAndroidHarwareBuffer(device, ahb_props, ahb_desc);
  if (!image) {
    return;
  }
 
  // Create a device memory allocation to refer to our external image.
  auto device_memory = ImportVKDeviceMemoryFromAndroidHarwareBuffer(
      device, physical_device, image.get(), ahb, ahb_props);
  if (!device_memory) {
    return;
  }
 
  // Bind the image to the image memory.
  if (auto result = device.bindImageMemory(image.get(), device_memory.get(), 0);
      result != vk::Result::eSuccess) {
    VALIDATION_LOG << "Could not bind external device memory to image : "
                   << vk::to_string(result);
    return;
  }
 
  // Figure out how to perform YUV conversions.
  needs_yuv_conversion_ = ahb_format.format == vk::Format::eUndefined ||
                          RequiresYCBCRConversion(ahb_format.format);
  std::shared_ptr<YUVConversionVK> yuv_conversion;
  if (needs_yuv_conversion_) {
    yuv_conversion = CreateYUVConversion(context, ahb_props);
    if (!yuv_conversion || !yuv_conversion->IsValid()) {
      return;
    }
  }
 
  // Create image view for the newly created image.
  auto image_info = CreateImageViewInfo(image.get(),     //
                                        yuv_conversion,  //
                                        ahb_props,       //
                                        ahb_desc         //
  );
  auto image_view = device.createImageViewUnique(image_info.get());
  if (image_view.result != vk::Result::eSuccess) {
    VALIDATION_LOG << "Could not create external image view: "
                   << vk::to_string(image_view.result);
    return;
  }
 
  device_memory_ = std::move(device_memory);
  image_ = std::move(image);
  yuv_conversion_ = std::move(yuv_conversion);
  image_view_ = std::move(image_view.value);
 
#ifdef IMPELLER_DEBUG
  context.SetDebugName(device_memory_.get(), "AHB Device Memory");
  context.SetDebugName(image_.get(), "AHB Image");
  if (yuv_conversion_) {
    context.SetDebugName(yuv_conversion_->GetConversion(),
                         "AHB YUV Conversion");
  }
  context.SetDebugName(image_view_.get(), "AHB ImageView");
#endif  // IMPELLER_DEBUG
 
  is_valid_ = true;
}

References impeller::BackendCast< ContextVK, Context >::Cast(), context, CreateImageViewInfo(), CreateVKImageWrapperForAndroidHarwareBuffer(), device, image, physical_device, and VALIDATION_LOG.

◆ AHBTextureSourceVK() [2/2]

impeller::AHBTextureSourceVK::AHBTextureSourceVK	(	const std::shared_ptr< Context > &	context,
		std::unique_ptr< android::HardwareBuffer >	backing_store,
		bool	is_swapchain_image
	)

Definition at line 282 of file ahb_texture_source_vk.cc.

    : AHBTextureSourceVK(context,
                         backing_store->GetHandle(),
                         backing_store->GetAndroidDescriptor()) {
  backing_store_ = std::move(backing_store);
  is_swapchain_image_ = is_swapchain_image;
}

◆ ~AHBTextureSourceVK()

impeller::AHBTextureSourceVK::~AHBTextureSourceVK ( )

overridedefault

Member Function Documentation

◆ CreateImageViewInfo()

AHBTextureSourceVK::ImageViewInfo impeller::AHBTextureSourceVK::CreateImageViewInfo	(	const vk::Image &	image,
		const std::shared_ptr< YUVConversionVK > &	yuv_conversion_wrapper,
		const AHBProperties &	ahb_props,
		const AHardwareBuffer_Desc &	ahb_desc
	)

static

Create a VkImageViewCreateInfo that matches the properties of an Android hardware buffer.

Definition at line 405 of file ahb_texture_source_vk.cc.

                                          {
  const auto& ahb_format =
      ahb_props.get<vk::AndroidHardwareBufferFormatPropertiesANDROID>();
 
  ImageViewInfo view_chain;
 
  auto& view_info = view_chain.get();
 
  view_info.image = image;
  view_info.viewType = vk::ImageViewType::e2D;
  view_info.format = ahb_format.format;
  if (IsOpaque(static_cast<AHardwareBuffer_Format>(ahb_desc.format))) {
    view_info.components.a = vk::ComponentSwizzle::eOne;
  }
  view_info.subresourceRange.aspectMask = vk::ImageAspectFlagBits::eColor;
  view_info.subresourceRange.baseMipLevel = 0u;
  view_info.subresourceRange.baseArrayLayer = 0u;
  view_info.subresourceRange.levelCount =
      (ahb_desc.usage & AHARDWAREBUFFER_USAGE_GPU_MIPMAP_COMPLETE)
          ? ISize{ahb_desc.width, ahb_desc.height}.MipCount()
          : 1u;
  view_info.subresourceRange.layerCount = ahb_desc.layers;
 
  // We need a custom YUV conversion only if we don't recognize the format.
  if (view_info.format == vk::Format::eUndefined ||
      RequiresYCBCRConversion(view_info.format)) {
    view_chain.get<vk::SamplerYcbcrConversionInfo>().conversion =
        yuv_conversion_wrapper->GetConversion();
  } else {
    view_chain.unlink<vk::SamplerYcbcrConversionInfo>();
  }
 
  return view_chain;
}

References FlutterVulkanImage::format, image, and impeller::TSize< T >::width.

Referenced by AHBTextureSourceVK(), and impeller::android::testing::TEST().

◆ CreateVKImageWrapperForAndroidHarwareBuffer()

vk::UniqueImage impeller::AHBTextureSourceVK::CreateVKImageWrapperForAndroidHarwareBuffer	(	const vk::Device &	device,
		const AHBProperties &	ahb_props,
		const AHardwareBuffer_Desc &	ahb_desc
	)

static

Create a VkImage that wraps an Android hardware buffer.

Definition at line 332 of file ahb_texture_source_vk.cc.

                                          {
  const auto& ahb_format =
      ahb_props.get<vk::AndroidHardwareBufferFormatPropertiesANDROID>();
 
  vk::StructureChain<vk::ImageCreateInfo,
                     // For VK_KHR_external_memory
                     vk::ExternalMemoryImageCreateInfo,
                     // For VK_ANDROID_external_memory_android_hardware_buffer
                     vk::ExternalFormatANDROID>
      image_chain;
 
  auto& image_info = image_chain.get<vk::ImageCreateInfo>();
 
  vk::ImageUsageFlags image_usage_flags;
  if (ahb_desc.usage & AHARDWAREBUFFER_USAGE_GPU_SAMPLED_IMAGE) {
    image_usage_flags |= vk::ImageUsageFlagBits::eSampled;
  }
  if (ahb_desc.usage & AHARDWAREBUFFER_USAGE_GPU_FRAMEBUFFER) {
    image_usage_flags |= vk::ImageUsageFlagBits::eColorAttachment;
    image_usage_flags |= vk::ImageUsageFlagBits::eInputAttachment;
  }
 
  vk::ImageCreateFlags image_create_flags;
  if (ahb_desc.usage & AHARDWAREBUFFER_USAGE_PROTECTED_CONTENT) {
    image_create_flags |= vk::ImageCreateFlagBits::eProtected;
  }
  if (ahb_desc.usage & AHARDWAREBUFFER_USAGE_GPU_CUBE_MAP) {
    image_create_flags |= vk::ImageCreateFlagBits::eCubeCompatible;
  }
 
  image_info.imageType = vk::ImageType::e2D;
  image_info.format = ahb_format.format;
  image_info.extent.width = ahb_desc.width;
  image_info.extent.height = ahb_desc.height;
  image_info.extent.depth = 1;
  image_info.mipLevels =
      (ahb_desc.usage & AHARDWAREBUFFER_USAGE_GPU_MIPMAP_COMPLETE)
          ? ISize{ahb_desc.width, ahb_desc.height}.MipCount()
          : 1u;
  image_info.arrayLayers = ahb_desc.layers;
  image_info.samples = vk::SampleCountFlagBits::e1;
  image_info.tiling = vk::ImageTiling::eOptimal;
  image_info.usage = image_usage_flags;
  image_info.flags = image_create_flags;
  image_info.sharingMode = vk::SharingMode::eExclusive;
  image_info.initialLayout = vk::ImageLayout::eUndefined;
 
  image_chain.get<vk::ExternalMemoryImageCreateInfo>().handleTypes =
      vk::ExternalMemoryHandleTypeFlagBits::eAndroidHardwareBufferANDROID;
 
  // If the format isn't natively supported by Vulkan (i.e, be a part of the
  // base vkFormat enum), an untyped "external format" must be specified when
  // creating the image and the image views. Usually includes YUV formats.
  if (ahb_format.format == vk::Format::eUndefined) {
    image_chain.get<vk::ExternalFormatANDROID>().externalFormat =
        ahb_format.externalFormat;
  } else {
    image_chain.unlink<vk::ExternalFormatANDROID>();
  }
 
  auto image = device.createImageUnique(image_chain.get());
  if (image.result != vk::Result::eSuccess) {
    VALIDATION_LOG << "Could not create image for external buffer: "
                   << vk::to_string(image.result);
    return {};
  }
 
  return std::move(image.value);
}

References device, image, VALIDATION_LOG, and impeller::TSize< T >::width.

Referenced by AHBTextureSourceVK(), and impeller::android::testing::TEST().

◆ GetBackingStore()

const android::HardwareBuffer * impeller::AHBTextureSourceVK::GetBackingStore ( ) const

Definition at line 328 of file ahb_texture_source_vk.cc.

                                                                       {
  return backing_store_.get();
}

Referenced by impeller::glvk::CreateEGLImageFromAHBTexture().

◆ GetImage()

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

overridevirtual

Get the image handle for this texture source.

Returns: The image.

Implements impeller::TextureSourceVK.

Definition at line 301 of file ahb_texture_source_vk.cc.

                                           {
  return image_.get();
}

◆ GetImageView()

vk::ImageView impeller::AHBTextureSourceVK::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 306 of file ahb_texture_source_vk.cc.

                                                   {
  return image_view_.get();
}

◆ GetRenderTargetView()

vk::ImageView impeller::AHBTextureSourceVK::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 311 of file ahb_texture_source_vk.cc.

                                {
  // Hardware buffer textures are always a single 2D mip and layer.
  return image_view_.get();
}

◆ GetYUVConversion()

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

overridevirtual

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 from impeller::TextureSourceVK.

Definition at line 324 of file ahb_texture_source_vk.cc.

                                                                          {
  return needs_yuv_conversion_ ? yuv_conversion_ : nullptr;
}

Referenced by impeller::android::testing::TEST(), and impeller::android::testing::TEST().

◆ IsSwapchainImage()

bool impeller::AHBTextureSourceVK::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 319 of file ahb_texture_source_vk.cc.

                                                {
  return is_swapchain_image_;
}

◆ IsValid()

bool impeller::AHBTextureSourceVK::IsValid ( ) const

Definition at line 296 of file ahb_texture_source_vk.cc.

                                       {
  return is_valid_;
}

Referenced by impeller::android::testing::TEST(), and impeller::android::testing::TEST().

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

impeller/renderer/backend/vulkan/android/ahb_texture_source_vk.h
impeller/renderer/backend/vulkan/android/ahb_texture_source_vk.cc

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ AHBProperties

◆ ImageViewInfo

Constructor & Destructor Documentation

◆ AHBTextureSourceVK() [1/2]

◆ AHBTextureSourceVK() [2/2]

◆ ~AHBTextureSourceVK()

Member Function Documentation

◆ CreateImageViewInfo()

◆ CreateVKImageWrapperForAndroidHarwareBuffer()

◆ GetBackingStore()

◆ GetImage()

◆ GetImageView()

◆ GetRenderTargetView()

◆ GetYUVConversion()

◆ IsSwapchainImage()

◆ IsValid()