flutter_runner::SoftwareSurface Class Reference

#include <software_surface.h>

Inheritance diagram for flutter_runner::SoftwareSurface:

Public Member Functions
	SoftwareSurface (fuchsia::sysmem2::AllocatorSyncPtr &sysmem_allocator, fuchsia::ui::composition::AllocatorPtr &flatland_allocator, const SkISize &size)
	~SoftwareSurface () override
size_t	GetAllocationSize () const
size_t	AdvanceAndGetAge () override
bool	FlushSessionAcquireAndReleaseEvents () override
bool	IsValid () const override
SkISize	GetSize () const override
void	SignalWritesFinished (const std::function< void(void)> &on_surface_read_finished) override
void	SetImageId (uint32_t image_id) override
uint32_t	GetImageId () override
sk_sp< SkSurface >	GetSkiaSurface () const override
fuchsia::ui::composition::BufferCollectionImportToken	GetBufferCollectionImportToken () override
zx::event	GetAcquireFence () override
zx::event	GetReleaseFence () override
void	SetReleaseImageCallback (ReleaseImageCallback release_image_callback) override
Public Member Functions inherited from flutter_runner::SurfaceProducerSurface
virtual	~SurfaceProducerSurface ()=default

Detailed Description

Definition at line 25 of file software_surface.h.

Constructor & Destructor Documentation

SoftwareSurface()

flutter_runner::SoftwareSurface::SoftwareSurface	(	fuchsia::sysmem2::AllocatorSyncPtr &	sysmem_allocator,
		fuchsia::ui::composition::AllocatorPtr &	flatland_allocator,
		const SkISize &	size
	)

Definition at line 47 of file software_surface.cc.

    : wait_for_surface_read_finished_(this) {
  FML_CHECK(flatland_allocator.is_bound());
 
  if (!SetupSkiaSurface(sysmem_allocator, flatland_allocator, size)) {
    FML_LOG(ERROR) << "Could not create render surface.";
    return;
  }
 
  if (!CreateFences()) {
    FML_LOG(ERROR) << "Could not create signal fences.";
    return;
  }
 
  wait_for_surface_read_finished_.set_object(release_event_.get());
  wait_for_surface_read_finished_.set_trigger(ZX_EVENT_SIGNALED);
  Reset();
 
  valid_ = true;
}

References FML_CHECK, and FML_LOG.

~SoftwareSurface()

flutter_runner::SoftwareSurface::~SoftwareSurface ( )

override

Definition at line 71 of file software_surface.cc.

                                  {
  release_image_callback_();
  wait_for_surface_read_finished_.Cancel();
  wait_for_surface_read_finished_.set_object(ZX_HANDLE_INVALID);
}

Member Function Documentation

AdvanceAndGetAge()

size_t flutter_runner::SoftwareSurface::AdvanceAndGetAge ( )

overridevirtual

Implements flutter_runner::SurfaceProducerSurface.

Definition at line 326 of file software_surface.cc.

                                         {
  return ++age_;
}

FlushSessionAcquireAndReleaseEvents()

bool flutter_runner::SoftwareSurface::FlushSessionAcquireAndReleaseEvents ( )

overridevirtual

Implements flutter_runner::SurfaceProducerSurface.

Definition at line 330 of file software_surface.cc.

                                                          {
  age_ = 0;
  return true;
}

GetAcquireFence()

zx::event flutter_runner::SoftwareSurface::GetAcquireFence ( )

overridevirtual

Implements flutter_runner::SurfaceProducerSurface.

Definition at line 310 of file software_surface.cc.

                                         {
  zx::event fence;
  acquire_event_.duplicate(ZX_RIGHT_SAME_RIGHTS, &fence);
  return fence;
}

GetAllocationSize()

size_t flutter_runner::SoftwareSurface::GetAllocationSize ( ) const

inline

Definition at line 33 of file software_surface.h.

{ return surface_size_bytes_; }

GetBufferCollectionImportToken()

fuchsia::ui::composition::BufferCollectionImportToken flutter_runner::SoftwareSurface::GetBufferCollectionImportToken ( )

overridevirtual

