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
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100

#![allow(non_camel_case_types)]
//!
//! This crates provides data types to build structures ready to upload into UBO.
//! Data layout will match one for uniform blocks declared with `layout(std140)`.
//! See [specs](https://www.khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159) for alignment rules.
//!
//! # Examples
//!
//! ```rust
//! # macro_rules! offset_of {
//! #     ($type:ty: $($name:ident).+) => {
//! #         unsafe { // No dereferencing
//! #             let value: &$type = &*::std::ptr::null();
//! #             let offset = &value $(.$name)+ as *const _ as usize;
//! #             let base = value as *const _ as usize;
//! #             offset - base
//! #         }
//! #     }
//! # }
//! #
//! # #[macro_use]
//! # extern crate glsl_layout;
//! # use glsl_layout::*;
//! # fn main() {
//! #     use std::mem::size_of;
//! #
//! #[derive(Debug, Default, Clone, Copy, AsStd140)]
//! struct Foo {
//!     x: int,
//!     y: vec3,
//!     z: float,
//!     w: mat4x4,
//!     a: [f32; 3],
//!     b: f32,
//! }
//!
//! type UFoo = <Foo as AsStd140>::Std140;
//!
//! assert_eq!(
//!     offset_of!(UFoo: y),
//!     round_up_to(size_of::<int>(), 16), // `vec3` has alignment of size `vec4`
//!     "Offset of field `y` must be equal of size of `x` rounded up to the alignment",
//! );
//!
//! assert_eq!(
//!     offset_of!(UFoo: z),
//!     round_up_to(offset_of!(UFoo: y) + size_of::<vec3>(), 4),
//!     "Field `z` must follow `y`. `y` should not have padding at the end",
//! );
//!
//! assert_eq!(
//!     offset_of!(UFoo: b),
//!     offset_of!(UFoo: a) + size_of::<[[f32; 4]; 3]>(),
//!     "Field `b` must follow `a`. But `a` has padding at the end.",
//! );
//! #
//! let foo_uniform = Foo {
//!     x: 2,
//!     y: [0.0; 3].into(),
//!     z: 0.0,
//!     w: [[0.0; 4]; 4].into(),
//!     a: [0.0; 3].into(),
//!     b: 0.0,
//! }.std140();
//! # }
//!
//! # fn round_up_to(offset: usize, align: usize) -> usize {
//! #     if offset % align == 0 {
//! #         offset
//! #     } else {
//! #         (((offset - 1) / align) + 1) * align
//! #     }
//! # }
//! ```
//!

#[doc(hidden)]
pub mod align;
mod scalar;
mod vec;

#[macro_use]
mod array;
mod mat;
mod std140;

#[cfg(feature = "cgmath")]
mod cgmath;

pub use array::*;
pub use mat::*;
pub use scalar::*;
pub use std140::*;
pub use vec::*;

#[allow(unused_imports)]
#[macro_use]
extern crate glsl_layout_derive;
#[doc(hidden)]
pub use glsl_layout_derive::*;