Struct RenderPassDescriptor 

pub struct RenderPassDescriptor(/* private fields */);

A render pass descriptor that configures a render pass.

C++ equivalent: MTL::RenderPassDescriptor

Implementations

impl RenderPassDescriptor

pub unsafe fn from_raw(ptr: *mut c_void) -> Option<Self>

Create a RenderPassDescriptor from a raw pointer.

Safety

The pointer must be a valid Metal render pass descriptor object.

pub fn as_raw(&self) -> *mut c_void

Get the raw pointer.

pub fn new() -> Option<Self>

Create a new render pass descriptor.

C++ equivalent: RenderPassDescriptor::renderPassDescriptor()

pub fn color_attachments( &self, ) -> Option<RenderPassColorAttachmentDescriptorArray>

Get the array of color attachment descriptors.

C++ equivalent: RenderPassColorAttachmentDescriptorArray* colorAttachments() const

pub fn depth_attachment(&self) -> Option<RenderPassDepthAttachmentDescriptor>

Get the depth attachment descriptor.

C++ equivalent: RenderPassDepthAttachmentDescriptor* depthAttachment() const

pub fn set_depth_attachment( &self, attachment: Option<&RenderPassDepthAttachmentDescriptor>, )

Set the depth attachment descriptor.

C++ equivalent: void setDepthAttachment(const RenderPassDepthAttachmentDescriptor*)

pub fn stencil_attachment( &self, ) -> Option<RenderPassStencilAttachmentDescriptor>

Get the stencil attachment descriptor.

C++ equivalent: RenderPassStencilAttachmentDescriptor* stencilAttachment() const

pub fn set_stencil_attachment( &self, attachment: Option<&RenderPassStencilAttachmentDescriptor>, )

Set the stencil attachment descriptor.

C++ equivalent: void setStencilAttachment(const RenderPassStencilAttachmentDescriptor*)

pub fn visibility_result_buffer(&self) -> Option<Buffer>

Get the visibility result buffer.

C++ equivalent: Buffer* visibilityResultBuffer() const

pub fn set_visibility_result_buffer(&self, buffer: Option<&Buffer>)

Set the visibility result buffer.

C++ equivalent: void setVisibilityResultBuffer(const Buffer*)

pub fn visibility_result_type(&self) -> VisibilityResultType

Get the visibility result type.

C++ equivalent: VisibilityResultType visibilityResultType() const

pub fn set_visibility_result_type(&self, result_type: VisibilityResultType)

Set the visibility result type.

C++ equivalent: void setVisibilityResultType(VisibilityResultType)

pub fn render_target_width(&self) -> UInteger

Get the render target width.

C++ equivalent: NS::UInteger renderTargetWidth() const

pub fn set_render_target_width(&self, width: UInteger)

Set the render target width.

C++ equivalent: void setRenderTargetWidth(NS::UInteger)

pub fn render_target_height(&self) -> UInteger

Get the render target height.

C++ equivalent: NS::UInteger renderTargetHeight() const

pub fn set_render_target_height(&self, height: UInteger)

Set the render target height.

C++ equivalent: void setRenderTargetHeight(NS::UInteger)

pub fn render_target_array_length(&self) -> UInteger

Get the render target array length.

C++ equivalent: NS::UInteger renderTargetArrayLength() const

pub fn set_render_target_array_length(&self, length: UInteger)

Set the render target array length.

C++ equivalent: void setRenderTargetArrayLength(NS::UInteger)

pub fn default_raster_sample_count(&self) -> UInteger

Get the default raster sample count.

C++ equivalent: NS::UInteger defaultRasterSampleCount() const

pub fn set_default_raster_sample_count(&self, count: UInteger)

Set the default raster sample count.

C++ equivalent: void setDefaultRasterSampleCount(NS::UInteger)

pub fn set_sample_positions(&self, positions: &[SamplePosition])

Set the sample positions.

C++ equivalent: void setSamplePositions(const SamplePosition*, NS::UInteger)

pub fn get_sample_positions(&self, positions: &mut [SamplePosition]) -> UInteger

Get the sample positions.

C++ equivalent: NS::UInteger getSamplePositions(SamplePosition*, NS::UInteger)

pub fn tile_width(&self) -> UInteger

Get the tile width.

C++ equivalent: NS::UInteger tileWidth() const

pub fn set_tile_width(&self, width: UInteger)

Set the tile width.

C++ equivalent: void setTileWidth(NS::UInteger)

pub fn tile_height(&self) -> UInteger

Get the tile height.

C++ equivalent: NS::UInteger tileHeight() const

pub fn set_tile_height(&self, height: UInteger)

Set the tile height.

C++ equivalent: void setTileHeight(NS::UInteger)

pub fn threadgroup_memory_length(&self) -> UInteger

Get the threadgroup memory length.

C++ equivalent: NS::UInteger threadgroupMemoryLength() const

pub fn set_threadgroup_memory_length(&self, length: UInteger)

Set the threadgroup memory length.

C++ equivalent: void setThreadgroupMemoryLength(NS::UInteger)

pub fn imageblock_sample_length(&self) -> UInteger

Get the imageblock sample length.

C++ equivalent: NS::UInteger imageblockSampleLength() const

pub fn set_imageblock_sample_length(&self, length: UInteger)

Set the imageblock sample length.

C++ equivalent: void setImageblockSampleLength(NS::UInteger)

pub fn rasterization_rate_map(&self) -> *mut c_void

Get the rasterization rate map.

C++ equivalent: RasterizationRateMap* rasterizationRateMap() const

Returns a raw pointer to the rasterization rate map.

pub unsafe fn set_rasterization_rate_map(&self, rate_map: *const c_void)

Set the rasterization rate map.

C++ equivalent: void setRasterizationRateMap(const RasterizationRateMap*)

Safety

The rate_map pointer must be valid or null.

pub fn support_color_attachment_mapping(&self) -> bool

Check if color attachment mapping is supported.

C++ equivalent: bool supportColorAttachmentMapping() const

pub fn set_support_color_attachment_mapping(&self, support: bool)

Set whether color attachment mapping is supported.

C++ equivalent: void setSupportColorAttachmentMapping(bool)

Trait Implementations

impl Clone for RenderPassDescriptor

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RenderPassDescriptor

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

Formats the value using the given formatter.

impl Default for RenderPassDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Drop for RenderPassDescriptor

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for RenderPassDescriptor

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.

fn as_mut_ptr(&self) -> *mut c_void

Get the raw mutable pointer to the Objective-C object.

fn retain(&self) -> Self

where Self: Clone,

Retain the object, incrementing its reference count.

fn release(&self)

Release the object, decrementing its reference count.

fn autorelease(&self) -> Self

where Self: Clone,

Autorelease the object.

fn retain_count(&self) -> usize

Get the retain count of the object.

impl Send for RenderPassDescriptor

impl Sync for RenderPassDescriptor