Struct radiant_rs::Layer

pub struct Layer { /* fields omitted */ }

A drawing surface for text and sprites that implements send+sync and is wait-free for drawing operations.

In radiant_rs, sprite drawing happens on layers. Layers provide transformation capabilities in the form of model- and view-matrices and the layer's blendmode and color determine how sprites are rendered to the drawing target. Layers can be rendered multiple times using different matrices, blendmodes or colors without having to redraw their contents first.

For convenience, layers are created with a view-matrix that maps the given dimensions to the entirety of the drawing target. The layer itself is infinite though, and can be transformed at any time before rendering.

Drawing to a layer is a wait-free atomic operation that can be safely performed from multiple threads at the same time. Modifying layer properties like the matrices may cause other threads to wait.

Methods

impl Layer

pub fn new<T>(dimensions: T) -> Self where     (f32, f32): From<T>,

Creates a new layer with given dimensions, meaning that is is created with a view matrix that maps the given dimensions to the entirety of the drawing target.

pub fn with_program<T>(dimensions: T, program: Program) -> Self where     (f32, f32): From<T>,

Creates a new layer with given dimensions and fragment program.

pub fn clone_with_program(&self, program: Program) -> Self

Creates a new layer that references the contents of this layer but has its own color, blendmode, program and set of matrices.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn set_color(&self, color: Color) -> &Self

Sets a global color multiplicator. Setting this to white means that the layer contents are renderered in their original colors.

Note that Colors contain alpha information and are not clamped to any range, so it is possible to use an overbright color to brighten the result or use the alpha channel to apply global transparency.

pub fn color(&self) -> MutexGuard<Color>

Returns a mutex guarded mutable reference to the global color multiplicator.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn set_view_matrix<T>(&self, matrix: T) -> &Self where     [[f32; 4]; 4]: From<T>,

Sets the view matrix.

View matrix transformation is applied after the objects are fully positioned on the layer. As a result, manipulating the view matrix has the effect of manipulating the layer itself, e.g. rotating the entire layer.

pub fn view_matrix(&self) -> MutexGuard<Mat4Stack<f32>>

Returns a mutex guarded mutable reference to the view matrix. See set_view_matrix() for a description of the view matrix.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn set_model_matrix<T>(&self, matrix: T) -> &Self where     [[f32; 4]; 4]: From<T>,

Sets the model matrix.

Model matrix transformation is applied before each object is transformed to its position on the layer. As a result, manipulating the model matrix has the effect of manipulating every object on the layer in the same way, e.g. rotating every individual object on the layer around a point relative to the individual object.

pub fn model_matrix(&self) -> MutexGuard<Mat4Stack<f32>>

Returns a mutex guarded mutable reference to the model matrix. See set_model_matrix() for a description of the model matrix.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn set_blendmode(&self, blendmode: BlendMode) -> &Self

Sets the blendmode.

pub fn blendmode(&self) -> MutexGuard<BlendMode>

Returns a mutex guarded mutable reference to the blendmode.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn clear(&self) -> &Self

Removes all previously added objects from the layer. Typically invoked after the layer has been rendered.

pub fn capacity(&self) -> usize

Returns the number of sprites the layer can hold without having to perform a blocking reallocation.

pub fn len(&self) -> usize

Returns the number of sprites currently stored the layer.

pub fn arc(self) -> Arc<Self>

Returns the layer wrapped in an std::Arc.

pub fn program(&self) -> Option<&Program>

Returns a reference to the program used by this layer.

Trait Implementations

impl Debug for Layer

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

Formats the value using the given formatter.

impl Send for Layer

impl Sync for Layer

impl Clone for Layer

fn clone(&self) -> Self

Creates a new layer that references the contents of this layer but has its own color, blendmode and set of matrices.

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

Performs copy-assignment from source.