draco-oxide 0.1.0-alpha.8

draco-oxide is a rust rewrite of Google's draco mesh compression library.
Documentation 
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

// lib.rs

/// Re-export of the shared core crate (`draco-oxide-core`): the geometry/attribute
/// data model, numeric primitives (`core::types`), and the codec algorithms shared
/// between encoder and decoder (`core::codec`). Reachable as `draco_oxide::core`.
pub use draco_oxide_core as core;

// Re-export the core data-model types a caller needs to drive the encoder, so
// depending on `draco-oxide` alone is enough — no separate `draco-oxide-core`
// import just to name a `Mesh`, build one, or reach `Config::default()`. The full
// surface remains available under `draco_oxide::core`.

/// The geometry container consumed by [`encode`](encode::encode), and the builder
/// used to assemble one.
///
/// Everything needed to drive the encoder is reachable from `draco_oxide` alone:
///
/// ```
/// use draco_oxide::{
///     Attribute, AttributeDomain, AttributeType, ComponentDataType, ConfigType, Mesh,
///     MeshBuilder, NdVector,
/// };
/// use draco_oxide::encode::Config;
///
/// let _builder = MeshBuilder::new();
/// let _cfg = <Config as ConfigType>::default();
/// let _ty = AttributeType::Position;
/// let _dom = AttributeDomain::Position;
/// let _ct = ComponentDataType::F32;
/// fn _drives(_m: Mesh, _a: Attribute, _v: NdVector<3, f32>) {}
/// ```
pub use draco_oxide_core::mesh::{builder::MeshBuilder, Mesh};

/// The attribute data model: a vertex attribute and the enums describing it.
pub use draco_oxide_core::attribute::{
    Attribute, AttributeDomain, AttributeId, AttributeType, ComponentDataType,
};

/// Numeric primitive for attribute values, and the trait exposing `default()` on
/// the encoder configs.
pub use draco_oxide_core::types::{ConfigType, NdVector};

/// Contains the interface between `Mesh` object and 3D geometry files
/// such as obj and gltf.
pub mod io;

/// Defines the mesh encoder.
pub mod encode;

// The decoder crate (`draco-oxide-decoder`) is not published to crates.io yet, so
// `draco-oxide` cannot depend on it while it is published. Once the decoder is
// published, re-add the optional dep + `decoder` feature and restore:
//
//     #[cfg(feature = "decoder")]
//     pub use draco_oxide_decoder::decode;

/// Cross-crate round-trip / integration tests relocated from `draco-oxide-core`
/// and `draco-oxide-decoder` (they need the encoder + io + decoder together).
#[cfg(test)]
mod roundtrip_tests;

/// Evaluation module contains the evaluation functions for the encoder and the decoder.
/// When enabled, draco-oxide encoder will spit out the evaluation data mixed with encoded data,
/// and then the `EvalWriter` is used to filter out the evaluation data. This functionality is
/// most often used in the development and testing phase.
#[cfg(feature = "evaluation")]
pub mod eval;