gfxd-sys 0.1.1

Rust bindings for libgfxd, the N64 display list decompiler 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

/* SPDX-FileCopyrightText: © 2025 Decompollaborate */
/* SPDX-License-Identifier: MIT */

//! Read and write `Gfx` packets.
//!
//! The input consists of any number of `Gfx` packets, and the output is the
//! decompiled macros in plain-text. The endianness and microcode type of the
//! input can be set using [`gfxd_endian`] and [`gfxd_target`].
//!
//! Several methods of doing I/O are available. No method is selected by
//! default, meaning there will be no input, and any output will be discarded.
//!
//! [`gfxd_endian`]: crate::settings::gfxd_endian
//! [`gfxd_target`]: crate::settings::gfxd_target

use crate::ffi;

use crate::ptr::{NonNullConst, NonNullMut};

#[link(name = "gfxd", kind = "static")]
extern "C" {
    /// Use the buffer pointed to by `buf`, of `size` bytes.
    pub fn gfxd_input_buffer(buf: Option<NonNullConst<ffi::c_void>>, size: ffi::c_int);

    /// Use the buffer pointed to by `buf`, of `size` bytes.
    pub fn gfxd_output_buffer(buf: Option<NonNullConst<ffi::c_char>>, size: ffi::c_int);

    /// Use `read()` with the provided file descriptor, `fd`.
    pub fn gfxd_input_fd(fd: ffi::c_int);

    /// Use `write()` with the provided file descriptor, `fd`.
    pub fn gfxd_output_fd(fd: ffi::c_int);

    /// Use the provided callback function, `fn`.
    ///
    /// `fn` should copy at most `count` bytes to/from `buf`, and return the
    /// number of bytes actually copied.
    ///
    /// The input callback should return 0 to signal end of input.
    pub fn gfxd_input_callback(fn_: Option<gfxd_input_fn_t>);

    /// Use the provided callback function, `fn`.
    ///
    /// `fn` should copy at most `count` bytes to/from `buf`, and return the
    /// number of bytes actually copied.
    pub fn gfxd_output_callback(fn_: Option<gfxd_output_fn_t>);
}

pub type gfxd_input_fn_t =
    unsafe extern "C" fn(buf: NonNullMut<ffi::c_void>, count: ffi::c_int) -> ffi::c_int;

pub type gfxd_output_fn_t =
    unsafe extern "C" fn(buf: NonNullConst<ffi::c_char>, count: ffi::c_int) -> ffi::c_int;