Flutter Engine
The Flutter Engine
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
flutter::testing::DlSurfaceProvider Class Referenceabstract

#include <dl_test_surface_provider.h>

Inheritance diagram for flutter::testing::DlSurfaceProvider:
flutter::testing::DlMetalSurfaceProvider flutter::testing::DlOpenGLSurfaceProvider flutter::testing::DlSoftwareSurfaceProvider

Public Types

enum  PixelFormat { kN32PremulPixelFormat , k565PixelFormat }
 
enum  BackendType { kSoftwareBackend , kOpenGlBackend , kMetalBackend }
 

Public Member Functions

virtual ~DlSurfaceProvider ()=default
 
virtual const std::string backend_name () const =0
 
virtual BackendType backend_type () const =0
 
virtual bool supports (PixelFormat format) const =0
 
virtual bool supports_impeller () const
 
virtual bool InitializeSurface (size_t width, size_t height, PixelFormat format=kN32PremulPixelFormat)=0
 
virtual std::shared_ptr< DlSurfaceInstance > GetPrimarySurface () const =0
 
virtual std::shared_ptr< DlSurfaceInstance > MakeOffscreenSurface (size_t width, size_t height, PixelFormat format=kN32PremulPixelFormat) const =0
 
virtual bool Snapshot (std::string &filename) const
 
virtual sk_sp< DlPixelData > ImpellerSnapshot (const sk_sp< DisplayList > &list, int width, int height) const
 
virtual sk_sp< DlImage > MakeImpellerImage (const sk_sp< DisplayList > &list, int width, int height) const
 

Static Public Member Functions

static SkImageInfo MakeInfo (PixelFormat format, int w, int h)
 
static std::string BackendName (BackendType type)
 
static std::unique_ptr< DlSurfaceProvider > Create (BackendType backend_type)
 

Protected Member Functions

 DlSurfaceProvider ()=default
 

Detailed Description

Definition at line 52 of file dl_test_surface_provider.h.

Member Enumeration Documentation

◆ BackendType

enum flutter::testing::DlSurfaceProvider::BackendType
Enumerator
kSoftwareBackend 
kOpenGlBackend 
kMetalBackend 

Definition at line 55 of file dl_test_surface_provider.h.

55{ kSoftwareBackend, kOpenGlBackend, kMetalBackend } BackendType;

◆ PixelFormat

enum flutter::testing::DlSurfaceProvider::PixelFormat
Enumerator
kN32PremulPixelFormat 
k565PixelFormat 

Definition at line 54 of file dl_test_surface_provider.h.

54{ kN32PremulPixelFormat, k565PixelFormat } PixelFormat;

Constructor & Destructor Documentation

◆ ~DlSurfaceProvider()

virtual flutter::testing::DlSurfaceProvider::~DlSurfaceProvider ( )
virtualdefault

◆ DlSurfaceProvider()

flutter::testing::DlSurfaceProvider::DlSurfaceProvider ( )
protecteddefault

Member Function Documentation

◆ backend_name()

virtual const std::string flutter::testing::DlSurfaceProvider::backend_name ( ) const
pure virtual

Implemented in flutter::testing::DlOpenGLSurfaceProvider, flutter::testing::DlMetalSurfaceProvider, and flutter::testing::DlSoftwareSurfaceProvider.

◆ backend_type()

virtual BackendType flutter::testing::DlSurfaceProvider::backend_type ( ) const
pure virtual

Implemented in flutter::testing::DlOpenGLSurfaceProvider, flutter::testing::DlMetalSurfaceProvider, and flutter::testing::DlSoftwareSurfaceProvider.

◆ BackendName()

std::string flutter::testing::DlSurfaceProvider::BackendName ( BackendType  type)
static

Definition at line 26 of file dl_test_surface_provider.cc.

26 {
27 switch (type) {
28 case kMetalBackend:
29 return "Metal";
30 case kOpenGlBackend:
31 return "OpenGL";
32 case kSoftwareBackend:
33 return "Software";
34 }
35}
type
GLenum type
Definition: blit_command_gles.cc:126

◆ Create()

std::unique_ptr< DlSurfaceProvider > flutter::testing::DlSurfaceProvider::Create ( BackendType  backend_type)
static

Definition at line 37 of file dl_test_surface_provider.cc.

