Metal

https://docs.rs/metal/latest
Admin
A Rust binding for Apple's Metal framework, providing low-level, high-performance access to 3D...
Tokens:913,150
Snippets:9,512
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install name methods

Source: https://docs.rs/metal/latest/metal/struct.CompileOptions.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods to get and set the install name. Available on macOS 11.0+ and iOS 14.0+.

```rust
pub fn install_name(&self) -> &str
```

```rust
pub fn set_install_name(&self, name: &str)
```

--------------------------------

### Start Capture with Device

Source: https://docs.rs/metal/latest/metal/struct.CaptureManager.html

Starts a Metal capture session specifically for the given device. This is a convenience method for starting capture on a particular device.

```rust
pub fn start_capture_with_device(&self, device: &DeviceRef)
```

--------------------------------

### begin_scope

Source: https://docs.rs/metal/latest/metal/struct.CaptureScopeRef.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Starts the capture scope.

```APIDOC
### pub fn begin_scope(&self)

Starts the capture scope.
```

--------------------------------

### CompileOptions::install_name

Source: https://docs.rs/metal/latest/metal/struct.CompileOptions.html

Gets the install name for a dynamic library.

```APIDOC
## CompileOptions::install_name

### Description
Gets the install name for a dynamic library.

### Method
`pub fn install_name(&self) -> &str`

### Availability
Only available on (macos(11.0), ios(14.0))
```

--------------------------------

### Get Start of Encoder Sample Index

Source: https://docs.rs/metal/latest/metal/struct.AccelerationStructurePassSampleBufferAttachmentDescriptorRef.html

Retrieves the start index for the encoder sample.

```rust
pub fn start_of_encoder_sample_index(&self) -> NSUInteger
```

--------------------------------

### Start Capture with Command Queue

Source: https://docs.rs/metal/latest/metal/struct.CaptureManager.html

Starts a Metal capture session for commands issued through the specified command queue. This allows targeted capture of command queue activity.

```rust
pub fn start_capture_with_command_queue(&self, command_queue: &CommandQueueRef)
```

--------------------------------

### CaptureManager start_capture_with_device method

Source: https://docs.rs/metal/latest/metal/struct.CaptureManager.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Starts a capture session with the specified device.

```rust
pub fn start_capture_with_device(&self, device: &DeviceRef)
```

--------------------------------

### Library Type and Install Name

Source: https://docs.rs/metal/latest/src/metal/library.rs.html?search=u32+-%3E+bool

Accessors for library type and install name.

```rust
pub fn library_type(&self) -> MTLLibraryType {
        unsafe { msg_send![self, type] }
    }

    /// Only available on (macos(11.0), ios(14.0))
    pub fn install_name(&self) -> Option<&str> {
        unsafe {
            let maybe_name: *mut Object = msg_send![self, installName];
```

--------------------------------

### start_capture

Source: https://docs.rs/metal/latest/metal/struct.CaptureManagerRef.html?search=u32+-%3E+bool

Starts a capture session using the provided capture descriptor.

```APIDOC
## pub fn start_capture(&self, descriptor: &CaptureDescriptorRef) -> Result<(), String>

### Description
Starts capturing with the capture session defined by a descriptor object. This function will panic if Metal capture is not enabled.

### Parameters
- **descriptor** (&CaptureDescriptorRef) - Required - The capture descriptor defining the session configuration.
```

--------------------------------

### Start Capture with Scope

Source: https://docs.rs/metal/latest/metal/struct.CaptureManager.html

Starts a Metal capture session using a predefined capture scope. This method is useful when a capture scope has already been configured.

```rust
pub fn start_capture_with_scope(&self, scope: &CaptureScopeRef)
```

--------------------------------

### install_name()

Source: https://docs.rs/metal/latest/metal/struct.DynamicLibraryRef.html?search=

Retrieves the install name of the dynamic library.

```APIDOC
## pub fn install_name(&self) -> &str

### Description
Returns the install name string of the dynamic library.

### Signature
`pub fn install_name(&self) -> &str`
```

--------------------------------

### Set Start of Encoder Sample Index

Source: https://docs.rs/metal/latest/metal/struct.AccelerationStructurePassSampleBufferAttachmentDescriptorRef.html

Sets the start index for the encoder sample.

```rust
pub fn set_start_of_encoder_sample_index( &self, start_of_encoder_sample_index: NSUInteger, )
```

--------------------------------

### Start Capture with Descriptor

Source: https://docs.rs/metal/latest/metal/struct.CaptureManager.html

Starts a Metal capture session using a provided capture descriptor. This function will panic if Metal capture is not enabled. Capture can be enabled via Xcode, the METAL_CAPTURE_ENABLED=1 environment variable, or an Info.plist entry.

```rust
pub fn start_capture( &self, descriptor: &CaptureDescriptorRef, ) -> Result<(), String>
```

--------------------------------

### CaptureManagerRef::start_capture_with_device

Source: https://docs.rs/metal/latest/metal/struct.CaptureManagerRef.html

Starts capturing using a specific Metal device.

```APIDOC
## CaptureManagerRef::start_capture_with_device

### Description
Starts capturing using a specific Metal device.

### Method
(Implicitly called via CaptureManagerRef)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **device** (*&DeviceRef*) - The Metal device to use for capture.
```

--------------------------------

### start_of_encoder_sample_index

Source: https://docs.rs/metal/latest/metal/struct.AccelerationStructurePassSampleBufferAttachmentDescriptorRef.html?search=std%3A%3Avec

Retrieves the starting sample index for the encoder.

```APIDOC
### pub fn start_of_encoder_sample_index(&self) -> NSUInteger

Returns the starting sample index for the encoder.
```

--------------------------------

### Create Command Queues

Source: https://docs.rs/metal/latest/src/metal/device.rs.html?search=

Methods for initializing command queues on the device.

```rust
pub fn new_fence(&self) -> Fence {
        unsafe { msg_send![self, newFence] }
    }

    pub fn new_command_queue(&self) -> CommandQueue {
        unsafe { msg_send![self, newCommandQueue] }
    }

    pub fn new_command_queue_with_max_command_buffer_count(
        &self,
        count: NSUInteger,
    ) -> CommandQueue {
        unsafe { msg_send![self, newCommandQueueWithMaxCommandBufferCount: count] }
    }
```

--------------------------------

### Create Metal command queues and libraries

Source: https://docs.rs/metal/latest/src/metal/device.rs.html?search=std%3A%3Avec

Methods for initializing command queues and loading shader libraries from various sources.

