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
#![cfg_attr(docs, feature(doc_auto_cfg))]
#![deny(rustdoc::broken_intra_doc_links)]
#![warn(
future_incompatible,
nonstandard_style,
rust_2018_idioms,
rust_2021_compatibility,
unused,
// missing_docs,
single_use_lifetimes,
trivial_casts,
trivial_numeric_casts,
// unreachable_pub,
unused_qualifications,
variant_size_differences
)]
#![doc = include_str!("../README.md")]
#![doc(
html_logo_url = "https://raw.githubusercontent.com/teoxoy/encase/3d6d2e4d7670863e97463a15ceeafac6d13ee73e/logo.svg"
)]
/// Used to implement `ShaderType` for structs
///
/// # Attributes
///
/// Field attributes
///
/// - `#[align(X)]` where `X` is a power of 2 [`u32`] literal (equivalent to [WGSL align attribute](https://gpuweb.github.io/gpuweb/wgsl/#attribute-align))
///
/// Used to increase the alignment of the field
///
/// - `#[size(X)]` where `X` is a [`u32`] literal (equivalent to [WGSL size attribute](https://gpuweb.github.io/gpuweb/wgsl/#attribute-size))
///
/// Used to increase the size of the field
///
/// - `#[size(runtime)]` can only be attached to the last field of the struct
///
/// Used to denote the fact that the field it is attached to is a runtime-sized array
///
/// # Note about generics
///
/// While structs using generic type parameters are supported by this derive macro
///
/// - the `#[align(X)]` and `#[size(X)]` attributes will only work
/// if they are attached to fields whose type contains no generic type parameters
///
/// # Examples
///
/// Simple
///
/// ```
/// # use mint;
/// # use crate::encase::ShaderType;
/// #[derive(ShaderType)]
/// struct AffineTransform2D {
/// matrix: mint::ColumnMatrix2<f32>,
/// translate: mint::Vector2<f32>
/// }
/// ```
///
/// Contains a runtime-sized array
///
/// _The [`ArrayLength`] type can be used to explicitly write or read the length of the contained runtime-sized array_
///
/// ```
/// # use mint;
/// # use crate::encase::ShaderType;
/// # use crate::encase::ArrayLength;
/// #[derive(ShaderType)]
/// struct Positions {
/// length: ArrayLength,
/// #[size(runtime)]
/// positions: Vec<mint::Point2<f32>>
/// }
/// ```
///
/// Complex
///
/// ```
/// # use crate::encase::{ShaderType, ShaderSize};
/// #[derive(ShaderType)]
/// struct Complex<
/// 'a,
/// 'b: 'a,
/// E: 'a + ShaderType + ShaderSize,
/// T: 'b + ShaderType + ShaderSize,
/// const N: usize,
/// > {
/// array: [&'a mut E; N],
/// #[size(runtime)]
/// rts_array: &'a mut Vec<&'b T>,
/// }
/// ```
///
pub use encase_derive::ShaderType;
#[macro_use]
mod utils;
mod core;
mod types;
mod impls;
pub use crate::core::{
CalculateSizeFor, DynamicStorageBuffer, DynamicUniformBuffer, ShaderSize, ShaderType,
StorageBuffer, UniformBuffer,
};
pub use types::runtime_sized_array::ArrayLength;
pub mod internal {
pub use super::core::{
AlignmentValue, BufferMut, BufferRef, CreateFrom, EnlargeError, Error, ReadContext,
ReadFrom, Reader, Result, SizeValue, WriteContext, WriteInto, Writer,
};
}
/// Module containing items necessary to implement `ShaderType` for runtime-sized arrays
pub mod rts_array {
#[doc(inline)]
pub use super::impl_rts_array;
pub use super::types::runtime_sized_array::{Length, Truncate};
}
/// Module containing items necessary to implement `ShaderType` for vectors
pub mod vector {
#[doc(inline)]
pub use super::impl_vector;
pub use super::types::vector::{
AsMutVectorParts, AsRefVectorParts, FromVectorParts, VectorScalar,
};
}
/// Module containing items necessary to implement `ShaderType` for matrices
pub mod matrix {
#[doc(inline)]
pub use super::impl_matrix;
pub use super::types::matrix::{
AsMutMatrixParts, AsRefMatrixParts, FromMatrixParts, MatrixScalar,
};
}
/// Private module used by macros
#[doc(hidden)]
pub mod private {
pub use super::build_struct;
pub use super::core::AlignmentValue;
pub use super::core::BufferMut;
pub use super::core::BufferRef;
pub use super::core::CreateFrom;
pub use super::core::Metadata;
pub use super::core::ReadFrom;
pub use super::core::Reader;
pub use super::core::RuntimeSizedArray;
pub use super::core::SizeValue;
pub use super::core::WriteInto;
pub use super::core::Writer;
pub use super::types::array::ArrayMetadata;
pub use super::types::matrix::*;
pub use super::types::r#struct::StructMetadata;
pub use super::types::runtime_sized_array::{ArrayLength, Length, Truncate};
pub use super::types::vector::*;
pub use super::utils::consume_zsts;
pub use super::CalculateSizeFor;
pub use super::ShaderSize;
pub use super::ShaderType;
pub use const_panic::concat_assert;
}