A resource manager controls how resources are allocated and reclaimed. More...

#include <resource_manager_vk.h>

Inheritance diagram for impeller::ResourceManagerVK:

Public Member Functions
void	Reclaim (std::unique_ptr< ResourceVK > resource)
	Mark a resource as being reclaimable. More...

	~ResourceManagerVK ()
	Destroys the resource manager. More...

Static Public Member Functions
static std::shared_ptr< ResourceManagerVK >	Create ()
	Creates a shared resource manager (a dedicated thread). More...

Detailed Description

A resource manager controls how resources are allocated and reclaimed.

Reclaimed resources are collected in a batch on a separate thread. In the future, the resource manager may allow resource pooling/reuse, delaying reclamation past frame workloads, etc...

Definition at line 37 of file resource_manager_vk.h.

Constructor & Destructor Documentation

◆ ~ResourceManagerVK()

impeller::ResourceManagerVK::~ResourceManagerVK ( )

Destroys the resource manager.

The resource manager will stop collecting resources and will be destroyed when all references to it are dropped.

Definition at line 25 of file resource_manager_vk.cc.

                                      {
  FML_DCHECK(waiter_.get_id() != std::this_thread::get_id())
      << "The ResourceManager being destructed on its own spawned thread is a "
      << "sign that ContextVK was not properly destroyed. A usual fix for this "
      << "is to ensure that ContextVK is shutdown (i.e. context->Shutdown()) "
         "before the ResourceManager is destroyed (i.e. at the end of a test).";
  Terminate();
  waiter_.join();
}

Member Function Documentation

◆ Create()

std::shared_ptr< ResourceManagerVK > impeller::ResourceManagerVK::Create ( )

static

Creates a shared resource manager (a dedicated thread).

Upon creation, a thread is spawned which will collect resources as they are reclaimed (passed to Reclaim). The thread will exit when the resource manager is destroyed.

Note: Only one |ResourceManagerVK| should be created per Vulkan context, but that contract is not enforced by this method.

Returns: A resource manager if one could be created.

Definition at line 14 of file resource_manager_vk.cc.

                                                           {
  // It will be tempting to refactor this to create the waiter thread in the
  // static method instead of the constructor. However, that causes the
  // destructor never to be called, and the thread never terminates!
  //
  // See https://github.com/flutter/flutter/issues/134482.
  return std::shared_ptr<ResourceManagerVK>(new ResourceManagerVK());
}

◆ Reclaim()

void impeller::ResourceManagerVK::Reclaim ( std::unique_ptr< ResourceVK > resource )

Mark a resource as being reclaimable.

The resource will be reset at some point in the future.

Parameters

[in] resource The resource to reclaim.

Note: Despite being a public API, this method cannot be invoked directly. Instead, use UniqueResourceVKT to create a unique handle to a resource, which will call this method.

Definition at line 75 of file resource_manager_vk.cc.

                                                                  {
  if (!resource) {
    return;
  }
  {
    std::scoped_lock lock(reclaimables_mutex_);
    reclaimables_.emplace_back(std::move(resource));
  }
  reclaimables_cv_.notify_one();
}

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

impeller/renderer/backend/vulkan/resource_manager_vk.h
impeller/renderer/backend/vulkan/resource_manager_vk.cc