Skip to main content

PushConstantsLayout

Struct PushConstantsLayout 

Source
pub struct PushConstantsLayout {
    pub ranges: Vec<PushConstantRange>,
    pub total_size: u32,
}
Expand description

Describes all push-constant data ranges used by a pipeline.

In wgpu 29 only the total byte size matters at pipeline-creation time (set via wgpu::PipelineLayoutDescriptor::immediate_size). The per-range breakdown is kept here for documentation and validation purposes.

§Invariants

All ranges must individually satisfy PushConstantRange::validate, and total_size must equal end of the last range (or the extent of all non-overlapping ranges combined).

Fields§

§ranges: Vec<PushConstantRange>

Individual data ranges (may overlap in theory, though callers should keep them distinct for clarity).

§total_size: u32

Total number of bytes reserved in the immediate-data block. Must be 4-byte aligned and ≤ MAX_PUSH_CONSTANTS_SIZE_BYTES.

Implementations§

Source§

impl PushConstantsLayout

Source

pub fn compute_only(size: u32) -> Self

Create a layout with a single compute-only range covering [0, size).

§Examples
use oxigdal_gpu::push_constants::PushConstantsLayout;

let l = PushConstantsLayout::compute_only(64);
assert_eq!(l.total_size, 64);
assert_eq!(l.ranges.len(), 1);
assert!(l.validate().is_ok());
Source

pub fn validate(&self) -> GpuResult<()>

Validate all contained ranges.

§Errors

Propagates the first validation error from any constituent PushConstantRange::validate call. Also returns an error when total_size exceeds MAX_PUSH_CONSTANTS_SIZE_BYTES or is not 4-byte aligned.

Source

pub fn immediate_size_for_wgpu(&self) -> u32

Return the immediate_size value to pass to wgpu::PipelineLayoutDescriptor.

This is simply self.total_size.

Source

pub fn to_wgpu_ranges(&self) -> Vec<PushConstantRangeDesc>

Convert all ranges to a vector of descriptive strings (for logging).

Trait Implementations§

Source§

impl Clone for PushConstantsLayout

Source§

fn clone(&self) -> PushConstantsLayout

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PushConstantsLayout

Source§

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

Formats the value using the given formatter. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more