unity-native-plugin 0.8.0

Unity Native Plugin API for Rust
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
use crate::define_unity_interface;
use crate::interface::UnityInterface;
use crate::profiler::*;
use std::ffi::c_void;
use std::fmt::*;
use unity_native_plugin_sys::*;

define_unity_interface!(
    UnityProfilerCallbacks,
    unity_native_plugin_sys::IUnityProfilerCallbacks,
    0x572FDB38CE3C4B1F_u64,
    0xA6071A9A7C4F52D8_u64
);

#[derive(Debug)]
pub struct ProfilerCategoryDesc {
    pub(crate) native: *const UnityProfilerCategoryDesc,
}

impl ProfilerCategoryDesc {
    pub fn id(&self) -> ProfilerCategoryId {
        unsafe { (*self.native).id as ProfilerCategoryId }
    }

    pub fn rgba_color(&self) -> u32 {
        unsafe { (*self.native).rgbaColor }
    }

    pub fn name(&self) -> &std::ffi::CStr {
        unsafe { std::ffi::CStr::from_ptr((*self.native).name) }
    }
}

pub struct ProfilerThreadDesc {
    pub(crate) native: *const UnityProfilerThreadDesc,
}

impl ProfilerThreadDesc {
    pub fn thread_id(&self) -> ProfilerThreadId {
        unsafe { (*self.native).threadId as ProfilerThreadId }
    }

    pub fn group_name(&self) -> &std::ffi::CStr {
        unsafe { std::ffi::CStr::from_ptr((*self.native).groupName) }
    }

    pub fn name(&self) -> &std::ffi::CStr {
        unsafe { std::ffi::CStr::from_ptr((*self.native).name) }
    }
}

pub struct ProfilerMarkerEvent<'a> {
    pub desc: ProfilerMarkerDesc,
    pub event_type: ProfilerMarkerEventType,
    pub event_data: &'a [ProfilerMarkerData],
}

impl<'a> std::fmt::Debug for ProfilerMarkerEvent<'a> {
    fn fmt(&self, fmt: &mut Formatter) -> std::fmt::Result {
        write!(
            fmt,
            "[event desc={:?}, ty={:?}, data_len={:?}]",
            self.desc,
            self.event_type,
            self.event_data.len(),
        )
    }
}

#[repr(transparent)]
pub struct ProfilerMarkerData(UnityProfilerMarkerData);

impl ProfilerMarkerData {
    pub fn value(&self) -> ProfilerMarkerDataValue {
        match unsafe { std::mem::transmute::<_, ProfilerMarkerDataType>(self.0.type_) } {
            ProfilerMarkerDataType::None => ProfilerMarkerDataValue::None,
            ProfilerMarkerDataType::InstanceId => {
                ProfilerMarkerDataValue::InstanceId(unsafe { *(self.0.ptr as *const i32) })
            }
            ProfilerMarkerDataType::Int32 => {
                ProfilerMarkerDataValue::Int32(unsafe { *(self.0.ptr as *const i32) })
            }
            ProfilerMarkerDataType::UInt32 => {
                ProfilerMarkerDataValue::UInt32(unsafe { *(self.0.ptr as *const u32) })
            }
            ProfilerMarkerDataType::Int64 => {
                ProfilerMarkerDataValue::Int64(unsafe { *(self.0.ptr as *const i64) })
            }
            ProfilerMarkerDataType::UInt64 => {
                ProfilerMarkerDataValue::UInt64(unsafe { *(self.0.ptr as *const u64) })
            }
            ProfilerMarkerDataType::Float => {
                ProfilerMarkerDataValue::Float(unsafe { *(self.0.ptr as *const f32) })
            }
            ProfilerMarkerDataType::Double => {
                ProfilerMarkerDataValue::Double(unsafe { *(self.0.ptr as *const f64) })
            }
            ProfilerMarkerDataType::String => ProfilerMarkerDataValue::String(unsafe {
                std::ffi::CStr::from_ptr(self.0.ptr as *const std::ffi::c_char)
                    .to_str()
                    .unwrap()
                    .to_string()
            }),
            ProfilerMarkerDataType::String16 => ProfilerMarkerDataValue::String(
                std::char::decode_utf16(unsafe {
                    std::slice::from_raw_parts(
                        self.0.ptr as *const u16,
                        (self.0.size / 2 - 1) as usize,
                    )
                    .iter()
                    .copied()
                })
                .map(|c| c.unwrap_or(std::char::REPLACEMENT_CHARACTER))
                .collect(),
            ),
            other => ProfilerMarkerDataValue::Unknown {
                ty: other,
                data: unsafe {
                    std::slice::from_raw_parts(self.0.ptr as *const u8, self.0.size as usize)
                },
            },
        }
    }
}

