Struct GaussiansBuffer 

pub struct GaussiansBuffer<G: GaussianPod>(/* private fields */);

The Gaussians storage buffer.

This buffer holds an array of Gaussians represented by the specified GaussianPod.

Implementations

impl<G: GaussianPod> GaussiansBuffer<G>

pub fn new(device: &Device, gaussians: &impl IterGaussian) -> Self

Create a new Gaussians buffer.

Examples found in repository

examples/read_ply.rs (line 40)

async fn main() {
    let model_path = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "examples/model.ply".to_string());

    let instance = wgpu::Instance::new(&wgpu::InstanceDescriptor::default());

    let adapter = instance
        .request_adapter(&wgpu::RequestAdapterOptions::default())
        .await
        .expect("adapter");

    let (device, _) = adapter
        .request_device(&wgpu::DeviceDescriptor {
            label: Some("Device"),
            required_limits: adapter.limits(),
            ..Default::default()
        })
        .await
        .expect("device");

    println!("Reading gaussians from {}", model_path);

    let gaussians = gs::PlyGaussians::read_from_file(&model_path).expect("gaussians");

    let gaussians_buffer = gs::GaussiansBuffer::<GaussianPod>::new(&device, &gaussians);

    println!(
        "Loaded {} gaussians ({:.3} KB) into GPU buffer.",
        gaussians_buffer.len(),
        gaussians_buffer.buffer().size() as f32 / 1024.0,
    );
}

examples/read_spz.rs (line 42)

async fn main() {
    let model_path = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "examples/model.spz".to_string());

    let instance = wgpu::Instance::new(&wgpu::InstanceDescriptor::default());

    let adapter = instance
        .request_adapter(&wgpu::RequestAdapterOptions::default())
        .await
        .expect("adapter");

    let (device, _) = adapter
        .request_device(&wgpu::DeviceDescriptor {
            label: Some("Device"),
            required_limits: adapter.limits(),
            ..Default::default()
        })
        .await
        .expect("device");

    println!("Reading gaussians from {}", model_path);

    let gaussians = gs::SpzGaussians::read_from_file(&model_path).expect("gaussians");

    println!("Header: {:?}", gaussians.header);

    let gaussians_buffer = gs::GaussiansBuffer::<GaussianPod>::new(&device, &gaussians);

    println!(
        "Loaded {} gaussians ({:.3} KB) into GPU buffer.",
        gaussians_buffer.len(),
        gaussians_buffer.buffer().size() as f32 / 1024.0,
    );
}

pub fn new_with_usage( device: &Device, gaussians: &impl IterGaussian, usage: BufferUsages, ) -> Self

Create a new Gaussians buffer with the specified size with wgpu::BufferUsages.

pub fn new_with_pods(device: &Device, gaussians: &[G]) -> Self

Create a new Gaussians buffer with GaussianPod.

pub fn new_with_pods_and_usage( device: &Device, gaussians: &[G], usage: BufferUsages, ) -> Self

Create a new Gaussians buffer with GaussianPod and the specified size and wgpu::BufferUsages.

pub fn new_empty(device: &Device, len: usize) -> Self

Create a new Gaussians buffer with the specified size.

pub fn new_empty_with_usage( device: &Device, len: usize, usage: BufferUsages, ) -> Self

Create a new Gaussians buffer with the specified size and wgpu::BufferUsages.

pub fn len(&self) -> usize

Get the number of Gaussians.

Examples found in repository

examples/read_ply.rs (line 44)

async fn main() {
    let model_path = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "examples/model.ply".to_string());

    let instance = wgpu::Instance::new(&wgpu::InstanceDescriptor::default());

    let adapter = instance
        .request_adapter(&wgpu::RequestAdapterOptions::default())
        .await
        .expect("adapter");

    let (device, _) = adapter
        .request_device(&wgpu::DeviceDescriptor {
            label: Some("Device"),
            required_limits: adapter.limits(),
            ..Default::default()
        })
        .await
        .expect("device");

    println!("Reading gaussians from {}", model_path);

    let gaussians = gs::PlyGaussians::read_from_file(&model_path).expect("gaussians");

    let gaussians_buffer = gs::GaussiansBuffer::<GaussianPod>::new(&device, &gaussians);

    println!(
        "Loaded {} gaussians ({:.3} KB) into GPU buffer.",
        gaussians_buffer.len(),
        gaussians_buffer.buffer().size() as f32 / 1024.0,
    );
}

examples/read_spz.rs (line 46)

