Struct Blas

pub struct Blas {
    pub(crate) handle: Option<u64>,
    pub(crate) inner: DispatchBlas,
}

Bottom Level Acceleration Structure (BLAS).

A BLAS is a device-specific raytracing acceleration structure that contains geometry data.

These BLASes are combined with transform in a TlasInstance to create a Tlas.

Fields

handle: Option<u64>

inner: DispatchBlas

Implementations

impl Blas

pub fn handle(&self) -> Option<u64>

Raw handle to the acceleration structure, used inside raw instance buffers.

pub unsafe fn as_hal<A: HalApi, F: FnOnce(Option<&A::AccelerationStructure>) -> R, R>( &mut self, hal_blas_callback: F, ) -> R

Available on wgpu_core only.

Returns the inner hal Acceleration Structure using a callback. The hal acceleration structure will be None if the backend type argument does not match with this wgpu Blas

This method will start the wgpu_core level command recording.

Safety

• The raw handle obtained from the hal Acceleration Structure must not be manually destroyed

pub fn as_custom<T: BlasInterface>(&self) -> Option<&T>

Available on custom only.

Returns custom implementation of Blas (if custom backend and is internally T)

impl Blas

pub fn prepare_compaction_async( &self, callback: impl FnOnce(Result<(), BlasAsyncError>) + WasmNotSend + 'static, )

Asynchronously prepares this BLAS for compaction. The callback is called once all builds using this BLAS are finished and the BLAS is compactable. This can be checked using Blas::ready_for_compaction. Rebuilding this BLAS will reset its compacted state, and it will need to be prepared again.

Interaction with other functions

On native, queue.submit(..) and polling devices (that is calling instance.poll_all or device.poll) with PollType::Poll may call the callback. On native, polling devices with PollType::Wait (or PollType::WaitForSubmissionIndex with a submission index greater than the last submit the BLAS was used in) will guarantee callback is called.

pub fn ready_for_compaction(&self) -> bool

Checks whether this BLAS is ready for compaction. The returned value is true if Blas::prepare_compaction_async’s callback was called with a non-error value, otherwise this is false.

Trait Implementations

impl Clone for Blas

fn clone(&self) -> Blas

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Blas

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

Formats the value using the given formatter.

impl Hash for Blas

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 Ord for Blas

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Blas

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 PartialOrd for Blas

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Blas