Trait MTLAccelerationStructureCommandEncoder

Source

pub unsafe trait MTLAccelerationStructureCommandEncoder: MTLCommandEncoder {
Show 14 methods    // Provided methods
    fn buildAccelerationStructure_descriptor_scratchBuffer_scratchBufferOffset(
        &self,
        acceleration_structure: &ProtocolObject<dyn MTLAccelerationStructure>,
        descriptor: &MTLAccelerationStructureDescriptor,
        scratch_buffer: &ProtocolObject<dyn MTLBuffer>,
        scratch_buffer_offset: NSUInteger,
    )
       where Self: Sized + Message { ... }
    unsafe fn refitAccelerationStructure_descriptor_destination_scratchBuffer_scratchBufferOffset(
        &self,
        source_acceleration_structure: &ProtocolObject<dyn MTLAccelerationStructure>,
        descriptor: &MTLAccelerationStructureDescriptor,
        destination_acceleration_structure: Option<&ProtocolObject<dyn MTLAccelerationStructure>>,
        scratch_buffer: Option<&ProtocolObject<dyn MTLBuffer>>,
        scratch_buffer_offset: NSUInteger,
    )
       where Self: Sized + Message { ... }
    unsafe fn refitAccelerationStructure_descriptor_destination_scratchBuffer_scratchBufferOffset_options(
        &self,
        source_acceleration_structure: &ProtocolObject<dyn MTLAccelerationStructure>,
        descriptor: &MTLAccelerationStructureDescriptor,
        destination_acceleration_structure: Option<&ProtocolObject<dyn MTLAccelerationStructure>>,
        scratch_buffer: Option<&ProtocolObject<dyn MTLBuffer>>,
        scratch_buffer_offset: NSUInteger,
        options: MTLAccelerationStructureRefitOptions,
    )
       where Self: Sized + Message { ... }
    unsafe fn copyAccelerationStructure_toAccelerationStructure(
        &self,
        source_acceleration_structure: &ProtocolObject<dyn MTLAccelerationStructure>,
        destination_acceleration_structure: &ProtocolObject<dyn MTLAccelerationStructure>,
    )
       where Self: Sized + Message { ... }
    fn writeCompactedAccelerationStructureSize_toBuffer_offset(
        &self,
        acceleration_structure: &ProtocolObject<dyn MTLAccelerationStructure>,
        buffer: &ProtocolObject<dyn MTLBuffer>,
        offset: NSUInteger,
    )
       where Self: Sized + Message { ... }
    unsafe fn writeCompactedAccelerationStructureSize_toBuffer_offset_sizeDataType(
        &self,
        acceleration_structure: &ProtocolObject<dyn MTLAccelerationStructure>,
        buffer: &ProtocolObject<dyn MTLBuffer>,
        offset: NSUInteger,
        size_data_type: MTLDataType,
    )
       where Self: Sized + Message { ... }
    fn copyAndCompactAccelerationStructure_toAccelerationStructure(
        &self,
        source_acceleration_structure: &ProtocolObject<dyn MTLAccelerationStructure>,
        destination_acceleration_structure: &ProtocolObject<dyn MTLAccelerationStructure>,
    )
       where Self: Sized + Message { ... }
    fn updateFence(&self, fence: &ProtocolObject<dyn MTLFence>)
       where Self: Sized + Message { ... }
    fn waitForFence(&self, fence: &ProtocolObject<dyn MTLFence>)
       where Self: Sized + Message { ... }
    fn useResource_usage(
        &self,
        resource: &ProtocolObject<dyn MTLResource>,
        usage: MTLResourceUsage,
    )
       where Self: Sized + Message { ... }
    unsafe fn useResources_count_usage(
        &self,
        resources: NonNull<NonNull<ProtocolObject<dyn MTLResource>>>,
        count: NSUInteger,
        usage: MTLResourceUsage,
    )
       where Self: Sized + Message { ... }
    fn useHeap(&self, heap: &ProtocolObject<dyn MTLHeap>)
       where Self: Sized + Message { ... }
    unsafe fn useHeaps_count(
        &self,
        heaps: NonNull<NonNull<ProtocolObject<dyn MTLHeap>>>,
        count: NSUInteger,
    )
       where Self: Sized + Message { ... }
    unsafe fn sampleCountersInBuffer_atSampleIndex_withBarrier(
        &self,
        sample_buffer: &ProtocolObject<dyn MTLCounterSampleBuffer>,
        sample_index: NSUInteger,
        barrier: bool,
    )
       where Self: Sized + Message { ... }
}

