Struct MTLCaptureManager

Source

pub struct MTLCaptureManager { /* private fields */ }

Available on crate feature MTLCaptureManager only.

Expand description

Apple’s documentation

Implementations§

Source §

impl MTLCaptureManager

Source

pub unsafe fn sharedCaptureManager() -> Retained<MTLCaptureManager>

Retrieves the shared capture manager for this process. There is only one capture manager per process. The capture manager allows the user to create capture scopes and trigger captures from code. When a capture has been completed, it will be displayed in Xcode and the application will be paused.

: only MTLCommandBuffers created after starting a capture and committed before stopping it are captured.

Source

pub fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub fn newCaptureScopeWithDevice( &self, device: &ProtocolObject<dyn MTLDevice>, ) -> Retained<ProtocolObject<dyn MTLCaptureScope>>

Available on crate features MTLCaptureScope and MTLDevice only.

Source

pub fn newCaptureScopeWithCommandQueue( &self, command_queue: &ProtocolObject<dyn MTLCommandQueue>, ) -> Retained<ProtocolObject<dyn MTLCaptureScope>>

Available on crate features MTLCaptureScope and MTLCommandQueue only.

Source

pub fn newCaptureScopeWithMTL4CommandQueue( &self, command_queue: &ProtocolObject<dyn MTL4CommandQueue>, ) -> Retained<ProtocolObject<dyn MTLCaptureScope>>

Available on crate features MTL4CommandQueue and MTLCaptureScope only.

Source

pub fn supportsDestination(&self, destination: MTLCaptureDestination) -> bool

Source

pub fn startCaptureWithDescriptor_error( &self, descriptor: &MTLCaptureDescriptor, ) -> Result<(), Retained<NSError>>

Start capturing until stopCapture is called.

Parameter descriptor: MTLCaptureDescriptor specifies the parameters.

Parameter error: Optional error output to check why a capture could not be started.

Returns: true if the capture was successfully started, otherwise false.

Only MTLCommandBuffers created after starting and committed before stopping it are captured.

Source

pub fn startCaptureWithDevice(&self, device: &ProtocolObject<dyn MTLDevice>)

👎Deprecated: Use startCaptureWithDescriptor:error: instead

Available on crate feature MTLDevice only.

Source

pub fn startCaptureWithCommandQueue( &self, command_queue: &ProtocolObject<dyn MTLCommandQueue>, )

👎Deprecated: Use startCaptureWithDescriptor:error: instead

Available on crate feature MTLCommandQueue only.

Source

pub fn startCaptureWithScope( &self, capture_scope: &ProtocolObject<dyn MTLCaptureScope>, )

👎Deprecated: Use startCaptureWithDescriptor:error: instead

Available on crate feature MTLCaptureScope only.

Source

pub fn stopCapture(&self)

Source

pub fn defaultCaptureScope( &self, ) -> Option<Retained<ProtocolObject<dyn MTLCaptureScope>>>

Available on crate feature MTLCaptureScope only.

Source

pub fn setDefaultCaptureScope( &self, default_capture_scope: Option<&ProtocolObject<dyn MTLCaptureScope>>, )

Available on crate feature MTLCaptureScope only.

Setter for defaultCaptureScope.

Source

pub fn isCapturing(&self) -> bool

Source §

impl MTLCaptureManager

Methods declared on superclass NSObject.

Source

pub fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}