```rust
pub fn new_fence(&self) -> Fence {
        unsafe { msg_send![self, newFence] }
    }

    pub fn new_command_queue(&self) -> CommandQueue {
        unsafe { msg_send![self, newCommandQueue] }
    }

    pub fn new_command_queue_with_max_command_buffer_count(
        &self,
        count: NSUInteger,
    ) -> CommandQueue {
        unsafe { msg_send![self, newCommandQueueWithMaxCommandBufferCount: count] }
    }

    pub fn new_default_library(&self) -> Library {
        unsafe { msg_send![self, newDefaultLibrary] }
    }

    pub fn new_library_with_source(
        &self,
        src: &str,
        options: &CompileOptionsRef,
    ) -> Result<Library, String> {
        let source = nsstring_from_str(src);
        unsafe {
            let mut err: *mut Object = ptr::null_mut();
            let library: *mut MTLLibrary = msg_send![self, newLibraryWithSource:source
                                                                        options:options
                                                                          error:&mut err];
            if !err.is_null() {
                let desc: *mut Object = msg_send![err, localizedDescription];
                let compile_error: *const c_char = msg_send![desc, UTF8String];
                let message = CStr::from_ptr(compile_error).to_string_lossy().into_owned();
                if library.is_null() {
                    return Err(message);
                } else {
                    warn!("Shader warnings: {}", message);
                }
            }

            assert!(!library.is_null());
            Ok(Library::from_ptr(library))
        }
    }

    pub fn new_library_with_file<P: AsRef<Path>>(&self, file: P) -> Result<Library, String> {
        let filename = nsstring_from_str(file.as_ref().to_string_lossy().as_ref());
        unsafe {
            let library: *mut MTLLibrary = try_objc! { err =>
                msg_send![self, newLibraryWithFile:filename.as_ref()
                                             error:&mut err]
            };
            Ok(Library::from_ptr(library))
        }
    }

    pub fn new_library_with_data(&self, library_data: &[u8]) -> Result<Library, String> {
        unsafe {
            // SAFETY:
            // `library_data` does not necessarily outlive the dispatch data
            // in which it will be contained (since the dispatch data will be
            // contained in the MTLLibrary returned by this function).
            //
            // To prevent the MTLLibrary from referencing the data outside of
```

--------------------------------

### Get Install Name

Source: https://docs.rs/metal/latest/metal/struct.CompileOptionsRef.html

Retrieves the install name for dynamic libraries. Available on macOS 11.0+ and iOS 14.0+.

```rust
pub fn install_name(&self) -> &str
```

--------------------------------

### CaptureManager start_capture_with_scope method

Source: https://docs.rs/metal/latest/metal/struct.CaptureManager.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Starts a capture session with the specified scope.

```rust
pub fn start_capture_with_scope(&self, scope: &CaptureScopeRef)
```

--------------------------------

### CompileOptions::set_install_name

Source: https://docs.rs/metal/latest/metal/struct.CompileOptions.html

Sets the install name for a dynamic library.

```APIDOC
## CompileOptions::set_install_name

### Description
Sets the install name for a dynamic library.

### Method
`pub fn set_install_name(&self, name: &str)`

### Availability
Only available on (macos(11.0), ios(14.0))
```

--------------------------------

### Get Start of Fragment Sample Index

Source: https://docs.rs/metal/latest/src/metal/renderpass.rs.html

Retrieves the start of fragment sample index for a render pass. This is part of the MTLRenderPassAttachmentDescriptor.

```rust
pub fn start_of_fragment_sample_index(&self) -> NSUInteger {
        unsafe { msg_send![self, startOfFragmentSampleIndex] }
    }
```

--------------------------------

### CaptureManager start_capture_with_command_queue method

Source: https://docs.rs/metal/latest/metal/struct.CaptureManager.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Starts a capture session with the specified command queue.

```rust
pub fn start_capture_with_command_queue(&self, command_queue: &CommandQueueRef)
```

--------------------------------

### Get Dynamic Library Install Name

Source: https://docs.rs/metal/latest/src/metal/library.rs.html

Retrieves the install name of a Metal dynamic library. This is the name used for linking.

```rust
pub fn install_name(&self) -> &str {
        unsafe {
            let name = msg_send![self, installName];
            crate::nsstring_as_str(name)
        }
    }
```

--------------------------------

### CaptureManager::start_capture_with_command_queue

Source: https://docs.rs/metal/latest/metal/struct.CaptureManager.html

Starts capturing using a specific Metal command queue.

```APIDOC
## CaptureManager::start_capture_with_command_queue

### Description
Starts capturing using a specific Metal command queue.

### Parameters
#### Path Parameters
- **command_queue** (*&CommandQueueRef*) - Required - The Metal command queue to use for capturing.

```

--------------------------------

### RenderPassSampleBufferAttachmentDescriptor::start_of_fragment_sample_index()

Source: https://docs.rs/metal/latest/metal/struct.RenderPassSampleBufferAttachmentDescriptor.html

Gets the starting index for fragment samples.

```rust
pub fn start_of_fragment_sample_index(&self) -> NSUInteger
```

--------------------------------

### RenderPassSampleBufferAttachmentDescriptor::start_of_vertex_sample_index()

Source: https://docs.rs/metal/latest/metal/struct.RenderPassSampleBufferAttachmentDescriptor.html

Gets the starting index for vertex samples.

```rust
pub fn start_of_vertex_sample_index(&self) -> NSUInteger
```

--------------------------------

### NSURL Wrapper Implementation

Source: https://docs.rs/metal/latest/src/metal/lib.rs.html?search=u32+-%3E+bool

Implementation of URL creation and string conversion for NSURL.

```rust
impl URL {
    pub fn new_with_string(string: &str) -> Self {
        unsafe {
            let ns_str = crate::nsstring_from_str(string);
            let class = class!(NSURL);
            msg_send![class, URLWithString: ns_str]
        }
    }
}

impl URLRef {
    pub fn absolute_string(&self) -> &str {
        unsafe {
            let absolute_string = msg_send![self, absoluteString];
            crate::nsstring_as_str(absolute_string)
        }
    }
```

--------------------------------

### CaptureManager::start_capture_with_scope

Source: https://docs.rs/metal/latest/metal/struct.CaptureManager.html

Starts capturing using a specified capture scope.

```APIDOC
## CaptureManager::start_capture_with_scope

### Description
Starts capturing using a specified capture scope.

### Parameters
#### Path Parameters
- **scope** (*&CaptureScopeRef*) - Required - The capture scope to use for capturing.

```

--------------------------------

### SamplerDescriptor::new

Source: https://docs.rs/metal/latest/metal/struct.SamplerDescriptor.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new instance of a SamplerDescriptor.

```APIDOC
### pub fn new() -> Self

Creates a new, default instance of a SamplerDescriptor.
```

--------------------------------

### Get and Set Vertex Sample Indices for RenderPassSampleBufferAttachmentDescriptor

