impeller::AllocatedTextureSourceVK Class Reference

Inheritance diagram for impeller::AllocatedTextureSourceVK:

Public Member Functions
	AllocatedTextureSourceVK (const ContextVK &context, const TextureDescriptor &desc, VmaAllocator allocator, vk::Device device, bool supports_memoryless_textures)
	~AllocatedTextureSourceVK ()=default
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 () const override
	Retrieve the image view used for render target attachments with this texture source.
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)
const FramebufferAndRenderPass &	GetCachedFrameData (SampleCount sample_count) 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 287 of file allocator_vk.cc.

Constructor & Destructor Documentation

AllocatedTextureSourceVK()

impeller::AllocatedTextureSourceVK::AllocatedTextureSourceVK ( const ContextVK &  context, const TextureDescriptor &  desc, VmaAllocator  allocator, vk::Device  device, bool  supports_memoryless_textures  )

inline

Definition at line 289 of file allocator_vk.cc.

      : TextureSourceVK(desc), resource_(context.GetResourceManager()) {
    FML_DCHECK(desc.format != PixelFormat::kUnknown);
    vk::StructureChain<vk::ImageCreateInfo, vk::ImageCompressionControlEXT>
        image_info_chain;
    auto& image_info = image_info_chain.get();
    image_info.flags = ToVKImageCreateFlags(desc.type);
    image_info.imageType = vk::ImageType::e2D;
    image_info.format = ToVKImageFormat(desc.format);
    image_info.extent = VkExtent3D{
        static_cast<uint32_t>(desc.size.width),   // width
        static_cast<uint32_t>(desc.size.height),  // height
        1u                                        // depth
    };
    image_info.samples = ToVKSampleCount(desc.sample_count);
    image_info.mipLevels = desc.mip_count;
    image_info.arrayLayers = ToArrayLayerCount(desc.type);
    image_info.tiling = vk::ImageTiling::eOptimal;
    image_info.initialLayout = vk::ImageLayout::eUndefined;
    image_info.usage = AllocatorVK::ToVKImageUsageFlags(
        desc.format, desc.usage, desc.storage_mode,
        supports_memoryless_textures);
    image_info.sharingMode = vk::SharingMode::eExclusive;
 
    vk::ImageCompressionFixedRateFlagsEXT frc_rates[1] = {
        vk::ImageCompressionFixedRateFlagBitsEXT::eNone};
 
    const auto frc_rate =
        CapabilitiesVK::Cast(*context.GetCapabilities())
            .GetSupportedFRCRate(desc.compression_type,
                                 FRCFormatDescriptor{image_info});
    if (frc_rate.has_value()) {
      // This array must not be in a temporary scope.
      frc_rates[0] = frc_rate.value();
 
      auto& compression_info =
          image_info_chain.get<vk::ImageCompressionControlEXT>();
      compression_info.pFixedRateFlags = frc_rates;
      compression_info.compressionControlPlaneCount = 1u;
      compression_info.flags =
          vk::ImageCompressionFlagBitsEXT::eFixedRateExplicit;
    } else {
      image_info_chain.unlink<vk::ImageCompressionControlEXT>();
    }
 
    VmaAllocationCreateInfo alloc_nfo = {};
 
    alloc_nfo.usage = ToVMAMemoryUsage();
    alloc_nfo.preferredFlags =
        static_cast<VkMemoryPropertyFlags>(ToVKTextureMemoryPropertyFlags(
            desc.storage_mode, supports_memoryless_textures));
    alloc_nfo.flags = ToVmaAllocationCreateFlags(desc.storage_mode);
 
    auto create_info_native =
        static_cast<vk::ImageCreateInfo::NativeType>(image_info);
 
    VkImage vk_image = VK_NULL_HANDLE;
    VmaAllocation allocation = {};
    VmaAllocationInfo allocation_info = {};
    {
      auto result = vk::Result{::vmaCreateImage(allocator,            //
                                                &create_info_native,  //
                                                &alloc_nfo,           //
                                                &vk_image,            //
                                                &allocation,          //
                                                &allocation_info      //
                                                )};
      if (result != vk::Result::eSuccess) {
        VALIDATION_LOG << "Unable to allocate Vulkan Image: "
                       << vk::to_string(result)
                       << " Type: " << TextureTypeToString(desc.type)
                       << " Mode: " << StorageModeToString(desc.storage_mode)
                       << " Usage: " << TextureUsageMaskToString(desc.usage)
                       << " [VK]Flags: " << vk::to_string(image_info.flags)
                       << " [VK]Format: " << vk::to_string(image_info.format)
                       << " [VK]Usage: " << vk::to_string(image_info.usage)
                       << " [VK]Mem. Flags: "
                       << vk::to_string(vk::MemoryPropertyFlags(
                              alloc_nfo.preferredFlags));
        return;
      }
    }
 
    auto image = vk::Image{vk_image};
 
    vk::ImageViewCreateInfo view_info = {};
    view_info.image = image;
    view_info.viewType = ToVKImageViewType(desc.type);
    view_info.format = image_info.format;
    view_info.subresourceRange.aspectMask = ToVKImageAspectFlags(desc.format);
    view_info.subresourceRange.levelCount = image_info.mipLevels;
    view_info.subresourceRange.layerCount = ToArrayLayerCount(desc.type);
 
    // Vulkan does not have an image format that is equivalent to
    // `MTLPixelFormatA8Unorm`, so we use `R8Unorm` instead. Given that the
    // shaders expect that alpha channel to be set in the cases, we swizzle.
    // See: https://github.com/flutter/flutter/issues/115461 for more details.
    if (desc.format == PixelFormat::kA8UNormInt) {
      view_info.components.a = vk::ComponentSwizzle::eR;
      view_info.components.r = vk::ComponentSwizzle::eA;
    }
 
    auto [result, image_view] = device.createImageViewUnique(view_info);
    if (result != vk::Result::eSuccess) {
      VALIDATION_LOG << "Unable to create an image view for allocation: "
                     << vk::to_string(result);
      return;
    }
    // Create a specialized view for render target attachments.
    view_info.subresourceRange.levelCount = 1u;
    auto [rt_result, rt_image_view] = device.createImageViewUnique(view_info);
    if (rt_result != vk::Result::eSuccess) {
      VALIDATION_LOG << "Unable to create an image view for allocation: "
                     << vk::to_string(rt_result);
      return;
    }
 
    resource_.Swap(ImageResource(
        ImageVMA{allocator, allocation, image}, std::move(image_view),
        std::move(rt_image_view), context.GetResourceAllocator(),
        context.GetDeviceHolder()));
    is_valid_ = true;
  }

