impeller::interop::ContextVK Class Reference

#include <context_vk.h>

Inheritance diagram for impeller::interop::ContextVK:

Classes
struct	Settings

Public Member Functions
	~ContextVK () override
	ContextVK (const ContextVK &)=delete
ContextVK &	operator= (const ContextVK &)=delete
bool	GetInfo (ImpellerContextVulkanInfo &info) const
Public Member Functions inherited from impeller::interop::Context
	~Context () override
	Context (const Context &)=delete
Context &	operator= (const Context &)=delete
bool	IsValid () const
std::shared_ptr< impeller::Context >	GetContext () const
AiksContext &	GetAiksContext ()
bool	IsBackend (impeller::Context::BackendType type) const
bool	IsGL () const
bool	IsMetal () const
bool	IsVulkan () const
Public Member Functions inherited from impeller::interop::ObjectBase
	ObjectBase ()=default
virtual	~ObjectBase ()=default
	ObjectBase (const ObjectBase &)=delete
	ObjectBase (ObjectBase &&)=delete
ObjectBase &	operator= (const ObjectBase &)=delete
ObjectBase &	operator= (ObjectBase &&)=delete
void	Retain ()
void	Release ()
uint64_t	GetRefCountForTests () const

Static Public Member Functions
static ScopedObject< Context >	Create (const Settings &settings)
static ScopedObject< Context >	Create (std::shared_ptr< impeller::Context > context)
Static Public Member Functions inherited from impeller::interop::ObjectBase
static void	SafeRetain (void *ptr)
static void	SafeRelease (void *ptr)

Additional Inherited Members
Public Types inherited from impeller::interop::Object< Context, IMPELLER_INTERNAL_HANDLE_NAME(ImpellerContext)>
using	InteropClass = Context
using	InteropCSibling = IMPELLER_INTERNAL_HANDLE_NAME(ImpellerContext)
Protected Member Functions inherited from impeller::interop::Context
	Context (std::shared_ptr< impeller::Context > context)

Detailed Description

Definition at line 14 of file context_vk.h.

Constructor & Destructor Documentation

~ContextVK()

impeller::interop::ContextVK::~ContextVK ( )

overridedefault

ContextVK()

impeller::interop::ContextVK::ContextVK ( const ContextVK &  )

delete

Referenced by Create().

Member Function Documentation

Create() [1/2]

ScopedObject< Context > impeller::interop::ContextVK::Create ( const Settings &  settings )

static

Definition at line 45 of file context_vk.cc.

                                                                {
  if (!settings.IsValid()) {
    VALIDATION_LOG << "Invalid settings for Vulkan context creation.";
    return {};
  }
  impeller::ContextVK::Settings impeller_settings;
  impeller_settings.shader_libraries_data = CreateShaderLibraryMappings();
  impeller_settings.cache_directory = fml::paths::GetCachesDirectory();
  impeller_settings.enable_validation = true;
  sContextVKProcAddressCallback = settings.instance_proc_address_callback;
  impeller_settings.proc_address_callback = ContextVKGetInstanceProcAddress;
  impeller_settings.flags = impeller::Flags{};
  auto impeller_context =
      impeller::ContextVK::Create(std::move(impeller_settings));
  sContextVKProcAddressCallback = nullptr;
  if (!impeller_context) {
    VALIDATION_LOG << "Could not create Impeller context.";
    return {};
  }
  return Create(std::move(impeller_context));
}

References impeller::ContextVK::Settings::cache_directory, impeller::interop::ContextVKGetInstanceProcAddress(), impeller::ContextVK::Create(), impeller::interop::CreateShaderLibraryMappings(), impeller::ContextVK::Settings::enable_validation, impeller::ContextVK::Settings::flags, impeller::interop::ContextVK::Settings::instance_proc_address_callback, impeller::interop::ContextVK::Settings::IsValid(), impeller::ContextVK::Settings::proc_address_callback, impeller::interop::sContextVKProcAddressCallback, impeller::ContextVK::Settings::shader_libraries_data, and VALIDATION_LOG.

Referenced by impeller::interop::testing::CreateSharedContext(), and impeller::interop::ImpellerContextCreateVulkanNew().

Create() [2/2]

ScopedObject< Context > impeller::interop::ContextVK::Create ( std::shared_ptr< impeller::Context >  context )

static

Definition at line 67 of file context_vk.cc.

                                                     {
  // Can't call Create because of private constructor. Adopt the raw pointer
  // instead.
  auto context = Adopt<Context>(new ContextVK(std::move(impeller_context)));
  if (!context->IsValid()) {
    VALIDATION_LOG << " Could not create valid context.";
    return {};
  }
  return context;
}

References ContextVK(), and VALIDATION_LOG.

GetInfo()

bool impeller::interop::ContextVK::GetInfo

(

ImpellerContextVulkanInfo &

info

)

const

Definition at line 98 of file context_vk.cc.

                                                             {
  if (!IsValid()) {
    return false;
  }
  const auto& context = impeller::ContextVK::Cast(*GetContext());
  // NOLINTBEGIN(google-readability-casting)
  info.vk_instance = reinterpret_cast<void*>(VkInstance(context.GetInstance()));
  info.vk_physical_device =
      reinterpret_cast<void*>(VkPhysicalDevice(context.GetPhysicalDevice()));
  info.vk_logical_device =
      reinterpret_cast<void*>(VkDevice(context.GetDevice()));
  // NOLINTEND(google-readability-casting)
  info.graphics_queue_family_index =
      context.GetGraphicsQueue()->GetIndex().family;
  info.graphics_queue_index = context.GetGraphicsQueue()->GetIndex().index;
  return true;
}

References impeller::BackendCast< ContextVK, Context >::Cast(), impeller::interop::Context::GetContext(), ImpellerContextVulkanInfo::graphics_queue_family_index, ImpellerContextVulkanInfo::graphics_queue_index, impeller::interop::Context::IsValid(), ImpellerContextVulkanInfo::vk_instance, ImpellerContextVulkanInfo::vk_logical_device, and ImpellerContextVulkanInfo::vk_physical_device.

operator=()

ContextVK& impeller::interop::ContextVK::operator= ( const ContextVK &  )

delete

---

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

• impeller/toolkit/interop/backend/vulkan/context_vk.h
• impeller/toolkit/interop/backend/vulkan/context_vk.cc