Skip to content

Commit

Permalink
Unify type_for_format* macros (vulkano-rs#2171)
Browse files Browse the repository at this point in the history
  • Loading branch information
@marc0246 @hakolao
marc0246 authored and hakolao committed Feb 20, 2024
1 parent e38be60 commit 5efbea2
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 74 deletions.
11 changes: 8 additions & 3 deletions vulkano/Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
name = "vulkano"
version = "0.32.0"
edition = "2021"
authors = ["Pierre Krieger <pierre.krieger1708@gmail.com>", "The vulkano contributors"]
authors = [
"Pierre Krieger <pierre.krieger1708@gmail.com>",
"The vulkano contributors",
]
repository = "https://github.com/vulkano-rs/vulkano"
description = "Safe wrapper for the Vulkan graphics API"
license = "MIT/Apache-2.0"
Expand All @@ -19,11 +22,9 @@ ahash = "0.8"
# All versions of vk.xml can be found at https://github.com/KhronosGroup/Vulkan-Headers/commits/main/registry/vk.xml.
ash = "^0.37.2"
bytemuck = "1.7"
cgmath = { version = "0.18.0", optional = true }
crossbeam-queue = "0.3"
half = { version = "2", features = ["bytemuck"] }
libloading = "0.7"
nalgebra = { version = "0.32.0", optional = true }
once_cell = "1.17"
parking_lot = { version = "0.12", features = ["send_guard"] }
serde = { version = "1.0", optional = true }
Expand All @@ -47,5 +48,9 @@ serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
vk-parse = "0.8"

[dev-dependencies]
cgmath = "0.18"
nalgebra = "0.32"

[features]
document_unchecked = []
87 changes: 18 additions & 69 deletions vulkano/autogen/formats.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ fn formats_output(members: &[FormatMember]) -> TokenStream {
..
}| {
(type_cgmath.as_ref().or(type_std_array.as_ref())).map(|ty| {
quote! { (#name) => { #ty }; }
quote! { (cgmath, #name) => { #ty }; }
})
},
);
Expand All @@ -243,7 +243,7 @@ fn formats_output(members: &[FormatMember]) -> TokenStream {
..
}| {
(type_nalgebra.as_ref().or(type_std_array.as_ref())).map(|ty| {
quote! { (#name) => { #ty }; }
quote! { (nalgebra, #name) => { #ty }; }
})
},
);
Expand Down Expand Up @@ -551,87 +551,36 @@ fn formats_output(members: &[FormatMember]) -> TokenStream {
///
/// # Examples
///
/// For arrays:
///
/// ```
/// # #[macro_use] extern crate vulkano;
/// # fn main() {
/// # use vulkano::type_for_format;
/// let pixel: type_for_format!(R32G32B32A32_SFLOAT);
/// # }
/// pixel = [1.0f32, 0.0, 0.0, 1.0];
/// ```
///
/// The type of `pixel` will be `[f32; 4]`.
#[macro_export]
macro_rules! type_for_format {
#(#type_for_format_items)*
}

/// Converts a format enum identifier to a [`cgmath`] or standard Rust type that is
/// suitable for representing the format in a buffer or image.
///
/// This macro returns one possible suitable representation, but there are usually other
/// possibilities for a given format. A compile error occurs for formats that have no
/// well-defined size (the `size` method returns `None`).
///
/// - For regular unpacked formats with one component, this returns a single floating point,
/// signed or unsigned integer with the appropriate number of bits. For formats with
/// multiple components, a [`cgmath`] `Vector` is returned.
/// - For packed formats, this returns an unsigned integer with the size of the packed
/// element. For multi-packed formats (such as `2PACK16`), an array is returned.
/// - For compressed formats, this returns `[u8; N]` where N is the size of a block.
///
/// Note: for 16-bit floating point values, you need to import the [`half::f16`] type.
///
/// # Examples
/// For [`cgmath`]:
///
/// ```
/// # #[macro_use] extern crate vulkano;
/// # fn main() {
/// let pixel: type_for_format_cgmath!(R32G32B32A32_SFLOAT);
/// # }
/// # use vulkano::type_for_format;
/// let pixel: type_for_format!(cgmath, R32G32B32A32_SFLOAT);
/// pixel = cgmath::Vector4::new(1.0f32, 0.0, 0.0, 1.0);
/// ```
///
/// The type of `pixel` will be [`Vector4<f32>`].
///
/// [`cgmath`]: https://crates.io/crates/cgmath
/// [`Vector4<f32>`]: https://docs.rs/cgmath/latest/cgmath/struct.Vector4.html
#[cfg(feature = "cgmath")]
#[macro_export]
macro_rules! type_for_format_cgmath {
#(#type_for_format_cgmath_items)*
}

/// Converts a format enum identifier to a [`nalgebra`] or standard Rust type that is
/// suitable for representing the format in a buffer or image.
///
/// This macro returns one possible suitable representation, but there are usually other
/// possibilities for a given format. A compile error occurs for formats that have no
/// well-defined size (the `size` method returns `None`).
///
/// - For regular unpacked formats with one component, this returns a single floating point,
/// signed or unsigned integer with the appropriate number of bits. For formats with
/// multiple components, a [`nalgebra`] [`SVector`] is returned.
/// - For packed formats, this returns an unsigned integer with the size of the packed
/// element. For multi-packed formats (such as `2PACK16`), an array is returned.
/// - For compressed formats, this returns `[u8; N]` where N is the size of a block.
///
/// Note: for 16-bit floating point values, you need to import the [`half::f16`] type.
///
/// # Examples
/// For [`nalgebra`]:
///
/// ```
/// # #[macro_use] extern crate vulkano;
/// # fn main() {
/// let pixel: type_for_format_nalgebra!(R32G32B32A32_SFLOAT);
/// # }
/// # use vulkano::type_for_format;
/// let pixel: type_for_format!(nalgebra, R32G32B32A32_SFLOAT);
/// pixel = nalgebra::vector![1.0f32, 0.0, 0.0, 1.0];
/// ```
///
/// The type of `pixel` will be [`Vector4<f32>`].
///
/// [`cgmath`]: https://crates.io/crates/cgmath
/// [`nalgebra`]: https://crates.io/crates/nalgebra
/// [`SVector`]: https://docs.rs/nalgebra/latest/nalgebra/base/type.SVector.html
/// [`Vector4<f32>`]: https://docs.rs/nalgebra/latest/nalgebra/base/type.Vector4.html
#[cfg(feature = "nalgebra")]
#[macro_export]
macro_rules! type_for_format_nalgebra {
macro_rules! type_for_format {
#(#type_for_format_items)*
#(#type_for_format_cgmath_items)*
#(#type_for_format_nalgebra_items)*
}
}
Expand Down
2 changes: 0 additions & 2 deletions vulkano/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@
//! | Feature | Description |
//! |----------------------|-------------------------------------------------------------------------------|
//! | `document_unchecked` | Include `_unchecked` functions in the generated documentation. |
//! | `cgmath` | Generate additional definitions and functions using the [`cgmath`] library. |
//! | `nalgebra` | Generate additional definitions and functions using the [`nalgebra`] library. |
//! | `serde` | Enables (de)serialization of certain types using [`serde`]. |
//!
//! # Starting off with Vulkano
Expand Down

0 comments on commit 5efbea2

Please # to comment.