Struct plasma::Plasma

pub struct Plasma {
    pub pixel_width: u32,
    pub pixel_height: u32,
    /* private fields */
}

The struct that holds the meta information about current plasma state

Fields

pixel_width: u32

The plasma pixel width

pixel_height: u32

The plasma pixel height

Implementations

impl Plasma

pub fn new<R: Rng + ?Sized>( pixel_width: u32, pixel_height: u32, config: PhaseAmpCfg, rng: &mut R, ) -> Self

Creates new plasma instance.

Provide the initial pixel_width and pixel_height, initialized PhaseAmpCfg and an instance of Rng.

pub fn update<R: Rng + ?Sized>(&mut self, rng: &mut R)

Animates the plasma by modifying the internal PhaseAmp variables.

Provide an instance of initialized Rng instance.

pub fn render<'a, B, L, M>( &'a self, buffer: &mut [u8], pitch: usize, wrkspc: Option<&mut Vec<u8>>, )

where B: PixelBuffer, L: ICProducer<'a>, M: Mixer<f32>,

Renders the plasma into the provided buffer.

You must also provide a struct implementing PixelBuffer trait.

The pitch should contain the number of bytes of a single line in a buffer.

The wrkspc is an optional temporary memory scractchpad. If None is provided the new memory will be allocated.

pub fn render_part<'a, B, L, M>( &'a self, buffer: &mut [u8], pitch: usize, x: usize, y: usize, w: usize, h: usize, wrkspc: Option<&mut Vec<u8>>, )

where B: PixelBuffer, L: ICProducer<'a>, M: Mixer<f32>,

Renders the part of the plasma into the provided buffer.

You must also provide a struct implementing PixelBuffer trait.

The pitch should contain the number of bytes of a single line in a buffer.

The boundary of rendered part should be provided by x, y, w and h arguments in pixel coordinates starting from left/top corner.

The wrkspc is an optional temporary memory scractchpad. If None is provided the new memory will be allocated.

pub fn import_phase_amps(&mut self, source: &[f32])

Import the internal plasma state from a slice of 32bit floats.

pub fn export_phase_amps(&self, out: &mut Vec<f32>)

Exports the internal plasma state into the Vec of 32bit floats.

pub fn min_steps(&self) -> f32

pub fn max_steps(&self) -> f32

Trait Implementations

impl Clone for Plasma

fn clone(&self) -> Plasma

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Plasma

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

Formats the value using the given formatter.

impl PartialEq for Plasma

fn eq(&self, other: &Plasma) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Plasma