Struct MTLRenderPipelineDescriptor 

pub struct MTLRenderPipelineDescriptor { /* private fields */ }

Available on crate feature MTLRenderPipeline only.

Apple’s documentation

Implementations

impl MTLRenderPipelineDescriptor

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

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

Setter for label.

This is copied when set.

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

Available on crate feature MTLLibrary only.

pub fn setVertexFunction( &self, vertex_function: Option<&ProtocolObject<dyn MTLFunction>>, )

Available on crate feature MTLLibrary only.

Setter for vertexFunction.

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

Available on crate feature MTLLibrary only.

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

Available on crate feature MTLLibrary only.

Setter for fragmentFunction.

pub fn vertexDescriptor(&self) -> Option<Retained<MTLVertexDescriptor>>

Available on crate feature MTLVertexDescriptor only.

pub fn setVertexDescriptor( &self, vertex_descriptor: Option<&MTLVertexDescriptor>, )

Available on crate feature MTLVertexDescriptor only.

Setter for vertexDescriptor.

This is copied when set.

pub fn sampleCount(&self) -> NSUInteger

👎Deprecated

pub fn setSampleCount(&self, sample_count: NSUInteger)

👎Deprecated

Setter for sampleCount.

pub fn rasterSampleCount(&self) -> NSUInteger

pub fn setRasterSampleCount(&self, raster_sample_count: NSUInteger)

Setter for rasterSampleCount.

pub fn isAlphaToCoverageEnabled(&self) -> bool

pub fn setAlphaToCoverageEnabled(&self, alpha_to_coverage_enabled: bool)

Setter for isAlphaToCoverageEnabled.

pub fn isAlphaToOneEnabled(&self) -> bool

pub fn setAlphaToOneEnabled(&self, alpha_to_one_enabled: bool)

Setter for isAlphaToOneEnabled.

pub fn isRasterizationEnabled(&self) -> bool

pub fn setRasterizationEnabled(&self, rasterization_enabled: bool)

Setter for isRasterizationEnabled.

pub fn maxVertexAmplificationCount(&self) -> NSUInteger

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>

pub fn depthAttachmentPixelFormat(&self) -> MTLPixelFormat

Available on crate feature MTLPixelFormat only.

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.

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

Available on crate feature MTLPixelFormat only.

Setter for stencilAttachmentPixelFormat.

pub fn inputPrimitiveTopology(&self) -> MTLPrimitiveTopologyClass

pub unsafe fn setInputPrimitiveTopology( &self, input_primitive_topology: MTLPrimitiveTopologyClass, )

Setter for inputPrimitiveTopology.

pub fn tessellationPartitionMode(&self) -> MTLTessellationPartitionMode

pub unsafe fn setTessellationPartitionMode( &self, tessellation_partition_mode: MTLTessellationPartitionMode, )

Setter for tessellationPartitionMode.

pub fn maxTessellationFactor(&self) -> NSUInteger

pub unsafe fn setMaxTessellationFactor( &self, max_tessellation_factor: NSUInteger, )

Setter for maxTessellationFactor.

pub fn isTessellationFactorScaleEnabled(&self) -> bool

pub fn setTessellationFactorScaleEnabled( &self, tessellation_factor_scale_enabled: bool, )

Setter for isTessellationFactorScaleEnabled.

pub fn tessellationFactorFormat(&self) -> MTLTessellationFactorFormat

pub fn setTessellationFactorFormat( &self, tessellation_factor_format: MTLTessellationFactorFormat, )

Setter for tessellationFactorFormat.

pub fn tessellationControlPointIndexType( &self, ) -> MTLTessellationControlPointIndexType

pub unsafe fn setTessellationControlPointIndexType( &self, tessellation_control_point_index_type: MTLTessellationControlPointIndexType, )

Setter for tessellationControlPointIndexType.

pub fn tessellationFactorStepFunction( &self, ) -> MTLTessellationFactorStepFunction

pub fn setTessellationFactorStepFunction( &self, tessellation_factor_step_function: MTLTessellationFactorStepFunction, )

Setter for tessellationFactorStepFunction.

pub fn tessellationOutputWindingOrder(&self) -> MTLWinding

Available on crate feature MTLRenderCommandEncoder only.

pub fn setTessellationOutputWindingOrder( &self, tessellation_output_winding_order: MTLWinding, )

Available on crate feature MTLRenderCommandEncoder only.

Setter for tessellationOutputWindingOrder.

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

Available on crate feature MTLPipeline only.

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

Available on crate feature MTLPipeline only.

pub fn supportIndirectCommandBuffers(&self) -> bool

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 vertexPreloadedLibraries( &self, ) -> Retained<NSArray<ProtocolObject<dyn MTLDynamicLibrary>>>

