Struct MTL4RenderPassDescriptor 

pub struct MTL4RenderPassDescriptor { /* private fields */ }

Available on crate feature MTL4RenderPass only.

Describes a render pass.

You use render pass descriptors to create instances of MTL4RenderCommandEncoder and encode draw commands into instances of MTL4CommandBuffer.

To create render command encoders, you typically call MTL4CommandBuffer/renderCommandEncoderWithDescriptor:. The MTL4CommandBuffer/renderCommandEncoderWithDescriptor:options: variant of this method allows you to specify additional options to encode a render pass in parallel from multiple CPU cores by creating suspending and resuming render passes.

See also Apple’s documentation

Implementations

impl MTL4RenderPassDescriptor

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

Available on crate feature MTLRenderPass only.

Accesses the array of state information for render attachments that store color data.

pub fn depthAttachment( &self, ) -> Retained<MTLRenderPassDepthAttachmentDescriptor>

Available on crate feature MTLRenderPass only.

Accesses state information for a render attachment that stores depth data.

pub fn setDepthAttachment( &self, depth_attachment: Option<&MTLRenderPassDepthAttachmentDescriptor>, )

Available on crate feature MTLRenderPass only.

Setter for depthAttachment.

This is copied when set.

pub fn stencilAttachment( &self, ) -> Retained<MTLRenderPassStencilAttachmentDescriptor>

Available on crate feature MTLRenderPass only.

Accesses state information for a render attachment that stores stencil data.

pub fn setStencilAttachment( &self, stencil_attachment: Option<&MTLRenderPassStencilAttachmentDescriptor>, )

Available on crate feature MTLRenderPass only.

Setter for stencilAttachment.

This is copied when set.

pub fn renderTargetArrayLength(&self) -> NSUInteger

Assigns the number of layers that all attachments this descriptor references have.

pub fn setRenderTargetArrayLength(&self, render_target_array_length: NSUInteger)

Setter for renderTargetArrayLength.

pub fn imageblockSampleLength(&self) -> NSUInteger

Assigns the per-sample size, in bytes, of the largest explicit imageblock layout in the render pass.

pub fn setImageblockSampleLength(&self, imageblock_sample_length: NSUInteger)

Setter for imageblockSampleLength.

pub fn threadgroupMemoryLength(&self) -> NSUInteger

Assigns the per-tile size, in bytes, of the persistent threadgroup memory allocation of this render pass.

pub fn setThreadgroupMemoryLength(&self, threadgroup_memory_length: NSUInteger)

Setter for threadgroupMemoryLength.

pub fn tileWidth(&self) -> NSUInteger

The width of the tiles, in pixels, a render pass you create with this descriptor applies to its attachments.

For tile-based rendering, Metal divides each render attachment into smaller regions, or tiles. The property’s default is 0, which tells Metal to select a size that fits in tile memory.

See for more information about tiles, tile memory, and deferred rendering.

pub fn setTileWidth(&self, tile_width: NSUInteger)

Setter for tileWidth.

pub fn tileHeight(&self) -> NSUInteger

The height of the tiles, in pixels, a render pass you create with this descriptor applies to its attachments.

For tile-based rendering, Metal divides each render attachment into smaller regions, or tiles. The property’s default is 0, which tells Metal to select a size that fits in tile memory.

See for more information about tiles, tile memory, and deferred rendering.

pub fn setTileHeight(&self, tile_height: NSUInteger)

Setter for tileHeight.

pub fn defaultRasterSampleCount(&self) -> NSUInteger

Sets the default raster sample count for the render pass when it references no attachments.

pub unsafe fn setDefaultRasterSampleCount( &self, default_raster_sample_count: NSUInteger, )

Setter for defaultRasterSampleCount.

Safety

This might not be bounds-checked.

pub fn renderTargetWidth(&self) -> NSUInteger

Sets the width, in pixels, to which Metal constrains the render target.

When this value is non-zero, you need to assign it to be smaller than or equal to the minimum width of all attachments.

The default value of this property is 0.

pub fn setRenderTargetWidth(&self, render_target_width: NSUInteger)

Setter for renderTargetWidth.

pub fn renderTargetHeight(&self) -> NSUInteger

Sets the height, in pixels, to which Metal constrains the render target.

When this value is non-zero, you need to assign it to be smaller than or equal to the minimum height of all attachments.

