Struct FmodPlugin

pub struct FmodPlugin {
    pub audio_banks_paths: &'static [&'static str],
    pub plugin_paths: Option<&'static [&'static str]>,
}

Initializes the FMOD Studio API and provides systems to update the audio sources and listeners.

Fields

audio_banks_paths: &'static [&'static str]

Paths to the audio banks which are usually in the Build folder of the FMOD project.

plugin_paths: Option<&'static [&'static str]>

Optionally you can provide paths to FMOD plugins which will then be loaded automatically. For more information see: https://www.fmod.com/docs/2.01/api/core-guide.html#dynamic

Implementations

impl FmodPlugin

pub fn new(audio_banks_paths: &'static [&'static str]) -> Self

Trait Implementations

impl Plugin for FmodPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.