apple-metal 0.6.0

Safe Rust bindings for Apple's Metal framework — devices, resources, command encoding, advanced GPU objects, and IOSurface interop on macOS, backed by a Swift bridge
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

//! Raw FFI declarations matching `swift-bridge/Sources/AppleMetalBridge/AppleMetal.swift`.

#![allow(missing_docs)]

use core::ffi::c_void;

extern "C" {
    pub fn am_device_system_default() -> *mut c_void;
    pub fn am_device_release(handle: *mut c_void);
    pub fn am_device_has_unified_memory(handle: *mut c_void) -> bool;
    pub fn am_device_recommended_max_working_set_size(handle: *mut c_void) -> u64;
    pub fn am_device_supports_family(handle: *mut c_void, family: i64) -> bool;

    pub fn am_device_new_buffer(
        device_handle: *mut c_void,
        length: usize,
        options: usize,
    ) -> *mut c_void;
    pub fn am_buffer_release(handle: *mut c_void);
    pub fn am_buffer_length(handle: *mut c_void) -> usize;
    pub fn am_buffer_contents(handle: *mut c_void) -> *mut c_void;

    pub fn am_device_new_texture_2d(
        device_handle: *mut c_void,
        pixel_format: usize,
        width: usize,
        height: usize,
        mipmapped: bool,
        usage: usize,
        storage_mode: usize,
    ) -> *mut c_void;
    pub fn am_texture_release(handle: *mut c_void);
    pub fn am_texture_width(handle: *mut c_void) -> usize;
    pub fn am_texture_height(handle: *mut c_void) -> usize;
    pub fn am_texture_pixel_format(handle: *mut c_void) -> usize;

    pub fn am_device_new_texture_from_iosurface(
        device_handle: *mut c_void,
        iosurface_ptr: *mut c_void,
        plane_index: usize,
        pixel_format: usize,
        width: usize,
        height: usize,
    ) -> *mut c_void;

    pub fn am_device_new_command_queue(device_handle: *mut c_void) -> *mut c_void;
    pub fn am_command_queue_release(handle: *mut c_void);
    pub fn am_command_queue_new_command_buffer(handle: *mut c_void) -> *mut c_void;
    pub fn am_command_buffer_release(handle: *mut c_void);
    pub fn am_command_buffer_commit(handle: *mut c_void);
    pub fn am_command_buffer_wait_until_completed(handle: *mut c_void);
    pub fn am_command_buffer_blit_copy_buffer(
        cb_handle: *mut c_void,
        src_handle: *mut c_void,
        src_offset: usize,
        dst_handle: *mut c_void,
        dst_offset: usize,
        size: usize,
    ) -> bool;

    // ---- Library + Function + ComputePipelineState + dispatch (v0.5) ----
    pub fn am_device_new_library_with_source(
        device_handle: *mut c_void,
        source: *const core::ffi::c_char,
        out_error_message: *mut *mut core::ffi::c_char,
    ) -> *mut c_void;
    pub fn am_library_release(handle: *mut c_void);
    pub fn am_library_new_function(
        lib_handle: *mut c_void,
        name: *const core::ffi::c_char,
    ) -> *mut c_void;
    pub fn am_function_release(handle: *mut c_void);
    pub fn am_device_new_compute_pipeline_state(
        device_handle: *mut c_void,
        fn_handle: *mut c_void,
        out_error_message: *mut *mut core::ffi::c_char,
    ) -> *mut c_void;
    pub fn am_compute_pipeline_state_release(handle: *mut c_void);
    pub fn am_command_buffer_dispatch_compute_1d(
        cb_handle: *mut c_void,
        pso_handle: *mut c_void,
        buffers: *const *mut c_void,
        buffer_count: usize,
        threadgroups: usize,
        threads_per_group: usize,
    ) -> bool;
}