Maintains a bounded pool of hardware buffer backed texture sources that can be used as swapchain images. More...

#include <ahb_texture_pool_vk.h>

Classes
struct	PoolEntry

Public Member Functions
	AHBTexturePoolVK (std::weak_ptr< Context > context, android::HardwareBufferDescriptor desc)
	Create a new (empty) texture pool.

	~AHBTexturePoolVK ()

	AHBTexturePoolVK (const AHBTexturePoolVK &)=delete

AHBTexturePoolVK &	operator= (const AHBTexturePoolVK &)=delete

bool	IsValid () const
	If the pool can create and pool hardware buffer backed texture sources. The only reason valid textures cannot be obtained from a valid pool is because of resource exhaustion.

PoolEntry	Pop ()
	Pops an texture source from the pool. If the pool is empty, a new texture source is created and returned.

void	Push (std::shared_ptr< AHBTextureSourceVK > texture, fml::UniqueFD render_ready_fence)
	Push a popped texture back into the pool. This also performs a GC.

Detailed Description

Maintains a bounded pool of hardware buffer backed texture sources that can be used as swapchain images.

The number of cached entries in the texture pool is capped to a caller specified value.

If a previously cached entry cannot be obtained from the pool, a new entry is created. The only case where a valid texture source cannot be obtained is due to resource exhaustion.

Pools are thread-safe.

Definition at line 29 of file ahb_texture_pool_vk.h.

Constructor & Destructor Documentation

◆ AHBTexturePoolVK() [1/2]

impeller::AHBTexturePoolVK::AHBTexturePoolVK	(	std::weak_ptr< Context >	context,
		android::HardwareBufferDescriptor	desc
	)

explicit

Create a new (empty) texture pool.

Parameters

[in]	context	The context whose allocators will be used to create the resources for the texture sources.
[in]	desc	The descriptor of the hardware buffers that will be used to create the backing stores of the texture sources.
[in]	max_entries	The maximum entries that will remain cached in the pool.

Definition at line 11 of file ahb_texture_pool_vk.cc.

    : context_(std::move(context)), desc_(desc) {
  if (!desc_.IsAllocatable()) {
    VALIDATION_LOG << "Swapchain image is not allocatable.";
    return;
  }
  is_valid_ = true;
}

References impeller::android::HardwareBufferDescriptor::IsAllocatable(), and VALIDATION_LOG.

◆ ~AHBTexturePoolVK()

impeller::AHBTexturePoolVK::~AHBTexturePoolVK ( )

default

◆ AHBTexturePoolVK() [2/2]

impeller::AHBTexturePoolVK::AHBTexturePoolVK ( const AHBTexturePoolVK & )

delete

Member Function Documentation

◆ IsValid()

bool impeller::AHBTexturePoolVK::IsValid ( ) const

If the pool can create and pool hardware buffer backed texture sources. The only reason valid textures cannot be obtained from a valid pool is because of resource exhaustion.

Returns: true if valid, false otherwise.

Definition at line 73 of file ahb_texture_pool_vk.cc.

                                     {
  return is_valid_;
}

◆ operator=()

AHBTexturePoolVK & impeller::AHBTexturePoolVK::operator= ( const AHBTexturePoolVK & )

delete

◆ Pop()

AHBTexturePoolVK::PoolEntry impeller::AHBTexturePoolVK::Pop ( )

Pops an texture source from the pool. If the pool is empty, a new texture source is created and returned.

This operation is thread-safe.

Returns: A texture source that can be used as a swapchain image. This can be nullptr in case of resource exhaustion.

Definition at line 23 of file ahb_texture_pool_vk.cc.

                                                {
  {
    Lock lock(pool_mutex_);
    if (!pool_.empty()) {
      // Buffers are pushed to the back of the queue. To give the ready fences
      // the most time to signal, pick a buffer from the front of the queue.
      auto entry = pool_.front();
      pool_.pop_front();
      return entry;
    }
  }
  return PoolEntry{CreateTexture()};
}

◆ Push()

void impeller::AHBTexturePoolVK::Push	(	std::shared_ptr< AHBTextureSourceVK >	texture,
		fml::UniqueFD	render_ready_fence
	)

Push a popped texture back into the pool. This also performs a GC.

This operation is thread-safe.

Warning: Only a texture source obtained from the same pool can be returned to it. It is user error to mix and match texture sources from different pools.

Parameters

[in] texture The texture to be returned to the pool.

Definition at line 37 of file ahb_texture_pool_vk.cc.

                                                            {
  if (!texture) {
    return;
  }
  Lock lock(pool_mutex_);
  pool_.push_back(PoolEntry{std::move(texture), std::move(render_ready_fence)});
}

References texture.

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

impeller/renderer/backend/vulkan/swapchain/ahb/ahb_texture_pool_vk.h
impeller/renderer/backend/vulkan/swapchain/ahb/ahb_texture_pool_vk.cc

Classes

Public Member Functions