Struct Blas 

pub struct Blas { /* private fields */ }

Available on crate feature bevy_render only.

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.

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>( &mut self, ) -> Option<impl Deref<Target = <A as Api>::AccelerationStructure> + WasmNotSendSync>

where A: Api,

Available on wgpu_core only.

Get the wgpu_hal acceleration structure from this Blas.

Find the Api struct corresponding to the active backend in wgpu_hal::api, and pass that struct to the to the A type parameter.

Returns a guard that dereferences to the type of the hal backend which implements A::AccelerationStructure.

Types

The returned type depends on the backend:

• hal::api::Vulkan uses hal::vulkan::AccelerationStructure
• hal::api::Metal uses hal::metal::AccelerationStructure
• hal::api::Dx12 uses hal::dx12::AccelerationStructure
• hal::api::Gles uses hal::gles::AccelerationStructure

Deadlocks

• The returned guard holds a read-lock on a device-local “destruction” lock, which will cause all calls to destroy to block until the guard is released.

Errors

This method will return None if:

• The acceleration structure is not from the backend specified by A.
• The acceleration structure is from the webgpu or custom backend.

Safety

• The returned resource must not be destroyed unless the guard is the last reference to it and it is not in use by the GPU. The guard and handle may be dropped at any time however.
• All the safety requirements of wgpu-hal must be upheld.

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 (optionally 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 duplicate 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<(), Error>

Formats the value using the given formatter.

impl Eq for Blas

impl Hash for Blas

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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: &Blas) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Blas

fn eq(&self, other: &Blas) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Blas

fn partial_cmp(&self, other: &Blas) -> 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.