#graphics #glsl #gamedev

glsl-layout

Provides data types and traits to build structures ready to upload into UBO

9 unstable releases

0.5.0 Dec 6, 2022
0.4.2 Aug 5, 2022
0.4.1 Jul 25, 2022
0.4.0 Jan 11, 2021
0.1.1 May 17, 2018

#760 in Graphics APIs

Download history 1001/week @ 2024-04-22 904/week @ 2024-04-29 786/week @ 2024-05-06 786/week @ 2024-05-13 941/week @ 2024-05-20 1053/week @ 2024-05-27 882/week @ 2024-06-03 571/week @ 2024-06-10 856/week @ 2024-06-17 901/week @ 2024-06-24 163/week @ 2024-07-01 806/week @ 2024-07-08 907/week @ 2024-07-15 804/week @ 2024-07-22 709/week @ 2024-07-29 703/week @ 2024-08-05

3,301 downloads per month
Used in 38 crates (12 directly)

MIT/Apache

41KB
770 lines

GLSL-LAYOUT

This crates provides data types and traits to build structures ready to upload into UBO.

Usage

Deriving Uniform with proc-macro will produce associated type Std140 with same data layout as uniform blocks declared with layout(std140). All members of structure that derives Uniform must implement Uniform as well.

Implementing Uniform should be done via deriving. Implementing it manually is possible. It requires to provide associated type Std140 which must implement Std140 trait. But trait Std140 is marked unsafe so be careful.

Trait Uniform also requires Copy.

Typical usage scenario is:

#[derive(Copy, Clone, Uniform)]
struct FragmentArgs {
    pos: vec3,
    dir: vec3,
    count: uint,
}

write_to_buffer(&FragmentArgs {
    pos: [0.0, 1.0, 2.0].into(),
    dir: [3.0, 4.0, 5.0].into(),
    count: 42,
}.std140());

Data types

There are basic data types from glsl:

  • boolean (name bool is already occupied)
  • int
  • uint
  • float
  • double

Also more complex types:

  • vectors - (vec2, vec3, vec4, bvec2, ivec2, uvec2, dvec2 etc)
  • matrices - (mat2x3, dmat4 etc)
  • arrays -

License

glsl-layout is free and open source software distributed under the terms of both the MIT License and the Apache License 2.0.

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.

Known issues

On MacOS

If uniform block contains array of structures and this array accessed with dynamic index (variable instead of literal) it may load wrong bytes for members not aligned to size of vec4 (16 bytes). In this case manual padding can be the fix.

Dependencies

~1.2–2.9MB
~72K SLoC