Source: https://docs.rs/metal/latest/src/metal/renderpass.rs.html

Provides methods to get and set the start and end indices for vertex samples within a RenderPassSampleBufferAttachmentDescriptor.

```rust
impl RenderPassSampleBufferAttachmentDescriptorRef {
    pub fn start_of_vertex_sample_index(&self) -> NSUInteger {
        unsafe { msg_send![self, startOfVertexSampleIndex] }
    }

    pub fn set_start_of_vertex_sample_index(&self, start_of_vertex_sample_index: NSUInteger) {
        unsafe {
            msg_send![
                self,
                setStartOfVertexSampleIndex: start_of_vertex_sample_index
            ]
        }
    }

    pub fn end_of_vertex_sample_index(&self) -> NSUInteger {
        unsafe { msg_send![self, endOfVertexSampleIndex] }
    }

    pub fn set_end_of_vertex_sample_index(&self, end_of_vertex_sample_index: NSUInteger) {
        unsafe { msg_send![self, setEndOfVertexSampleIndex: end_of_vertex_sample_index] }
    }
}
```

--------------------------------

### start_of_encoder_sample_index / set_start_of_encoder_sample_index

Source: https://docs.rs/metal/latest/metal/struct.ComputePassSampleBufferAttachmentDescriptor.html?search=std%3A%3Avec

Gets or sets the starting sample index for the encoder.

```APIDOC
### pub fn start_of_encoder_sample_index(&self) -> NSUInteger
### pub fn set_start_of_encoder_sample_index(&self, start_of_encoder_sample_index: NSUInteger)

Configures the starting index for sample recording.
```

--------------------------------

### Create Libraries

Source: https://docs.rs/metal/latest/src/metal/device.rs.html?search=

Methods for creating shader libraries from default sources, source strings, or files.

```rust
pub fn new_default_library(&self) -> Library {
        unsafe { msg_send![self, newDefaultLibrary] }
    }

    pub fn new_library_with_source(
        &self,
        src: &str,
        options: &CompileOptionsRef,
    ) -> Result<Library, String> {
        let source = nsstring_from_str(src);
        unsafe {
            let mut err: *mut Object = ptr::null_mut();
            let library: *mut MTLLibrary = msg_send![self, newLibraryWithSource:source
                                                                        options:options
                                                                          error:&mut err];
            if !err.is_null() {
                let desc: *mut Object = msg_send![err, localizedDescription];
                let compile_error: *const c_char = msg_send![desc, UTF8String];
                let message = CStr::from_ptr(compile_error).to_string_lossy().into_owned();
                if library.is_null() {
                    return Err(message);
                } else {
                    warn!("Shader warnings: {}", message);
                }
            }

            assert!(!library.is_null());
            Ok(Library::from_ptr(library))
        }
    }

    pub fn new_library_with_file<P: AsRef<Path>>(&self, file: P) -> Result<Library, String> {
        let filename = nsstring_from_str(file.as_ref().to_string_lossy().as_ref());
        unsafe {
            let library: *mut MTLLibrary = try_objc! { err =>
                msg_send![self, newLibraryWithFile:filename.as_ref()
                                             error:&mut err]
            };
            Ok(Library::from_ptr(library))
        }
    }

    pub fn new_library_with_data(&self, library_data: &[u8]) -> Result<Library, String> {
        unsafe {
            // SAFETY:
            // `library_data` does not necessarily outlive the dispatch data
            // in which it will be contained (since the dispatch data will be
            // contained in the MTLLibrary returned by this function).
            //
            // To prevent the MTLLibrary from referencing the data outside of
```

--------------------------------

### Fragment sample index accessors

Source: https://docs.rs/metal/latest/metal/struct.RenderPassSampleBufferAttachmentDescriptor.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods to get and set the start and end fragment sample indices.

```rust
pub fn start_of_fragment_sample_index(&self) -> NSUInteger
```

```rust
pub fn set_start_of_fragment_sample_index( &self, start_of_fragment_sample_index: NSUInteger, )
```

```rust
pub fn end_of_fragment_sample_index(&self) -> NSUInteger
```

```rust
pub fn set_end_of_fragment_sample_index( &self, end_of_fragment_sample_index: NSUInteger, )
```

--------------------------------

### CaptureManager::start_capture_with_device

Source: https://docs.rs/metal/latest/metal/struct.CaptureManager.html

Starts capturing using a specific Metal device.

```APIDOC
## CaptureManager::start_capture_with_device

### Description
Starts capturing using a specific Metal device.

### Parameters
#### Path Parameters
- **device** (*&DeviceRef*) - Required - The Metal device to use for capturing.

```

--------------------------------

### Vertex sample index accessors

Source: https://docs.rs/metal/latest/metal/struct.RenderPassSampleBufferAttachmentDescriptor.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods to get and set the start and end vertex sample indices.

```rust
pub fn start_of_vertex_sample_index(&self) -> NSUInteger
```

```rust
pub fn set_start_of_vertex_sample_index( &self, start_of_vertex_sample_index: NSUInteger, )
```

```rust
pub fn end_of_vertex_sample_index(&self) -> NSUInteger
```

```rust
pub fn set_end_of_vertex_sample_index( &self, end_of_vertex_sample_index: NSUInteger, )
```

--------------------------------

### Device Creation

Source: https://docs.rs/metal/latest/metal/struct.Device.html

Methods for creating or retrieving Device instances.

```APIDOC
## Device Creation

### `system_default()`

Retrieves the default Metal device available on the system.

- **Returns**: `Option<Device>` - An optional Device instance if available, otherwise None.

### `all()`

Retrieves all available Metal devices on the system.

- **Returns**: `Vec<Device>` - A vector containing all available Device instances.
```

--------------------------------

### Configure BlitPassSampleBufferAttachmentDescriptor properties

Source: https://docs.rs/metal/latest/src/metal/blitpass.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods to get and set the sample buffer, start index, and end index for the blit pass sample buffer attachment.

```rust
impl BlitPassSampleBufferAttachmentDescriptorRef {
    pub fn sample_buffer(&self) -> Option<&CounterSampleBufferRef> {
        unsafe { msg_send![self, sampleBuffer] }
    }

    pub fn set_sample_buffer(&self, sample_buffer: &CounterSampleBufferRef) {
        unsafe { msg_send![self, setSampleBuffer: sample_buffer] }
    }

    pub fn start_of_encoder_sample_index(&self) -> NSUInteger {
        unsafe { msg_send![self, startOfEncoderSampleIndex] }
    }

    pub fn set_start_of_encoder_sample_index(&self, start_of_encoder_sample_index: NSUInteger) {
        unsafe {
            msg_send![
                self,
                setStartOfEncoderSampleIndex: start_of_encoder_sample_index
            ]
        }
    }

    pub fn end_of_encoder_sample_index(&self) -> NSUInteger {
        unsafe { msg_send![self, endOfEncoderSampleIndex] }
    }

    pub fn set_end_of_encoder_sample_index(&self, end_of_encoder_sample_index: NSUInteger) {
        unsafe {
            msg_send![
                self,
                setEndOfEncoderSampleIndex: end_of_encoder_sample_index
            ]
        }
    }
}
```

