Struct MTL4TileRenderPipelineDescriptor

Source

pub struct MTL4TileRenderPipelineDescriptor { /* private fields */ }

Available on crate features MTL4PipelineState and MTL4TileRenderPipeline only.

Expand description

Groups together properties you use to create a tile render pipeline state object.

Implementations§

Source §

impl MTL4TileRenderPipelineDescriptor

Source

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

Available on crate feature MTL4FunctionDescriptor only.

Configures the tile function that the render pipeline executes for each tile in the tile shader stage.

Source

pub fn setTileFunctionDescriptor( &self, tile_function_descriptor: Option<&MTL4FunctionDescriptor>, )

Available on crate feature MTL4FunctionDescriptor only.

Setter for tileFunctionDescriptor.

This is copied when set.

Source

pub fn rasterSampleCount(&self) -> NSUInteger

Configures the number of samples per pixel used for multisampling.

Source

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

Setter for rasterSampleCount.

§Safety

This might not be bounds-checked.

Source

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

Available on crate feature MTLRenderPipeline only.

Access an array of descriptors that configure the properties of each color attachment in the tile render pipeline.

Source

pub fn threadgroupSizeMatchesTileSize(&self) -> bool

Indicating whether the size of the threadgroup matches the size of a tile in the render pipeline.

Source

pub fn setThreadgroupSizeMatchesTileSize( &self, threadgroup_size_matches_tile_size: bool, )

Setter for threadgroupSizeMatchesTileSize.

Source

pub fn maxTotalThreadsPerThreadgroup(&self) -> NSUInteger

Sets the maximum number of threads that the GPU can execute simultaneously within a single threadgroup in the tile render pipeline.

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.

Sets the required number of threads per threadgroup for tile dispatches.

This value is typically optional, except in the cases where the tile function that tileFunctionDescriptor references uses CooperativeTensors. In this case, you need to provide a non-zero value to this property.

Additionally, when you set this value, the threadsPerTile argument of any tile dispatch needs to match it.

Setting this value to a size of 0 in every dimension disables this property.

Source

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

Available on crate feature MTLTypes only.

Setter for requiredThreadsPerThreadgroup.

Source

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

Available on crate feature MTL4LinkingDescriptor only.

Configures an object that contains information about functions to link to the tile render pipeline when Metal builds it.

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

Indicates whether the pipeline supports linking binary functions.

Source

pub fn setSupportBinaryLinking(&self, support_binary_linking: bool)

Setter for supportBinaryLinking.

Source

pub fn reset(&self)

Resets the descriptor to the default state.

Source §

impl MTL4TileRenderPipelineDescriptor

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