impeller::CommandBufferVK Class Reference

#include <command_buffer_vk.h>

Inheritance diagram for impeller::CommandBufferVK:

Public Member Functions
	~CommandBufferVK () override
bool	Track (const std::shared_ptr< SharedObjectVK > &object)
	Ensure that [object] is kept alive until this command buffer completes execution. More...
bool	Track (const std::shared_ptr< const DeviceBuffer > &buffer)
	Ensure that [buffer] is kept alive until this command buffer completes execution. More...
bool	Track (const std::shared_ptr< const Texture > &texture)
	Ensure that [texture] is kept alive until this command buffer completes execution. More...
bool	Track (const std::shared_ptr< const TextureSourceVK > &texture)
	Ensure that [texture] is kept alive until this command buffer completes execution. More...
vk::CommandBuffer	GetCommandBuffer () const
	Retrieve the native command buffer from this object. More...
void	PushDebugGroup (std::string_view label) const
	Push a debug group. More...
void	PopDebugGroup () const
	Pop the previous debug group. More...
void	InsertDebugMarker (std::string_view label) const
	Insert a new debug marker. More...
bool	EndCommandBuffer () const
	End recording of the current command buffer. More...
fml::StatusOr< vk::DescriptorSet >	AllocateDescriptorSets (const vk::DescriptorSetLayout &layout, PipelineKey pipeline_key, const ContextVK &context)
	Allocate a new descriptor set for the given [layout]. More...
DescriptorPoolVK &	GetDescriptorPool () const
Public Member Functions inherited from impeller::CommandBuffer
virtual	~CommandBuffer ()
void	WaitUntilCompleted ()
	Block the current thread until the GPU has completed execution of the commands. More...
void	WaitUntilScheduled ()
	Block the current thread until the GPU has completed scheduling execution of the commands. More...
std::shared_ptr< RenderPass >	CreateRenderPass (const RenderTarget &render_target)
	Create a render pass to record render commands into. More...
std::shared_ptr< BlitPass >	CreateBlitPass ()
	Create a blit pass to record blit commands into. More...
std::shared_ptr< ComputePass >	CreateComputePass ()
	Create a compute pass to record compute commands into. More...

Friends
class	ContextVK
class	CommandQueueVK

Additional Inherited Members
Public Types inherited from impeller::CommandBuffer
enum class	Status {   kPending ,   kError ,   kCompleted }
using	CompletionCallback = std::function< void(Status)>
Static Public Member Functions inherited from impeller::BackendCast< CommandBufferVK, CommandBuffer >
static CommandBufferVK &	Cast (CommandBuffer &base)
static const CommandBufferVK &	Cast (const CommandBuffer &base)
static CommandBufferVK *	Cast (CommandBuffer *base)
static const CommandBufferVK *	Cast (const CommandBuffer *base)
Protected Member Functions inherited from impeller::CommandBuffer
	CommandBuffer (std::weak_ptr< const Context > context)
Protected Attributes inherited from impeller::CommandBuffer
std::weak_ptr< const Context >	context_

Detailed Description

Definition at line 23 of file command_buffer_vk.h.

Constructor & Destructor Documentation

~CommandBufferVK()

impeller::CommandBufferVK::~CommandBufferVK ( )

overridedefault

Member Function Documentation

AllocateDescriptorSets()

fml::StatusOr< vk::DescriptorSet > impeller::CommandBufferVK::AllocateDescriptorSets	(	const vk::DescriptorSetLayout &	layout,
		PipelineKey	pipeline_key,
		const ContextVK &	context
	)

Allocate a new descriptor set for the given [layout].

Definition at line 160 of file command_buffer_vk.cc.

                              {
  if (!IsValid()) {
    return fml::Status(fml::StatusCode::kUnknown, "command encoder invalid");
  }
 
  return tracked_objects_->GetDescriptorPool().AllocateDescriptorSets(
      layout, pipeline_key, context);
}

References context.

EndCommandBuffer()

bool impeller::CommandBufferVK::EndCommandBuffer

(

)

const

End recording of the current command buffer.

Definition at line 104 of file command_buffer_vk.cc.

                                             {
  InsertDebugMarker("QueueSubmit");
 
  auto command_buffer = GetCommandBuffer();
  tracked_objects_->GetGPUProbe().RecordCmdBufferEnd(command_buffer);
 
  auto status = command_buffer.end();
  if (status != vk::Result::eSuccess) {
    VALIDATION_LOG << "Failed to end command buffer: " << vk::to_string(status);
    return false;
  }
  return true;
}

References command_buffer, and VALIDATION_LOG.

