alice-sdf 5.0.0

ALICE-SDF: 3D/Spatial Data Specialist — Store laws, not polygons. GLSL/WGSL/HLSL transpile, SVO, GPU marching cubes, texture-fit, procedural CSG. Optional bridges to alice-physics / alice-codec / libasp / alice-cache behind features.
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//! FFI functions for library version info and category counts.
//!
//! Author: Moroya Sakamoto

use super::guard::{clear_last_error, ffi_guard, take_last_error};
use super::types::*;
use crate::prelude::*;
use std::ffi::{c_char, CString};
use std::ptr;

// ============================================================================
// Library Info
// ============================================================================

/// Get the library version
#[no_mangle]
pub const extern "C" fn alice_sdf_version() -> VersionInfo {
    VersionInfo::current()
}

/// Get version string (caller must free with alice_sdf_free_string)
#[no_mangle]
pub extern "C" fn alice_sdf_version_string() -> *mut c_char {
    ffi_guard(std::ptr::null_mut(), || {
        let version = format!(
            "ALICE-SDF v{}.{}.{} (Deep Fried)",
            VersionInfo::current().major,
            VersionInfo::current().minor,
            VersionInfo::current().patch
        );
        CString::new(version).map_or_else(|_| ptr::null_mut(), CString::into_raw)
    })
}

// ============================================================================
// Error reporting
// ============================================================================

/// Message of the most recent panic / error raised by an FFI call on this
/// thread, or null if there is none. Every exported function catches panics
/// internally (returning its sentinel: null handle, `f32::MAX`, `0`, `false`
/// or `SdfResult_Unknown`) and records the message here; the message is
/// consumed by this call. Caller must free with `alice_sdf_free_string`.
#[no_mangle]
pub extern "C" fn alice_sdf_last_error() -> *mut c_char {
    ffi_guard(ptr::null_mut(), || {
        take_last_error()
            .and_then(|m| CString::new(m).ok())
            .map_or_else(ptr::null_mut, CString::into_raw)
    })
}

/// Discard the most recent error message on this thread.
#[no_mangle]
pub extern "C" fn alice_sdf_clear_last_error() {
    // cannot panic in practice; guarded so the "every extern fn is guarded"
    // invariant holds without an allowlist
    ffi_guard((), clear_last_error);
}

// ============================================================================
// Category Counts
// ============================================================================

/// Get number of primitive SDF variants
#[no_mangle]
pub const extern "C" fn alice_sdf_primitive_count() -> u32 {
    SdfCategory::Primitive.count()
}

/// Get number of operation SDF variants
#[no_mangle]
pub const extern "C" fn alice_sdf_operation_count() -> u32 {
    SdfCategory::Operation.count()
}

/// Get number of transform SDF variants
#[no_mangle]
pub const extern "C" fn alice_sdf_transform_count() -> u32 {
    SdfCategory::Transform.count()
}

/// Get number of modifier SDF variants
#[no_mangle]
pub const extern "C" fn alice_sdf_modifier_count() -> u32 {
    SdfCategory::Modifier.count()
}

/// Get total number of all SDF variants
#[no_mangle]
pub const extern "C" fn alice_sdf_total_count() -> u32 {
    SdfCategory::total()
}

#[cfg(test)]
mod tests {
    use super::*;

    /// `alice_sdf_version()` is what a C caller (the UE5 plugin, the Unity
    /// bindings) uses to decide whether the library matches what it was built
    /// against. It reported 1.1.0 through the whole 2.x and 3.0/3.1 line
    /// because the numbers were hand-written.
    #[test]
    fn version_is_the_crate_version() {
        let v = alice_sdf_version();
        assert_eq!(
            (u32::from(v.major), u32::from(v.minor), u32::from(v.patch)),
            (
                env!("CARGO_PKG_VERSION_MAJOR").parse::<u32>().unwrap(),
                env!("CARGO_PKG_VERSION_MINOR").parse::<u32>().unwrap(),
                env!("CARGO_PKG_VERSION_PATCH").parse::<u32>().unwrap()
            ),
            "alice_sdf_version() must follow Cargo.toml"
        );
    }

    #[test]
    fn version_string_matches_version() {
        let ptr = alice_sdf_version_string();
        assert!(!ptr.is_null());
        let text = unsafe { CString::from_raw(ptr) }.into_string().unwrap();
        assert!(
            text.contains(env!("CARGO_PKG_VERSION")),
            "`{text}` does not contain {}",
            env!("CARGO_PKG_VERSION")
        );
    }
}