--------------------------------

### Get Texture Bytes (Multi-Slice)

Source: https://docs.rs/metal/latest/src/metal/texture.rs.html

Retrieve raw byte data from a specific region, mipmap level, and slice of the texture. `image_stride` is the number of bytes between the start of one slice and the next.

```rust
pub fn get_bytes_in_slice(
        &self,
        bytes: *mut std::ffi::c_void,
        stride: NSUInteger,
        image_stride: NSUInteger,
        region: MTLRegion,
        mipmap_level: NSUInteger,
        slice: NSUInteger,
    ) {
        unsafe {
            msg_send![self, getBytes:bytes
                         bytesPerRow:stride
                       bytesPerImage:image_stride
                          fromRegion:region
                         mipmapLevel:mipmap_level
                               slice:slice]
        }
    }
```

--------------------------------

### Device Resource Creation and Capability Methods

Source: https://docs.rs/metal/latest/metal/struct.Device.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

A collection of methods for creating Metal resources and querying device-specific hardware support.

```APIDOC
## Device Methods

### new_texture
Creates a new texture based on the provided descriptor.

### new_sampler
Creates a new sampler state based on the provided descriptor.

### new_heap
Creates a new heap based on the provided descriptor.

### new_event
Creates a new event object.

### new_shared_event
Creates a new shared event object.

### argument_buffers_support
Returns the supported argument buffer tier.

### raster_order_groups_supported
Returns a boolean indicating if raster order groups are supported.

### current_allocated_size
Returns the current allocated size in bytes.
```

--------------------------------

### Get and Set Encoder Sample Index Range

Source: https://docs.rs/metal/latest/src/metal/acceleration_structure_pass.rs.html

Configures or retrieves the start and end indices within the sample buffer that correspond to the encoder's activity. This helps in isolating performance data for specific encoder operations.

```rust
impl AccelerationStructurePassSampleBufferAttachmentDescriptorRef {
    pub fn start_of_encoder_sample_index(&self) -> NSUInteger {
        unsafe { msg_send![self, startOfEncoderSampleIndex] }
    }

    pub fn set_start_of_encoder_sample_index(&self, start_of_encoder_sample_index: NSUInteger) {
        unsafe {
            msg_send![
                self,
                setStartOfEncoderSampleIndex: start_of_encoder_sample_index
            ]
        }
    }

    pub fn end_of_encoder_sample_index(&self) -> NSUInteger {
        unsafe { msg_send![self, endOfEncoderSampleIndex] }
    }

    pub fn set_end_of_encoder_sample_index(&self, end_of_encoder_sample_index: NSUInteger) {
        unsafe {
            msg_send![
                self,
                setEndOfEncoderSampleIndex: end_of_encoder_sample_index
            ]
        }
    }
}
```

--------------------------------

### device Method

Source: https://docs.rs/metal/latest/metal/struct.AccelerationStructure.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the device associated with the resource.

```rust
pub fn device(&self) -> &DeviceRef
```

--------------------------------

### CaptureManagerRef::start_capture_with_scope

Source: https://docs.rs/metal/latest/metal/struct.CaptureManagerRef.html

Starts capturing using a specific capture scope.

```APIDOC
## CaptureManagerRef::start_capture_with_scope

### Description
Starts capturing using a specific capture scope.

### Method
(Implicitly called via CaptureManagerRef)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **scope** (*&CaptureScopeRef*) - The capture scope to use for capture.
```

--------------------------------

### CaptureManagerRef::start_capture_with_command_queue

Source: https://docs.rs/metal/latest/metal/struct.CaptureManagerRef.html

Starts capturing using a specific Metal command queue.

```APIDOC
## CaptureManagerRef::start_capture_with_command_queue

### Description
Starts capturing using a specific Metal command queue.

### Method
(Implicitly called via CaptureManagerRef)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **command_queue** (*&CommandQueueRef*) - The Metal command queue to use for capture.
```

--------------------------------

### Device::all

Source: https://docs.rs/metal/latest/src/metal/device.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns a list of all available Metal devices on the system.

```APIDOC
### Method
`Device::all() -> Vec<Self>`

### Description
Enumerates all available Metal-compatible GPUs on the system.
```

--------------------------------

### start_capture

Source: https://docs.rs/metal/latest/metal/struct.CaptureManager.html?search=u32+-%3E+bool

Starts a GPU capture session using the provided capture descriptor. This method requires Metal capture to be enabled via Xcode, environment variables, or the application's info.plist.

```APIDOC
## pub fn start_capture(&self, descriptor: &CaptureDescriptorRef) -> Result<(), String>

### Description
Starts capturing with the capture session defined by a descriptor object. This function will panic if Metal capture is not enabled.

### Parameters
- **descriptor** (&CaptureDescriptorRef) - Required - The capture descriptor defining the session configuration.

### Returns
- **Result<(), String>** - Returns Ok(()) on success, or an error string if the capture could not be started.
```

--------------------------------

### Get and Set Sample Buffer for RenderPassSampleBufferAttachmentDescriptor

Source: https://docs.rs/metal/latest/src/metal/renderpass.rs.html

Provides methods to get and set the CounterSampleBuffer associated with a RenderPassSampleBufferAttachmentDescriptor.

```rust
impl RenderPassSampleBufferAttachmentDescriptorRef {
    pub fn sample_buffer(&self) -> Option<&CounterSampleBufferRef> {
        unsafe { msg_send![self, sampleBuffer] }
    }

    pub fn set_sample_buffer(&self, sample_buffer: &CounterSampleBufferRef) {
        unsafe { msg_send![self, setSampleBuffer: sample_buffer] }
    }
}
```

--------------------------------

### Set Install Name

Source: https://docs.rs/metal/latest/metal/struct.CompileOptionsRef.html

Sets the install name for dynamic libraries. Available on macOS 11.0+ and iOS 14.0+.

```rust
pub fn set_install_name(&self, name: &str)
```

--------------------------------

### CaptureManager capture initiation methods

Source: https://docs.rs/metal/latest/metal/struct.CaptureManager.html?search=u32+-%3E+bool

Methods to start a capture session using a device, command queue, or scope.

```rust
pub fn start_capture_with_device(&self, device: &DeviceRef)
```

