flutter::gpu::CommandBuffer Class Reference

#include <command_buffer.h>

Inheritance diagram for flutter::gpu::CommandBuffer:

Public Member Functions
	CommandBuffer (std::shared_ptr< impeller::Context > context, std::shared_ptr< impeller::CommandBuffer > command_buffer)
std::shared_ptr< impeller::CommandBuffer >	GetCommandBuffer ()
void	AddRenderPass (std::shared_ptr< impeller::RenderPass > render_pass)
bool	AddCompletionCallback (impeller::CommandBuffer::CompletionCallback completion_callback)
bool	CopyBufferToTexture (DeviceBuffer &source, size_t source_offset, size_t source_length, Texture &destination, impeller::IRect destination_region, uint32_t mip_level, uint32_t slice)
bool	CopyTextureToBuffer (Texture &source, impeller::IRect source_region, DeviceBuffer &destination, size_t destination_offset)
bool	CopyTextureToTexture (Texture &source, Texture &destination, impeller::IRect source_region, impeller::IPoint destination_origin)
bool	Submit ()
bool	Submit (const impeller::CommandBuffer::CompletionCallback &completion_callback)
	~CommandBuffer () override
Public Member Functions inherited from flutter::RefCountedDartWrappable< CommandBuffer >
virtual void	RetainDartWrappableReference () const override
virtual void	ReleaseDartWrappableReference () const override
Public Member Functions inherited from fml::RefCountedThreadSafe< T >
void	Release () const
Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void	AddRef () const
bool	HasOneRef () const
void	AssertHasOneRef () const
Public Member Functions inherited from tonic::DartWrappable
	DartWrappable ()
virtual const DartWrapperInfo &	GetDartWrapperInfo () const =0
Dart_Handle	CreateDartWrapper (DartState *dart_state)
void	AssociateWithDartWrapper (Dart_Handle wrappable)
void	ClearDartWrapper ()
Dart_WeakPersistentHandle	dart_wrapper () const

Additional Inherited Members
Public Types inherited from tonic::DartWrappable
enum	DartNativeFields {   kPeerIndex ,   kNumberOfNativeFields }
Protected Member Functions inherited from fml::RefCountedThreadSafe< T >
	RefCountedThreadSafe ()
	~RefCountedThreadSafe ()
Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
	RefCountedThreadSafeBase ()
	~RefCountedThreadSafeBase ()
bool	Release () const
void	Adopt ()
Protected Member Functions inherited from tonic::DartWrappable
virtual	~DartWrappable ()
Static Protected Member Functions inherited from tonic::DartWrappable
static Dart_PersistentHandle	GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)

Detailed Description

Definition at line 26 of file command_buffer.h.

Constructor & Destructor Documentation

CommandBuffer()

flutter::gpu::CommandBuffer::CommandBuffer	(	std::shared_ptr< impeller::Context >	context,
		std::shared_ptr< impeller::CommandBuffer >	command_buffer
	)

Definition at line 20 of file command_buffer.cc.

    : context_(std::move(context)),
      command_buffer_(std::move(command_buffer)) {}

~CommandBuffer()

flutter::gpu::CommandBuffer::~CommandBuffer ( )

overridedefault

References render_pass.

Member Function Documentation

AddCompletionCallback()

bool flutter::gpu::CommandBuffer::AddCompletionCallback

(

impeller::CommandBuffer::CompletionCallback

completion_callback

)

Definition at line 107 of file command_buffer.cc.

                                                                 {
  if (submitted_) {
    return false;
  }
  if (completion_callback) {
    completion_callbacks_.push_back(std::move(completion_callback));
  }
  return true;
}

AddRenderPass()

void flutter::gpu::CommandBuffer::AddRenderPass

(

std::shared_ptr< impeller::RenderPass >

render_pass

)

Definition at line 42 of file command_buffer.cc.

                                                   {
  Encodable encodable;
  encodable.render_pass = std::move(render_pass);
  encodables_.push_back(std::move(encodable));
}

References render_pass.

CopyBufferToTexture()

bool flutter::gpu::CommandBuffer::CopyBufferToTexture	(	DeviceBuffer &	source,
		size_t	source_offset,
		size_t	source_length,
		Texture &	destination,
		impeller::IRect	destination_region,
		uint32_t	mip_level,
		uint32_t	slice
	)

Definition at line 63 of file command_buffer.cc.

                                                        {
  auto blit_pass = GetOrCreateBlitPass();
  if (!blit_pass) {
    return false;
  }
  impeller::BufferView source_view(
      source.GetBuffer(), impeller::Range(source_offset, source_length));
  return blit_pass->AddCopy(
      std::move(source_view), destination.GetTexture(), destination_region,
      /*label=*/"CommandBuffer.copyBufferToTexture", mip_level, slice);
}