38 {
39 switch (backend_type) {
40#ifdef ENABLE_SOFTWARE_BENCHMARKS
41 case kSoftwareBackend:
42 return std::make_unique<DlSoftwareSurfaceProvider>();
43#endif
44#ifdef ENABLE_OPENGL_BENCHMARKS
45 case kOpenGLBackend:
46 return std::make_unique<DlOpenGLSurfaceProvider>();
47#endif
48#ifdef ENABLE_METAL_BENCHMARKS
49 case kMetalBackend:
50 return std::make_unique<DlMetalSurfaceProvider>();
51#endif
52 default:
53 return nullptr;
54 }
55
56 return nullptr;
57}
flutter::testing::DlSurfaceProvider::backend_type
virtual BackendType backend_type() const =0

◆ GetPrimarySurface()

virtual std::shared_ptr< DlSurfaceInstance > flutter::testing::DlSurfaceProvider::GetPrimarySurface ( ) const
pure virtual

Implemented in flutter::testing::DlOpenGLSurfaceProvider, flutter::testing::DlMetalSurfaceProvider, and flutter::testing::DlSoftwareSurfaceProvider.

◆ ImpellerSnapshot()

virtual sk_sp< DlPixelData > flutter::testing::DlSurfaceProvider::ImpellerSnapshot ( const sk_sp< DisplayList > &  list,
int  width,
int  height 
) const
inlinevirtual

Reimplemented in flutter::testing::DlMetalSurfaceProvider.

Definition at line 87 of file dl_test_surface_provider.h.

89 {
90 return nullptr;
91 }

◆ InitializeSurface()

virtual bool flutter::testing::DlSurfaceProvider::InitializeSurface ( size_t  width,
size_t  height,
PixelFormat  format = kN32PremulPixelFormat 
)
pure virtual

Implemented in flutter::testing::DlOpenGLSurfaceProvider, flutter::testing::DlMetalSurfaceProvider, and flutter::testing::DlSoftwareSurfaceProvider.

◆ MakeImpellerImage()

virtual sk_sp< DlImage > flutter::testing::DlSurfaceProvider::MakeImpellerImage ( const sk_sp< DisplayList > &  list,
int  width,
int  height 
) const
inlinevirtual

Reimplemented in flutter::testing::DlMetalSurfaceProvider.

Definition at line 92 of file dl_test_surface_provider.h.

94 {
95 return nullptr;
96 }

◆ MakeInfo()

static SkImageInfo flutter::testing::DlSurfaceProvider::MakeInfo ( PixelFormat  format,
int  w,
int  h 
)
inlinestatic

Definition at line 57 of file dl_test_surface_provider.h.

57 {
58 switch (format) {
59 case kN32PremulPixelFormat:
60 return SkImageInfo::MakeN32Premul(w, h);
61 case k565PixelFormat:
62 return SkImageInfo::Make(SkISize::Make(w, h), kRGB_565_SkColorType,
63 kOpaque_SkAlphaType);
64 }
65 FML_DCHECK(false);
66 }
kOpaque_SkAlphaType
@ kOpaque_SkAlphaType
pixel is opaque
Definition: SkAlphaType.h:28
kRGB_565_SkColorType
@ kRGB_565_SkColorType
pixel with 5 bits red, 6 bits green, 5 bits blue, in 16-bit word
Definition: SkColorType.h:22
FML_DCHECK
#define FML_DCHECK(condition)
Definition: logging.h:103
flutter::h
DEF_SWITCHES_START aot vmservice shared library Name of the *so containing AOT compiled Dart assets for launching the service isolate vm snapshot The VM snapshot data that will be memory mapped as read only SnapshotAssetPath must be present isolate snapshot The isolate snapshot data that will be memory mapped as read only SnapshotAssetPath must be present cache dir Path to the cache directory This is different from the persistent_cache_path in embedder h
Definition: switches.h:59
flutter::format
DEF_SWITCHES_START aot vmservice shared library Name of the *so containing AOT compiled Dart assets for launching the service isolate vm snapshot The VM snapshot data that will be memory mapped as read only SnapshotAssetPath must be present isolate snapshot The isolate snapshot data that will be memory mapped as read only SnapshotAssetPath must be present cache dir Path to the cache directory This is different from the persistent_cache_path in embedder which is used for Skia shader cache icu native lib Path to the library file that exports the ICU data vm service The hostname IP address on which the Dart VM Service should be served If not defaults to or::depending on whether ipv6 is specified vm service A custom Dart VM Service port The default is to pick a randomly available open port disable vm Disable the Dart VM Service The Dart VM Service is never available in release mode disable vm service Disable mDNS Dart VM Service publication Bind to the IPv6 localhost address for the Dart VM Service Ignored if vm service host is set endless trace Enable an endless trace buffer The default is a ring buffer This is useful when very old events need to viewed For during application launch Memory usage will continue to grow indefinitely however Start app with an specific route defined on the framework flutter assets Path to the Flutter assets directory enable service port Allow the VM service to fallback to automatic port selection if binding to a specified port fails trace Trace early application lifecycle Automatically switches to an endless trace buffer trace skia Filters out all Skia trace event categories except those that are specified in this comma separated list dump skp on shader Automatically dump the skp that triggers new shader compilations This is useful for writing custom ShaderWarmUp to reduce jank By this is not enabled to reduce the overhead purge persistent Remove all existing persistent cache This is mainly for debugging purposes such as reproducing the shader compilation jank trace to Write the timeline trace to a file at the specified path The file will be in Perfetto s proto format
Definition: switches.h:203
w
SkScalar w
Definition: pictureshadertile.cpp:30
SkISize::Make
static constexpr SkISize Make(int32_t w, int32_t h)
Definition: SkSize.h:20
SkImageInfo::MakeN32Premul
static SkImageInfo MakeN32Premul(int width, int height)
Definition: SkImageInfo.cpp:157
SkImageInfo::Make
static SkImageInfo Make(int width, int height, SkColorType ct, SkAlphaType at)
Definition: SkImageInfo.cpp:127