The default value of this property is 0.

pub fn setRenderTargetHeight(&self, render_target_height: NSUInteger)

Setter for renderTargetHeight.

pub fn rasterizationRateMap( &self, ) -> Option<Retained<ProtocolObject<dyn MTLRasterizationRateMap>>>

Available on crate feature MTLRasterizationRate only.

Assigns an optional variable rasterization rate map that Metal uses in the render pass.

Enabling variable rasterization rate allows Metal to decrease the rasterization rate, typically in unimportant regions of color attachments, to accelerate processing.

When set to nil, the default, Metal doesn’t use variable rasterization rate.

pub fn setRasterizationRateMap( &self, rasterization_rate_map: Option<&ProtocolObject<dyn MTLRasterizationRateMap>>, )

Available on crate feature MTLRasterizationRate only.

Setter for rasterizationRateMap.

pub fn visibilityResultBuffer( &self, ) -> Option<Retained<ProtocolObject<dyn MTLBuffer>>>

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Configures a buffer into which Metal writes counts of fragments (pixels) passing the depth and stencil tests.

pub unsafe fn setVisibilityResultBuffer( &self, visibility_result_buffer: Option<&ProtocolObject<dyn MTLBuffer>>, )

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Setter for visibilityResultBuffer.

Safety

• visibility_result_buffer may need to be synchronized.
• visibility_result_buffer may be unretained, you must ensure it is kept alive while in use.
• visibility_result_buffer contents should be of the correct type.

pub fn visibilityResultType(&self) -> MTLVisibilityResultType

Available on crate feature MTLRenderPass only.

Determines if Metal accumulates visibility results between render encoders or resets them.

pub fn setVisibilityResultType( &self, visibility_result_type: MTLVisibilityResultType, )

Available on crate feature MTLRenderPass only.

Setter for visibilityResultType.

pub unsafe fn setSamplePositions_count( &self, positions: *const MTLSamplePosition, count: NSUInteger, )

Available on crate feature MTLTypes only.

Configures the custom sample positions to use in MSAA rendering.

• Parameters:
• positions: Array of MTLSamplePosition instances.
• count: Number of MTLSamplePosition instances in the array. This value needs to be a valid sample count, or 0 to disable custom sample positions.

Safety

• positions must be a valid pointer or null.
• count might not be bounds-checked.

pub unsafe fn getSamplePositions_count( &self, positions: *mut MTLSamplePosition, count: NSUInteger, ) -> NSUInteger

Available on crate feature MTLTypes only.

Retrieves the previously-configured custom sample positions.

This method stores the app’s last set custom sample positions into an output array. Metal only modifies the array when the count parameter consists of a length sufficient to store the number of sample positions.

• Parameters:

• positions: The destination array where Metal stores MTLSamplePosition instances.

• count: Number of MTLSamplePosition instances in the array. This array needs to be large enough to store all sample positions.

• Returns: The number of previously-configured custom sample positions.

Safety

• positions must be a valid pointer or null.
• count might not be bounds-checked.

pub fn supportColorAttachmentMapping(&self) -> bool

Controls if the render pass supports color attachment mapping.

pub fn setSupportColorAttachmentMapping( &self, support_color_attachment_mapping: bool, )

Setter for supportColorAttachmentMapping.

impl MTL4RenderPassDescriptor

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 MTL4RenderPassDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MTL4RenderPassDescriptor> for MTL4RenderPassDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MTL4RenderPassDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MTL4RenderPassDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTL4RenderPassDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTL4RenderPassDescriptor

const NAME: &'static str = "MTL4RenderPassDescriptor"

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

type Super = NSObject

The superclass of this class.

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

type Result = MTL4RenderPassDescriptor

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

impl Debug for MTL4RenderPassDescriptor

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

Formats the value using the given formatter.

impl DefaultRetained for MTL4RenderPassDescriptor

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for MTL4RenderPassDescriptor

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MTL4RenderPassDescriptor

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 MTL4RenderPassDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MTL4RenderPassDescriptor

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 MTL4RenderPassDescriptor

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 MTL4RenderPassDescriptor

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 MTL4RenderPassDescriptor

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

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

impl DowncastTarget for MTL4RenderPassDescriptor

impl Eq for MTL4RenderPassDescriptor