#[derive(Debug)]
pub enum ProfilerMarkerDataValue<'a> {
    None,
    InstanceId(i32),
    Int32(i32),
    UInt32(u32),
    Int64(i64),
    UInt64(u64),
    Float(f32),
    Double(f64),
    String(String),
    Unknown {
        ty: ProfilerMarkerDataType,
        data: &'a [u8],
    },
}

extern "system" fn create_category_bridge(
    _desc: *const UnityProfilerCategoryDesc,
    _userdata: *mut c_void,
) {
    let ptr = _userdata as *mut Box<dyn FnMut(&ProfilerCategoryDesc)>;
    let mut cb = unsafe { Box::from_raw(ptr) };

    let desc = ProfilerCategoryDesc { native: _desc };
    cb(&desc);
    std::mem::forget(cb);
}

extern "system" fn create_marker_bridge(
    _desc: *const UnityProfilerMarkerDesc,
    _userdata: *mut c_void,
) {
    let ptr = _userdata as *mut Box<dyn FnMut(&ProfilerMarkerDesc)>;
    let mut cb = unsafe { Box::from_raw(ptr) };

    let desc = ProfilerMarkerDesc { native: _desc };
    cb(&desc);
    std::mem::forget(cb);
}

extern "system" fn marker_event_bridge(
    _desc: *const UnityProfilerMarkerDesc,
    _event_type: UnityProfilerMarkerEventType,
    _event_data_count: u16,
    _event_data: *const UnityProfilerMarkerData,
    _userdata: *mut c_void,
) {
    let desc = ProfilerMarkerDesc { native: _desc };
    let event_type = match ProfilerMarkerEventType::from(_event_type) {
        Some(v) => v,
        None => return,
    };

    let event_data = if !_event_data.is_null() && _event_data_count > 0 {
        unsafe {
            std::slice::from_raw_parts(
                _event_data as *const ProfilerMarkerData,
                _event_data_count as usize,
            )
        }
    } else {
        &[]
    };

    let desc = ProfilerMarkerEvent {
        desc,
        event_type,
        event_data,
    };

    let ptr = _userdata as *mut Box<dyn FnMut(&ProfilerMarkerEvent)>;
    let mut cb = unsafe { Box::from_raw(ptr) };

    cb(&desc);
    std::mem::forget(cb);
}

extern "system" fn frame_bridge(_userdata: *mut c_void) {
    let ptr = _userdata as *mut Box<dyn FnMut()>;
    let mut cb = unsafe { Box::from_raw(ptr) };

    cb();
    std::mem::forget(cb);
}

extern "system" fn create_thread_bridge(
    desc: *const UnityProfilerThreadDesc,
    _userdata: *mut c_void,
) {
    let desc = ProfilerThreadDesc { native: desc };

    let ptr = _userdata as *mut Box<dyn FnMut(&ProfilerThreadDesc)>;
    let mut cb = unsafe { Box::from_raw(ptr) };

    cb(&desc);
    std::mem::forget(cb);
}

pub struct CreateCategoryRegister(*mut c_void);
pub struct CreateMarkerRegister(*mut c_void);
pub struct MarkerEventRegister {
    ptr: *mut c_void,
    desc: *const UnityProfilerMarkerDesc,
}
pub struct FrameRegister(*mut c_void);
pub struct CreateThreadRegister(*mut c_void);

macro_rules! iface_fn {
    ($self:tt, $name:tt) => {
        $self.interface().$name.expect(stringify!($name))
    };
}

