gvox-rs

Safe, high-level Rust API for the GVOX voxel data library

This library supplies an idiomatic Rust abstraction over the GVOX C API. It provides type safety, memory safety, and thread safety without any significant deviation from the C library's design. For more information on the API's design, see the GVOX Wiki.

Below is a simple example which demonstrates how to create adapter contexts and utilize them to convert a .gvox file to colored text console output. For additional examples, see the tests in src/tests.rs.

```rust const BYTES: &[u8] = includebytes!("palette.gvox"); let mut obuffer = Box::default();

{ let gvoxctx = gvoxrs::Context::new();

let o_config = gvox_rs::adapters::ByteBufferOutputAdapterConfig::from(&mut o_buffer);

let s_config = gvox_rs::adapters::ColoredTextSerializeAdapterConfig {
    downscale_factor: 1,
    downscale_mode: gvox_rs::adapters::ColoredTextSerializeAdapterDownscaleMode::Nearest,
    non_color_max_value: 5,
};

let mut i_ctx = gvox_ctx.get_adapter::<gvox_rs::Input, gvox_rs::adapters::ByteBuffer>()
    .expect("Failed to get byte buffer input adapter.").create_adapter_context(BYTES)
    .expect("Failed to create adapter context.");

let mut o_ctx = gvox_ctx.get_adapter::<gvox_rs::Output, gvox_rs::adapters::ByteBuffer>()
    .expect("Failed to get byte buffer input adapter.").create_adapter_context(o_config)
    .expect("Failed to create adapter context.");

let mut p_ctx = gvox_ctx.get_adapter::<gvox_rs::Parse, gvox_rs::adapters::GvoxPalette>()
    .expect("Failed to get byte buffer input adapter.").create_adapter_context(())
    .expect("Failed to create adapter context.");

let mut s_ctx = gvox_ctx.get_adapter::<gvox_rs::Serialize, gvox_rs::adapters::ColoredText>()
    .expect("Failed to get byte buffer input adapter.").create_adapter_context(s_config)
    .expect("Failed to create adapter context.");

let region = gvox_rs::RegionRange {
    offset: gvox_rs::Offset3D {
        x: -4,
        y: -4,
        z: -4,
    },
    extent: gvox_rs::Extent3D { x: 8, y: 8, z: 8 },
};

gvox_rs::blit_region(
    &mut i_ctx,
    &mut o_ctx,
    &mut p_ctx,
    &mut s_ctx,
    &region,
    gvox_rs::ChannelId::COLOR | gvox_rs::ChannelId::NORMAL | gvox_rs::ChannelId::MATERIAL_ID,
).expect("Error while translating.");

}

asserteq!(22228, obuffer.len(), "Buffer output length did not match expected."); println!("{}", std::str::fromutf8(&obuffer).expect("Bad string slice.")); ```

Building

For now, you must have the following things installed to build the repository * A C++ compiler * CMake (3.21 or higher) * Ninja build * vcpkg (plus the VCPKGROOT environment variable) * The latest WASISDK (if you are building for WASM)