Struct MTLMeshRenderPipelineDescriptor 

pub struct MTLMeshRenderPipelineDescriptor { /* private fields */ }

Available on crate feature MTLRenderPipeline only.

As an alternative to a vertex + fragment shader render pipeline, this render pipeline uses a (object +) mesh + fragment shader for rendering geometry.

See also Apple’s documentation

Implementations

impl MTLMeshRenderPipelineDescriptor

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

A name or description provided by the application that will be displayed in debugging tools. The default value is nil.

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

Setter for label.

This is copied when set.

pub fn objectFunction( &self, ) -> Option<Retained<ProtocolObject<dyn MTLFunction>>>

Available on crate feature MTLLibrary only.

Optional shader function responsible for determining how many threadgroups of the mesh shader to run, can optionally provide payload data for the mesh stage. If this is nil, no payload data is available to the mesh function, and the draw command determines how many threadgroups of the mesh stage to run. The default value is nil.

pub unsafe fn setObjectFunction( &self, object_function: Option<&ProtocolObject<dyn MTLFunction>>, )

Available on crate feature MTLLibrary only.

Setter for objectFunction.

Safety

• object_function must be safe to call.
• object_function must have the correct argument and return types.

pub fn meshFunction(&self) -> Option<Retained<ProtocolObject<dyn MTLFunction>>>

Available on crate feature MTLLibrary only.

Shader function responsible for exporting a chunk of geometry per threadgroup for the rasterizer. The default value is nil.

pub unsafe fn setMeshFunction( &self, mesh_function: Option<&ProtocolObject<dyn MTLFunction>>, )

Available on crate feature MTLLibrary only.

Setter for meshFunction.

Safety

• mesh_function must be safe to call.
• mesh_function must have the correct argument and return types.

pub fn fragmentFunction( &self, ) -> Option<Retained<ProtocolObject<dyn MTLFunction>>>

Available on crate feature MTLLibrary only.

Like a classical render pipeline, this fragments covered by the rasterized geometry are shaded with this function. The default value is nil. To create a pipeline, you must either set fragmentFunction to non-nil, or set rasterizationEnabled to NO.

pub unsafe fn setFragmentFunction( &self, fragment_function: Option<&ProtocolObject<dyn MTLFunction>>, )

Available on crate feature MTLLibrary only.

Setter for fragmentFunction.

Safety

• fragment_function must be safe to call.
• fragment_function must have the correct argument and return types.

pub fn maxTotalThreadsPerObjectThreadgroup(&self) -> NSUInteger

The maximum size of the product of threadsPerObjectThreadgroup that can be used for draws with this pipeline. This information can be used by the optimizer to generate more efficient code, specifically when the specified value does not exceed the thread execution width of the underlying GPU. The default value is 0, which means that the value specified with the [[max_total_threads_per_threadgroup(N)]] specified on objectFunction will be used. When both the [[max_total_threads_per_threadgroup(N)]] attribute and a non-zero value are specified, both values must match. Any value specified cannot exceed the device limit as documented in the “Metal Feature Set Tables” for “Maximum threads per threadgroup”.

pub fn setMaxTotalThreadsPerObjectThreadgroup( &self, max_total_threads_per_object_threadgroup: NSUInteger, )

Setter for maxTotalThreadsPerObjectThreadgroup.

pub fn maxTotalThreadsPerMeshThreadgroup(&self) -> NSUInteger

The maximum size of the product of threadsPerMeshThreadgroup that can be used for draws with this pipeline. This information can be used by the optimizer to generate more efficient code, specifically when the specified value does not exceed the thread execution width of the underlying GPU. The default value is 0, which means that the value specified with the [[max_total_threads_per_threadgroup(N)]] specified on meshFunction will be used. When both the [[max_total_threads_per_threadgroup(N)]] attribute and a non-zero value are specified, both values must match. Any value specified cannot exceed the device limit as documented in the “Metal Feature Set Tables” for “Maximum threads per threadgroup”.

