impeller::ImpellerMetalCaptureManager Class Reference

Creates and manages a Metal capture scope that supports frame capture when using the FlutterMetalLayer backed drawable. More...

#include <context_mtl.h>

Public Member Functions
	ImpellerMetalCaptureManager (id< MTLDevice > device)
	Construct a new capture manager from the provided Metal device. More...
	~ImpellerMetalCaptureManager ()=default
bool	CaptureScopeActive () const
void	StartCapture ()
	Begin a new capture scope, no-op if the scope has already started. More...
void	FinishCapture ()
	End the current capture scope. More...

Detailed Description

Creates and manages a Metal capture scope that supports frame capture when using the FlutterMetalLayer backed drawable.

Definition at line 37 of file context_mtl.h.

Constructor & Destructor Documentation

ImpellerMetalCaptureManager()

impeller::ImpellerMetalCaptureManager::ImpellerMetalCaptureManager ( id< MTLDevice >  device )

explicit

Construct a new capture manager from the provided Metal device.

Definition at line 520 of file context_mtl.mm.

                                                                             {
  current_capture_scope_ = [[MTLCaptureManager sharedCaptureManager]
      newCaptureScopeWithDevice:device];
  [current_capture_scope_ setLabel:@"Impeller Frame"];
  [[MTLCaptureManager sharedCaptureManager]
      setDefaultCaptureScope:current_capture_scope_];
}

~ImpellerMetalCaptureManager()

impeller::ImpellerMetalCaptureManager::~ImpellerMetalCaptureManager ( )

default

Member Function Documentation

CaptureScopeActive()

bool impeller::ImpellerMetalCaptureManager::CaptureScopeActive

(

)

const

Whether or not the Impeller capture scope is active.

This is distinct from whether or not there is a session recording the capture. That can be checked with [[MTLCaptureManager sharedCaptureManager] isCapturing].

Definition at line 528 of file context_mtl.mm.

                                                           {
  return scope_active_;
}

FinishCapture()

void impeller::ImpellerMetalCaptureManager::FinishCapture

(

)

End the current capture scope.

Definition at line 540 of file context_mtl.mm.

                                                {
  FML_DCHECK(scope_active_);
  [current_capture_scope_ endScope];
  scope_active_ = false;
}

StartCapture()

void impeller::ImpellerMetalCaptureManager::StartCapture

(

)

Begin a new capture scope, no-op if the scope has already started.

Definition at line 532 of file context_mtl.mm.

                                               {
  if (scope_active_) {
    return;
  }
  scope_active_ = true;
  [current_capture_scope_ beginScope];
}

---

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

• impeller/renderer/backend/metal/context_mtl.h
• impeller/renderer/backend/metal/context_mtl.mm