Struct MTL4ComputePipelineDescriptor

Source

pub struct MTL4ComputePipelineDescriptor { /* private fields */ }

Available on crate features MTL4ComputePipeline and MTL4PipelineState only.

Expand description

Describes a compute pipeline state.

Implementations§

Source §

impl MTL4ComputePipelineDescriptor

Source

pub fn computeFunctionDescriptor( &self, ) -> Option<Retained<MTL4FunctionDescriptor>>

Available on crate feature MTL4FunctionDescriptor only.

A descriptor representing the compute pipeline’s function.

You don’t assign instances of MTL4FunctionDescriptor to this property directly, instead assign an instance of one of its subclasses, such as MTL4LibraryFunctionDescriptor, which represents a function from a Metal library.

Source

pub fn setComputeFunctionDescriptor( &self, compute_function_descriptor: Option<&MTL4FunctionDescriptor>, )

Available on crate feature MTL4FunctionDescriptor only.

Setter for computeFunctionDescriptor.

This is copied when set.

Source

pub fn threadGroupSizeIsMultipleOfThreadExecutionWidth(&self) -> bool

A boolean value indicating whether each dimension of the threadgroup size is a multiple of its corresponding thread execution width.

Source

pub fn setThreadGroupSizeIsMultipleOfThreadExecutionWidth( &self, thread_group_size_is_multiple_of_thread_execution_width: bool, )

Setter for threadGroupSizeIsMultipleOfThreadExecutionWidth.

Source

pub fn maxTotalThreadsPerThreadgroup(&self) -> NSUInteger

The maximum total number of threads that Metal can execute in a single threadgroup for the compute function.

Source

pub fn setMaxTotalThreadsPerThreadgroup( &self, max_total_threads_per_threadgroup: NSUInteger, )

Setter for maxTotalThreadsPerThreadgroup.

Source

pub fn requiredThreadsPerThreadgroup(&self) -> MTLSize

Available on crate feature MTLTypes only.

The required number of threads per threadgroup for compute dispatches.

When you set this value, you are responsible for ensuring that the threadsPerThreadgroup argument of any compute dispatch matches it.

Setting this property is optional, except in cases where the pipeline uses CooperativeTensors.

This property’s default value is 0, which disables its effect.

Source

pub fn setRequiredThreadsPerThreadgroup( &self, required_threads_per_threadgroup: MTLSize, )

Available on crate feature MTLTypes only.

Setter for requiredThreadsPerThreadgroup.

Source

pub fn supportBinaryLinking(&self) -> bool

A boolean value indicating whether the compute pipeline supports linking binary functions.

Source

pub fn setSupportBinaryLinking(&self, support_binary_linking: bool)

Setter for supportBinaryLinking.

Source

pub fn staticLinkingDescriptor( &self, ) -> Option<Retained<MTL4StaticLinkingDescriptor>>

Available on crate feature MTL4LinkingDescriptor only.

An object that contains information about functions to link to the compute pipeline.

Source

pub fn setStaticLinkingDescriptor( &self, static_linking_descriptor: Option<&MTL4StaticLinkingDescriptor>, )

Available on crate feature MTL4LinkingDescriptor only.

Setter for staticLinkingDescriptor.

This is copied when set.

Source

pub fn supportIndirectCommandBuffers( &self, ) -> MTL4IndirectCommandBufferSupportState

A value indicating whether the pipeline supports Metal indirect command buffers.

Source

pub fn setSupportIndirectCommandBuffers( &self, support_indirect_command_buffers: MTL4IndirectCommandBufferSupportState, )

Setter for supportIndirectCommandBuffers.

Source

pub fn reset(&self)

Resets the descriptor to its default values.

Source §

impl MTL4ComputePipelineDescriptor

Methods declared on superclass NSObject.

Source

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

Source

pub fn new() -> Retained<Self>

Methods from Deref<Target = MTL4PipelineDescriptor>§

Source

pub fn label(&self) -> Option<Retained<NSString>>

Assigns an optional string that uniquely identifies a pipeline descriptor.

After you provide this label, you can use it to look up a pipeline state object by name in a binary archive.

Source

pub fn setLabel(&self, label: Option<&NSString>)

Setter for label.

This is copied when set.

Source

pub fn options(&self) -> Option<Retained<MTL4PipelineOptions>>

Provides compile-time options when you build the pipeline.

Source

pub fn setOptions(&self, options: Option<&MTL4PipelineOptions>)

Setter for options.

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`
    }
}