flutter::Surface Class Reference

Abstract Base Class that represents where we will be rendering content. More...

#include <surface.h>

Inheritance diagram for flutter::Surface:

Classes
struct	SurfaceData
	A screenshot of the surface's raw data. More...

Public Member Functions
	Surface ()
virtual	~Surface ()
virtual bool	IsValid ()=0
virtual std::unique_ptr< SurfaceFrame >	AcquireFrame (const SkISize &size)=0
virtual SkMatrix	GetRootTransformation () const =0
virtual GrDirectContext *	GetContext ()=0
virtual std::unique_ptr< GLContextResult >	MakeRenderContextCurrent ()
virtual bool	ClearRenderContext ()
virtual bool	AllowsDrawingWhenGpuDisabled () const
virtual bool	EnableRasterCache () const
virtual std::shared_ptr< impeller::AiksContext >	GetAiksContext () const
virtual SurfaceData	GetSurfaceData () const

Detailed Description

Abstract Base Class that represents where we will be rendering content.

Definition at line 24 of file surface.h.

Constructor & Destructor Documentation

Surface()

Surface::Surface ( )

default

~Surface()

Surface::~Surface ( )

virtualdefault

Reimplemented in flutter_runner::Surface.

Member Function Documentation

AcquireFrame()

virtual std::unique_ptr< SurfaceFrame > flutter::Surface::AcquireFrame ( const SkISize &  size )

pure virtual

Implemented in flutter::GPUSurfaceMetalImpeller, flutter::GPUSurfaceGLImpeller, flutter::GPUSurfaceGLSkia, flutter::GPUSurfaceMetalSkia, flutter::GPUSurfaceSoftware, flutter::GPUSurfaceVulkan, flutter::GPUSurfaceVulkanImpeller, and flutter_runner::Surface.

AllowsDrawingWhenGpuDisabled()

bool Surface::AllowsDrawingWhenGpuDisabled ( ) const

virtual

Reimplemented in flutter::GPUSurfaceGLImpeller, flutter::GPUSurfaceGLSkia, flutter::GPUSurfaceMetalImpeller, and flutter::GPUSurfaceMetalSkia.

Definition at line 21 of file surface.cc.

                                                 {
  return true;
}

ClearRenderContext()

bool Surface::ClearRenderContext ( )

virtual

Reimplemented in flutter::GPUSurfaceGLImpeller, and flutter::GPUSurfaceGLSkia.

Definition at line 17 of file surface.cc.

                                 {
  return false;
}

EnableRasterCache()

bool Surface::EnableRasterCache ( ) const

virtual

Reimplemented in flutter::GPUSurfaceGLImpeller, flutter::GPUSurfaceMetalImpeller, flutter::GPUSurfaceVulkanImpeller, and flutter::TesterGPUSurfaceSoftware.

Definition at line 25 of file surface.cc.

                                      {
  return true;
}

GetAiksContext()

std::shared_ptr< impeller::AiksContext > Surface::GetAiksContext ( ) const

virtual

Reimplemented in flutter::GPUSurfaceGLImpeller, flutter::GPUSurfaceMetalImpeller, and flutter::GPUSurfaceVulkanImpeller.

Definition at line 29 of file surface.cc.

                                                                 {
  return nullptr;
}

GetContext()

virtual GrDirectContext * flutter::Surface::GetContext ( )

pure virtual

Implemented in flutter::GPUSurfaceGLImpeller, flutter::GPUSurfaceGLSkia, flutter::GPUSurfaceMetalImpeller, flutter::GPUSurfaceMetalSkia, flutter::GPUSurfaceSoftware, flutter::GPUSurfaceVulkan, flutter::GPUSurfaceVulkanImpeller, and flutter_runner::Surface.

GetRootTransformation()

virtual SkMatrix flutter::Surface::GetRootTransformation ( ) const

pure virtual

Implemented in flutter::GPUSurfaceGLImpeller, flutter::GPUSurfaceGLSkia, flutter::GPUSurfaceMetalImpeller, flutter::GPUSurfaceMetalSkia, flutter::GPUSurfaceSoftware, flutter::GPUSurfaceVulkan, flutter::GPUSurfaceVulkanImpeller, and flutter_runner::Surface.

GetSurfaceData()

Surface::SurfaceData Surface::GetSurfaceData ( ) const

virtual

Capture the SurfaceData currently present in the surface.

Not guaranteed to work on all setups and not intended to be used in production. The data field will be null if it was unable to work.

Reimplemented in flutter::GPUSurfaceMetalImpeller.

Definition at line 33 of file surface.cc.

                                                 {
  return {};
}

IsValid()

virtual bool flutter::Surface::IsValid ( )

pure virtual

Implemented in flutter::GPUSurfaceGLImpeller, flutter::GPUSurfaceGLSkia, flutter::GPUSurfaceMetalImpeller, flutter::GPUSurfaceMetalSkia, flutter::GPUSurfaceSoftware, flutter::GPUSurfaceVulkan, flutter::GPUSurfaceVulkanImpeller, and flutter_runner::Surface.

MakeRenderContextCurrent()

std::unique_ptr< GLContextResult > Surface::MakeRenderContextCurrent ( )

virtual

Reimplemented in flutter::GPUSurfaceGLImpeller, flutter::GPUSurfaceGLSkia, flutter::GPUSurfaceMetalImpeller, flutter::GPUSurfaceMetalSkia, and flutter::GPUSurfaceVulkanImpeller.

Definition at line 13 of file surface.cc.

                                                                 {
  return std::make_unique<GLContextDefaultResult>(true);
}

---

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

• flow/surface.h
• flow/surface.cc