pub fn setMaxTotalThreadsPerMeshThreadgroup( &self, max_total_threads_per_mesh_threadgroup: NSUInteger, )

Setter for maxTotalThreadsPerMeshThreadgroup.

pub fn objectThreadgroupSizeIsMultipleOfThreadExecutionWidth(&self) -> bool

Set this value to YES when you will only use draws with the product of threadsPerObjectThreadgroup set to a multiple of the objectThreadExecutionWidth of the returned pipeline state. This information can be used by the optimizer to generate more efficient code. The default value is NO.

pub fn setObjectThreadgroupSizeIsMultipleOfThreadExecutionWidth( &self, object_threadgroup_size_is_multiple_of_thread_execution_width: bool, )

Setter for objectThreadgroupSizeIsMultipleOfThreadExecutionWidth.

pub fn meshThreadgroupSizeIsMultipleOfThreadExecutionWidth(&self) -> bool

Set this value to YES when you will only use draws with the product of threadsPerMeshThreadgroup set to a multiple of the meshThreadExecutionWidth of the returned pipeline state. This information can be used by the optimizer to generate more efficient code. The default value is NO.

pub fn setMeshThreadgroupSizeIsMultipleOfThreadExecutionWidth( &self, mesh_threadgroup_size_is_multiple_of_thread_execution_width: bool, )

Setter for meshThreadgroupSizeIsMultipleOfThreadExecutionWidth.

pub fn payloadMemoryLength(&self) -> NSUInteger

The size, in bytes, of the buffer indicated by [[payload]] in the object and mesh shader. If this value is 0, the size of the dereferenced type declared in the object shader for the buffer is used (space for a single element is assumed for pointers). The default value is 0.

pub fn setPayloadMemoryLength(&self, payload_memory_length: NSUInteger)

Setter for payloadMemoryLength.

pub fn maxTotalThreadgroupsPerMeshGrid(&self) -> NSUInteger

The maximum value of the product of vector elements that the object shader may pass to the mesh_grid_properties::set_threadgroups_per_grid built-in function. The default value is 0, which means that the value specified with the [[max_total_threadgroups_per_mesh_grid(N)]] specified on objectFunction will be used. When both the [[max_total_threadgroups_per_mesh_grid(N)]] attribute and a non-zero value are specified, both values must match. Any value specified cannot exceed the device limit as documented in the “Metal Feature Set Tables” for “Maximum threadgroups per mesh grid”. Specifying this value is optional; it may be used to improve scheduling of the workload. If neither this value nor the shader attribute are used, the device’s maximum supported value is used instead.

pub fn setMaxTotalThreadgroupsPerMeshGrid( &self, max_total_threadgroups_per_mesh_grid: NSUInteger, )

Setter for maxTotalThreadgroupsPerMeshGrid.

pub fn objectBuffers(&self) -> Retained<MTLPipelineBufferDescriptorArray>

Available on crate feature MTLPipeline only.

Provide mutability information on the buffers used by objectFunction.

Specifying these values is optional; it may be used to optimize the shader code.

pub fn meshBuffers(&self) -> Retained<MTLPipelineBufferDescriptorArray>

Available on crate feature MTLPipeline only.

Provide mutability information on the buffers used by meshFunction.

Specifying these values is optional; it may be used to optimize the shader code.

pub fn fragmentBuffers(&self) -> Retained<MTLPipelineBufferDescriptorArray>

Available on crate feature MTLPipeline only.

Provide mutability information on the buffers used by fragmentFunction.

Specifying these values is optional; it may be used to optimize the shader code.

pub fn rasterSampleCount(&self) -> NSUInteger

The number of samples per fragment of the render pass in which this pipeline will be used.

pub unsafe fn setRasterSampleCount(&self, raster_sample_count: NSUInteger)

Setter for rasterSampleCount.

Safety

This might not be bounds-checked.

pub fn isAlphaToCoverageEnabled(&self) -> bool

Whether the alpha value exported by the fragment shader for the first color attachment is converted to a sample mask, which is subsequently AND-ed with the fragments’ sample mask