macro_rules! common_impl {
    ($name: tt) => {
        impl $name {
            pub fn register_create_category(
                &self,
                f: Box<dyn FnMut(&ProfilerCategoryDesc) + Send + Sync>,
            ) -> CreateCategoryRegister {
                let ptr = Box::into_raw(Box::new(f)) as *mut c_void;

                unsafe {
                    iface_fn!(self, RegisterCreateCategoryCallback)(
                        Some(create_category_bridge),
                        ptr,
                    );
                }
                CreateCategoryRegister(ptr)
            }

            pub fn unregister_create_category(&self, register: CreateCategoryRegister) {
                unsafe {
                    iface_fn!(self, UnregisterCreateCategoryCallback)(
                        Some(create_category_bridge),
                        register.0,
                    );
                }
            }

            pub fn register_create_marker(
                &self,
                f: Box<dyn FnMut(&ProfilerMarkerDesc) + Send + Sync>,
            ) -> CreateMarkerRegister {
                let ptr = Box::into_raw(Box::new(f)) as *mut c_void;

                unsafe {
                    iface_fn!(self, RegisterCreateMarkerCallback)(Some(create_marker_bridge), ptr);
                }
                CreateMarkerRegister(ptr)
            }

            pub fn unregister_create_marker(&self, register: CreateMarkerRegister) {
                unsafe {
                    iface_fn!(self, UnregisterCreateMarkerCallback)(
                        Some(create_marker_bridge),
                        register.0,
                    );
                }
            }

            pub fn register_marker_event(
                &self,
                desc: &ProfilerMarkerDesc,
                f: Box<dyn FnMut(&ProfilerMarkerEvent) + Send + Sync>,
            ) -> MarkerEventRegister {
                let ptr = Box::into_raw(Box::new(f)) as *mut c_void;

                unsafe {
                    iface_fn!(self, RegisterMarkerEventCallback)(
                        desc.native,
                        Some(marker_event_bridge),
                        ptr,
                    );
                }
                MarkerEventRegister {
                    ptr,
                    desc: desc.native,
                }
            }

            pub fn unregister_marker_event(&self, register: MarkerEventRegister) {
                unsafe {
                    iface_fn!(self, UnregisterMarkerEventCallback)(
                        register.desc,
                        Some(marker_event_bridge),
                        register.ptr,
                    );
                }
            }

            pub fn register_frame(&self, f: Box<dyn FnMut() + Send + Sync>) -> FrameRegister {
                let ptr = Box::into_raw(Box::new(f)) as *mut c_void;

                unsafe {
                    iface_fn!(self, RegisterFrameCallback)(Some(frame_bridge), ptr);
                }
                FrameRegister(ptr)
            }

            pub fn unregister_frame(&self, register: FrameRegister) {
                unsafe {
                    iface_fn!(self, UnregisterFrameCallback)(Some(frame_bridge), register.0);
                }
            }

            pub fn register_create_thread(
                &self,
                f: Box<dyn FnMut(&ProfilerThreadDesc) + Send + Sync>,
            ) -> CreateThreadRegister {
                let ptr = Box::into_raw(Box::new(f)) as *mut c_void;

                unsafe {
                    iface_fn!(self, RegisterCreateThreadCallback)(Some(create_thread_bridge), ptr);
                }
                CreateThreadRegister(ptr)
            }

            pub fn unregister_create_thread(&self, register: CreateThreadRegister) {
                unsafe {
                    iface_fn!(self, UnregisterCreateThreadCallback)(
                        Some(create_thread_bridge),
                        register.0,
                    );
                }
            }
        }
    };
}

common_impl!(UnityProfilerCallbacks);

define_unity_interface!(
    UnityProfilerCallbacksV2,
    unity_native_plugin_sys::IUnityProfilerCallbacksV2,
    0x5DEB59E88F2D4571_u64,
    0x81E8583069A5E33C_u64
);

#[derive(Clone, Copy, Debug)]
pub struct ProfilerFlowEvent {
    pub ty: ProfilerFlowEventType,
    pub flow_id: u32,
}

extern "system" fn flow_event_bridge(
    ty: UnityProfilerFlowEventType,
    flow_id: u32,
    _userdata: *mut c_void,
) {
    let ty = match ProfilerFlowEventType::from(ty) {
        Some(ty) => ty,
        None => return,
    };

    let desc = ProfilerFlowEvent { ty, flow_id };

    let ptr = _userdata as *mut Box<dyn FnMut(&ProfilerFlowEvent)>;
    let mut cb = unsafe { Box::from_raw(ptr) };

    cb(&desc);
    std::mem::forget(cb);
}

pub struct FlowEventRegister(*mut c_void);

common_impl!(UnityProfilerCallbacksV2);
impl UnityProfilerCallbacksV2 {
    pub fn register_flow_event(
        &self,
        f: Box<dyn FnMut(&ProfilerFlowEvent) + Send + Sync>,
    ) -> FlowEventRegister {
        let ptr = Box::into_raw(Box::new(f)) as *mut c_void;

        unsafe {
            iface_fn!(self, RegisterFlowEventCallback)(Some(flow_event_bridge), ptr);
        }
        FlowEventRegister(ptr)
    }

    pub fn unregister_flow_event(&self, register: FlowEventRegister) {
        unsafe {
            iface_fn!(self, UnregisterFlowEventCallback)(Some(flow_event_bridge), register.0);
        }
    }
}