Struct MTL4RenderPipelineDescriptor 

pub struct MTL4RenderPipelineDescriptor { /* private fields */ }

Available on crate features MTL4PipelineState and MTL4RenderPipeline only.

Groups together properties to create a render pipeline state object.

Compared to MTLRenderPipelineDescriptor, this interface doesn’t offer a mechanism to hint to Metal mutability of vertex and fragment buffers. Additionally, using this descriptor, you don’t specify binary archives.

See also Apple’s documentation

Implementations

impl MTL4RenderPipelineDescriptor

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

Available on crate feature MTL4FunctionDescriptor only.

Assigns the shader function that this pipeline executes for each vertex.

pub fn setVertexFunctionDescriptor( &self, vertex_function_descriptor: Option<&MTL4FunctionDescriptor>, )

Available on crate feature MTL4FunctionDescriptor only.

Setter for vertexFunctionDescriptor.

This is copied when set.

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

Available on crate feature MTL4FunctionDescriptor only.

Assigns the shader function that this pipeline executes for each fragment.

When you don’t specify a fragment function, you need to disable rasterization by setting property rasterizationEnabled to false.

pub fn setFragmentFunctionDescriptor( &self, fragment_function_descriptor: Option<&MTL4FunctionDescriptor>, )

Available on crate feature MTL4FunctionDescriptor only.

Setter for fragmentFunctionDescriptor.

This is copied when set.

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

Available on crate feature MTLVertexDescriptor only.

Configures an optional vertex descriptor for the vertex input.

A vertex descriptor specifies the layout of your vertex data, allowing your vertex shaders to access the content in your vertex arrays via the [[stage_in]] attribute in Metal Shading Language.

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

Available on crate feature MTLVertexDescriptor only.

Setter for vertexDescriptor.

This is copied when set.

pub fn rasterSampleCount(&self) -> NSUInteger

Controls the number of samples this pipeline applies for each fragment.

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

Setter for rasterSampleCount.

Safety

This might not be bounds-checked.

pub fn alphaToCoverageState(&self) -> MTL4AlphaToCoverageState

Indicates whether to read and use the alpha channel fragment output of color attachments to compute a sample coverage mask.

pub fn setAlphaToCoverageState( &self, alpha_to_coverage_state: MTL4AlphaToCoverageState, )

Setter for alphaToCoverageState.

pub fn alphaToOneState(&self) -> MTL4AlphaToOneState

Indicates whether the pipeline forces alpha channel values of color attachments to the largest representable value.

pub fn setAlphaToOneState(&self, alpha_to_one_state: MTL4AlphaToOneState)

Setter for alphaToOneState.

pub fn isRasterizationEnabled(&self) -> bool

Determines whether the pipeline rasterizes primitives.

By default, this value is <doc ://com.apple.documentation/documentation/swift/true>, specifying that this pipeline rasterizes primitives. Set this property to <doc ://com.apple.documentation/documentation/swift/false> when you don’t provide a fragment shader function via function fragmentFunctionDescriptor.

pub fn setRasterizationEnabled(&self, rasterization_enabled: bool)

Setter for isRasterizationEnabled.

pub fn maxVertexAmplificationCount(&self) -> NSUInteger

Determines the maximum value that can you can pass as the pipeline’s amplification count.

This property controls the maximum count you pass to MTL4RenderCommandEncoder/setVertexAmplificationCount:viewMappings: when using vertex amplification with this pipeline.

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<MTL4RenderPipelineColorAttachmentDescriptorArray>

Accesses an array containing descriptions of the color attachments this pipeline writes to.

pub fn inputPrimitiveTopology(&self) -> MTLPrimitiveTopologyClass

Available on crate feature MTLRenderPipeline only.

Assigns type of primitive topology this pipeline renders.

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

Available on crate feature MTLRenderPipeline only.

Setter for inputPrimitiveTopology.

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

Available on crate feature MTL4LinkingDescriptor only.

Provides static linking information for the vertex stage of the render pipeline.

