Struct CaptureDescriptor 

pub struct CaptureDescriptor(/* private fields */);

Descriptor for configuring a GPU capture session.

C++ equivalent: MTL::CaptureDescriptor

Implementations

impl CaptureDescriptor

pub fn alloc() -> Option<Self>

Allocate a new capture descriptor.

C++ equivalent: static CaptureDescriptor* alloc()

pub fn init(&self) -> Option<Self>

Initialize an allocated capture descriptor.

C++ equivalent: CaptureDescriptor* init()

pub fn new() -> Option<Self>

Create a new capture descriptor.

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 descriptor.

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

Get the raw pointer.

pub fn capture_object(&self) -> Option<*mut c_void>

Get the object to capture.

C++ equivalent: NS::Object* captureObject() const

pub fn set_capture_object(&self, object: *const c_void)

Set the object to capture (Device, CommandQueue, or CaptureScope).

C++ equivalent: void setCaptureObject(NS::Object*)

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

Set a device as the capture target.

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

Set a command queue as the capture target.

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

Set a capture scope as the capture target.

pub fn destination(&self) -> CaptureDestination

Get the capture destination.

C++ equivalent: CaptureDestination destination() const

pub fn set_destination(&self, destination: CaptureDestination)

Set the capture destination.

C++ equivalent: void setDestination(CaptureDestination)

pub fn output_url(&self) -> Option<Url>

Get the output URL for trace document captures.

C++ equivalent: NS::URL* outputURL() const

pub fn set_output_url(&self, url: &Url)

Set the output URL for trace document captures.

C++ equivalent: void setOutputURL(const NS::URL*)

Trait Implementations

impl Clone for CaptureDescriptor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CaptureDescriptor

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

Formats the value using the given formatter.

impl Default for CaptureDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Drop for CaptureDescriptor

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for CaptureDescriptor

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.

fn as_mut_ptr(&self) -> *mut c_void

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

fn retain(&self) -> Self

where Self: Clone,

Retain the object, incrementing its reference count.

fn release(&self)

Release the object, decrementing its reference count.

fn autorelease(&self) -> Self

where Self: Clone,

Autorelease the object.

fn retain_count(&self) -> usize

Get the retain count of the object.

impl Send for CaptureDescriptor

impl Sync for CaptureDescriptor