Struct MTLRenderPassDescriptor

Source

pub struct MTLRenderPassDescriptor { /* private fields */ }

Available on crate feature MTLRenderPass only.

Expand description

MTLRenderPassDescriptor represents a collection of attachments to be used to create a concrete render command encoder

Implementations§

Source §

impl MTLRenderPassDescriptor

Source

pub fn renderPassDescriptor() -> Retained<MTLRenderPassDescriptor>

Create an autoreleased default frame buffer descriptor

Source

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

Source

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

Source

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

Setter for depthAttachment.

This is copied when set.

Source

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

Source

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

Setter for stencilAttachment.

This is copied when set.

Source

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

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Buffer into which samples passing the depth and stencil tests are counted.

Source

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

Available on crate features MTLAllocation and MTLBuffer and MTLResource only.

Setter for visibilityResultBuffer.

Source

pub fn renderTargetArrayLength(&self) -> NSUInteger

The number of active layers

Source

pub fn setRenderTargetArrayLength(&self, render_target_array_length: NSUInteger)

Setter for renderTargetArrayLength.

Source

pub fn imageblockSampleLength(&self) -> NSUInteger

The per sample size in bytes of the largest explicit imageblock layout in the renderPass.

Source

pub fn setImageblockSampleLength(&self, imageblock_sample_length: NSUInteger)

Setter for imageblockSampleLength.

Source

pub fn threadgroupMemoryLength(&self) -> NSUInteger

The per tile size in bytes of the persistent threadgroup memory allocation.

Source

pub fn setThreadgroupMemoryLength(&self, threadgroup_memory_length: NSUInteger)

Setter for threadgroupMemoryLength.

Source

pub fn tileWidth(&self) -> NSUInteger

The width in pixels of the tile.

Defaults to 0. Zero means Metal chooses a width that fits within the local memory.

Source

pub fn setTileWidth(&self, tile_width: NSUInteger)

Setter for tileWidth.

Source

pub fn tileHeight(&self) -> NSUInteger

The height in pixels of the tile.

Defaults to 0. Zero means Metal chooses a height that fits within the local memory.

Source

pub fn setTileHeight(&self, tile_height: NSUInteger)

Setter for tileHeight.

Source

pub fn defaultRasterSampleCount(&self) -> NSUInteger

The raster sample count for the render pass when no attachments are given.

Source

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

Setter for defaultRasterSampleCount.

Source

pub fn renderTargetWidth(&self) -> NSUInteger

The width in pixels to constrain the render target to.

Defaults to 0. If non-zero the value must be smaller than or equal to the minimum width of all attachments.

Source

pub fn setRenderTargetWidth(&self, render_target_width: NSUInteger)

Setter for renderTargetWidth.

Source

pub fn renderTargetHeight(&self) -> NSUInteger

The height in pixels to constrain the render target to.

Defaults to 0. If non-zero the value must be smaller than or equal to the minimum height of all attachments.

Source

pub fn setRenderTargetHeight(&self, render_target_height: NSUInteger)

Setter for renderTargetHeight.

Source

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

Available on crate feature MTLTypes only.

Configure the custom sample positions, to be used in MSAA rendering (i.e. when sample count > 1).

Parameter positions: The source array for custom sample position data.

Parameter count: Specifies the length of the positions array, and must 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.

Source

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

Available on crate feature MTLTypes only.

Retrieve the previously configured custom sample positions. The positions input array will only be modified when count specifies a length sufficient for the number of previously configured positions.

Parameter positions: The destination array for custom sample position data.

Parameter count: Specifies the length of the positions array, which must be large enough to hold all configured 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.

Source

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

Available on crate feature MTLRasterizationRate only.

The variable rasterization rate map to use when rendering this pass, or nil to not use variable rasterization rate.

The default value is nil. Enabling variable rasterization rate allows for decreasing the rasterization rate in unimportant regions of screen space.

Source

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

Available on crate feature MTLRasterizationRate only.

Setter for rasterizationRateMap.

Source

pub fn sampleBufferAttachments( &self, ) -> Retained<MTLRenderPassSampleBufferAttachmentDescriptorArray>

An array of sample buffers and associated sample indices.

Source

pub fn visibilityResultType(&self) -> MTLVisibilityResultType

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

Source

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

Setter for visibilityResultType.

Source

pub fn supportColorAttachmentMapping(&self) -> bool

Specifies if the render pass should support color attachment mapping.

Source

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

Setter for supportColorAttachmentMapping.

Source §

impl MTLRenderPassDescriptor

Methods declared on superclass NSObject.

Source

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

Source

pub fn new() -> Retained<Self>

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