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 DeviceHolder > 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	Submit (SubmitCallback callback={})
bool	Track (std::shared_ptr< SharedObjectVK > object)
bool	Track (std::shared_ptr< const Buffer > buffer)
bool	IsTracking (const std::shared_ptr< const Buffer > &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 (const char *label) const
void	PopDebugGroup () const
void	InsertDebugMarker (const char *label) const
std::optional< vk::DescriptorSet >	AllocateDescriptorSet (const vk::DescriptorSetLayout &layout, size_t command_count)

Friends
class	ContextVK

Detailed Description

Definition at line 45 of file command_encoder_vk.h.

Member Typedef Documentation

SubmitCallback

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

Definition at line 47 of file command_encoder_vk.h.

Constructor & Destructor Documentation

CommandEncoderVK()

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

Definition at line 142 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

AllocateDescriptorSet()

std::optional< vk::DescriptorSet > impeller::CommandEncoderVK::AllocateDescriptorSet	(	const vk::DescriptorSetLayout &	layout,
		size_t	command_count
	)

Definition at line 284 of file command_encoder_vk.cc.

                          {
  if (!IsValid()) {
    return std::nullopt;
  }
 
  return tracked_objects_->GetDescriptorPool().AllocateDescriptorSet(
      layout, command_count);
}

References IsValid().

Referenced by impeller::AllocateAndBindDescriptorSets().

GetCommandBuffer()

vk::CommandBuffer impeller::CommandEncoderVK::GetCommandBuffer

(

)

const

Definition at line 218 of file command_encoder_vk.cc.

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

Referenced by impeller::BlitCopyTextureToTextureCommandVK::Encode(), impeller::BlitCopyTextureToBufferCommandVK::Encode(), impeller::BlitCopyBufferToTextureCommandVK::Encode(), impeller::BlitGenerateMipmapCommandVK::Encode(), impeller::EncodeCommand(), InsertDebugMarker(), PopDebugGroup(), PushDebugGroup(), and Submit().

InsertDebugMarker()

void impeller::CommandEncoderVK::InsertDebugMarker

(

const char *

label

)

const

Definition at line 315 of file command_encoder_vk.cc.

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

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

Referenced by Submit().

IsTracking() [1/2]

bool impeller::CommandEncoderVK::IsTracking

(

const std::shared_ptr< const Buffer > &

texture

)

const

Definition at line 248 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 274 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 154 of file command_encoder_vk.cc.

                                     {
  return is_valid_;
}

Referenced by AllocateDescriptorSet(), IsTracking(), Submit(), and Track().

PopDebugGroup()

void impeller::CommandEncoderVK::PopDebugGroup

(

)

const

Definition at line 306 of file command_encoder_vk.cc.

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

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

Referenced by impeller::EncodeCommand().

PushDebugGroup()

void impeller::CommandEncoderVK::PushDebugGroup

(

const char *

label

)

const

Definition at line 295 of file command_encoder_vk.cc.

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

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

Referenced by impeller::EncodeCommand().

Submit()

bool impeller::CommandEncoderVK::Submit

(

SubmitCallback

callback = {}

)

Definition at line 158 of file command_encoder_vk.cc.

                                                     {
  // Make sure to call callback with `false` if anything returns early.
  bool fail_callback = !!callback;
  if (!IsValid()) {
    VALIDATION_LOG << "Cannot submit invalid CommandEncoderVK.";
    if (fail_callback) {
      callback(false);
    }
    return false;
  }
 
  // Success or failure, you only get to submit once.
  fml::ScopedCleanupClosure reset([&]() {
    if (fail_callback) {
      callback(false);
    }
    Reset();
  });
 
  InsertDebugMarker("QueueSubmit");
 
  auto command_buffer = GetCommandBuffer();
 
  auto status = command_buffer.end();
  if (status != vk::Result::eSuccess) {
    VALIDATION_LOG << "Failed to end command buffer: " << vk::to_string(status);
    return false;
  }
  std::shared_ptr<const DeviceHolder> strong_device = device_holder_.lock();
  if (!strong_device) {
    VALIDATION_LOG << "Device lost.";
    return false;
  }
  auto [fence_result, fence] = strong_device->GetDevice().createFenceUnique({});
  if (fence_result != vk::Result::eSuccess) {
    VALIDATION_LOG << "Failed to create fence: " << vk::to_string(fence_result);
    return false;
  }
 
  vk::SubmitInfo submit_info;
  std::vector<vk::CommandBuffer> buffers = {command_buffer};
  submit_info.setCommandBuffers(buffers);
  status = queue_->Submit(submit_info, *fence);
  if (status != vk::Result::eSuccess) {
    VALIDATION_LOG << "Failed to submit queue: " << vk::to_string(status);
    return false;
  }
 
  // Submit will proceed, call callback with true when it is done and do not
  // call when `reset` is collected.
  fail_callback = false;
  return fence_waiter_->AddFence(
      std::move(fence),
      [callback, tracked_objects = std::move(tracked_objects_)] {
        if (callback) {
          callback(true);
        }
      });
}

References GetCommandBuffer(), InsertDebugMarker(), IsValid(), and VALIDATION_LOG.

Track() [1/4]

bool impeller::CommandEncoderVK::Track

(

const std::shared_ptr< const Texture > &

texture

)

Definition at line 264 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 Buffer >

buffer

)

Definition at line 240 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 256 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 232 of file command_encoder_vk.cc.

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

References IsValid().

Referenced by impeller::AllocateAndBindDescriptorSets(), impeller::BlitCopyTextureToTextureCommandVK::Encode(), impeller::BlitCopyTextureToBufferCommandVK::Encode(), impeller::BlitCopyBufferToTextureCommandVK::Encode(), impeller::BlitGenerateMipmapCommandVK::Encode(), impeller::EncodeCommand(), and Track().

Friends And Related Function Documentation

ContextVK

friend class ContextVK

friend

Definition at line 86 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