Struct SystemBuilder

pub struct SystemBuilder { /* private fields */ }

Available on crate feature studio only.

A builder for creating and initializing a System.

Handles setting values that can only be set before initialization for you.

Implementations

impl SystemBuilder

pub unsafe fn new() -> Result<Self>

Creates a new SystemBuilder.

Safety

Calling this function concurrently with any FMOD Studio API function (including this function) may cause undefined behavior. External synchronization must be used if calls to SystemBuilder::new or System::release could overlap other FMOD Studio API calls. All other FMOD Studio API functions are thread safe and may be called freely from any thread unless otherwise documented.

pub unsafe fn synchronous_update(&mut self)

Available on non-crate feature thread-unsafe only.

Safety

This function sets up FMOD Studio to run all commands on the calling thread, and FMOD Studio expects all calls to be issued from a single thread.

This has the side effect of making EVERY Studio Struct in this crate !Send and !Sync without marking them as !Send and !Sync. This means that there are no handrails preventing you from using FMOD Studio across multiple threads, and you must ensure this yourself!

pub fn settings(&mut self, settings: &AdvancedSettings) -> Result<&mut Self>

Sets advanced settings.

pub fn build( self, max_channels: c_int, studio_flags: InitFlags, flags: InitFlags, ) -> Result<System>

Builds the Studio System.

The core system used by the studio system is initialized at the same time as the studio system.

pub fn core_builder(&mut self) -> &mut SystemBuilder

Returns the FMOD core SystemBuilder.

This function only returns a &mut reference to prevent building the core System as building the studio System will handle that for you.

pub unsafe fn build_with_extra_driver_data( self, max_channels: c_int, studio_flags: InitFlags, flags: InitFlags, driver_data: *mut c_void, ) -> Result<System>

Safety

See the FMOD docs explaining driver data for more safety information.

Trait Implementations

impl Debug for SystemBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Send for SystemBuilder

Available on non-crate feature thread-unsafe only.

impl Sync for SystemBuilder

Available on non-crate feature thread-unsafe only.