Flutter Impeller
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 470 of file context_mtl.mm.

470  {
471  current_capture_scope_ = [[MTLCaptureManager sharedCaptureManager]
472  newCaptureScopeWithDevice:device];
473  [current_capture_scope_ setLabel:@"Impeller Frame"];
474 }

◆ ~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 476 of file context_mtl.mm.

476  {
477  return scope_active_;
478 }

◆ FinishCapture()

void impeller::ImpellerMetalCaptureManager::FinishCapture ( )

End the current capture scope.

Definition at line 488 of file context_mtl.mm.

488  {
489  FML_DCHECK(scope_active_);
490  [current_capture_scope_ endScope];
491  scope_active_ = false;
492 }

◆ StartCapture()

void impeller::ImpellerMetalCaptureManager::StartCapture ( )

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

Definition at line 480 of file context_mtl.mm.

480  {
481  if (scope_active_) {
482  return;
483  }
484  scope_active_ = true;
485  [current_capture_scope_ beginScope];
486 }

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