fmod/studio/event_instance/
mod.rs

1// Copyright (c) 2024 Melody Madeline Lyons
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at https://mozilla.org/MPL/2.0/.
6
7use std::ptr::NonNull;
8
9use fmod_sys::*;
10
11mod attributes_3d;
12mod callback;
13mod core;
14mod general;
15mod parameters;
16mod playback;
17mod playback_properties;
18mod profiling;
19
20pub use callback::EventInstanceCallback;
21pub(crate) use callback::event_callback_impl;
22
23/// An instance of an FMOD Studio event.
24#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
25#[repr(transparent)] // so we can transmute between types
26pub struct EventInstance {
27    pub(crate) inner: NonNull<FMOD_STUDIO_EVENTINSTANCE>,
28}
29
30#[cfg(not(feature = "thread-unsafe"))]
31unsafe impl Send for EventInstance {}
32#[cfg(not(feature = "thread-unsafe"))]
33unsafe impl Sync for EventInstance {}
34
35impl EventInstance {
36    /// # Safety
37    ///
38    /// `value` must be a valid pointer either aquired from [`Self::as_ptr`] or FMOD.
39    ///
40    /// # Panics
41    ///
42    /// Panics if `value` is null.
43    pub unsafe fn from_ffi(value: *mut FMOD_STUDIO_EVENTINSTANCE) -> Self {
44        let inner = NonNull::new(value).unwrap();
45        EventInstance { inner }
46    }
47
48    /// Converts `self` into its raw representation.
49    pub fn as_ptr(self) -> *mut FMOD_STUDIO_EVENTINSTANCE {
50        self.inner.as_ptr()
51    }
52}
53
54impl From<EventInstance> for *mut FMOD_STUDIO_EVENTINSTANCE {
55    fn from(value: EventInstance) -> Self {
56        value.inner.as_ptr()
57    }
58}
fmod/studio/event_instance/mod.rs

fmod/studio/event_instance/
mod.rs
