Skip to main content

AccelerationStructureCommandEncoder

Struct AccelerationStructureCommandEncoder 

Source
pub struct AccelerationStructureCommandEncoder(/* private fields */);

Implementations§

Source§

impl AccelerationStructureCommandEncoder

Source

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

Create from a raw pointer.

§Safety

The pointer must be a valid Metal acceleration structure command encoder.

Source

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

Get the raw pointer.

Source

pub fn label(&self) -> Option<String>

Get the label.

C++ equivalent: NS::String* label() const

Source

pub fn set_label(&self, label: &str)

Set the label.

C++ equivalent: void setLabel(const NS::String*)

Source

pub fn end_encoding(&self)

End encoding commands.

C++ equivalent: void endEncoding()

Source

pub fn insert_debug_signpost(&self, name: &str)

Insert a debug signpost.

C++ equivalent: void insertDebugSignpost(const NS::String*)

Source

pub fn push_debug_group(&self, name: &str)

Push a debug group.

C++ equivalent: void pushDebugGroup(const NS::String*)

Source

pub fn pop_debug_group(&self)

Pop a debug group.

C++ equivalent: void popDebugGroup()

Source

pub fn build_acceleration_structure( &self, acceleration_structure: &AccelerationStructure, descriptor: &AccelerationStructureDescriptor, scratch_buffer: &Buffer, scratch_buffer_offset: UInteger, )

Build an acceleration structure.

C++ equivalent: void buildAccelerationStructure(AccelerationStructure*, AccelerationStructureDescriptor*, Buffer*, NS::UInteger)

Source

pub fn copy_acceleration_structure( &self, source: &AccelerationStructure, destination: &AccelerationStructure, )

Copy an acceleration structure.

C++ equivalent: void copyAccelerationStructure(AccelerationStructure*, AccelerationStructure*)

Source

pub fn copy_and_compact_acceleration_structure( &self, source: &AccelerationStructure, destination: &AccelerationStructure, )

Copy and compact an acceleration structure.

C++ equivalent: void copyAndCompactAccelerationStructure(AccelerationStructure*, AccelerationStructure*)

Source

pub fn refit_acceleration_structure( &self, source: &AccelerationStructure, descriptor: &AccelerationStructureDescriptor, destination: &AccelerationStructure, scratch_buffer: &Buffer, scratch_buffer_offset: UInteger, )

Refit an acceleration structure.

C++ equivalent: void refitAccelerationStructure(AccelerationStructure*, AccelerationStructureDescriptor*, AccelerationStructure*, Buffer*, NS::UInteger)

Source

pub fn refit_acceleration_structure_with_options( &self, source: &AccelerationStructure, descriptor: &AccelerationStructureDescriptor, destination: &AccelerationStructure, scratch_buffer: &Buffer, scratch_buffer_offset: UInteger, options: AccelerationStructureRefitOptions, )

Refit an acceleration structure with options.

C++ equivalent: void refitAccelerationStructure(AccelerationStructure*, AccelerationStructureDescriptor*, AccelerationStructure*, Buffer*, NS::UInteger, AccelerationStructureRefitOptions)

Source

pub fn write_compacted_acceleration_structure_size( &self, acceleration_structure: &AccelerationStructure, buffer: &Buffer, offset: UInteger, )

Write the compacted size of an acceleration structure.

C++ equivalent: void writeCompactedAccelerationStructureSize(AccelerationStructure*, Buffer*, NS::UInteger)

Source

pub fn write_compacted_acceleration_structure_size_with_type( &self, acceleration_structure: &AccelerationStructure, buffer: &Buffer, offset: UInteger, size_data_type: DataType, )

Write the compacted size of an acceleration structure with size data type.

C++ equivalent: void writeCompactedAccelerationStructureSize(AccelerationStructure*, Buffer*, NS::UInteger, DataType)

Source

pub unsafe fn sample_counters_in_buffer_ptr( &self, sample_buffer: *const c_void, sample_index: UInteger, barrier: bool, )

Sample counters in a buffer.

§Safety

The sample_buffer pointer must be valid.

C++ equivalent: void sampleCountersInBuffer(CounterSampleBuffer*, NS::UInteger, bool)

Source

pub fn wait_for_fence(&self, fence: &Fence)

Wait for a fence.

C++ equivalent: void waitForFence(Fence*)

Source

pub fn update_fence(&self, fence: &Fence)

Update a fence.

C++ equivalent: void updateFence(Fence*)

Source

pub fn use_resource<R: Referencing>(&self, resource: &R, usage: ResourceUsage)

Use a resource.

C++ equivalent: void useResource(Resource*, ResourceUsage)

Source

pub unsafe fn use_resources_ptr( &self, resources: *const *const c_void, count: UInteger, usage: ResourceUsage, )

Use multiple resources.

§Safety

The resources pointer must be valid for the given count.

Source

pub fn use_heap(&self, heap: &Heap)

Use a heap.

C++ equivalent: void useHeap(Heap*)

Source

pub unsafe fn use_heaps_ptr(&self, heaps: *const *const c_void, count: UInteger)

Use multiple heaps.

§Safety

The heaps pointer must be valid for the given count.

Trait Implementations§

Source§

impl Clone for AccelerationStructureCommandEncoder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AccelerationStructureCommandEncoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for AccelerationStructureCommandEncoder

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Referencing for AccelerationStructureCommandEncoder

Source§

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.
Source§

fn as_mut_ptr(&self) -> *mut c_void

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

fn retain(&self) -> Self
where Self: Clone,

Retain the object, incrementing its reference count. Read more
Source§

fn release(&self)

Release the object, decrementing its reference count. Read more
Source§

fn autorelease(&self) -> Self
where Self: Clone,

Autorelease the object. Read more
Source§

fn retain_count(&self) -> usize

Get the retain count of the object. Read more
Source§

impl Send for AccelerationStructureCommandEncoder

Source§

impl Sync for AccelerationStructureCommandEncoder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.