Available on crate features MTLAccelerationStructureCommandEncoder and MTLCommandEncoder only.

Expand description

Apple’s documentation

Provided Methods§

Source

fn buildAccelerationStructure_descriptor_scratchBuffer_scratchBufferOffset( &self, acceleration_structure: &ProtocolObject<dyn MTLAccelerationStructure>, descriptor: &MTLAccelerationStructureDescriptor, scratch_buffer: &ProtocolObject<dyn MTLBuffer>, scratch_buffer_offset: NSUInteger, )
where Self: Sized + Message,

Available on crate features MTLAccelerationStructure and MTLAllocation and MTLBuffer and MTLResource only.

Encode an acceleration structure build into the command buffer. All bottom-level acceleration structure builds must have completed before a top-level acceleration structure build may begin. The resulting acceleration structure will not retain any references to the input vertex buffer, instance buffer, etc.

The acceleration structure build will not be completed until the command buffer has been committed and finished executing. However, it is safe to encode ray tracing work against the acceleration structure as long as the command buffers are scheduled and synchronized such that the command buffer will have completed by the time the ray tracing starts.

The acceleration structure and scratch buffer must be at least the size returned by the [MTLDevice accelerationStructureSizesWithDescriptor:] query.

Parameter accelerationStructure: Acceleration structure storage to build into

Parameter descriptor: Object describing the acceleration structure to build

Parameter scratchBuffer: Scratch buffer to use while building the acceleration structure. The contents may be overwritten and are undefined after the build has started/completed.

Parameter scratchBufferOffset: Offset into the scratch buffer

Source

unsafe fn refitAccelerationStructure_descriptor_destination_scratchBuffer_scratchBufferOffset( &self, source_acceleration_structure: &ProtocolObject<dyn MTLAccelerationStructure>, descriptor: &MTLAccelerationStructureDescriptor, destination_acceleration_structure: Option<&ProtocolObject<dyn MTLAccelerationStructure>>, scratch_buffer: Option<&ProtocolObject<dyn MTLBuffer>>, scratch_buffer_offset: NSUInteger, )
where Self: Sized + Message,

Available on crate features MTLAccelerationStructure and MTLAllocation and MTLBuffer and MTLResource only.

Encode an acceleration structure refit into the command buffer. Refitting can be used to update the acceleration structure when geometry changes and is much faster than rebuilding from scratch. However, the quality of the acceleration structure and the subsequent ray tracing performance will degrade depending on how much the geometry changes.

Refitting can not be used after certain changes, such as adding or removing geometry. Acceleration structures can be refit in place by specifying the same source and destination acceleration structures or by providing a nil destination acceleration structure. If the source and destination acceleration structures are not the same, they must not overlap in memory.

The destination acceleration structure must be at least as large as the source acceleration structure, unless the source acceleration structure has been compacted, in which case the destination acceleration structure must be at least as large as the compacted size of the source acceleration structure.

The scratch buffer must be at least the size returned by the accelerationStructureSizesWithDescriptor method of the MTLDevice.

Parameter descriptor: Object describing the acceleration structure to build

Parameter sourceAccelerationStructure: Acceleration structure to copy from

Parameter destinationAccelerationStructure: Acceleration structure to copy to

Parameter scratchBuffer: Scratch buffer to use while refitting the acceleration structure. The contents may be overwritten and are undefined after the refit has started/completed.

Parameter scratchBufferOffset: Offset into the scratch buffer.

§Safety

source_acceleration_structure may need to be synchronized.
source_acceleration_structure may be unretained, you must ensure it is kept alive while in use.
destination_acceleration_structure may need to be synchronized.
destination_acceleration_structure may be unretained, you must ensure it is kept alive while in use.
scratch_buffer may need to be synchronized.
scratch_buffer may be unretained, you must ensure it is kept alive while in use.
scratch_buffer contents should be of the correct type.
scratchBufferOffset might not be bounds-checked.

Source

unsafe fn refitAccelerationStructure_descriptor_destination_scratchBuffer_scratchBufferOffset_options( &self, source_acceleration_structure: &ProtocolObject<dyn MTLAccelerationStructure>, descriptor: &MTLAccelerationStructureDescriptor, destination_acceleration_structure: Option<&ProtocolObject<dyn MTLAccelerationStructure>>, scratch_buffer: Option<&ProtocolObject<dyn MTLBuffer>>, scratch_buffer_offset: NSUInteger, options: MTLAccelerationStructureRefitOptions, )
where Self: Sized + Message,