flutter::gpu::Context Class Reference

#include <context.h>

Inheritance diagram for flutter::gpu::Context:

Public Member Functions
	Context (std::shared_ptr< impeller::Context > context)
	~Context () override
impeller::Context &	GetContext ()
std::shared_ptr< impeller::Context > &	GetContextShared ()
Public Member Functions inherited from flutter::RefCountedDartWrappable< Context >
virtual void	RetainDartWrappableReference () const override
virtual void	ReleaseDartWrappableReference () const override
Public Member Functions inherited from fml::RefCountedThreadSafe< T >
void	Release () const
Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void	AddRef () const
bool	HasOneRef () const
void	AssertHasOneRef () const
Public Member Functions inherited from tonic::DartWrappable
	DartWrappable ()
virtual const DartWrapperInfo &	GetDartWrapperInfo () const =0
Dart_Handle	CreateDartWrapper (DartState *dart_state)
void	AssociateWithDartWrapper (Dart_Handle wrappable)
void	ClearDartWrapper ()
Dart_WeakPersistentHandle	dart_wrapper () const

Static Public Member Functions
static void	SetOverrideContext (std::shared_ptr< impeller::Context > context)
static std::shared_ptr< impeller::Context >	GetOverrideContext ()
static std::shared_ptr< impeller::Context >	GetDefaultContext (std::optional< std::string > &out_error)

Additional Inherited Members
Public Types inherited from tonic::DartWrappable
enum	DartNativeFields {   kPeerIndex ,   kNumberOfNativeFields }
Protected Member Functions inherited from fml::RefCountedThreadSafe< T >
	RefCountedThreadSafe ()
	~RefCountedThreadSafe ()
Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
	RefCountedThreadSafeBase ()
	~RefCountedThreadSafeBase ()
bool	Release () const
void	Adopt ()
Protected Member Functions inherited from tonic::DartWrappable
virtual	~DartWrappable ()
Static Protected Member Functions inherited from tonic::DartWrappable
static Dart_PersistentHandle	GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)

Detailed Description

Definition at line 18 of file context.h.

Constructor & Destructor Documentation

Context()

flutter::gpu::Context::Context ( std::shared_ptr< impeller::Context >  context )

explicit

Definition at line 82 of file context.cc.

    : context_(std::move(context)) {}

~Context()

flutter::gpu::Context::~Context ( )

overridedefault

Member Function Documentation

GetContext()

impeller::Context & flutter::gpu::Context::GetContext

(

)

Definition at line 87 of file context.cc.

                                     {
  return *context_;
}

Referenced by InternalFlutterGpu_CommandBuffer_Initialize(), InternalFlutterGpu_Context_GetDefaultColorFormat(), InternalFlutterGpu_Context_GetDefaultDepthStencilFormat(), InternalFlutterGpu_Context_GetDefaultStencilFormat(), InternalFlutterGpu_Context_GetMinimumUniformByteAlignment(), InternalFlutterGpu_Context_GetSupportsFramebufferRenderMipmap(), InternalFlutterGpu_Context_GetSupportsManuallyMippedTextures(), InternalFlutterGpu_Context_GetSupportsOffscreenMSAA(), InternalFlutterGpu_Context_SupportsTextureCompression(), InternalFlutterGpu_Context_SupportsTextureFormat(), InternalFlutterGpu_DeviceBuffer_Initialize(), InternalFlutterGpu_DeviceBuffer_InitializeWithHostData(), InternalFlutterGpu_Texture_Initialize(), and flutter::gpu::Texture::Overwrite().

GetContextShared()

std::shared_ptr< impeller::Context > & flutter::gpu::Context::GetContextShared

(

)

Definition at line 91 of file context.cc.

                                                          {
  return context_;
}

Referenced by InternalFlutterGpu_CommandBuffer_Initialize(), and flutter::gpu::Texture::Overwrite().

GetDefaultContext()

std::shared_ptr< impeller::Context > flutter::gpu::Context::GetDefaultContext ( std::optional< std::string > &  out_error )

static

Definition at line 39 of file context.cc.

                                       {
  auto override_context = GetOverrideContext();
  if (override_context) {
    return override_context;
  }
 
  auto dart_state = flutter::UIDartState::Current();
  if (!dart_state->IsImpellerEnabled()) {
    out_error =
        "Flutter GPU requires the Impeller rendering backend, but Impeller is "
        "not enabled. For more details about where Impeller is available and "
        "how to enable it, see: https://docs.flutter.dev/perf/impeller";
    return nullptr;
  }
  if (!dart_state->IsFlutterGPUEnabled()) {
    out_error =
        "Flutter GPU must be enabled via the Flutter GPU manifest "
        "setting. This can be done either via command line argument "
        "--enable-flutter-gpu or "
        "by adding the FLTEnableFlutterGPU key set to true in the Info.plist "
        "on iOS/macOS, or the io.flutter.embedding.android.EnableFlutterGPU "
        "metadata key to true in the AndroidManifest.xml on Android.";
    return nullptr;
  }
  // Grab the Impeller context from the IO manager.
  std::promise<std::shared_ptr<impeller::Context>> context_promise;
  auto impeller_context_future = context_promise.get_future();
  fml::TaskRunner::RunNowOrPostTask(
      dart_state->GetTaskRunners().GetIOTaskRunner(),
      fml::MakeCopyable([promise = std::move(context_promise),
                         io_manager = dart_state->GetIOManager()]() mutable {
        promise.set_value(io_manager ? io_manager->GetImpellerContext()
                                     : nullptr);
      }));
  auto context = impeller_context_future.get();
 
  if (!context) {
    out_error = "Unable to retrieve the Impeller context.";
  }
  return context;
}

References context, flutter::UIDartState::Current(), GetOverrideContext(), fml::MakeCopyable(), and fml::TaskRunner::RunNowOrPostTask().

Referenced by InternalFlutterGpu_Context_InitializeDefault(), InternalFlutterGpu_ShaderLibrary_InitializeWithAsset(), and InternalFlutterGpu_ShaderLibrary_ReinitializeWithAsset().

GetOverrideContext()

std::shared_ptr< impeller::Context > flutter::gpu::Context::GetOverrideContext ( )

static

Definition at line 35 of file context.cc.

                                                           {
  return default_context_;
}

Referenced by GetDefaultContext().

SetOverrideContext()

void flutter::gpu::Context::SetOverrideContext ( std::shared_ptr< impeller::Context >  context )

static

Definition at line 31 of file context.cc.

                                                                       {
  default_context_ = std::move(context);
}

References context.

Referenced by impeller::testing::RendererDartTest::GetIsolate().

---

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

• lib/gpu/context.h
• lib/gpu/context.cc