Instance Property


The object whose contents should be captured.


var captureObject: Any? { get set }


The default value is nil, but you must set an object before using this descriptor to start a capture session.

The behavior of the capture session depends on the kind of object being captured:

  • Specify a MTLDevice object to capture commands in command buffers created on any command queues created by the device object.

  • Specify a MTLCommandQueue object to capture commands in command buffers created by a specific command queue.

  • Specify a MTLCaptureScope object to indirectly define which commands are captured.

See Also

Setting Capture Parameters

var destination: MTLCaptureDestination

The destination for any captured command data.

var outputURL: URL?

A URL for a file to write the capture data into.


Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software