flutter::testing::DlSurfaceProvider Class Reference

#include <dl_test_surface_provider.h>

Inheritance diagram for flutter::testing::DlSurfaceProvider:

Public Types
enum	PixelFormat {   kN32Premul ,   k565 }
enum class	BackendType {   kSkiaSoftware ,   kSkiaOpenGL ,   kSkiaMetal ,   kImpellerMetal ,   kImpellerMetalSDF }

Public Member Functions
virtual	~DlSurfaceProvider ()=default
virtual const std::string	GetBackendName () const =0
virtual BackendType	GetBackendType () const =0
virtual bool	SupportsPixelFormat (PixelFormat format) const =0
virtual bool	TargetsImpeller () const =0
virtual bool	InitializeSurface (size_t width, size_t height, PixelFormat format=kN32Premul)=0
virtual std::shared_ptr< DlSurfaceInstance >	GetPrimarySurface () const =0
virtual std::unique_ptr< DlSurfaceInstance >	MakeOffscreenSurface (size_t width, size_t height, PixelFormat format=kN32Premul) const =0

Static Public Member Functions
static SkImageInfo	MakeInfo (PixelFormat format, int w, int h)
static std::optional< BackendType >	NameToBackend (const std::string &name)
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 90 of file dl_test_surface_provider.h.

Member Enumeration Documentation

BackendType

enum class flutter::testing::DlSurfaceProvider::BackendType

strong

Enumerator
kSkiaSoftware
kSkiaOpenGL
kSkiaMetal
kImpellerMetal
kImpellerMetalSDF

Definition at line 97 of file dl_test_surface_provider.h.

                         {
    kSkiaSoftware,
    kSkiaOpenGL,
    kSkiaMetal,
    kImpellerMetal,
    kImpellerMetalSDF,
  };

PixelFormat

enum flutter::testing::DlSurfaceProvider::PixelFormat

Enumerator
kN32Premul
k565

Definition at line 92 of file dl_test_surface_provider.h.

                   {
    kN32Premul,
    k565,
  };

Constructor & Destructor Documentation

~DlSurfaceProvider()

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

virtualdefault

DlSurfaceProvider()

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

protecteddefault

Member Function Documentation

BackendName()

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

static

Definition at line 30 of file dl_test_surface_provider.cc.

                                                         {
  switch (type) {
    case BackendType::kSkiaSoftware:
      return "SkiaSoftware";
    case BackendType::kSkiaOpenGL:
      return "SkiaOpenGL";
    case BackendType::kSkiaMetal:
      return "SkiaMetal";
    case BackendType::kImpellerMetal:
      return "ImpellerMetal";
    case BackendType::kImpellerMetalSDF:
      return "ImpellerMetalSDF";
  }
}

References type.

Referenced by flutter::testing::DisplayListRendering::GetProvider(), and flutter::testing::DisplayListRendering::SetUpTestSuite().

Create()

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

static

Definition at line 45 of file dl_test_surface_provider.cc.

                              {
  switch (backend_type) {
    case BackendType::kSkiaSoftware:
      return CreateSkiaSoftware();
    case BackendType::kSkiaOpenGL:
      return CreateSkiaOpenGL();
    case BackendType::kSkiaMetal:
      return CreateSkiaMetal();
    case BackendType::kImpellerMetal:
      return CreateImpellerMetal();
    case BackendType::kImpellerMetalSDF:
      return CreateImpellerMetalSDF();
  }
}

Referenced by flutter::testing::BM_DrawArc(), flutter::testing::BM_DrawCircle(), flutter::testing::BM_DrawDRRect(), flutter::testing::BM_DrawImage(), flutter::testing::BM_DrawImageNine(), flutter::testing::BM_DrawImageRect(), flutter::testing::BM_DrawLine(), flutter::testing::BM_DrawOval(), flutter::testing::BM_DrawPath(), flutter::testing::BM_DrawPoints(), flutter::testing::BM_DrawRect(), flutter::testing::BM_DrawRRect(), flutter::testing::BM_DrawRSE(), flutter::testing::BM_DrawShadow(), flutter::testing::BM_DrawTextBlob(), flutter::testing::BM_DrawVertices(), flutter::testing::BM_EmptyDisplayList(), flutter::testing::BM_SaveLayer(), flutter::testing::BM_SingleOpDisplayList(), flutter::testing::BM_SyncOverhead(), and flutter::testing::DisplayListRendering::GetProvider().

GetBackendName()

virtual const std::string flutter::testing::DlSurfaceProvider::GetBackendName ( ) const

pure virtual

Implemented in flutter::testing::DlOpenGLSurfaceProvider, flutter::testing::DlSurfaceProviderImpellerMetal, flutter::testing::DlSurfaceProviderImpellerMetalSDF, flutter::testing::DlSurfaceProviderSkiaMetal, and flutter::testing::DlSoftwareSurfaceProvider.

Referenced by flutter::testing::RenderEnvironment::GetBackendName().

