Skip to main content

RayTracingPass

Struct RayTracingPass 

Source
pub struct RayTracingPass<'encoder> {
    pub(crate) inner: DispatchRayTracingPass,
    pub(crate) actions: Arc<Mutex<DeferredCommandBufferActions>>,
    pub(crate) _encoder_guard: PhantomDrop<&'encoder ()>,
}
Expand description

In-progress recording of a ray tracing pass.

It can be created with CommandEncoder::begin_ray_tracing_pass.

Fields§

§inner: DispatchRayTracingPass§actions: Arc<Mutex<DeferredCommandBufferActions>>

Shared with CommandEncoder to enqueue deferred actions from within a pass.

§_encoder_guard: PhantomDrop<&'encoder ()>

This lifetime is used to protect the CommandEncoder from being used while the pass is alive. This needs to be PhantomDrop to prevent the lifetime from being shortened.

Implementations§

Source§

impl RayTracingPass<'_>

Source

pub fn forget_lifetime(self) -> RayTracingPass<'static>

Drops the lifetime relationship to the parent command encoder, making usage of the encoder while this pass is recorded a run-time error instead.

Attention: As long as the ray tracing pass has not been ended, any mutating operation on the parent command encoder will cause a run-time error and invalidate it! By default, the lifetime constraint prevents this, but it can be useful to handle this at run time, such as when storing the pass and encoder in the same data structure.

This operation has no effect on pass recording. It’s a safe operation, since CommandEncoder is in a locked state as long as the pass is active regardless of the lifetime constraint or its absence.

Source

pub fn set_pipeline(&mut self, pipeline: &RayTracingPipeline)

Sets the active ray tracing pipeline.

Source

pub fn set_bind_group<'a, BG>( &mut self, index: u32, bind_group: BG, offsets: &[DynamicOffset], )
where Option<&'a BindGroup>: From<BG>,

Sets the active bind group for a given bind group index. The bind group layout in the active pipeline when the trace_rays() function is called must match the layout of this bind group.

If the bind group have dynamic offsets, provide them in the binding order. These offsets have to be aligned to Limits::min_uniform_buffer_offset_alignment or Limits::min_storage_buffer_offset_alignment appropriately.

Source

pub fn insert_debug_marker(&mut self, label: &str)

Inserts debug marker.

Source

pub fn push_debug_group(&mut self, label: &str)

Start record commands and group it into debug marker group.

Source

pub fn pop_debug_group(&mut self)

Stops command recording and creates debug group.

Source

pub fn trace_rays(&mut self, x: u32, y: u32, z: u32)

Dispatches rays in the current ray tracing pipeline.

Source§

impl RayTracingPass<'_>

Features::IMMEDIATES must be enabled on the device in order to call these functions.

Source

pub fn set_immediates(&mut self, offset: u32, data: &[u8])

Set immediate data for subsequent RayTracingPass::trace_rays calls.

Write the bytes in data at offset offset within immediate data storage. Both offset and the length of data must be multiples of crate::IMMEDIATE_DATA_ALIGNMENT, which is always 4.

For example, if offset is 4 and data is eight bytes long, this call will write data to bytes 4..12 of immediate data storage.

Trait Implementations§

Source§

impl<'encoder> Debug for RayTracingPass<'encoder>

Source§

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

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

impl Hash for RayTracingPass<'_>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for RayTracingPass<'_>

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for RayTracingPass<'_>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for RayTracingPass<'_>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl Eq for RayTracingPass<'_>

Auto Trait Implementations§

§

impl<'encoder> Freeze for RayTracingPass<'encoder>

§

impl<'encoder> !RefUnwindSafe for RayTracingPass<'encoder>

§

impl<'encoder> Send for RayTracingPass<'encoder>

§

impl<'encoder> Sync for RayTracingPass<'encoder>

§

impl<'encoder> Unpin for RayTracingPass<'encoder>

§

impl<'encoder> UnsafeUnpin for RayTracingPass<'encoder>

§

impl<'encoder> !UnwindSafe for RayTracingPass<'encoder>

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> AsAny for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

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
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CommonTraits for T
where T: AsAny + Any + Debug + WasmNotSendSync,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,