| Flutter Impeller |

Public Types | Public Member Functions | List of all members
impeller::CommandQueue Class Reference

An interface for submitting command buffers to the GPU for encoding and execution. More...

`#include <command_queue.h>`

Inheritance diagram for impeller::CommandQueue:

## Public Types
using | CompletionCallback = std::function< void(CommandBuffer::Status)>

## Public Member Functions
| CommandQueue ()
virtual | ~CommandQueue ()
virtual fml::Status | Submit (const std::vector< std::shared_ptr< CommandBuffer >> &buffers, const CompletionCallback &completion_callback={}, bool block_on_schedule=false)
| Submit one or more command buffer objects to be encoded and executed on the GPU. More...

## Detailed Description

An interface for submitting command buffers to the GPU for encoding and execution.

Definition at line 17 of file command_queue.h.

## Member Typedef Documentation

## ◆ CompletionCallback

using impeller::CommandQueue::CompletionCallback = std::function<void(CommandBuffer::Status)>

Definition at line 19 of file command_queue.h.

## Constructor & Destructor Documentation

## ◆ CommandQueue()

impeller::CommandQueue::CommandQueue | ( |  | ) |
| default

## ◆ ~CommandQueue()

impeller::CommandQueue::~CommandQueue | ( |  | ) |
| virtual default

## Member Function Documentation

## ◆ Submit()

fml::Status impeller::CommandQueue::Submit | ( | const std::vector< std::shared_ptr< CommandBuffer >> & | buffers,
|  | const CompletionCallback & | completion_callback = `{}`,
|  | bool | block_on_schedule = `false`
| ) |  |
| virtual

Submit one or more command buffer objects to be encoded and executed on the GPU.

The order of the provided buffers determines the ordering in which they are submitted.

The returned status only indicates if the command buffer was successfully submitted. Successful completion of the command buffer can only be checked in the optional completion callback.

Only the Metal and Vulkan backends can give a status beyond successful encoding. This callback may be called more than once and potentially on a different thread.

If [block_on_schedule] is true, this function will not return until the command buffer has been scheduled. This only impacts the Metal backend.

Reimplemented in impeller::CommandQueueVK.

Definition at line 14 of file command_queue.cc.

17 {
18 if (buffers.empty()) {
19 if (completion_callback) {
20 completion_callback(CommandBuffer::Status::kError);
21 }
22 return fml::Status(fml::StatusCode::kInvalidArgument,
23 "No command buffers provided.");
24 }
25 for (const std::shared_ptr<CommandBuffer>& buffer : buffers) {
26 if (!buffer->SubmitCommands(block_on_schedule, completion_callback)) {
27 return fml::Status(fml::StatusCode::kCancelled,
28 "Failed to submit command buffer.");
29 }
30 }
31 return fml::Status();
32 }
impeller::CommandBuffer::Status::kError
@ kError

References impeller::CommandBuffer::kError.

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

- impeller/renderer/command_queue.h
- impeller/renderer/command_queue.cc