Struct PushConstantsBuffer 

pub struct PushConstantsBuffer {
    pub data: Vec<u8>,
    pub layout: PushConstantsLayout,
}

A typed byte buffer holding push-constant (immediate) data.

Callers write scalar and vector values into the buffer via the typed helper methods (write_u32, write_f32, etc.) and then upload the raw bytes to the GPU via wgpu::ComputePass::set_immediates.

Layout

The buffer is zero-initialised at construction. Writes use little-endian byte order (matching wgpu’s expectation on all supported platforms).

Fields

data: Vec<u8>

Raw byte storage.

layout: PushConstantsLayout

Layout that governs this buffer’s structure.

Implementations

impl PushConstantsBuffer

pub fn new(layout: PushConstantsLayout) -> Self

Allocate a new zero-initialised buffer sized to layout.total_size.

Examples

use oxigdal_gpu::push_constants::{PushConstantsBuffer, PushConstantsLayout};

let layout = PushConstantsLayout::compute_only(16);
let buf = PushConstantsBuffer::new(layout);
assert_eq!(buf.size(), 16);
assert!(buf.as_bytes().iter().all(|&b| b == 0));

pub fn write<T: NoUninit + Copy>( &mut self, offset: u32, value: T, ) -> GpuResult<()>

Write any NoUninit + Copy type at offset bytes into the buffer.

The write is bounds-checked: an error is returned if offset + size_of::<T>() would exceed the buffer size.

Errors

Returns GpuError::InvalidKernelParams on bounds overflow.

pub fn write_u32(&mut self, offset: u32, value: u32) -> GpuResult<()>

Write a u32 at offset bytes (little-endian).

Errors

Returns an error when the write would exceed the buffer bounds.

pub fn write_i32(&mut self, offset: u32, value: i32) -> GpuResult<()>

Write an i32 at offset bytes (little-endian).

Errors

Returns an error when the write would exceed the buffer bounds.

pub fn write_f32(&mut self, offset: u32, value: f32) -> GpuResult<()>

Write an f32 at offset bytes (little-endian, IEEE 754).

Errors

Returns an error when the write would exceed the buffer bounds.

pub fn write_vec4_f32(&mut self, offset: u32, value: [f32; 4]) -> GpuResult<()>

Write a [f32; 4] vec4 starting at offset bytes.

This writes 16 bytes: [x, y, z, w] in little-endian order.

Errors

Returns an error when the write would exceed the buffer bounds.

pub fn write_uvec4(&mut self, offset: u32, value: [u32; 4]) -> GpuResult<()>

Write a [u32; 4] uvec4 starting at offset bytes (16 bytes total).

Errors

Returns an error when the write would exceed the buffer bounds.

pub fn write_vec2_f32(&mut self, offset: u32, value: [f32; 2]) -> GpuResult<()>

Write a [f32; 2] vec2 starting at offset bytes (8 bytes total).

Errors

Returns an error when the write would exceed the buffer bounds.

pub fn as_bytes(&self) -> &[u8]

Return a view of the raw byte content.

pub fn size(&self) -> u32

Return the size of the buffer in bytes.

pub fn clear(&mut self)

Reset all bytes to zero.

Trait Implementations

impl Clone for PushConstantsBuffer

fn clone(&self) -> PushConstantsBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PushConstantsBuffer

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

Formats the value using the given formatter.