pebble-engine 0.16.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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

//! `use pebble::wgpu::prelude::*;` for everything needed to construct and
//! render 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`], [`TextureBuilder`] — chained `.method(...)` calls
//! instead of a hand-written `wgpu::BufferDescriptor`/`BindGroupLayoutDescriptor`/
//! `BindGroupDescriptor`, producing opaque types ([`Buffer`], [`DynamicBuffer`],
//! [`TextureView`], [`BindGroupLayout`], [`BindGroup`], ...) rather than raw
//! `wgpu` ones — there's no `wgpu::*` type anywhere in this module's public
//! surface. Recording draw/dispatch calls is opaque too: [`RenderPass`]
//! (from `ActiveFrame::begin_pass`) and [`ComputePass`] (from
//! [`WGPUBackend::create_command_encoder`]/[`CommandEncoder::compute_pass`])
//! take these types directly.
//!
//! `backend.device`/`backend.queue` are still there for the handful of
//! operations this module doesn't cover (submitting an encoder built some
//! other way, a resource shape [`TextureBuilder`] doesn't handle), but for
//! buffers, textures, bind groups, and pass recording, 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::{BindGroupLayout, BindGroupLayoutBuilder, BindGroupTarget, BindingEntry, BindingKind};
pub use super::buffer::{Buffer, DynamicBuffer};
pub use super::buffers::{
    BindGroup, BindGroupBuilder, BufferBuilder, DynamicBufferBuilder, dynamic_storage_offset_stride,
    dynamic_uniform_offset_stride,
};
pub use super::compute::ComputePipeline;
pub use super::compute_pass::{CommandEncoder, ComputePass};
pub use super::cubemap::GPUCubemap;
pub use super::layout::{GroupLayout, OwnedGroupLayout};
pub use super::material::RenderPipeline;
pub use super::render_pass::{IndexFormat, RenderPass};
pub use super::samplers::{GlobalSamplers, Sampler, SamplerKind};
pub use super::texture_array::GPUTextureArray;
pub use super::texture_view::{TextureBuilder, TextureView};
pub use super::textures::GPUTexture;