Implements flutter_runner::SurfaceProducerSurface.

Definition at line 304 of file software_surface.cc.

                                                {
  fuchsia::ui::composition::BufferCollectionImportToken import_dup;
  import_token_.value.duplicate(ZX_RIGHT_SAME_RIGHTS, &import_dup.value);
  return import_dup;
}

GetImageId()

uint32_t flutter_runner::SoftwareSurface::GetImageId ( )

overridevirtual

Implements flutter_runner::SurfaceProducerSurface.

Definition at line 295 of file software_surface.cc.

                                     {
  return image_id_;
}

GetReleaseFence()

zx::event flutter_runner::SoftwareSurface::GetReleaseFence ( )

overridevirtual

Implements flutter_runner::SurfaceProducerSurface.

Definition at line 316 of file software_surface.cc.

                                         {
  zx::event fence;
  release_event_.duplicate(ZX_RIGHT_SAME_RIGHTS, &fence);
  return fence;
}

GetSize()

SkISize flutter_runner::SoftwareSurface::GetSize ( ) const

overridevirtual

Implements flutter_runner::SurfaceProducerSurface.

Definition at line 81 of file software_surface.cc.

                                       {
  if (!valid_) {
    return SkISize::Make(0, 0);
  }
 
  return SkISize::Make(sk_surface_->width(), sk_surface_->height());
}

GetSkiaSurface()

sk_sp< SkSurface > flutter_runner::SoftwareSurface::GetSkiaSurface ( ) const

overridevirtual

Implements flutter_runner::SurfaceProducerSurface.

Definition at line 299 of file software_surface.cc.

                                                       {
  return valid_ ? sk_surface_ : nullptr;
}

IsValid()

bool flutter_runner::SoftwareSurface::IsValid ( ) const

overridevirtual

Implements flutter_runner::SurfaceProducerSurface.

Definition at line 77 of file software_surface.cc.

                                    {
  return valid_;
}

SetImageId()

void flutter_runner::SoftwareSurface::SetImageId ( uint32_t  image_id )

overridevirtual

Implements flutter_runner::SurfaceProducerSurface.

Definition at line 290 of file software_surface.cc.

                                                  {
  FML_CHECK(image_id_ == 0);
  image_id_ = image_id;
}

References FML_CHECK.

SetReleaseImageCallback()

void flutter_runner::SoftwareSurface::SetReleaseImageCallback ( ReleaseImageCallback  release_image_callback )

overridevirtual

Implements flutter_runner::SurfaceProducerSurface.

Definition at line 321 of file software_surface.cc.

                                                 {
  release_image_callback_ = release_image_callback;
}

SignalWritesFinished()

void flutter_runner::SoftwareSurface::SignalWritesFinished ( const std::function< void(void)> &  on_surface_read_finished )

overridevirtual

Implements flutter_runner::SurfaceProducerSurface.

Definition at line 335 of file software_surface.cc.

                                                             {
  FML_CHECK(on_surface_read_finished);
 
  if (!valid_) {
    on_surface_read_finished();
    return;
  }
 
  FML_CHECK(surface_read_finished_callback_ == nullptr)
      << "Attempted to signal a write on the surface when the "
         "previous write has not yet been acknowledged by the "
         "compositor.";
  surface_read_finished_callback_ = on_surface_read_finished;
 
  // Sysmem *may* require the cache to be cleared after writes to the surface
  // are complete.
  if (needs_cache_clean_) {
    surface_vmo_.op_range(ZX_VMO_OP_CACHE_CLEAN, 0, surface_size_bytes_,
                          /*buffer*/ nullptr,
                          /*buffer_size*/ 0);
  }
 
  // Inform scenic that flutter is finished writing to the surface.
  zx_status_t signal_status = acquire_event_.signal(0u, ZX_EVENT_SIGNALED);
  if (signal_status != ZX_OK) {
    FML_LOG(ERROR) << "Failed to signal acquire event; "
                   << zx_status_get_string(signal_status);
  }
}

References FML_CHECK, and FML_LOG.

---

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

• shell/platform/fuchsia/flutter/software_surface.h
• shell/platform/fuchsia/flutter/software_surface.cc