pebble-engine 0.14.0

A modular, ECS-style graphics/app framework for Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//! `use pebble::wgpu::prelude::*;` for everything needed to construct
//! custom GPU resources against a [`WGPUBackend`] — a camera's uniform
//! buffer, a compute pass's storage buffers, anything built by hand inside
//! a [`LazyResource`](crate::assets::singleton_asset::LazyResource) or
//! [`Asset`](crate::assets::upload::Asset) impl that isn't already covered
//! by [`MaterialDescriptor`](super::material::MaterialDescriptor)/
//! [`ComputeDescriptor`](super::compute::ComputeDescriptor).
//!
//! Everything that constructs a GPU resource here is a builder —
//! [`BindGroupLayoutBuilder`], [`BufferBuilder`], [`DynamicBufferBuilder`],
//! [`BindGroupBuilder`] — chained `.method(...)` calls instead of a
//! hand-written `wgpu::BufferDescriptor`/`BindGroupLayoutDescriptor`/
//! `BindGroupDescriptor`. `backend.device`/`backend.queue` are still there
//! (a few operations — submitting encoders, one-off resource types this
//! module doesn't cover — genuinely need them directly), but for buffers,
//! bind group layouts, and bind groups, reach for a builder first: typing
//! `SomeBuilder::new().` and letting autocomplete show you what's available
//! beats remembering a specific free function's name, and each builder
//! folds in bookkeeping a hand-written descriptor won't (duplicate-`@binding(N)`
//! detection in [`BindGroupLayoutBuilder::build`], correct dynamic-offset
//! alignment in [`DynamicBufferBuilder::build`]) that's easy to get subtly
//! wrong by hand and would otherwise show up as an opaque wgpu validation
//! panic instead of a clear one.
//!
//! See the book's [Camera, Depth, and Lazy Resources](https://akihiro120.github.io/pebble/ch10-camera-and-depth.html)
//! chapter for a worked example.

pub use super::backend::WGPUBackend;
pub use super::binding::{BindGroupLayoutBuilder, BindGroupTarget, BindingEntry, BindingKind};
pub use super::buffers::{
    BindGroupBuilder, BufferBuilder, DynamicBufferBuilder, dynamic_storage_offset_stride,
    dynamic_uniform_offset_stride, update_buffer, update_buffer_at,
};
pub use super::layout::{GroupLayout, OwnedGroupLayout, assemble_bind_group_layouts};