◆ MakeOffscreenSurface()

virtual std::shared_ptr< DlSurfaceInstance > flutter::testing::DlSurfaceProvider::MakeOffscreenSurface ( size_t  width,
size_t  height,
PixelFormat  format = kN32PremulPixelFormat 
) const
pure virtual

Implemented in flutter::testing::DlOpenGLSurfaceProvider, flutter::testing::DlMetalSurfaceProvider, and flutter::testing::DlSoftwareSurfaceProvider.

◆ Snapshot()

bool flutter::testing::DlSurfaceProvider::Snapshot ( std::string &  filename) const
virtual

Definition at line 59 of file dl_test_surface_provider.cc.

59 {
60#ifdef BENCHMARKS_NO_SNAPSHOT
61 return false;
62#else
63 auto image = GetPrimarySurface()->sk_surface()->makeImageSnapshot();
64 if (!image) {
65 return false;
66 }
67 auto raster = image->makeRasterImage();
68 if (!raster) {
69 return false;
70 }
71 auto data = SkPngEncoder::Encode(nullptr, raster.get(), {});
72 if (!data) {
73 return false;
74 }
75 fml::NonOwnedMapping mapping(static_cast<const uint8_t*>(data->data()),
76 data->size());
77 return WriteAtomically(OpenFixturesDirectory(), filename.c_str(), mapping);
78#endif
79}
SkImage::makeRasterImage
sk_sp< SkImage > makeRasterImage(GrDirectContext *, CachingHint cachingHint=kDisallow_CachingHint) const
Definition: SkImage.cpp:267
flutter::testing::DlSurfaceProvider::GetPrimarySurface
virtual std::shared_ptr< DlSurfaceInstance > GetPrimarySurface() const =0
SkPngEncoder::Encode
SK_API bool Encode(SkWStream *dst, const SkPixmap &src, const Options &options)
Definition: SkPngEncoder_none.cpp:20
SkRecords::image
sk_sp< const SkImage > image
Definition: SkRecords.h:269
flutter::testing::OpenFixturesDirectory
fml::UniqueFD OpenFixturesDirectory()
Opens the fixtures directory for the unit-test harness.
Definition: testing.cc:23
flutter::data
DEF_SWITCHES_START aot vmservice shared library Name of the *so containing AOT compiled Dart assets for launching the service isolate vm snapshot data
Definition: switches.h:41
fml::WriteAtomically
bool WriteAtomically(const fml::UniqueFD &base_directory, const char *file_name, const Mapping &mapping)
Definition: file_posix.cc:191

◆ supports()

virtual bool flutter::testing::DlSurfaceProvider::supports ( PixelFormat  format) const
pure virtual

Implemented in flutter::testing::DlOpenGLSurfaceProvider, flutter::testing::DlMetalSurfaceProvider, and flutter::testing::DlSoftwareSurfaceProvider.

◆ supports_impeller()

virtual bool flutter::testing::DlSurfaceProvider::supports_impeller ( ) const
inlinevirtual

Reimplemented in flutter::testing::DlMetalSurfaceProvider.

Definition at line 75 of file dl_test_surface_provider.h.

75{ return false; }
The documentation for this class was generated from the following files:
Generated on Sun Jun 23 2024 22:00:09 for Flutter Engine by doxygen 1.9.4