GetCommandBuffer()

vk::CommandBuffer impeller::CommandBufferVK::GetCommandBuffer

(

)

const

Retrieve the native command buffer from this object.

Definition at line 118 of file command_buffer_vk.cc.

                                                        {
  if (tracked_objects_) {
    return tracked_objects_->GetCommandBuffer();
  }
  return {};
}

Referenced by impeller::GPUTracerVK::InitializeQueryPool(), and impeller::testing::TEST().

GetDescriptorPool()

DescriptorPoolVK & impeller::CommandBufferVK::GetDescriptorPool

(

)

const

Definition at line 203 of file command_buffer_vk.cc.

                                                           {
  return tracked_objects_->GetDescriptorPool();
}

Referenced by impeller::testing::TEST().

InsertDebugMarker()

void impeller::CommandBufferVK::InsertDebugMarker

(

std::string_view

label

)

const

Insert a new debug marker.

This label is only visible in debuggers like RenderDoc. This function is ignored in release builds.

Definition at line 192 of file command_buffer_vk.cc.

                                                                  {
  if (!HasValidationLayers()) {
    return;
  }
  vk::DebugUtilsLabelEXT label_info;
  label_info.pLabelName = label.data();
  if (auto command_buffer = GetCommandBuffer()) {
    command_buffer.insertDebugUtilsLabelEXT(label_info);
  }
}

References command_buffer, and impeller::HasValidationLayers().

PopDebugGroup()

void impeller::CommandBufferVK::PopDebugGroup

(

)

const

Pop the previous debug group.

This label is only visible in debuggers like RenderDoc. This function is ignored in release builds.

Definition at line 183 of file command_buffer_vk.cc.

                                          {
  if (!HasValidationLayers()) {
    return;
  }
  if (auto command_buffer = GetCommandBuffer()) {
    command_buffer.endDebugUtilsLabelEXT();
  }
}

References command_buffer, and impeller::HasValidationLayers().

PushDebugGroup()

void impeller::CommandBufferVK::PushDebugGroup

(

std::string_view

label

)

const

Push a debug group.

This label is only visible in debuggers like RenderDoc. This function is ignored in release builds.

Definition at line 172 of file command_buffer_vk.cc.

                                                               {
  if (!HasValidationLayers()) {
    return;
  }
  vk::DebugUtilsLabelEXT label_info;
  label_info.pLabelName = label.data();
  if (auto command_buffer = GetCommandBuffer()) {
    command_buffer.beginDebugUtilsLabelEXT(label_info);
  }
}

References command_buffer, and impeller::HasValidationLayers().

Track() [1/4]

bool impeller::CommandBufferVK::Track

(

const std::shared_ptr< const DeviceBuffer > &

buffer

)

Ensure that [buffer] is kept alive until this command buffer completes execution.

Definition at line 133 of file command_buffer_vk.cc.

                                                                           {
  if (!IsValid()) {
    return false;
  }
  tracked_objects_->Track(buffer);
  return true;
}

Track() [2/4]

bool impeller::CommandBufferVK::Track

(

const std::shared_ptr< const Texture > &

texture

)

Ensure that [texture] is kept alive until this command buffer completes execution.

Definition at line 150 of file command_buffer_vk.cc.

                                                                       {
  if (!IsValid()) {
    return false;
  }
  if (!texture) {
    return true;
  }
  return Track(TextureVK::Cast(*texture).GetTextureSource());
}

Track() [3/4]

bool impeller::CommandBufferVK::Track

(

const std::shared_ptr< const TextureSourceVK > &

texture

)

Ensure that [texture] is kept alive until this command buffer completes execution.

Definition at line 141 of file command_buffer_vk.cc.

                                                         {
  if (!IsValid()) {
    return false;
  }
  tracked_objects_->Track(texture);
  return true;
}

Track() [4/4]

bool impeller::CommandBufferVK::Track

(

const std::shared_ptr< SharedObjectVK > &

object

)

Ensure that [object] is kept alive until this command buffer completes execution.

Definition at line 125 of file command_buffer_vk.cc.

                                                                       {
  if (!IsValid()) {
    return false;
  }
  tracked_objects_->Track(object);
  return true;
}

Friends And Related Function Documentation

CommandQueueVK

friend class CommandQueueVK

friend

Definition at line 84 of file command_buffer_vk.h.

ContextVK

friend class ContextVK

friend

Definition at line 83 of file command_buffer_vk.h.

---

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

• impeller/renderer/backend/vulkan/command_buffer_vk.h
• impeller/renderer/backend/vulkan/command_buffer_vk.cc