```rust
pub fn start_capture_with_command_queue(&self, command_queue: &CommandQueueRef)
```

```rust
pub fn start_capture_with_scope(&self, scope: &CaptureScopeRef)
```

--------------------------------

### Set Start of Fragment Sample Index

Source: https://docs.rs/metal/latest/src/metal/renderpass.rs.html

Sets the start of fragment sample index for a render pass. This is part of the MTLRenderPassAttachmentDescriptor.

```rust
pub fn set_start_of_fragment_sample_index(&self, start_of_fragment_sample_index: NSUInteger) {
        unsafe {
            msg_send![
                self,
                setStartOfFragmentSampleIndex: start_of_fragment_sample_index
            ]
        }
    }
```

--------------------------------

### Library Type and Install Name

Source: https://docs.rs/metal/latest/src/metal/library.rs.html?search=std%3A%3Avec

Accessors for library type and install name. Available on macOS 11.0+ and iOS 14.0+.

```rust
pub fn library_type(&self) -> MTLLibraryType {
        unsafe { msg_send![self, type] }
    }
```

```rust
pub fn install_name(&self) -> Option<&str> {
        unsafe {
            let maybe_name: *mut Object = msg_send![self, installName];
```

--------------------------------

### Configuration Methods

Source: https://docs.rs/metal/latest/metal/struct.IndirectInstanceAccelerationStructureDescriptor.html?search=u32+-%3E+bool

Methods to configure buffers, offsets, and counts for the acceleration structure descriptor.

```APIDOC
## Configuration Methods

- **set_instance_descriptor_buffer(&self, buffer: &BufferRef)**: Sets the instance descriptor buffer.
- **set_instance_descriptor_buffer_offset(&self, offset: NSUInteger)**: Sets the offset for the instance descriptor buffer.
- **set_instance_descriptor_stride(&self, stride: NSUInteger)**: Sets the stride for the instance descriptor buffer.
- **set_max_instance_count(&self, count: NSUInteger)**: Sets the maximum instance count.
- **set_instance_count_buffer(&self, buffer: &BufferRef)**: Sets the instance count buffer.
- **set_instance_count_buffer_offset(&self, offset: NSUInteger)**: Sets the offset for the instance count buffer.
- **set_instance_descriptor_type(&self, ty: MTLAccelerationStructureInstanceDescriptorType)**: Sets the instance descriptor type.
- **set_motion_transform_buffer(&self, buffer: &BufferRef)**: Sets the motion transform buffer.
- **set_motion_transform_buffer_offset(&self, offset: NSUInteger)**: Sets the offset for the motion transform buffer.
- **set_max_motion_transform_count(&self, count: NSUInteger)**: Sets the maximum motion transform count.
- **set_motion_transform_count_buffer(&self, buffer: &BufferRef)**: Sets the motion transform count buffer.
- **set_motion_transform_count_buffer_offset(&self, offset: NSUInteger)**: Sets the offset for the motion transform count buffer.
```

--------------------------------

### Set Install Name for Dynamic Libraries

Source: https://docs.rs/metal/latest/metal/struct.CompileOptions.html

Specifies the install name for dynamic libraries. This is relevant for macOS 11.0 and iOS 14.0 or later.

```rust
pub fn install_name(&self) -> &str
```

```rust
pub fn set_install_name(&self, name: &str)
```

--------------------------------

### RenderPipelineDescriptor::new

Source: https://docs.rs/metal/latest/src/metal/pipeline/render.rs.html?search=u32+-%3E+bool

Creates a new instance of a RenderPipelineDescriptor.

```APIDOC
## RenderPipelineDescriptor::new

### Description
Creates and returns a new instance of the RenderPipelineDescriptor.

### Signature
`pub fn new() -> Self`
```

--------------------------------

### CompileOptions::new

Source: https://docs.rs/metal/latest/metal/struct.CompileOptions.html

Creates a new instance of CompileOptions with default settings.

```APIDOC
## CompileOptions::new

### Description
Creates a new instance of `CompileOptions`.

### Method
`pub fn new() -> Self`
```

--------------------------------

### Get and Set Clear Depth for RenderPassDepthAttachmentDescriptor

Source: https://docs.rs/metal/latest/src/metal/renderpass.rs.html

Provides methods to get and set the clear depth for a RenderPassDepthAttachmentDescriptor. This value is used to clear the depth buffer.

```rust
impl RenderPassDepthAttachmentDescriptorRef {
    pub fn clear_depth(&self) -> f64 {
        unsafe { msg_send![self, clearDepth] }
    }

    pub fn set_clear_depth(&self, clear_depth: f64) {
        unsafe { msg_send![self, setClearDepth: clear_depth] }
    }
}
```

--------------------------------

### start_capture

Source: https://docs.rs/metal/latest/metal/struct.CaptureManagerRef.html?search=std%3A%3Avec

Starts a capture session using the provided CaptureDescriptorRef. Note that this method will panic if Metal capture is not enabled via Xcode, environment variables, or info.plist configuration.

```APIDOC
## pub fn start_capture(&self, descriptor: &CaptureDescriptorRef) -> Result<(), String>

### Description
Starts capturing with the capture session defined by a descriptor object.

### Parameters
- **descriptor** (&CaptureDescriptorRef) - Required - The capture descriptor defining the session parameters.

### Returns
- **Result<(), String>** - Returns Ok(()) on success, or an error string if the capture could not be started.
```

--------------------------------

### Create Library from File

Source: https://docs.rs/metal/latest/metal/struct.DeviceRef.html

Loads and compiles a Metal library from a file. Returns a Result containing the Library or an error string.

```rust
pub fn new_library_with_file<P: AsRef<Path>>( &self, file: P, ) -> Result<Library, String>
```

--------------------------------

### Getting Type ID of MTLAccelerationStructureDescriptor

Source: https://docs.rs/metal/latest/metal/enum.MTLAccelerationStructureDescriptor.html

This implementation of the Any trait provides a method to get the unique TypeId of an instance of MTLAccelerationStructureDescriptor. This is useful for runtime type identification.

```rust
fn type_id(&self) -> TypeId
{
    // ... implementation details ...
}

```

--------------------------------

### Get and Set Clear Stencil for RenderPassStencilAttachmentDescriptor

Source: https://docs.rs/metal/latest/src/metal/renderpass.rs.html

Provides methods to get and set the clear stencil value for a RenderPassStencilAttachmentDescriptor. This value is used to clear the stencil buffer.

```rust
impl RenderPassStencilAttachmentDescriptorRef {
    pub fn clear_stencil(&self) -> u32 {
        unsafe { msg_send![self, clearStencil] }
    }

    pub fn set_clear_stencil(&self, clear_stencil: u32) {
        unsafe { msg_send![self, setClearStencil: clear_stencil] }
    }
}
```

