flutter::gpu::Surface Class Reference

#include <surface.h>

Inheritance diagram for flutter::gpu::Surface:

Public Member Functions
	Surface (std::shared_ptr< impeller::Context > context, impeller::ISize size, impeller::PixelFormat format)
	~Surface () override
int	AcquireNextFrame (Dart_Handle texture_wrapper)
Dart_Handle	PresentFrame (size_t texture_index, CommandBuffer &command_buffer)
void	DiscardFrame (size_t texture_index)
Dart_Handle	GetCurrentImage () const
std::optional< std::string >	Resize (impeller::ISize size)
size_t	GetBackingTextureCount () const
Public Member Functions inherited from flutter::RefCountedDartWrappable< Surface >
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 29 of file surface.h.

Constructor & Destructor Documentation

Surface()

flutter::gpu::Surface::Surface	(	std::shared_ptr< impeller::Context >	context,
		impeller::ISize	size,
		impeller::PixelFormat	format
	)

Definition at line 40 of file surface.cc.

    : context_(std::move(context)), size_(size), format_(format) {}

References format.

~Surface()

flutter::gpu::Surface::~Surface ( )

overridedefault

References format, image, flutter::size, and texture.

Member Function Documentation

AcquireNextFrame()

int flutter::gpu::Surface::AcquireNextFrame

(

Dart_Handle

texture_wrapper

)

Definition at line 124 of file surface.cc.

                                                         {
  std::optional<size_t> available_index;
  size_t index = 0;
  for (const auto& record : records_) {
    if (!record && !available_index.has_value()) {
      available_index = index;
    }
    if (IsReusable(record, index)) {
      record->acquired = true;
      auto texture = fml::MakeRefCounted<Texture>(record->texture);
      texture->AssociateWithDartWrapper(texture_wrapper);
      return static_cast<int>(index);
    }
    index++;
  }
 
  auto record = CreateTextureRecord();
  if (!record) {
    return -1;
  }
  record->acquired = true;
 
  if (available_index.has_value()) {
    records_[available_index.value()] = record;
    index = available_index.value();
  } else {
    records_.push_back(record);
    index = records_.size() - 1u;
  }
 
  auto texture = fml::MakeRefCounted<Texture>(record->texture);
  texture->AssociateWithDartWrapper(texture_wrapper);
  return static_cast<int>(index);
}

References texture.

Referenced by InternalFlutterGpu_Surface_AcquireNextFrame().

DiscardFrame()

void flutter::gpu::Surface::DiscardFrame

(

size_t

texture_index

)

Definition at line 199 of file surface.cc.

                                               {
  if (texture_index >= records_.size()) {
    return;
  }
  auto record = records_[texture_index];
  if (record) {
    record->acquired = false;
  }
}

Referenced by InternalFlutterGpu_Surface_DiscardFrame().

GetBackingTextureCount()

size_t flutter::gpu::Surface::GetBackingTextureCount

(

)

const

Definition at line 233 of file surface.cc.

                                             {
  size_t count = 0;
  for (const auto& record : records_) {
    if (record) {
      count++;
    }
  }
  return count;
}

Referenced by InternalFlutterGpu_Surface_GetBackingTextureCount().

GetCurrentImage()

Dart_Handle flutter::gpu::Surface::GetCurrentImage

(

)

const

Definition at line 209 of file surface.cc.

                                           {
  if (!current_index_.has_value() ||
      current_index_.value() >= records_.size()) {
    return Dart_Null();
  }
  auto record = records_[current_index_.value()];
  if (!record) {
    return Dart_Null();
  }
  return CreateImage(record->image);
}

Referenced by InternalFlutterGpu_Surface_GetCurrentImage().

PresentFrame()

Dart_Handle flutter::gpu::Surface::PresentFrame	(	size_t	texture_index,
		CommandBuffer &	command_buffer
	)

Definition at line 168 of file surface.cc.

                                                                 {
  if (texture_index >= records_.size()) {
    return tonic::ToDart("SurfaceFrame does not belong to this GpuSurface.");
  }
 
  auto record = records_[texture_index];
  if (!record || !record->acquired) {
    return tonic::ToDart(
        "SurfaceFrame has already been presented or discarded.");
  }
 
  record->producer_pending.store(true);
  if (!command_buffer.AddCompletionCallback(
          [record]([[maybe_unused]] impeller::CommandBuffer::Status status) {
            record->producer_pending.store(false);
          })) {
    record->producer_pending.store(false);
    return tonic::ToDart(
        "SurfaceFrame.present must be called before submitting the command "
        "buffer.");
  }
 
  record->acquired = false;
  current_index_ = texture_index;
  PruneTextureRecords();
  // The presented image is read separately via GetCurrentImage, so avoid
  // allocating an image wrapper here on every presented frame.
  return Dart_Null();
}

References command_buffer, and tonic::ToDart().

Referenced by InternalFlutterGpu_Surface_PresentFrame().

Resize()

std::optional< std::string > flutter::gpu::Surface::Resize

(

impeller::ISize

size

)

Definition at line 221 of file surface.cc.

                                                         {
  for (const auto& record : records_) {
    if (record && record->acquired) {
      return "GpuSurface.resize cannot be called while a SurfaceFrame is "
             "acquired.";
    }
  }
  size_ = size;
  PruneTextureRecords();
  return std::nullopt;
}

References flutter::size.

Referenced by InternalFlutterGpu_Surface_Resize().

---

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

• lib/gpu/surface.h
• lib/gpu/surface.cc