References flutter::gpu::DeviceBuffer::GetBuffer(), and flutter::gpu::Texture::GetTexture().

CopyTextureToBuffer()

bool flutter::gpu::CommandBuffer::CopyTextureToBuffer	(	Texture &	source,
		impeller::IRect	source_region,
		DeviceBuffer &	destination,
		size_t	destination_offset
	)

Definition at line 81 of file command_buffer.cc.

                                                                   {
  auto blit_pass = GetOrCreateBlitPass();
  if (!blit_pass) {
    return false;
  }
  return blit_pass->AddCopy(source.GetTexture(), destination.GetBuffer(),
                            source_region, destination_offset,
                            "CommandBuffer.copyTextureToBuffer");
}

References flutter::gpu::DeviceBuffer::GetBuffer(), and flutter::gpu::Texture::GetTexture().

CopyTextureToTexture()

bool flutter::gpu::CommandBuffer::CopyTextureToTexture	(	Texture &	source,
		Texture &	destination,
		impeller::IRect	source_region,
		impeller::IPoint	destination_origin
	)

Definition at line 94 of file command_buffer.cc.

                                                                            {
  auto blit_pass = GetOrCreateBlitPass();
  if (!blit_pass) {
    return false;
  }
  return blit_pass->AddCopy(source.GetTexture(), destination.GetTexture(),
                            source_region, destination_origin,
                            "CommandBuffer.copyTextureToTexture");
}

References flutter::gpu::Texture::GetTexture().

GetCommandBuffer()

std::shared_ptr< impeller::CommandBuffer > flutter::gpu::CommandBuffer::GetCommandBuffer

(

)

Definition at line 38 of file command_buffer.cc.

                                                                     {
  return command_buffer_;
}

Submit() [1/2]

bool flutter::gpu::CommandBuffer::Submit

(

)

Definition at line 118 of file command_buffer.cc.

                           {
  return CommandBuffer::Submit({});
}

References Submit().

Referenced by InternalFlutterGpu_CommandBuffer_Submit(), and Submit().

Submit() [2/2]

bool flutter::gpu::CommandBuffer::Submit

(

const impeller::CommandBuffer::CompletionCallback &

completion_callback

)

Definition at line 122 of file command_buffer.cc.

                                                                        {
  if (submitted_) {
    return false;
  }
  submitted_ = true;
 
  std::vector<impeller::CommandBuffer::CompletionCallback> callbacks =
      std::move(completion_callbacks_);
  if (completion_callback) {
    callbacks.push_back(completion_callback);
  }
  impeller::CommandBuffer::CompletionCallback combined_completion_callback;
  if (!callbacks.empty()) {
    combined_completion_callback =
        [callbacks = std::move(callbacks)](
            impeller::CommandBuffer::Status status) mutable {
          for (auto& callback : callbacks) {
            callback(status);
          }
        };
  }
 
  // For the GLES backend, command queue submission just flushes the reactor,
  // which needs to happen on the raster thread.
  if (context_->GetBackendType() == impeller::Context::BackendType::kOpenGLES) {
    auto dart_state = flutter::UIDartState::Current();
    auto& task_runners = dart_state->GetTaskRunners();
 
    task_runners.GetRasterTaskRunner()->PostTask(
        fml::MakeCopyable([context = context_, command_buffer = command_buffer_,
                           completion_callback = combined_completion_callback,
                           encodables = encodables_]() mutable {
          for (auto& encodable : encodables) {
            if (!encodable.EncodeCommands()) {
              if (completion_callback) {
                completion_callback(impeller::CommandBuffer::Status::kError);
              }
              context->DisposeThreadLocalCachedResources();
              return;
            }
          }
 
          auto status = context->GetCommandQueue()->Submit({command_buffer},
                                                           completion_callback);
          if (!status.ok() && completion_callback) {
            completion_callback(impeller::CommandBuffer::Status::kError);
          }
          context->DisposeThreadLocalCachedResources();
        }));
    return true;
  }
 
  for (auto& encodable : encodables_) {
    if (!encodable.EncodeCommands()) {
      return false;
    }
  }
 
  auto status = context_->GetCommandQueue()->Submit(
      {command_buffer_}, combined_completion_callback);
  context_->DisposeThreadLocalCachedResources();
  if (!status.ok() && combined_completion_callback) {
    combined_completion_callback(impeller::CommandBuffer::Status::kError);
  }
  return status.ok();
}

References callback, command_buffer, context, flutter::UIDartState::Current(), impeller::CommandBuffer::kError, impeller::Context::kOpenGLES, and fml::MakeCopyable().

---

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

• lib/gpu/command_buffer.h
• lib/gpu/command_buffer.cc