--------------------------------

### HeapDescriptor::new

Source: https://docs.rs/metal/latest/metal/struct.HeapDescriptor.html

Creates a new HeapDescriptor instance. This is the primary way to initialize a heap descriptor.

```APIDOC
## HeapDescriptor::new

### Description
Creates a new, default `HeapDescriptor`.

### Method
`new()`

### Returns
A new `HeapDescriptor` instance.
```

--------------------------------

### Initialize RenderPipelineDescriptor

Source: https://docs.rs/metal/latest/metal/struct.RenderPipelineDescriptor.html

Creates a new, empty RenderPipelineDescriptor. This is the starting point for configuring a render pipeline.

```rust
pub struct RenderPipelineDescriptor(/* private fields */);
```

--------------------------------

### Get and Set Stencil Resolve Filter for RenderPassStencilAttachmentDescriptor

Source: https://docs.rs/metal/latest/src/metal/renderpass.rs.html

Provides methods to get and set the stencil resolve filter for a RenderPassStencilAttachmentDescriptor. This is used for multisample stencil resolve operations.

```rust
impl RenderPassStencilAttachmentDescriptorRef {
    pub fn stencil_resolve_filter(&self) -> MTLMultisampleStencilResolveFilter {
        unsafe { msg_send![self, stencilResolveFilter] }
    }

    pub fn set_stencil_resolve_filter(
        &self,
        stencil_resolve_filter: MTLMultisampleStencilResolveFilter,
    ) {
        unsafe { msg_send![self, setStencilResolveFilter: stencil_resolve_filter] }
    }
}
```

--------------------------------

### MTLBlitOption Initialization Methods

Source: https://docs.rs/metal/latest/metal/struct.MTLBlitOption.html

Methods for creating MTLBlitOption values, including empty, all bits set, and from raw bits.

```rust
pub const fn empty() -> Self
```

```rust
pub const fn all() -> Self
```

```rust
pub const fn from_bits(bits: NSUInteger) -> Option<Self>
```

```rust
pub const fn from_bits_truncate(bits: NSUInteger) -> Self
```

```rust
pub const fn from_bits_retain(bits: NSUInteger) -> Self
```

--------------------------------

### Get Function from Library

Source: https://docs.rs/metal/latest/metal/struct.Library.html

Retrieves a function from the library by its name. This method corresponds to Metal's `newFunctionWithName` and returns a retained object. Use this to get a specific function defined within the library.

```rust
pub fn get_function( 
  &self, 
  name: &str, 
  constants: Option<FunctionConstantValues>, 
) -> Result<Function, String>
```

--------------------------------

### Initialize CompileOptions

Source: https://docs.rs/metal/latest/metal/struct.CompileOptions.html

Creates a new instance of CompileOptions. This is the starting point for configuring compilation settings.

```rust
pub struct CompileOptions(/* private fields */);
```

--------------------------------

### Any::type_id

Source: https://docs.rs/metal/latest/metal/struct.CommonCounter.html

Gets the `TypeId` of `self`.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`. Read more

### Method
`type_id`
```

--------------------------------

### Create MTLDynamicLibrary from URL

Source: https://docs.rs/metal/latest/src/metal/device.rs.html?search=

Creates a dynamic library from a URL reference. Available on macOS 11.0+ and iOS 14.0+.

```rust
    /// Only available on (macos(11.0), ios(14.0))
    pub fn new_dynamic_library_with_url(&self, url: &URLRef) -> Result<DynamicLibrary, String> {
        unsafe {
            let mut err: *mut Object = ptr::null_mut();
            let dynamic_library: *mut MTLDynamicLibrary = msg_send![self, newDynamicLibraryWithURL:url
                                                                                             error:&mut err];
            if !err.is_null() {
                // FIXME: copy pasta
                let desc: *mut Object = msg_send![err, localizedDescription];
                let compile_error: *const c_char = msg_send![desc, UTF8String];
                let message = CStr::from_ptr(compile_error).to_string_lossy().into_owned();
                Err(message)
            } else {
                Ok(DynamicLibrary::from_ptr(dynamic_library))
            }
        }
    }
```

--------------------------------

### Get Depth

Source: https://docs.rs/metal/latest/metal/struct.TextureDescriptor.html

Retrieves the depth of the texture.

```rust
pub fn depth(&self) -> NSUInteger
```

--------------------------------

### Fragment Sample Index Configuration

Source: https://docs.rs/metal/latest/src/metal/renderpass.rs.html?search=u32+-%3E+bool

Methods to set and retrieve the start and end fragment sample indices for a render pass attachment.

```rust
    pub fn set_start_of_fragment_sample_index(&self, start_of_fragment_sample_index: NSUInteger) {
        unsafe {
            msg_send![
                self,
                setStartOfFragmentSampleIndex: start_of_fragment_sample_index
            ]
        }
    }

    pub fn end_of_fragment_sample_index(&self) -> NSUInteger {
        unsafe { msg_send![self, endOfFragmentSampleIndex] }
    }

    pub fn set_end_of_fragment_sample_index(&self, end_of_fragment_sample_index: NSUInteger) {
        unsafe {
            msg_send![
                self,
                setEndOfFragmentSampleIndex: end_of_fragment_sample_index
            ]
        }
    }
}
```

--------------------------------

### Get Height

Source: https://docs.rs/metal/latest/metal/struct.TextureDescriptor.html

Retrieves the height of the texture.

```rust
pub fn height(&self) -> NSUInteger
```

--------------------------------

### BinaryArchiveRef Methods

Source: https://docs.rs/metal/latest/metal/struct.BinaryArchiveRef.html

This section details the methods available on the BinaryArchiveRef struct for interacting with Metal binary archives.

```APIDOC
## BinaryArchiveRef

### Description
A borrowed reference to a `BinaryArchive`.

### Methods

#### `device()`
- **Returns**: `&DeviceRef`
- **Description**: Returns a reference to the associated `DeviceRef`.

#### `label()`
- **Returns**: `&str`
- **Description**: Returns the label of the binary archive.

#### `set_label(label: &str)`
- **Parameters**:
  - `label` (string) - The new label for the binary archive.
- **Description**: Sets the label for the binary archive.

#### `add_compute_pipeline_functions_with_descriptor(descriptor: &ComputePipelineDescriptorRef)`
- **Parameters**:
  - `descriptor` (`&ComputePipelineDescriptorRef`) - The descriptor for the compute pipeline.
- **Returns**: `Result<bool, String>`
- **Description**: Adds compute pipeline functions to the archive based on the provided descriptor.

#### `add_render_pipeline_functions_with_descriptor(descriptor: &RenderPipelineDescriptorRef)`
- **Parameters**:
  - `descriptor` (`&RenderPipelineDescriptorRef`) - The descriptor for the render pipeline.
- **Returns**: `Result<bool, String>`
- **Description**: Adds render pipeline functions to the archive based on the provided descriptor.

#### `serialize_to_url(url: &URLRef)`
- **Parameters**:
  - `url` (`&URLRef`) - The URL to serialize the archive to.
- **Returns**: `Result<bool, String>`
- **Description**: Serializes the binary archive to the specified URL.
```