The default value is NO.

pub fn setAlphaToCoverageEnabled(&self, alpha_to_coverage_enabled: bool)

Setter for isAlphaToCoverageEnabled.

pub fn isAlphaToOneEnabled(&self) -> bool

Whether the alpha value exported by the fragment shader for all color attachments is modified to 1 (after evaluating alphaToCoverage).

The default value is NO.

pub fn setAlphaToOneEnabled(&self, alpha_to_one_enabled: bool)

Setter for isAlphaToOneEnabled.

pub fn isRasterizationEnabled(&self) -> bool

Whether rasterization is disabled, all primitives are dropped prior to rasterization.

The default value is YES.

pub fn setRasterizationEnabled(&self, rasterization_enabled: bool)

Setter for isRasterizationEnabled.

pub fn maxVertexAmplificationCount(&self) -> NSUInteger

The maximum value that can be passed to setVertexAmplificationCount when using this pipeline.

The default value is 1. The value must be supported by the device, which can be checked with supportsVertexAmplificationCount.

pub unsafe fn setMaxVertexAmplificationCount( &self, max_vertex_amplification_count: NSUInteger, )

Setter for maxVertexAmplificationCount.

Safety

This might not be bounds-checked.

pub fn colorAttachments( &self, ) -> Retained<MTLRenderPipelineColorAttachmentDescriptorArray>

Describes the color attachments of the render pass in which this pipeline will be used.

pub fn depthAttachmentPixelFormat(&self) -> MTLPixelFormat

Available on crate feature MTLPixelFormat only.

The pixel format of the depth attachment of the render pass in which this pipeline will be used.

The default value is MTLPixelFormatInvalid; indicating no depth attachment will be used.

pub fn setDepthAttachmentPixelFormat( &self, depth_attachment_pixel_format: MTLPixelFormat, )

Available on crate feature MTLPixelFormat only.

Setter for depthAttachmentPixelFormat.

pub fn stencilAttachmentPixelFormat(&self) -> MTLPixelFormat

Available on crate feature MTLPixelFormat only.

The pixel format of the stencil attachment of the render pass in which this pipeline will be used.

The default value is MTLPixelFormatInvalid; indicating no stencil attachment will be used.

pub fn setStencilAttachmentPixelFormat( &self, stencil_attachment_pixel_format: MTLPixelFormat, )

Available on crate feature MTLPixelFormat only.

Setter for stencilAttachmentPixelFormat.

pub fn supportIndirectCommandBuffers(&self) -> bool

Whether this pipeline will support being used by commands in an indirect command buffer.

The default value is NO.

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

Setter for supportIndirectCommandBuffers.

pub fn binaryArchives( &self, ) -> Option<Retained<NSArray<ProtocolObject<dyn MTLBinaryArchive>>>>

Available on crate feature MTLBinaryArchive only.

The set of MTLBinaryArchive to search for compiled code when creating the pipeline state.

Accelerate pipeline state creation by providing archives of compiled code such that no compilation needs to happen on the fast path.

See: MTLBinaryArchive

pub fn setBinaryArchives( &self, binary_archives: Option<&NSArray<ProtocolObject<dyn MTLBinaryArchive>>>, )

Available on crate feature MTLBinaryArchive only.

Setter for binaryArchives.

This is copied when set.

pub fn objectLinkedFunctions(&self) -> Retained<MTLLinkedFunctions>

Available on crate feature MTLLinkedFunctions only.

The set of functions to be linked with the pipeline state and accessed from the object function.

See: MTLLinkedFunctions

pub fn setObjectLinkedFunctions( &self, object_linked_functions: Option<&MTLLinkedFunctions>, )

Available on crate feature MTLLinkedFunctions only.

Setter for objectLinkedFunctions.

This is copied when set.

pub fn meshLinkedFunctions(&self) -> Retained<MTLLinkedFunctions>

Available on crate feature MTLLinkedFunctions only.

The set of functions to be linked with the pipeline state and accessed from the mesh function.

See: MTLLinkedFunctions

