fmod-oxide 0.2.1

Zero cost bindings to FMOD and FMOD Studio
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

// Copyright (c) 2024 Melody Madeline Lyons
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

use crate::{Error, FmodResultExt, Result};
use fmod_sys::*;
use std::{ffi::c_char, os::raw::c_int};

mod structs;

use lanyard::Utf8CString;
pub use structs::*;

mod flags;
pub use flags::*;

mod enums;
pub use enums::*;

mod bank;
pub use bank::*;

mod bus;
pub use bus::*;

mod system;
pub use system::*;

mod command_replay;
pub use command_replay::*;

mod event_description;
pub use event_description::*;

mod event_instance;
pub use event_instance::*;

mod vca;
pub use vca::*;

fn get_string_out_size(
    mut get_fn: impl FnMut(*mut c_char, c_int, *mut c_int) -> fmod_sys::FMOD_RESULT,
) -> Result<Utf8CString> {
    let mut string_len = 0;

    match get_fn(std::ptr::null_mut(), 0, &raw mut string_len).to_error() {
        Some(Error::Truncated) => {}
        Some(err) => return Err(err),
        _ => {}
    }

    let mut buf = vec![0u8; string_len as usize];
    let mut expected_string_len = 0;

    get_fn(
        buf.as_mut_ptr().cast(),
        string_len,
        &raw mut expected_string_len,
    )
    .to_result()?;

    debug_assert_eq!(string_len, expected_string_len);

    let string = Utf8CString::from_utf8_with_nul(buf).unwrap();
    Ok(string)
}

/// The required memory alignment of banks in user memory.
///
/// When using [`System::load_bank_pointer`] you must align the past slice to this alignment.
pub const LOAD_POINT_ALIGNMENT: usize = FMOD_STUDIO_LOAD_MEMORY_ALIGNMENT as _;