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 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
//! Vertex formats, associated types and functions.
//!
//! A vertex is a type representing a point. It’s common to find vertex positions, normals, colors
//! or even texture coordinates. Even though you’re free to use whichever type you want, you’re
//! limited to a range of types and dimensions. See [`VertexAttribType`] and [`VertexAttribDim`]
//! for further details.
//!
//! [`VertexAttribDim`]: crate::vertex::VertexAttribDim
//! [`VertexAttribType`]: crate::vertex::VertexAttribType
use std::fmt::Debug;
/// A type that can be used as a [`Vertex`] has to implement that trait – it must provide an
/// associated [`VertexDesc`] value via a function call. This associated value gives enough
/// information on the types being used as attributes to reify enough memory data to align and, size
/// and type buffers correctly.
///
/// In theory, you should never have to implement that trait directly. Instead, feel free to use the
/// [luminance-derive] [`Vertex`] proc-macro-derive instead.
///
/// > Note: implementing this trait is `unsafe`.
pub unsafe trait Vertex: Copy {
/// Number of attributes.
const ATTR_COUNT: usize;
/// The associated vertex format.
fn vertex_desc() -> VertexDesc;
}
unsafe impl Vertex for () {
const ATTR_COUNT: usize = 0;
fn vertex_desc() -> VertexDesc {
Vec::new()
}
}
/// TODO
pub trait Deinterleave<T> {
/// Rank of the type in the original type.
const RANK: usize;
}
/// A [`VertexDesc`] is a list of [`VertexBufferDesc`]s.
pub type VertexDesc = Vec<VertexBufferDesc>;
/// A vertex attribute descriptor in a vertex buffer.
///
/// Such a description is used to state what vertex buffers are made of and how they should be
/// aligned / etc.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub struct VertexBufferDesc {
/// Internal index of the attribute.
///
/// That index is used as a mapping with vertex shaders to know how to fetch vertex attributes.
pub index: usize,
/// The name of the attribute.
///
/// Such a name is used in vertex shaders to perform mapping.
pub name: &'static str,
/// Whether _vertex instancing_ should be used with that vertex attribute.
pub instancing: VertexInstancing,
/// Vertex attribute descriptor.
pub attrib_desc: VertexAttribDesc,
}
impl VertexBufferDesc {
/// Create a new [`VertexBufferDesc`].
pub fn new<S>(sem: S, instancing: VertexInstancing, attrib_desc: VertexAttribDesc) -> Self
where
S: Semantics,
{
let index = sem.index();
let name = sem.name();
VertexBufferDesc {
index,
name,
instancing,
attrib_desc,
}
}
}
/// Should vertex instancing be used for a vertex attribute?
///
/// Enabling this is done per attribute but if you enable it for a single attribute of a struct, it
/// should be enabled for all others (interleaved vertex instancing is not supported).
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum VertexInstancing {
/// Use vertex instancing.
On,
/// Disable vertex instancing.
Off,
}
/// Vertex attribute format.
///
/// Vertex attributes (such as positions, colors, texture UVs, normals, etc.) have all a specific
/// format that must be passed to the GPU. This type gathers information about a single vertex
/// attribute and is completly agnostic of the rest of the attributes used to form a vertex.
///
/// A type is associated with a single value of type [`VertexAttribDesc`] via the [`VertexAttrib`]
/// trait. If such an implementor exists for a type, it means that this type can be used as a vertex
/// attribute.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub struct VertexAttribDesc {
/// Type of the attribute. See [`VertexAttribType`] for further details.
pub ty: VertexAttribType,
/// Dimension of the attribute. It should be in 1–4. See [`VertexAttribDim`] for further details.
pub dim: VertexAttribDim,
/// Size in bytes that a single element of the attribute takes. That is, if your attribute has
/// a dimension set to 2, then the unit size should be the size of a single element (not two).
pub unit_size: usize,
/// Alignment of the attribute. The best advice is to respect what Rust does, so it’s highly
/// recommended to use `::std::mem::align_of` to let it does the job for you.
pub align: usize,
}
impl VertexAttribDesc {
/// Normalize a vertex attribute format’s type.
pub fn normalize(self) -> Self {
VertexAttribDesc {
ty: self.ty.normalize(),
..self
}
}
}
/// Possible type of vertex attributes.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum VertexAttribType {
/// An integral type.
///
/// Typically, `i32` is integral but not `u32`.
Integral(Normalized),
/// An unsigned integral type.
///
/// Typically, `u32` is unsigned but not `i32`.
Unsigned(Normalized),
/// A floating point integral type.
Floating,
/// A boolean integral type.
Boolean,
}
impl VertexAttribType {
/// Normalize a vertex attribute type if it’s integral.
///
/// Return the normalized integer vertex attribute type if non-normalized. Otherwise, return the
/// vertex attribute type directly.
pub fn normalize(self) -> Self {
match self {
VertexAttribType::Integral(Normalized::No) => VertexAttribType::Integral(Normalized::Yes),
VertexAttribType::Unsigned(Normalized::No) => VertexAttribType::Unsigned(Normalized::Yes),
_ => self,
}
}
}
/// Whether an integral vertex type should be normalized when fetched from a shader program.
///
/// The default implementation is not to normalize anything. You have to explicitly ask for
/// normalized integers (that will, then, be accessed as floating vertex attributes).
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum Normalized {
/// Normalize integral values and expose them as floating-point values.
Yes,
/// Do not perform any normalization and hence leave integral values as-is.
No,
}
/// Possible dimension of vertex attributes.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum VertexAttribDim {
/// 1D.
Dim1,
/// 2D.
Dim2,
/// 3D.
Dim3,
/// 4D.
Dim4,
}
/// Class of vertex attributes.
///
/// A vertex attribute type is always associated with a single constant of type [`VertexAttribDesc`],
/// giving GPUs hints about how to treat them.
pub unsafe trait VertexAttrib {
/// The vertex attribute descriptor.
const VERTEX_ATTRIB_DESC: VertexAttribDesc;
}
/// Vertex attribute semantics.
///
/// Vertex attribute semantics are a mean to make shaders and vertex buffers talk to each other
/// correctly. This is important for several reasons:
///
/// - The memory layout of your vertex buffers might be very different from an ideal case or even
/// the common case. Shaders don’t have any way to know where to pick vertex attributes from, so
/// a mapping is needed.
/// - Sometimes, a shader just need a few information from the vertex attributes. You then want to
/// be able to authorize _“gaps”_ in the semantics so that shaders can be used for several
/// varieties of vertex formats.
///
/// Vertex attribute semantics are any type that can implement this trait. The idea is that
/// semantics must be unique. The vertex position should have an index that is never used anywhere
/// else in the vertex buffer. Because of the second point above, it’s also highly recommended
/// (even though valid not to) to stick to the same index for a given semantics when you have
/// several tessellations – that allows better composition with shaders. Basically, the best advice
/// to follow: define your semantics once, and keep to them.
///
/// > Note: feel free to use the [luminance-derive] crate to automatically derive this trait from
/// > an `enum`.
pub trait Semantics: Sized + Copy + Clone + Debug {
/// Retrieve the semantics index of this semantics.
fn index(&self) -> usize;
/// Get the name of this semantics.
fn name(&self) -> &'static str;
/// Get all available semantics.
fn semantics_set() -> Vec<SemanticsDesc>;
}
impl Semantics for () {
fn index(&self) -> usize {
0
}
fn name(&self) -> &'static str {
""
}
fn semantics_set() -> Vec<SemanticsDesc> {
Vec::new()
}
}
/// Semantics description.
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct SemanticsDesc {
/// Semantics index.
pub index: usize,
/// Name of the semantics (used in shaders).
pub name: String,
}
/// Class of types that have an associated value which type implements [`Semantics`], defining
/// vertex legit attributes.
///
/// Vertex attribute types can be associated with only one semantics.
pub trait HasSemantics {
/// Type of the semantics.
///
/// See the [`Semantics`] trait for further information.
type Sem: Semantics;
/// The aforementioned vertex semantics for the attribute type.
const SEMANTICS: Self::Sem;
}
/// A local version of size_of that depends on the state of the std feature.
#[inline(always)]
const fn size_of<T>() -> usize {
#[cfg(feature = "std")]
{
::std::mem::size_of::<T>()
}
#[cfg(not(feature = "std"))]
{
::core::mem::size_of::<T>()
}
}
/// A local version of align_of that depends on the state of the std feature.
#[inline(always)]
const fn align_of<T>() -> usize {
#[cfg(feature = "std")]
{
::std::mem::align_of::<T>()
}
#[cfg(not(feature = "std"))]
{
::core::mem::align_of::<T>()
}
}
// Macro to quickly implement VertexAttrib for a given type.
macro_rules! impl_vertex_attribute {
($t:ty, $q:ty, $attr_ty:expr, $dim:expr) => {
unsafe impl VertexAttrib for $t {
const VERTEX_ATTRIB_DESC: VertexAttribDesc = VertexAttribDesc {
ty: $attr_ty,
dim: $dim,
unit_size: $crate::vertex::size_of::<$q>(),
align: $crate::vertex::align_of::<$q>(),
};
}
};
($t:ty, $attr_ty:expr) => {
impl_vertex_attribute!($t, $t, $attr_ty, VertexAttribDim::Dim1);
impl_vertex_attribute!([$t; 1], $t, $attr_ty, VertexAttribDim::Dim1);
impl_vertex_attribute!([$t; 2], $t, $attr_ty, VertexAttribDim::Dim2);
impl_vertex_attribute!([$t; 3], $t, $attr_ty, VertexAttribDim::Dim3);
impl_vertex_attribute!([$t; 4], $t, $attr_ty, VertexAttribDim::Dim4);
};
}
impl_vertex_attribute!(i8, VertexAttribType::Integral(Normalized::No));
impl_vertex_attribute!(i16, VertexAttribType::Integral(Normalized::No));
impl_vertex_attribute!(i32, VertexAttribType::Integral(Normalized::No));
impl_vertex_attribute!(u8, VertexAttribType::Unsigned(Normalized::No));
impl_vertex_attribute!(u16, VertexAttribType::Unsigned(Normalized::No));
impl_vertex_attribute!(u32, VertexAttribType::Unsigned(Normalized::No));
impl_vertex_attribute!(f32, VertexAttribType::Floating);
impl_vertex_attribute!(f64, VertexAttribType::Floating);
impl_vertex_attribute!(bool, VertexAttribType::Boolean);