References impeller::TextureDescriptor::compression_type, device, FML_DCHECK, impeller::TextureDescriptor::format, impeller::ContextVK::GetCapabilities(), impeller::ContextVK::GetDeviceHolder(), impeller::ContextVK::GetResourceAllocator(), impeller::TSize< T >::height, FlutterVulkanImage::image, image, impeller::TextureDescriptor::mip_count, impeller::TextureDescriptor::sample_count, impeller::TextureDescriptor::size, impeller::TextureDescriptor::storage_mode, impeller::StorageModeToString(), impeller::TextureTypeToString(), impeller::TextureUsageMaskToString(), impeller::ToArrayLayerCount(), impeller::ToVKImageAspectFlags(), impeller::ToVKImageCreateFlags(), impeller::ToVKImageFormat(), impeller::ToVKImageViewType(), impeller::ToVKSampleCount(), impeller::ToVKTextureMemoryPropertyFlags(), impeller::ToVmaAllocationCreateFlags(), impeller::ToVMAMemoryUsage(), impeller::TextureDescriptor::type, impeller::TextureDescriptor::usage, VALIDATION_LOG, and impeller::TSize< T >::width.

~AllocatedTextureSourceVK()

impeller::AllocatedTextureSourceVK::~AllocatedTextureSourceVK ( )

default

Member Function Documentation

GetImage()

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

inlineoverridevirtual

Get the image handle for this texture source.

Returns

The image.

Implements impeller::TextureSourceVK.

Definition at line 421 of file allocator_vk.cc.

{ return resource_->image.get().image; }

GetImageView()

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

inlineoverridevirtual

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

Returns

The image view.

Implements impeller::TextureSourceVK.

Definition at line 423 of file allocator_vk.cc.

                                            {
    return resource_->image_view.get();
  }

GetRenderTargetView()

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

inlineoverridevirtual

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 427 of file allocator_vk.cc.

                                                   {
    return resource_->rt_image_view.get();
  }

IsSwapchainImage()

bool impeller::AllocatedTextureSourceVK::IsSwapchainImage ( ) const

inlineoverridevirtual

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 431 of file allocator_vk.cc.

{ return false; }

IsValid()

bool impeller::AllocatedTextureSourceVK::IsValid ( ) const

inline

Definition at line 419 of file allocator_vk.cc.

{ return is_valid_; }

---

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

• impeller/renderer/backend/vulkan/allocator_vk.cc