--------------------------------

### Get Width

Source: https://docs.rs/metal/latest/metal/struct.TextureDescriptor.html

Retrieves the width of the texture.

```rust
pub fn width(&self) -> NSUInteger
```

--------------------------------

### BinaryArchiveDescriptor::new

Source: https://docs.rs/metal/latest/metal/struct.BinaryArchiveDescriptor.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new instance of BinaryArchiveDescriptor.

```APIDOC
## pub fn new() -> Self

### Description
Creates a new instance of BinaryArchiveDescriptor.

### Returns
- **Self** - A new BinaryArchiveDescriptor instance.
```

--------------------------------

### label

Source: https://docs.rs/metal/latest/metal/struct.ParallelRenderCommandEncoderRef.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets or sets the label for the encoder.

```APIDOC
## pub fn label(&self) -> &str

### Description
Retrieves the label string associated with the encoder.

## pub fn set_label(&self, label: &str)

### Description
Sets the label string for the encoder.
```

--------------------------------

### Bounding Box Configuration Methods

Source: https://docs.rs/metal/latest/metal/struct.AccelerationStructureBoundingBoxGeometryDescriptor.html?search=

Methods to configure the bounding box buffer and layout properties.

```APIDOC
### set_bounding_box_buffer(&self, buffer: Option<&BufferRef>)
Sets the buffer containing the bounding box data.

### set_bounding_box_count(&self, count: NSUInteger)
Sets the number of bounding boxes in the geometry.

### set_bounding_box_stride(&self, stride: NSUInteger)
Sets the stride between bounding boxes in the buffer.

### set_bounding_box_buffer_offset(&self, offset: NSUInteger)
Sets the byte offset into the bounding box buffer.
```

--------------------------------

### destination

Source: https://docs.rs/metal/latest/metal/struct.CaptureDescriptorRef.html

Gets the capture destination for the descriptor.

```APIDOC
## destination

### Description
Gets the capture destination for the descriptor.

### Method
`destination`

### Returns
* `MTLCaptureDestination` - The capture destination.
```

--------------------------------

### Bounding Box Configuration Methods

Source: https://docs.rs/metal/latest/metal/struct.AccelerationStructureBoundingBoxGeometryDescriptor.html?search=std%3A%3Avec

Methods to configure the bounding box buffer, count, stride, and offset.

```APIDOC
### Methods
- `pub fn set_bounding_box_buffer(&self, buffer: Option<&BufferRef>)`
- `pub fn set_bounding_box_count(&self, count: NSUInteger)`
- `pub fn set_bounding_box_stride(&self, stride: NSUInteger)`
- `pub fn set_bounding_box_buffer_offset(&self, offset: NSUInteger)`

### Description
These methods configure the underlying buffer and layout properties for the bounding box geometry.
```

--------------------------------

### CaptureDescriptor::destination

Source: https://docs.rs/metal/latest/metal/struct.CaptureDescriptor.html

Gets the capture destination.

```APIDOC
## CaptureDescriptor::destination

### Description
Retrieves the capture destination type configured for this descriptor.

### Method
```
pub fn destination(&self) -> MTLCaptureDestination
```

### Returns
The `MTLCaptureDestination` enum value.
```

--------------------------------

### set_start_of_encoder_sample_index

Source: https://docs.rs/metal/latest/metal/struct.AccelerationStructurePassSampleBufferAttachmentDescriptorRef.html?search=std%3A%3Avec

Sets the starting sample index for the encoder.

```APIDOC
### pub fn set_start_of_encoder_sample_index(&self, start_of_encoder_sample_index: NSUInteger)

Sets the starting sample index for the encoder.
```

--------------------------------

### resource_options Method

Source: https://docs.rs/metal/latest/metal/struct.AccelerationStructure.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the resource options. Available on macOS 10.15+ and iOS 13.0+.

```rust
pub fn resource_options(&self) -> MTLResourceOptions
```

--------------------------------

### Create MTLDynamicLibrary from reference

Source: https://docs.rs/metal/latest/src/metal/device.rs.html?search=

Creates a dynamic library from a library reference. Available on macOS 11.0+ and iOS 14.0+.

```rust
    /// Only available on (macos(11.0), ios(14.0))
    pub fn new_dynamic_library(&self, library: &LibraryRef) -> Result<DynamicLibrary, String> {
        unsafe {
            let mut err: *mut Object = ptr::null_mut();
            let dynamic_library: *mut MTLDynamicLibrary = msg_send![self, newDynamicLibrary:library
                                                                                      error:&mut err];
            if !err.is_null() {
                // FIXME: copy pasta
                let desc: *mut Object = msg_send![err, localizedDescription];
                let compile_error: *const c_char = msg_send![desc, UTF8String];
                let message = CStr::from_ptr(compile_error).to_string_lossy().into_owned();
                Err(message)
            } else {
                Ok(DynamicLibrary::from_ptr(dynamic_library))
            }
        }
    }
```

--------------------------------

### ComputePipelineDescriptor Methods

Source: https://docs.rs/metal/latest/metal/struct.ComputePipelineDescriptor.html

Provides an overview of the methods available for the ComputePipelineDescriptor, including initialization and property setting.

