flutter::SurfaceFrame Class Reference

#include <surface_frame.h>

Classes
struct	FramebufferInfo
struct	SubmitInfo

Public Types
using	SubmitCallback = std::function< bool(SurfaceFrame &surface_frame, DlCanvas *canvas)>

Public Member Functions
	SurfaceFrame (sk_sp< SkSurface > surface, FramebufferInfo framebuffer_info, const SubmitCallback &submit_callback, SkISize frame_size, std::unique_ptr< GLContextResult > context_result=nullptr, bool display_list_fallback=false)
bool	Submit ()
bool	IsSubmitted () const
sk_sp< SkSurface >	SkiaSurface () const
DlCanvas *	Canvas ()
const FramebufferInfo &	framebuffer_info () const
void	set_submit_info (const SubmitInfo &submit_info)
const SubmitInfo &	submit_info () const
sk_sp< DisplayList >	BuildDisplayList ()

Detailed Description

Definition at line 24 of file surface_frame.h.

Member Typedef Documentation

SubmitCallback

using flutter::SurfaceFrame::SubmitCallback = std::function<bool(SurfaceFrame& surface_frame, DlCanvas* canvas)>

Definition at line 26 of file surface_frame.h.

Constructor & Destructor Documentation

SurfaceFrame()

flutter::SurfaceFrame::SurfaceFrame	(	sk_sp< SkSurface >	surface,
		FramebufferInfo	framebuffer_info,
		const SubmitCallback &	submit_callback,
		SkISize	frame_size,
		std::unique_ptr< GLContextResult >	context_result = nullptr,
		bool	display_list_fallback = false
	)

Definition at line 18 of file surface_frame.cc.

    : surface_(std::move(surface)),
      framebuffer_info_(framebuffer_info),
      submit_callback_(submit_callback),
      context_result_(std::move(context_result)) {
  FML_DCHECK(submit_callback_);
  if (surface_) {
#if !SLIMPELLER
    adapter_.set_canvas(surface_->getCanvas());
    canvas_ = &adapter_;
#else   //  !SLIMPELLER
    FML_LOG(FATAL) << "Impeller opt-out unavailable.";
    return;
#endif  //  !SLIMPELLER
  } else if (display_list_fallback) {
    FML_DCHECK(!frame_size.isEmpty());
    // The root frame of a surface will be filled by the layer_tree which
    // performs branch culling so it will be unlikely to need an rtree for
    // further culling during `DisplayList::Dispatch`. Further, this canvas
    // will live underneath any platform views so we do not need to compute
    // exact coverage to describe "pixel ownership" to the platform.
    dl_builder_ = sk_make_sp<DisplayListBuilder>(SkRect::Make(frame_size),
                                                 /*prepare_rtree=*/false);
    canvas_ = dl_builder_.get();
  }
}

Member Function Documentation

BuildDisplayList()

sk_sp< DisplayList > flutter::SurfaceFrame::BuildDisplayList

(

)

Definition at line 85 of file surface_frame.cc.

                                                  {
  TRACE_EVENT0("impeller", "SurfaceFrame::BuildDisplayList");
  return dl_builder_ ? dl_builder_->Build() : nullptr;
}

Canvas()

DlCanvas * flutter::SurfaceFrame::Canvas

(

)

Definition at line 65 of file surface_frame.cc.

                               {
  return canvas_;
}

framebuffer_info()

const FramebufferInfo & flutter::SurfaceFrame::framebuffer_info ( ) const

inline

Definition at line 93 of file surface_frame.h.

{ return framebuffer_info_; }

IsSubmitted()

bool flutter::SurfaceFrame::IsSubmitted

(

)

const

Definition at line 61 of file surface_frame.cc.

                                     {
  return submitted_;
}

set_submit_info()

void flutter::SurfaceFrame::set_submit_info ( const SubmitInfo &  submit_info )

inline

Definition at line 95 of file surface_frame.h.

                                                      {
    submit_info_ = submit_info;
  }

SkiaSurface()

sk_sp< SkSurface > flutter::SurfaceFrame::SkiaSurface

(

)

const

Definition at line 69 of file surface_frame.cc.

                                                 {
  return surface_;
}

Submit()

bool flutter::SurfaceFrame::Submit

(

)

Definition at line 50 of file surface_frame.cc.

                          {
  TRACE_EVENT0("flutter", "SurfaceFrame::Submit");
  if (submitted_) {
    return false;
  }
 
  submitted_ = PerformSubmit();
 
  return submitted_;
}

submit_info()

const SubmitInfo & flutter::SurfaceFrame::submit_info ( ) const

inline

Definition at line 98 of file surface_frame.h.

{ return submit_info_; }

---

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

• flow/surface_frame.h
• flow/surface_frame.cc