Struct arcs::window::Window

pub struct Window(pub Entity);

A wrapper around the "window" object.

Implementations

impl Window

pub fn create(world: &mut World) -> Self

Creates a new Window entity populated with all default components.

pub fn render_system<'a, R>(
    &'a self,
    backend: R,
    window_size: Size2D<f64, CanvasSpace>
) -> impl System<'a> + 'a where
    R: RenderContext + 'a, 

Get a System which will render using a particular RenderContext.

Note

This snapshots the window's state and styling (e.g. Viewport and WindowStyle) so you shouldn't keep this system around for any length of time.

impl Window

Accessors for the various components attached to this Window.

pub fn viewport<'a>(
    &self,
    storage: &'a ReadStorage<'a, Viewport>
) -> &'a Viewport

Get a reference to the Window's Viewport component.

pub fn viewport_mut<'a, 'world: 'a>(
    &self,
    storage: &'a mut WriteStorage<'world, Viewport>
) -> &'a mut Viewport

Get a mutable reference to the Window's Viewport component.

pub fn default_point_style<'a>(
    &self,
    storage: &'a ReadStorage<'a, PointStyle>
) -> &'a PointStyle

Get a reference to the Window's PointStyle component.

pub fn default_point_style_mut<'a, 'world: 'a>(
    &self,
    storage: &'a mut WriteStorage<'world, PointStyle>
) -> &'a mut PointStyle

Get a mutable reference to the Window's PointStyle component.

pub fn default_line_style<'a>(
    &self,
    storage: &'a ReadStorage<'a, LineStyle>
) -> &'a LineStyle

Get a reference to the Window's LineStyle component.

pub fn default_line_style_mut<'a, 'world: 'a>(
    &self,
    storage: &'a mut WriteStorage<'world, LineStyle>
) -> &'a mut LineStyle

Get a mutable reference to the Window's LineStyle component.

pub fn style<'a>(
    &self,
    storage: &'a ReadStorage<'a, WindowStyle>
) -> &'a WindowStyle

Get a reference to the Window's WindowStyle component.

pub fn style_mut<'a, 'world: 'a>(
    &self,
    storage: &'a mut WriteStorage<'world, WindowStyle>
) -> &'a mut WindowStyle

Get a mutable reference to the Window's WindowStyle component.

Trait Implementations

impl Clone for Window

fn clone(&self) -> Window

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Window

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

Formats the value using the given formatter.

impl PartialEq<Window> for Window

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Window