Bevy Crevice

这是为 Crevice 和 Bevy 的一个分支。

对于不在Bevy中使用的场合，您应考虑直接使用 Crevice。

分支是为了更好地集成到Bevy中

• 使用 derive 宏更简单，无需直接依赖 Crevice。
• 使用未合并的功能（截至分支），如 数组支持。
• 对特性和宏进行重命名，以更好地匹配Bevy API。

Crevice

Crevice通过 derive 宏的强大功能创建与GLSL兼容的类型版本。生成的结构体提供了一个 as_bytes 方法，允许将数据安全地打包到缓冲区以进行上传。

生成的结构体还实现了 bytemuck::Zeroable 和 bytemuck::Pod，以供其他库使用。

Crevice类似于 glsl-layout，但支持许多数学库的类型，可以生成从结构体到GLSL的源代码，并显式初始化填充以消除未定义行为的一个来源。

Crevice通过功能标志支持许多Rust数学库，并且通过 mint crate 支持大多数其他数学库。Crevice目前支持

• mint 0.5，默认启用
• cgmath 0.18，使用 cgmath 功能
• nalgebra 0.29，使用 nalgebra 功能
• glam 0.20，使用 glam 功能

欢迎提交PR添加或更新Crevice的数学库。

如果您的数学库不受支持，您可以使用mint中的类型定义结构体，并将您的数学库的类型转换为mint类型。大多数Rust数学库都支持此操作。

您的数学库可能需要您启用一个功能标志以获得 mint 支持。例如，cgmath 需要启用 "mint" 功能才能允许 mint 类型之间的转换。

示例

单个值

通过派生 AsStd140 并使用 as_std140 和 as_bytes 将结果转换为字节，可以实现上传多种类型。

uniform MAIN {
    mat3 orientation;
    vec3 position;
    float scale;
} main;

use bevy_crevice::std140::{AsStd140, Std140};

#[derive(AsStd140)]
struct MainUniform {
    orientation: mint::ColumnMatrix3<f32>,
    position: mint::Vector3<f32>,
    scale: f32,
}

let value = MainUniform {
    orientation: [
        [1.0, 0.0, 0.0],
        [0.0, 1.0, 0.0],
        [0.0, 0.0, 1.0],
    ].into(),
    position: [1.0, 2.0, 3.0].into(),
    scale: 4.0,
};

let value_std140 = value.as_std140();

upload_data_to_gpu(value_std140.as_bytes());

序列类型

可以使用 std140 Writer 类型上传更复杂的数据。

struct PointLight {
    vec3 position;
    vec3 color;
    float brightness;
};

buffer POINT_LIGHTS {
    uint len;
    PointLight[] lights;
} point_lights;

use bevy_crevice::std140::{self, AsStd140};

#[derive(AsStd140)]
struct PointLight {
    position: mint::Vector3<f32>,
    color: mint::Vector3<f32>,
    brightness: f32,
}

let lights = vec![
    PointLight {
        position: [0.0, 1.0, 0.0].into(),
        color: [1.0, 0.0, 0.0].into(),
        brightness: 0.6,
    },
    PointLight {
        position: [0.0, 4.0, 3.0].into(),
        color: [1.0, 1.0, 1.0].into(),
        brightness: 1.0,
    },
];

let target_buffer = map_gpu_buffer_for_write();
let mut writer = std140::Writer::new(target_buffer);

let light_count = lights.len() as u32;
writer.write(&light_count)?;

// Crevice will automatically insert the required padding to align the
// PointLight structure correctly. In this case, there will be 12 bytes of
// padding between the length field and the light list.

writer.write(lights.as_slice())?;

unmap_gpu_buffer();

功能

• std（默认）：启用基于 std::io::Write 的结构。
• cgmath：启用对 cgmath 类型支持。
• nalgebra：启用对 nalgebra 类型支持。
• glam：启用对 glam 类型支持。

最小支持的 Rust 版本（MSRV）

由于使用了新的 const fn 功能，Crevice 支持 Rust 1.52.1 及更高版本。

许可

在以下任一许可下授权：

• Apache License，版本 2.0，（LICENSE-APACHE）
• MIT 许可证（LICENSE-MIT）

任选其一。

贡献

除非您明确声明，否则您提交的任何贡献，根据 Apache-2.0 许可证定义，将按照上述方式双授权，不附加任何额外的条款或条件。