```APIDOC
## ComputePipelineDescriptor

Represents a descriptor for configuring a compute pipeline.

### Methods

#### `new()`

Creates a new, empty `ComputePipelineDescriptor`.

- **Returns**: `Self` (a new `ComputePipelineDescriptor` instance)

#### `label()`

Gets the label of the compute pipeline descriptor.

- **Returns**: `&str` - The label string.

#### `set_label(label: &str)`

Sets the label for the compute pipeline descriptor.

- **Parameters**:
  - `label` (`&str`): The label to set.

#### `compute_function()`

Gets the compute function associated with the descriptor.

- **Returns**: `Option<&FunctionRef>` - An optional reference to the `FunctionRef`.

#### `set_compute_function(function: Option<&FunctionRef>)`

Sets the compute function for the descriptor.

- **Parameters**:
  - `function` (`Option<&FunctionRef>`): The `FunctionRef` to set.

#### `thread_group_size_is_multiple_of_thread_execution_width()`

Checks if the thread group size is a multiple of the thread execution width.

- **Returns**: `bool` - `true` if it is a multiple, `false` otherwise.

#### `set_thread_group_size_is_multiple_of_thread_execution_width(size_is_multiple_of_width: bool)`

Sets whether the thread group size is a multiple of the thread execution width.

- **Parameters**:
  - `size_is_multiple_of_width` (`bool`): The boolean value to set.

#### `max_total_threads_per_threadgroup()`

Gets the maximum total threads per threadgroup.

- **Availability**: `macos(10.14)`, `ios(12.0)`
- **Returns**: `NSUInteger` - The maximum number of threads.

#### `set_max_total_threads_per_threadgroup(max_total_threads: NSUInteger)`

Sets the maximum total threads per threadgroup.

- **Availability**: `macos(10.14)`, `ios(12.0)`
- **Parameters**:
  - `max_total_threads` (`NSUInteger`): The maximum number of threads to set.

#### `support_indirect_command_buffers()`

Checks if indirect command buffers are supported.

- **Availability**: `ios(13.0)`, `macos(11.0)`
- **Returns**: `bool` - `true` if supported, `false` otherwise.

#### `set_support_indirect_command_buffers(support: bool)`

Sets whether to support indirect command buffers.

- **Availability**: `ios(13.0)`, `macos(11.0)`
- **Parameters**:
  - `support` (`bool`): The boolean value to set.

#### `support_adding_binary_functions()`

Checks if adding binary functions is supported.

- **Availability**: `macos(11.0)`, `ios(14.0)`
- **Returns**: `bool` - `true` if supported, `false` otherwise.

#### `set_support_adding_binary_functions(support: bool)`

Sets whether to support adding binary functions.

- **Availability**: `macos(11.0)`, `ios(14.0)`
- **Parameters**:
  - `support` (`bool`): The boolean value to set.

#### `max_call_stack_depth()`

Gets the maximum call stack depth.

- **Availability**: `macos(11.0)`, `ios(14.0)`
- **Returns**: `NSUInteger` - The maximum depth.

#### `set_max_call_stack_depth(depth: NSUInteger)`

Sets the maximum call stack depth.

- **Availability**: `macos(11.0)`, `ios(14.0)`
- **Parameters**:
  - `depth` (`NSUInteger`): The depth to set.

#### `insert_libraries()`

Gets the libraries to insert into the pipeline.

- **Availability**: `macos(11.0)`, `ios(14.0)`
- **Returns**: `Vec<DynamicLibrary>` - A vector of `DynamicLibrary`.

#### `set_insert_libraries(libraries: &[&DynamicLibraryRef])`

Sets the libraries to insert into the pipeline.

- **Availability**: `macos(11.0)`, `ios(14.0)`
- **Parameters**:
  - `libraries` (`&[&DynamicLibraryRef]`): A slice of references to `DynamicLibraryRef`.

#### `binary_archives()`

Gets the binary archives associated with the descriptor.

- **Availability**: `macos(11.0)`, `ios(14.0)`
- **Returns**: `Vec<BinaryArchive>` - A vector of `BinaryArchive`.

#### `set_binary_archives(archives: &[&BinaryArchiveRef])`

Sets the binary archives for the descriptor.

- **Availability**: `macos(11.0)`, `ios(14.0)`
- **Parameters**:
  - `archives` (`&[&BinaryArchiveRef]`): A slice of references to `BinaryArchiveRef`.

#### `linked_functions()`

Gets the linked functions descriptor.

- **Availability**: `macos(11.0)`, `ios(14.0)`
- **Returns**: `&LinkedFunctionsRef` - A reference to the `LinkedFunctionsRef`.

#### `set_linked_functions(functions: &LinkedFunctionsRef)`

Sets the linked functions descriptor.

- **Availability**: `macos(11.0)`, `ios(14.0)`
- **Parameters**:
  - `functions` (`&LinkedFunctionsRef`): The `LinkedFunctionsRef` to set.

#### `stage_input_descriptor()`

Gets the stage input descriptor.

- **Returns**: `Option<&StageInputOutputDescriptorRef>` - An optional reference to the `StageInputOutputDescriptorRef`.

#### `set_stage_input_descriptor(descriptor: Option<&StageInputOutputDescriptorRef>)`

Sets the stage input descriptor.

- **Parameters**:
  - `descriptor` (`Option<&StageInputOutputDescriptorRef>`): The `StageInputOutputDescriptorRef` to set.

#### `buffers()`

Gets the pipeline buffer descriptors.

- **Returns**: `Option<&PipelineBufferDescriptorArrayRef>` - An optional reference to the `PipelineBufferDescriptorArrayRef`.

#### `reset()`

Resets the descriptor to its default values.
```

--------------------------------

### Hardware Capability Queries

Source: https://docs.rs/metal/latest/metal/enum.MTLFeatureSet.html?search=u32+-%3E+bool

Methods to retrieve hardware limits and configuration constraints.

```APIDOC
## Hardware Limit Methods

- `max_3d_texture_size(&self) -> u32`: Returns the maximum dimension for 3D textures.
- `max_array_layers(&self) -> u32`: Returns the maximum number of array layers supported.
- `copy_texture_buffer_alignment(&self) -> u32`: Returns the required alignment for texture-to-buffer copies.
- `new_texture_buffer_alignment(&self) -> Option<u32>`: Returns the alignment for new texture buffers, or None if discovery via API query is required.
- `max_color_render_targets(&self) -> u32`: Returns the maximum number of simultaneous color render targets.
- `max_point_primitive_size(&self) -> u32`: Returns the maximum size for point primitives.
- `max_total_color_render_target_size(&self) -> Option<u32>`: Returns the maximum total size for color render targets if applicable.
- `max_visibility_query_offset(&self) -> u32`: Returns the maximum offset for visibility queries.
```

--------------------------------

### label

Source: https://docs.rs/metal/latest/src/metal/library.rs.html?search=std%3A%3Avec

Gets or sets the label associated with the library.

```APIDOC
## label / set_label

### Description
Methods to access or modify the label string of the library.

### Signatures
- `pub fn label(&self) -> &str`
- `pub fn set_label(&self, label: &str)`

### Parameters
- **label** (&str) - The label string to set.
```

--------------------------------

### MetalLayerRef::pixel_format

Source: https://docs.rs/metal/latest/src/metal/lib.rs.html

Gets the pixel format of the MetalLayer.

```APIDOC
## MetalLayerRef::pixel_format

### Description
Gets the pixel format of the MetalLayer.

### Method
Getter

### Endpoint
N/A (Method on MetalLayerRef)

### Parameters
None

### Response
#### Success Response
- **MTLPixelFormat** (MTLPixelFormat) - The pixel format of the layer.
```
Tokens:
Raw