impeller::CommandEncoderVK Class Reference

#include <command_encoder_vk.h>

Public Types
using	SubmitCallback = std::function< void(bool)>

Public Member Functions
	CommandEncoderVK (std::weak_ptr< const DeviceHolderVK > device_holder, std::shared_ptr< TrackedObjectsVK > tracked_objects, const std::shared_ptr< QueueVK > &queue, std::shared_ptr< FenceWaiterVK > fence_waiter)
	~CommandEncoderVK ()
bool	IsValid () const
bool	Track (std::shared_ptr< SharedObjectVK > object)
bool	Track (std::shared_ptr< const DeviceBuffer > buffer)
bool	IsTracking (const std::shared_ptr< const DeviceBuffer > &texture) const
bool	Track (const std::shared_ptr< const Texture > &texture)
bool	IsTracking (const std::shared_ptr< const Texture > &texture) const
bool	Track (std::shared_ptr< const TextureSourceVK > texture)
vk::CommandBuffer	GetCommandBuffer () const
void	PushDebugGroup (std::string_view label) const
void	PopDebugGroup () const
void	InsertDebugMarker (std::string_view label) const
bool	EndCommandBuffer () const
fml::StatusOr< vk::DescriptorSet >	AllocateDescriptorSets (const vk::DescriptorSetLayout &layout, const ContextVK &context)

Friends
class	ContextVK
class	CommandQueueVK

Detailed Description

Definition at line 50 of file command_encoder_vk.h.

Member Typedef Documentation

SubmitCallback

using impeller::CommandEncoderVK::SubmitCallback = std::function<void(bool)>

Definition at line 52 of file command_encoder_vk.h.

Constructor & Destructor Documentation

CommandEncoderVK()

impeller::CommandEncoderVK::CommandEncoderVK	(	std::weak_ptr< const DeviceHolderVK >	device_holder,
		std::shared_ptr< TrackedObjectsVK >	tracked_objects,
		const std::shared_ptr< QueueVK > &	queue,
		std::shared_ptr< FenceWaiterVK >	fence_waiter
	)

Definition at line 68 of file command_encoder_vk.cc.

    : device_holder_(std::move(device_holder)),
      tracked_objects_(std::move(tracked_objects)),
      queue_(queue),
      fence_waiter_(std::move(fence_waiter)) {}

~CommandEncoderVK()

impeller::CommandEncoderVK::~CommandEncoderVK ( )

default

Member Function Documentation

AllocateDescriptorSets()

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

Definition at line 164 of file command_encoder_vk.cc.

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

References IsValid().

EndCommandBuffer()

bool impeller::CommandEncoderVK::EndCommandBuffer

(

)

const

Definition at line 84 of file command_encoder_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 GetCommandBuffer(), InsertDebugMarker(), and VALIDATION_LOG.

GetCommandBuffer()

vk::CommandBuffer impeller::CommandEncoderVK::GetCommandBuffer

(

)

const

Definition at line 98 of file command_encoder_vk.cc.

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

Referenced by EndCommandBuffer(), InsertDebugMarker(), PopDebugGroup(), and PushDebugGroup().

InsertDebugMarker()

void impeller::CommandEncoderVK::InsertDebugMarker

(

std::string_view

label

)

const

Definition at line 195 of file command_encoder_vk.cc.

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

References GetCommandBuffer(), and impeller::HasValidationLayers().

Referenced by EndCommandBuffer().

IsTracking() [1/2]

bool impeller::CommandEncoderVK::IsTracking

(

const std::shared_ptr< const DeviceBuffer > &

texture

)

const

Definition at line 128 of file command_encoder_vk.cc.

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

References IsValid().

IsTracking() [2/2]

bool impeller::CommandEncoderVK::IsTracking

(

const std::shared_ptr< const Texture > &

texture

)

const

Definition at line 154 of file command_encoder_vk.cc.

                                                       {
  if (!IsValid()) {
    return false;
  }
  std::shared_ptr<const TextureSourceVK> source =
      TextureVK::Cast(*texture).GetTextureSource();
  return tracked_objects_->IsTracking(source);
}

References impeller::BackendCast< TextureVK, Texture >::Cast(), impeller::TextureVK::GetTextureSource(), and IsValid().

IsValid()

bool impeller::CommandEncoderVK::IsValid

(

)

const

Definition at line 80 of file command_encoder_vk.cc.

                                     {
  return is_valid_;
}

Referenced by AllocateDescriptorSets(), IsTracking(), and Track().

PopDebugGroup()

void impeller::CommandEncoderVK::PopDebugGroup

(

)

const

Definition at line 186 of file command_encoder_vk.cc.

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

References GetCommandBuffer(), and impeller::HasValidationLayers().

PushDebugGroup()

void impeller::CommandEncoderVK::PushDebugGroup

(

std::string_view

label

)

const

Definition at line 175 of file command_encoder_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 GetCommandBuffer(), and impeller::HasValidationLayers().

Track() [1/4]

bool impeller::CommandEncoderVK::Track

(

const std::shared_ptr< const Texture > &

texture

)

Definition at line 144 of file command_encoder_vk.cc.

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

References impeller::BackendCast< TextureVK, Texture >::Cast(), impeller::TextureVK::GetTextureSource(), IsValid(), and Track().

Track() [2/4]

bool impeller::CommandEncoderVK::Track

(

std::shared_ptr< const DeviceBuffer >

buffer

)

Definition at line 120 of file command_encoder_vk.cc.

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

References IsValid().

Track() [3/4]

bool impeller::CommandEncoderVK::Track

(

std::shared_ptr< const TextureSourceVK >

texture

)

Definition at line 136 of file command_encoder_vk.cc.

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

References IsValid().

Track() [4/4]

bool impeller::CommandEncoderVK::Track

(

std::shared_ptr< SharedObjectVK >

object

)

Definition at line 112 of file command_encoder_vk.cc.

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

References IsValid().

Referenced by Track().

Friends And Related Function Documentation

CommandQueueVK

friend class CommandQueueVK

friend

Definition at line 92 of file command_encoder_vk.h.

ContextVK

friend class ContextVK

friend

Definition at line 91 of file command_encoder_vk.h.

---

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

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