Skip to main content

CaptureManager

Struct CaptureManager 

Source
pub struct CaptureManager(/* private fields */);
Expand description

The singleton manager for GPU capture operations.

C++ equivalent: MTL::CaptureManager

Use CaptureManager::shared() to get the singleton instance.

Implementations§

Source§

impl CaptureManager

Source

pub fn shared() -> Option<Self>

Get the shared capture manager singleton.

Returns None if capture is not supported on this system.

C++ equivalent: static CaptureManager* sharedCaptureManager()

Source

pub unsafe fn from_raw(ptr: *mut c_void) -> Option<Self>

Create from a raw pointer.

§Safety

The pointer must be a valid Metal capture manager.

Source

pub fn as_raw(&self) -> *mut c_void

Get the raw pointer.

Source

pub fn is_capturing(&self) -> bool

Check if a capture is currently in progress.

C++ equivalent: bool isCapturing() const

Source

pub fn default_capture_scope(&self) -> Option<CaptureScope>

Get the default capture scope.

C++ equivalent: CaptureScope* defaultCaptureScope() const

Source

pub fn set_default_capture_scope(&self, scope: &CaptureScope)

Set the default capture scope.

C++ equivalent: void setDefaultCaptureScope(const CaptureScope*)

Source

pub fn new_capture_scope_with_device( &self, device: &Device, ) -> Option<CaptureScope>

Create a new capture scope for a device.

C++ equivalent: CaptureScope* newCaptureScope(const Device*)

Source

pub fn new_capture_scope_with_command_queue( &self, queue: &CommandQueue, ) -> Option<CaptureScope>

Create a new capture scope for a command queue.

C++ equivalent: CaptureScope* newCaptureScope(const CommandQueue*)

Source

pub fn supports_destination(&self, destination: CaptureDestination) -> bool

Check if a capture destination is supported.

C++ equivalent: bool supportsDestination(CaptureDestination)

Source

pub fn start_capture( &self, descriptor: &CaptureDescriptor, ) -> Result<(), CaptureError>

Start a capture with a descriptor.

Returns Ok(()) on success or Err(CaptureError) on failure.

C++ equivalent: bool startCapture(const CaptureDescriptor*, NS::Error**)

Source

pub fn start_capture_with_device(&self, device: &Device)

Start a capture for a device (simplified API).

C++ equivalent: void startCapture(const Device*)

Source

pub fn start_capture_with_command_queue(&self, queue: &CommandQueue)

Start a capture for a command queue (simplified API).

C++ equivalent: void startCapture(const CommandQueue*)

Source

pub fn start_capture_with_scope(&self, scope: &CaptureScope)

Start a capture for a capture scope (simplified API).

C++ equivalent: void startCapture(const CaptureScope*)

Source

pub fn stop_capture(&self)

Stop the current capture.

C++ equivalent: void stopCapture()

Trait Implementations§

Source§

impl Clone for CaptureManager

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CaptureManager

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Drop for CaptureManager

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Referencing for CaptureManager

Source§

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.
Source§

fn as_mut_ptr(&self) -> *mut c_void

Get the raw mutable pointer to the Objective-C object.
Source§

fn retain(&self) -> Self
where Self: Clone,

Retain the object, incrementing its reference count. Read more
Source§

fn release(&self)

Release the object, decrementing its reference count. Read more
Source§

fn autorelease(&self) -> Self
where Self: Clone,

Autorelease the object. Read more
Source§

fn retain_count(&self) -> usize

Get the retain count of the object. Read more
Source§

impl Send for CaptureManager

Source§

impl Sync for CaptureManager

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.