#glsl #std140 #std430

bevy_crevice

Create GLSL-compatible versions of structs with explicitly-initialized padding (Bevy version)

3 unstable releases

Uses new Rust 2021

0.7.0 Apr 15, 2022
0.6.1 Feb 14, 2022
0.6.0 Jan 8, 2022

#727 in Game dev

Download history 2767/week @ 2022-06-14 3493/week @ 2022-06-21 2843/week @ 2022-06-28 2599/week @ 2022-07-05 2910/week @ 2022-07-12 2810/week @ 2022-07-19 3289/week @ 2022-07-26 2388/week @ 2022-08-02 2344/week @ 2022-08-09 1105/week @ 2022-08-16 1094/week @ 2022-08-23 1023/week @ 2022-08-30 1380/week @ 2022-09-06 1055/week @ 2022-09-13 1124/week @ 2022-09-20 995/week @ 2022-09-27

4,791 downloads per month

MIT/Apache

67KB
1K SLoC

Bevy Crevice

This is a fork of Crevice for Bevy.

For use outside of Bevy, you should consider using Crevice directly.

It was forked to allow better integration in Bevy:

  • Easier derive macro usage, without needing to depend on Crevice directly.
  • Use of unmerged features (as of the fork), like Array Support.
  • Renaming of traits and macros to better match Bevy API.

Crevice

Crevice creates GLSL-compatible versions of types through the power of derive macros. Generated structures provide an as_bytes method to allow safely packing data into buffers for uploading.

Generated structs also implement bytemuck::Zeroable and bytemuck::Pod for use with other libraries.

Crevice is similar to glsl-layout, but supports types from many math crates, can generate GLSL source from structs, and explicitly initializes padding to remove one source of undefined behavior.

Crevice has support for many Rust math libraries via feature flags, and most other math libraries by use of the mint crate. Crevice currently supports:

  • mint 0.5, enabled by default
  • cgmath 0.18, using the cgmath feature
  • nalgebra 0.29, using the nalgebra feature
  • glam 0.20, using the glam feature

PRs are welcome to add or update math libraries to Crevice.

If your math library is not supported, it's possible to define structs using the types from mint and convert your math library's types into mint types. This is supported by most Rust math libraries.

Your math library may require you to turn on a feature flag to get mint support. For example, cgmath requires the "mint" feature to be enabled to allow conversions to and from mint types.

Examples

Single Value

Uploading many types can be done by deriving AsStd140 and using as_std140 and as_bytes to turn the result into bytes.

uniform MAIN {
    mat3 orientation;
    vec3 position;
    float scale;
} main;
use bevy_crevice::std140::{AsStd140, Std140};

#[derive(AsStd140)]
struct MainUniform {
    orientation: mint::ColumnMatrix3<f32>,
    position: mint::Vector3<f32>,
    scale: f32,
}

let value = MainUniform {
    orientation: [
        [1.0, 0.0, 0.0],
        [0.0, 1.0, 0.0],
        [0.0, 0.0, 1.0],
    ].into(),
    position: [1.0, 2.0, 3.0].into(),
    scale: 4.0,
};

let value_std140 = value.as_std140();

upload_data_to_gpu(value_std140.as_bytes());

Sequential Types

More complicated data can be uploaded using the std140 Writer type.

struct PointLight {
    vec3 position;
    vec3 color;
    float brightness;
};

buffer POINT_LIGHTS {
    uint len;
    PointLight[] lights;
} point_lights;
use bevy_crevice::std140::{self, AsStd140};

#[derive(AsStd140)]
struct PointLight {
    position: mint::Vector3<f32>,
    color: mint::Vector3<f32>,
    brightness: f32,
}

let lights = vec![
    PointLight {
        position: [0.0, 1.0, 0.0].into(),
        color: [1.0, 0.0, 0.0].into(),
        brightness: 0.6,
    },
    PointLight {
        position: [0.0, 4.0, 3.0].into(),
        color: [1.0, 1.0, 1.0].into(),
        brightness: 1.0,
    },
];

let target_buffer = map_gpu_buffer_for_write();
let mut writer = std140::Writer::new(target_buffer);

let light_count = lights.len() as u32;
writer.write(&light_count)?;

// Crevice will automatically insert the required padding to align the
// PointLight structure correctly. In this case, there will be 12 bytes of
// padding between the length field and the light list.

writer.write(lights.as_slice())?;

unmap_gpu_buffer();

Features

  • std (default): Enables std::io::Write-based structs.
  • cgmath: Enables support for types from cgmath.
  • nalgebra: Enables support for types from nalgebra.
  • glam: Enables support for types from glam.

Minimum Supported Rust Version (MSRV)

Crevice supports Rust 1.52.1 and newer due to use of new const fn features.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~1.1–3MB
~65K SLoC