Use this property to link extra shader functions to the vertex stage of the render pipeline.

pub fn setVertexStaticLinkingDescriptor( &self, vertex_static_linking_descriptor: Option<&MTL4StaticLinkingDescriptor>, )

Available on crate feature MTL4LinkingDescriptor only.

Setter for vertexStaticLinkingDescriptor.

This is copied when set.

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

Available on crate feature MTL4LinkingDescriptor only.

Provides static linking information for the fragment stage of the render pipeline.

Use this property to link extra shader functions to the fragment stage of the render pipeline.

pub fn setFragmentStaticLinkingDescriptor( &self, fragment_static_linking_descriptor: Option<&MTL4StaticLinkingDescriptor>, )

Available on crate feature MTL4LinkingDescriptor only.

Setter for fragmentStaticLinkingDescriptor.

This is copied when set.

pub fn supportVertexBinaryLinking(&self) -> bool

Indicates whether you can use the render pipeline to create new pipelines by adding binary functions to the vertex shader function’s callable functions list.

pub fn setSupportVertexBinaryLinking(&self, support_vertex_binary_linking: bool)

Setter for supportVertexBinaryLinking.

pub fn supportFragmentBinaryLinking(&self) -> bool

Indicates whether you can use the pipeline to create new pipelines by adding binary functions to the fragment shader function’s callable functions list.

pub fn setSupportFragmentBinaryLinking( &self, support_fragment_binary_linking: bool, )

Setter for supportFragmentBinaryLinking.

pub fn colorAttachmentMappingState( &self, ) -> MTL4LogicalToPhysicalColorAttachmentMappingState

Configures a logical-to-physical rendering remap state.

Use this property to assign how a MTL4RenderCommandEncoder instance maps the output of your fragment shader to physical color attachments.

pub fn setColorAttachmentMappingState( &self, color_attachment_mapping_state: MTL4LogicalToPhysicalColorAttachmentMappingState, )

Setter for colorAttachmentMappingState.

pub fn supportIndirectCommandBuffers( &self, ) -> MTL4IndirectCommandBufferSupportState

Indicates whether the pipeline supports indirect command buffers.

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

Setter for supportIndirectCommandBuffers.

pub fn reset(&self)

Resets this descriptor to its default state.

impl MTL4RenderPipelineDescriptor

Methods declared on superclass NSObject.

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

pub fn new() -> Retained<Self>

Methods from Deref<Target = MTL4PipelineDescriptor>

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.

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

Setter for label.

This is copied when set.

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

Provides compile-time options when you build the pipeline.

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

Setter for options.

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 MTL4RenderPipelineDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MTL4PipelineDescriptor> for MTL4RenderPipelineDescriptor

fn as_ref(&self) -> &MTL4PipelineDescriptor

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

impl AsRef<MTL4RenderPipelineDescriptor> for MTL4RenderPipelineDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MTL4RenderPipelineDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MTL4RenderPipelineDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MTL4PipelineDescriptor> for MTL4RenderPipelineDescriptor

fn borrow(&self) -> &MTL4PipelineDescriptor

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTL4RenderPipelineDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTL4RenderPipelineDescriptor

const NAME: &'static str = "MTL4RenderPipelineDescriptor"

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

type Super = MTL4PipelineDescriptor

The superclass of this class.

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

type Result = MTL4RenderPipelineDescriptor

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

impl Debug for MTL4RenderPipelineDescriptor

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

Formats the value using the given formatter.

impl DefaultRetained for MTL4RenderPipelineDescriptor

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for MTL4RenderPipelineDescriptor

type Target = MTL4PipelineDescriptor

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MTL4RenderPipelineDescriptor

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 MTL4RenderPipelineDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MTL4RenderPipelineDescriptor

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 MTL4RenderPipelineDescriptor

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 MTL4RenderPipelineDescriptor

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 MTL4RenderPipelineDescriptor

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

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

impl DowncastTarget for MTL4RenderPipelineDescriptor

impl Eq for MTL4RenderPipelineDescriptor