GetBackendType()

virtual BackendType flutter::testing::DlSurfaceProvider::GetBackendType ( ) const

pure virtual

Implemented in flutter::testing::DlOpenGLSurfaceProvider, flutter::testing::DlSurfaceProviderImpellerMetal, flutter::testing::DlSurfaceProviderImpellerMetalSDF, flutter::testing::DlSurfaceProviderSkiaMetal, and flutter::testing::DlSoftwareSurfaceProvider.

Referenced by flutter::testing::DisplayListNopTest::GetTestData(), flutter::testing::CanvasCompareTester::groupOpacityFudgeFactor(), and flutter::testing::CanvasCompareTester::RenderWithStrokes().

GetPrimarySurface()

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

pure virtual

Implemented in flutter::testing::DlOpenGLSurfaceProvider, flutter::testing::DlSurfaceProviderImpeller, flutter::testing::DlSurfaceProviderSkiaMetal, and flutter::testing::DlSoftwareSurfaceProvider.

InitializeSurface()

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

pure virtual

Implemented in flutter::testing::DlOpenGLSurfaceProvider, flutter::testing::DlSurfaceProviderImpeller, flutter::testing::DlSurfaceProviderSkiaMetal, and flutter::testing::DlSoftwareSurfaceProvider.

MakeInfo()

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

inlinestatic

Definition at line 105 of file dl_test_surface_provider.h.

                                                                {
    switch (format) {
      case kN32Premul:
        return SkImageInfo::MakeN32Premul(w, h);
      case k565:
        return SkImageInfo::Make(SkISize::Make(w, h), kRGB_565_SkColorType,
                                 kOpaque_SkAlphaType);
    }
    FML_DCHECK(false);
  }

References FML_DCHECK, format, flutter::h, k565, and kN32Premul.

Referenced by flutter::testing::DlOpenGLSurfaceProvider::MakeOffscreenSurface(), and flutter::testing::DlSoftwareSurfaceProvider::MakeOffscreenSurface().

MakeOffscreenSurface()

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

pure virtual

Implemented in flutter::testing::DlOpenGLSurfaceProvider, flutter::testing::DlSurfaceProviderImpeller, flutter::testing::DlSurfaceProviderSkiaMetal, and flutter::testing::DlSoftwareSurfaceProvider.

Referenced by flutter::testing::DisplayListNopTest::get_output().

NameToBackend()

std::optional< DlSurfaceProvider::BackendType > flutter::testing::DlSurfaceProvider::NameToBackend ( const std::string &  name )

static

Definition at line 9 of file dl_test_surface_provider.cc.

                           {
#define FLT_SURFACE_PROVIDER_HANDLE_BACKEND(name, BACKEND)         \
  {                                                                \
    BackendType type = BackendType::k##BACKEND;                    \
    if (name.compare(DlSurfaceProvider::BackendName(type)) == 0) { \
      return type;                                                 \
    }                                                              \
  }
 
  FLT_SURFACE_PROVIDER_HANDLE_BACKEND(name, SkiaSoftware);
  FLT_SURFACE_PROVIDER_HANDLE_BACKEND(name, SkiaOpenGL);
  FLT_SURFACE_PROVIDER_HANDLE_BACKEND(name, SkiaMetal);
  FLT_SURFACE_PROVIDER_HANDLE_BACKEND(name, ImpellerMetal);
  FLT_SURFACE_PROVIDER_HANDLE_BACKEND(name, ImpellerMetalSDF);
 
#undef FLT_SURFACE_PROVIDER_HANDLE_BACKEND
 
  return std::nullopt;
}

References FLT_SURFACE_PROVIDER_HANDLE_BACKEND, and flutter::name.

SupportsPixelFormat()

virtual bool flutter::testing::DlSurfaceProvider::SupportsPixelFormat ( PixelFormat  format ) const

pure virtual

Implemented in flutter::testing::DlOpenGLSurfaceProvider, flutter::testing::DlSurfaceProviderImpeller, flutter::testing::DlSurfaceProviderSkiaMetal, and flutter::testing::DlSoftwareSurfaceProvider.

Referenced by flutter::testing::RenderEnvironment::IsValid().

TargetsImpeller()

virtual bool flutter::testing::DlSurfaceProvider::TargetsImpeller ( ) const

pure virtual

Implemented in flutter::testing::DlSurfaceProviderImpeller, flutter::testing::DlSurfaceProviderSkiaMetal, and flutter::testing::DlSoftwareSurfaceProvider.

Referenced by flutter::testing::TestParameters::should_match().

---

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

• display_list/testing/dl_test_surface_provider.h
• display_list/testing/dl_test_surface_provider.cc
• display_list/testing/impeller/dl_test_surface_provider_impeller_metal.cc
• display_list/testing/skia/dl_test_surface_provider_skia_metal.mm
• display_list/testing/skia/dl_test_surface_provider_skia_software.cc