https://github.com/mosure/bevy_interleave

derive macros for interleaved and planar formats, compatible with bevy ShaderType
https://github.com/mosure/bevy_interleave

bevy interleaved macros

Last synced: 3 months ago
JSON representation

derive macros for interleaved and planar formats, compatible with bevy ShaderType

• Host: GitHub
• URL: https://github.com/mosure/bevy_interleave
• Owner: mosure
• License: mit
• Created: 2024-02-11T21:21:52.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-02-21T22:45:21.000Z (11 months ago)
• Last Synced: 2024-10-09T06:41:16.332Z (3 months ago)
• Topics: bevy, interleaved, macros
• Language: Rust
• Homepage:
• Size: 41 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bevy_interleave 🧩

[![test](https://github.com/mosure/bevy_interleave/workflows/test/badge.svg)](https://github.com/Mosure/bevy_interleave/actions?query=workflow%3Atest)

[![GitHub License](https://img.shields.io/github/license/mosure/bevy_interleave)](https://raw.githubusercontent.com/mosure/bevy_interleave/main/LICENSE)

[![GitHub Releases](https://img.shields.io/github/v/release/mosure/bevy_interleave?include_prereleases&sort=semver)](https://github.com/mosure/bevy_interleave/releases)

[![GitHub Issues](https://img.shields.io/github/issues/mosure/bevy_interleave)](https://github.com/mosure/bevy_interleave/issues)

[![crates.io](https://img.shields.io/crates/v/bevy_interleave.svg)](https://crates.io/crates/bevy_interleave)

bevy support for e2e packed to planar bind groups

## minimal example

```rust

use bevy_interleave::prelude::*;

#[derive(

    Debug,

    Planar,

    ReflectInterleaved,

    StorageBindings,

    TextureBindings,

)]

pub struct MyStruct {

    #[texture_format(TextureFormat::R32Sint)]

    pub field: i32,

    #[texture_format(TextureFormat::R32Uint)]

    pub field2: u32,

    #[texture_format(TextureFormat::R8Unorm)]

    pub bool_field: bool,

    #[texture_format(TextureFormat::Rgba32Uint)]

    pub array: [u32; 4],

}

fn interleaved() -> Vec {

    vec![

        MyStruct { field: 0, field2: 1_u32, bool_field: true, array: [0, 1, 2, 3] },

        MyStruct { field: 2, field2: 3_u32, bool_field: false, array: [4, 5, 6, 7] },

        MyStruct { field: 4, field2: 5_u32, bool_field: true, array: [8, 9, 10, 11] },

    ];

}

fn main() {

    let planar = PlanarMyStruct::from_interleaved(interleaved());

    println!("{:?}", planar.field);

    println!("{:?}", planar.field2);

    println!("{:?}", planar.bool_field);

    println!("{:?}", planar.array);

    // Prints:

    // [0, 2, 4]

    // [1, 3, 5]

    // [true, false, true]

    // [[0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11]]

    println!("\n\n{:?}", MyStruct::min_binding_sizes());

    println!("{:?}", MyStruct::ordered_field_names());

    // Prints:

    // [4, 4, 1, 16]

    // ["field", "field2", "bool_field", "array"]

    let mut app = App::new()

        .add_plugins((

            DefaultPlugins,

            PlanarPlugin::::default(),

            PlanarTexturePlugin::::default(),

        ));

    app.sub_app_mut(bevy::render::RenderApp)

        .add_systems(

            bevy::render::Render,

            check_bind_group.in_set(bevy::render::RenderSet::QueueMeshes),

        );

    app.run();

}

fn setup_planar_asset(

    mut commands: Commands,

    mut planar_assets: ResMut>,

) {

    let planar = PlanarMyStruct::from_interleaved(interleaved());

    commands.spawn(planar_assets.add(planar));

}

fn check_bind_group(

    bind_group: Query<&PlanarTextureBindGroup::>,

) {

    // attach bind group to render pipeline

    // size:

    //     2 x 2 x bpp

    // format:

    //     binding: 0 - texture - R32Sint - depth 1

    //     binding: 1 - texture - R32Uint - depth 1

    //     binding: 2 - texture - R8Unorm - depth 1

    //     binding: 3 - texture - Rgba32Uint - depth 1

}

```

## why bevy?

`bevy_interleave` simplifies bind group creation within `bevy`. `Planar` derives can be used in conjunction with `ShaderType`'s to support both packed and planar data render pipelines.

## compatible bevy versions

| `bevy_interleave` | `bevy` |

| :--               | :--    |

| `0.2`             | `0.13` |

| `0.1`             | `0.12` |