Struct livemod::LiveModHandle

pub struct LiveModHandle { /* fields omitted */ }

A handle to an external livemod viewer.

This handle is used to create ModVars and track StaticModVars. It must be kept alive for the user interface to continue running.

Implementations

impl LiveModHandle

pub fn new_gui() -> LiveModHandle

Initialise livemod with the external livemod-gui user interface

pub fn new_with_ui(command: &str) -> LiveModHandle

Initialise livemod with an external user interface, for which the specified command will be run.

pub fn track_variable<T: LiveMod + 'static>(
    &self,
    name: &str,
    var: &'static StaticModVar<T>
)

Track an existing StaticModVar

pub fn create_variable<T: LiveMod + 'static>(
    &self,
    name: &str,
    var: T
) -> ModVar<T>

Create a variable and send it to the external viewer to be tracked.

The variable will be removed from the external viewer when it is dropped.

pub unsafe fn create_variable_unchecked<'a, T: LiveMod + 'a>(
    &self,
    name: &str,
    var: T
) -> ModVar<T>

Create a variable and send it to the external viewer to be tracked.

The variable will be removed from the external viewer when it is dropped.

Safety

You must ensure the returned variable is dropped before any of the variables it references.

Trait Implementations

impl Drop for LiveModHandle

fn drop(&mut self)

Executes the destructor for this type.