pub fn setMeshLinkedFunctions( &self, mesh_linked_functions: Option<&MTLLinkedFunctions>, )

Available on crate feature MTLLinkedFunctions only.

Setter for meshLinkedFunctions.

This is copied when set.

pub fn fragmentLinkedFunctions(&self) -> Retained<MTLLinkedFunctions>

Available on crate feature MTLLinkedFunctions only.

The set of functions to be linked with the pipeline state and accessed from the fragment function.

See: MTLLinkedFunctions

pub fn setFragmentLinkedFunctions( &self, fragment_linked_functions: Option<&MTLLinkedFunctions>, )

Available on crate feature MTLLinkedFunctions only.

Setter for fragmentLinkedFunctions.

This is copied when set.

pub fn reset(&self)

Restore all mesh pipeline descriptor properties to their default values.

pub fn shaderValidation(&self) -> MTLShaderValidation

Available on crate feature MTLPipeline only.

Toggle that determines whether Metal Shader Validation should be enabled or disabled for the pipeline.

The value can be overridden using MTL_SHADER_VALIDATION_ENABLE_PIPELINES or MTL_SHADER_VALIDATION_DISABLE_PIPELINES Environment Variables.

pub fn setShaderValidation(&self, shader_validation: MTLShaderValidation)

Available on crate feature MTLPipeline only.

Setter for shaderValidation.

pub fn requiredThreadsPerObjectThreadgroup(&self) -> MTLSize

Available on crate feature MTLTypes only.

Sets the required object threads-per-threadgroup during mesh draws. The threadsPerObjectThreadgroup argument of any draw must match to this value if it is set. Optional, unless the pipeline is going to use CooperativeTensors in which case this must be set. Setting this to a size of 0 in every dimension disables this property

pub fn setRequiredThreadsPerObjectThreadgroup( &self, required_threads_per_object_threadgroup: MTLSize, )

Available on crate feature MTLTypes only.

Setter for requiredThreadsPerObjectThreadgroup.

pub fn requiredThreadsPerMeshThreadgroup(&self) -> MTLSize

Available on crate feature MTLTypes only.

Sets the required mesh threads-per-threadgroup during mesh draws. The threadsPerMeshThreadgroup argument of any draw must match to this value if it is set. Optional, unless the pipeline is going to use CooperativeTensors in which case this must be set. Setting this to a size of 0 in every dimension disables this property

pub fn setRequiredThreadsPerMeshThreadgroup( &self, required_threads_per_mesh_threadgroup: MTLSize, )

Available on crate feature MTLTypes only.

Setter for requiredThreadsPerMeshThreadgroup.

impl MTLMeshRenderPipelineDescriptor

Methods declared on superclass NSObject.

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

pub fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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());

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.

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

Trait Implementations

impl AsRef<AnyObject> for MTLMeshRenderPipelineDescriptor

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<MTLMeshRenderPipelineDescriptor> for MTLMeshRenderPipelineDescriptor

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for MTLMeshRenderPipelineDescriptor

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for MTLMeshRenderPipelineDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTLMeshRenderPipelineDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTLMeshRenderPipelineDescriptor

const NAME: &'static str = "MTLMeshRenderPipelineDescriptor"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<MTLMeshRenderPipelineDescriptor as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for MTLMeshRenderPipelineDescriptor

type Result = MTLMeshRenderPipelineDescriptor

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for MTLMeshRenderPipelineDescriptor

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

Formats the value using the given formatter.

impl DefaultRetained for MTLMeshRenderPipelineDescriptor

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for MTLMeshRenderPipelineDescriptor

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for MTLMeshRenderPipelineDescriptor

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for MTLMeshRenderPipelineDescriptor

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MTLMeshRenderPipelineDescriptor

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for MTLMeshRenderPipelineDescriptor

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for MTLMeshRenderPipelineDescriptor

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for MTLMeshRenderPipelineDescriptor

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for MTLMeshRenderPipelineDescriptor

impl Eq for MTLMeshRenderPipelineDescriptor