async fn main() {
    let model_path = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "examples/model.spz".to_string());

    let instance = wgpu::Instance::new(&wgpu::InstanceDescriptor::default());

    let adapter = instance
        .request_adapter(&wgpu::RequestAdapterOptions::default())
        .await
        .expect("adapter");

    let (device, _) = adapter
        .request_device(&wgpu::DeviceDescriptor {
            label: Some("Device"),
            required_limits: adapter.limits(),
            ..Default::default()
        })
        .await
        .expect("device");

    println!("Reading gaussians from {}", model_path);

    let gaussians = gs::SpzGaussians::read_from_file(&model_path).expect("gaussians");

    println!("Header: {:?}", gaussians.header);

    let gaussians_buffer = gs::GaussiansBuffer::<GaussianPod>::new(&device, &gaussians);

    println!(
        "Loaded {} gaussians ({:.3} KB) into GPU buffer.",
        gaussians_buffer.len(),
        gaussians_buffer.buffer().size() as f32 / 1024.0,
    );
}

pub fn is_empty(&self) -> bool

Check if the buffer is empty.

pub fn update( &self, queue: &Queue, gaussians: &impl IterGaussian, ) -> Result<(), GaussiansBufferUpdateError>

Update the buffer.

gaussians should have the same number of Gaussians as the buffer.

pub fn update_with_pod( &self, queue: &Queue, pods: &[G], ) -> Result<(), GaussiansBufferUpdateError>

Update the buffer with GaussianPod.

pods should have the same number of Gaussians as the buffer.

pub fn update_range( &self, queue: &Queue, start: usize, gaussians: &[Gaussian], ) -> Result<(), GaussiansBufferUpdateRangeError>

Update a range of the buffer.

gaussians should fit in the buffer starting from start.

pub fn update_range_with_pod( &self, queue: &Queue, start: usize, pods: &[G], ) -> Result<(), GaussiansBufferUpdateRangeError>

Update a range of the buffer with GaussianPod.

pods should fit in the buffer starting from start.

pub async fn download_gaussians( &self, device: &Device, queue: &Queue, ) -> Result<Vec<Gaussian>, DownloadBufferError>

Download the buffer data into a Vec of Gaussian.

Trait Implementations

impl<G: GaussianPod> BufferWrapper for GaussiansBuffer<G>

const DEFAULT_USAGES: BufferUsages

The default usages.

fn buffer(&self) -> &Buffer

Returns a reference to the buffer data.

fn download<'life0, 'life1, 'life2, 'async_trait, T>( &'life0 self, device: &'life1 Device, queue: &'life2 Queue, ) -> Pin<Box<dyn Future<Output = Result<Vec<T>, DownloadBufferError>> + Send + 'async_trait>>

where Self: Send + Sync + 'async_trait, T: 'async_trait + NoUninit + AnyBitPattern, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Download the buffer data into a Vec.

fn prepare_download( &self, device: &Device, encoder: &mut CommandEncoder, ) -> Buffer

Prepare for downloading the buffer data.

fn map_download<'life0, 'life1, 'async_trait, T>( download: &'life0 Buffer, device: &'life1 Device, ) -> Pin<Box<dyn Future<Output = Result<Vec<T>, DownloadBufferError>> + Send + 'async_trait>>

where T: 'async_trait + NoUninit + AnyBitPattern, Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Map the download buffer to read the buffer data.

fn map_download_with_poll_type<'life0, 'life1, 'async_trait, T>( download: &'life0 Buffer, device: &'life1 Device, poll_type: PollType, ) -> Pin<Box<dyn Future<Output = Result<Vec<T>, DownloadBufferError>> + Send + 'async_trait>>

where T: 'async_trait + NoUninit + AnyBitPattern, 'life0: 'async_trait, 'life1: 'async_trait,

Map the download buffer to read the buffer data with custom wgpu::PollType.

impl<G: Clone + GaussianPod> Clone for GaussiansBuffer<G>

fn clone(&self) -> GaussiansBuffer<G>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<G: Debug + GaussianPod> Debug for GaussiansBuffer<G>

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

Formats the value using the given formatter.

impl<G: GaussianPod> From<GaussiansBuffer<G>> for Buffer

fn from(wrapper: GaussiansBuffer<G>) -> Self

Converts to this type from the input type.

impl<G: GaussianPod> TryFrom<Buffer> for GaussiansBuffer<G>

type Error = GaussiansBufferTryFromBufferError

The type returned in the event of a conversion error.

fn try_from(buffer: Buffer) -> Result<Self, Self::Error>

Performs the conversion.