Available on crate feature MTLDynamicLibrary only.

The set of MTLDynamicLibrary to use to resolve external symbols for the vertexFunction before considering symbols from dependent MTLDynamicLibrary.

Typical workflows use the libraries property of MTLCompileOptions to record dependent libraries at compile time without having to use vertexPreloadedLibraries. This property can be used to override symbols from dependent libraries for experimentation or evaluating alternative implementations. It can also be used to provide dynamic libraries that are dynamically created (for example, from source) that have no stable installName that can be used to automatically load from the file system.

See: MTLDynamicLibrary

pub fn setVertexPreloadedLibraries( &self, vertex_preloaded_libraries: &NSArray<ProtocolObject<dyn MTLDynamicLibrary>>, )

Available on crate feature MTLDynamicLibrary only.

Setter for vertexPreloadedLibraries.

This is copied when set.

pub fn fragmentPreloadedLibraries( &self, ) -> Retained<NSArray<ProtocolObject<dyn MTLDynamicLibrary>>>

Available on crate feature MTLDynamicLibrary only.

The set of MTLDynamicLibrary to use to resolve external symbols for the fragmentFunction before considering symbols from dependent MTLDynamicLibrary.

Typical workflows use the libraries property of MTLCompileOptions to record dependent libraries at compile time without having to use fragmentPreloadedLibraries. This property can be used to override symbols from dependent libraries for experimentation or evaluating alternative implementations. It can also be used to provide dynamic libraries that are dynamically created (for example, from source) that have no stable installName that can be used to automatically load from the file system.

See: MTLDynamicLibrary

pub fn setFragmentPreloadedLibraries( &self, fragment_preloaded_libraries: &NSArray<ProtocolObject<dyn MTLDynamicLibrary>>, )

Available on crate feature MTLDynamicLibrary only.

Setter for fragmentPreloadedLibraries.

This is copied when set.

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

Available on crate feature MTLLinkedFunctions only.

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

See: MTLLinkedFunctions

pub fn setVertexLinkedFunctions( &self, vertex_linked_functions: Option<&MTLLinkedFunctions>, )

Available on crate feature MTLLinkedFunctions only.

Setter for vertexLinkedFunctions.

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 supportAddingVertexBinaryFunctions(&self) -> bool

This flag makes this pipeline support creating a new pipeline by adding binary functions.

pub fn setSupportAddingVertexBinaryFunctions( &self, support_adding_vertex_binary_functions: bool, )

Setter for supportAddingVertexBinaryFunctions.

pub fn supportAddingFragmentBinaryFunctions(&self) -> bool

This flag makes this pipeline support creating a new pipeline by adding binary functions.

pub fn setSupportAddingFragmentBinaryFunctions( &self, support_adding_fragment_binary_functions: bool, )

Setter for supportAddingFragmentBinaryFunctions.

pub fn maxVertexCallStackDepth(&self) -> NSUInteger

The maximum depth of the call stack in stack frames from the shader. Defaults to 1 additional stack frame.

pub fn setMaxVertexCallStackDepth( &self, max_vertex_call_stack_depth: NSUInteger, )

Setter for maxVertexCallStackDepth.

pub fn maxFragmentCallStackDepth(&self) -> NSUInteger

The maximum depth of the call stack in stack frames from the shader. Defaults to 1 additional stack frame.

pub fn setMaxFragmentCallStackDepth( &self, max_fragment_call_stack_depth: NSUInteger, )

Setter for maxFragmentCallStackDepth.

pub fn reset(&self)

Restore all 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.

impl MTLRenderPipelineDescriptor

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 MTLRenderPipelineDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MTLRenderPipelineDescriptor> for MTLRenderPipelineDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MTLRenderPipelineDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MTLRenderPipelineDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTLRenderPipelineDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTLRenderPipelineDescriptor

const NAME: &'static str = "MTLRenderPipelineDescriptor"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<MTLRenderPipelineDescriptor 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 MTLRenderPipelineDescriptor

type Result = MTLRenderPipelineDescriptor

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

impl Debug for MTLRenderPipelineDescriptor

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

Formats the value using the given formatter.

impl DefaultRetained for MTLRenderPipelineDescriptor

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for MTLRenderPipelineDescriptor

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MTLRenderPipelineDescriptor

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 MTLRenderPipelineDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MTLRenderPipelineDescriptor

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 MTLRenderPipelineDescriptor

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 MTLRenderPipelineDescriptor

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 MTLRenderPipelineDescriptor

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

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

impl DowncastTarget for MTLRenderPipelineDescriptor

impl Eq for MTLRenderPipelineDescriptor