flutter::SurfaceFrame Class Reference

#include <surface_frame.h>

Classes
struct	FramebufferInfo
struct	SubmitInfo

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

Public Member Functions
	SurfaceFrame (sk_sp< SkSurface > surface, FramebufferInfo framebuffer_info, const EncodeCallback &encode_callback, const SubmitCallback &submit_callback, DlISize frame_size, std::unique_ptr< GLContextResult > context_result=nullptr, bool display_list_fallback=false)
bool	Encode ()
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 ()
void	set_user_data (std::shared_ptr< impeller::Surface > data)
std::shared_ptr< impeller::Surface >	take_user_data ()

Detailed Description

Definition at line 27 of file surface_frame.h.

Member Typedef Documentation

EncodeCallback

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

Definition at line 29 of file surface_frame.h.

SubmitCallback

using flutter::SurfaceFrame::SubmitCallback = std::function<bool(SurfaceFrame& surface_frame)>

Definition at line 31 of file surface_frame.h.

Constructor & Destructor Documentation

SurfaceFrame()

flutter::SurfaceFrame::SurfaceFrame	(	sk_sp< SkSurface >	surface,
		FramebufferInfo	framebuffer_info,
		const EncodeCallback &	encode_callback,
		const SubmitCallback &	submit_callback,
		DlISize	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),
      encode_callback_(encode_callback),
      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>(DlRect::MakeSize(frame_size),
                                                 /*prepare_rtree=*/false);
    canvas_ = dl_builder_.get();
  }
}

References FML_DCHECK, FML_LOG, impeller::TSize< T >::IsEmpty(), impeller::TRect< Scalar >::MakeSize(), flutter::DlSkCanvasAdapter::set_canvas(), and surface.

Member Function Documentation

BuildDisplayList()

sk_sp< DisplayList > flutter::SurfaceFrame::BuildDisplayList

(

)

Definition at line 114 of file surface_frame.cc.

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

References TRACE_EVENT0.

Canvas()

DlCanvas * flutter::SurfaceFrame::Canvas

(

)

Definition at line 82 of file surface_frame.cc.

                               {
  return canvas_;
}

Referenced by flutter::TEST().

Encode()

bool flutter::SurfaceFrame::Encode

(

)

Definition at line 52 of file surface_frame.cc.

                          {
  TRACE_EVENT0("flutter", "SurfaceFrame::Encode");
  if (encoded_) {
    return false;
  }
 
  encoded_ = PerformEncode();
 
  return encoded_;
}

References TRACE_EVENT0.

Referenced by Submit().

framebuffer_info()

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

inline

Definition at line 120 of file surface_frame.h.

{ return framebuffer_info_; }

IsSubmitted()

bool flutter::SurfaceFrame::IsSubmitted

(

)

const

Definition at line 78 of file surface_frame.cc.

                                     {
  return submitted_;
}

set_submit_info()

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

inline

Definition at line 122 of file surface_frame.h.

                                                      {
    submit_info_ = submit_info;
  }

References submit_info().

set_user_data()

void flutter::SurfaceFrame::set_user_data ( std::shared_ptr< impeller::Surface >  data )

inline

Definition at line 129 of file surface_frame.h.

                                                          {
    user_data_ = std::move(data);
  }

References flutter::data.

SkiaSurface()

sk_sp< SkSurface > flutter::SurfaceFrame::SkiaSurface

(

)

const

Definition at line 86 of file surface_frame.cc.

                                                 {
  return surface_;
}

Submit()

bool flutter::SurfaceFrame::Submit

(

)

Definition at line 63 of file surface_frame.cc.

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

References Encode(), and TRACE_EVENT0.

submit_info()

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

inline

Definition at line 125 of file surface_frame.h.

{ return submit_info_; }

Referenced by set_submit_info(), flutter::TEST(), and flutter::TEST().

take_user_data()

std::shared_ptr< impeller::Surface > flutter::SurfaceFrame::take_user_data ( )

inline

Definition at line 133 of file surface_frame.h.

                                                  {
    return std::move(user_data_);
  }

---

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

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