Struct piston_window::PistonWindow

pub struct PistonWindow<T = (), W: Window = GlutinWindow> {
    pub window: Rc<RefCell<W>>,
    pub encoder: Rc<RefCell<GfxEncoder>>,
    pub device: Rc<RefCell<Device>>,
    pub output_color: Rc<RenderTargetView<Resources, Srgba8>>,
    pub output_stencil: Rc<DepthStencilView<Resources, DepthStencil>>,
    pub g2d: Rc<RefCell<Gfx2d<Resources>>>,
    pub events: Rc<RefCell<WindowEvents>>,
    pub event: Option<Event<W::Event>>,
    pub app: Rc<RefCell<T>>,
    pub factory: Rc<RefCell<Factory>>,
}

Contains everything required for controlling window, graphics, event loop.

Fields

window: Rc<RefCell<W>>

The window.

encoder: Rc<RefCell<GfxEncoder>>

GFX encoder.

device: Rc<RefCell<Device>>

GFX device.

output_color: Rc<RenderTargetView<Resources, Srgba8>>

Output frame buffer.

output_stencil: Rc<DepthStencilView<Resources, DepthStencil>>

Output stencil buffer.

g2d: Rc<RefCell<Gfx2d<Resources>>>

Gfx2d.

events: Rc<RefCell<WindowEvents>>

The event loop.

event: Option<Event<W::Event>>

The event.

app: Rc<RefCell<T>>

Application structure.

factory: Rc<RefCell<Factory>>

The factory that was created along with the device.

Methods

impl<T, W> PistonWindow<T, W> where W: Window, W::Event: GenericEvent

fn new(opengl: OpenGL, samples: u8, window: Rc<RefCell<W>>, app: Rc<RefCell<T>>) -> Self where W: OpenGLWindow

Creates a new piston window.

fn app<U>(self, app: Rc<RefCell<U>>) -> PistonWindow<U, W>

Changes application structure.

fn app_by_value<U>(self, app: U) -> PistonWindow<U, W>

Changes application structure.

fn draw_2d<F>(&self, f: F) where F: FnOnce(Context, &mut G2d)

Renders 2D graphics.

fn draw_3d<F>(&self, f: F) where F: FnOnce(&mut GfxEncoder)

Renders 3D graphics.

Trait Implementations

impl<W> BuildFromWindowSettings for PistonWindow<(), W> where W: Window + OpenGLWindow + BuildFromWindowSettings, W::Event: GenericEvent

fn build_from_window_settings(settings: WindowSettings) -> Result<PistonWindow<(), W>, String>

Builds window from window settings.

impl<T, W> Clone for PistonWindow<T, W> where W: Window, W::Event: Clone

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, W> Iterator for PistonWindow<T, W> where W: Window, W::Event: GenericEvent

type Item = PistonWindow<T, W>

The type of the elements being iterated over.

fn next(&mut self) -> Option<PistonWindow<T, W>>

Advances the iterator and returns the next value.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator.

fn count(self) -> usize

Consumes the iterator, counting the number of iterations and returning it.

fn last(self) -> Option<Self::Item>

Consumes the iterator, returning the last element.

fn nth(&mut self, n: usize) -> Option<Self::Item>

Consumes the n first elements of the iterator, then returns the next() one.

fn chain<U>(self, other: U) -> Chain<Self, U::IntoIter> where U: IntoIterator<Item=Self::Item>

Takes two iterators and creates a new iterator over both in sequence.

fn zip<U>(self, other: U) -> Zip<Self, U::IntoIter> where U: IntoIterator

'Zips up' two iterators into a single iterator of pairs.

fn map<B, F>(self, f: F) -> Map<Self, F> where F: FnMut(Self::Item) -> B

Takes a closure and creates an iterator which calls that closure on each element.

fn filter<P>(self, predicate: P) -> Filter<Self, P> where P: FnMut(&Self::Item) -> bool

Creates an iterator which uses a closure to determine if an element should be yielded.

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where F: FnMut(Self::Item) -> Option<B>

Creates an iterator that both filters and maps.

fn enumerate(self) -> Enumerate<Self>

Creates an iterator which gives the current iteration count as well as the next value.

fn peekable(self) -> Peekable<Self>

Creates an iterator which can use peek to look at the next element of the iterator without consuming it.

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where P: FnMut(&Self::Item) -> bool

Creates an iterator that [skip()]s elements based on a predicate.

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where P: FnMut(&Self::Item) -> bool

Creates an iterator that yields elements based on a predicate.

fn skip(self, n: usize) -> Skip<Self>

Creates an iterator that skips the first n elements.

fn take(self, n: usize) -> Take<Self>

Creates an iterator that yields its first n elements.

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where F: FnMut(&mut St, Self::Item) -> Option<B>

An iterator adaptor similar to [fold()] that holds internal state and produces a new iterator.

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where F: FnMut(Self::Item) -> U, U: IntoIterator

Creates an iterator that works like map, but flattens nested structure.

fn fuse(self) -> Fuse<Self>

Creates an iterator which ends after the first None.

fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnMut(&Self::Item) -> ()

Do something with each element of an iterator, passing the value on.

fn by_ref(&mut self) -> &mut Self

Borrows an iterator, rather than consuming it.

fn collect<B>(self) -> B where B: FromIterator<Self::Item>

Transforms an iterator into a collection.

fn partition<B, F>(self, f: F) -> (B, B) where B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool

Consumes an iterator, creating two collections from it.

fn fold<B, F>(self, init: B, f: F) -> B where F: FnMut(B, Self::Item) -> B

An iterator adaptor that applies a function, producing a single, final value.

fn all<F>(&mut self, f: F) -> bool where F: FnMut(Self::Item) -> bool

Tests if every element of the iterator matches a predicate.

fn any<F>(&mut self, f: F) -> bool where F: FnMut(Self::Item) -> bool

Tests if any element of the iterator matches a predicate.

fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where P: FnMut(&Self::Item) -> bool

Searches for an element of an iterator that satisfies a predicate.

fn position<P>(&mut self, predicate: P) -> Option<usize> where P: FnMut(Self::Item) -> bool

Searches for an element in an iterator, returning its index.

fn rposition<P>(&mut self, predicate: P) -> Option<usize> where P: FnMut(Self::Item) -> bool, Self: ExactSizeIterator + DoubleEndedIterator

Searches for an element in an iterator from the right, returning its index.

fn max(self) -> Option<Self::Item> where Self::Item: Ord

Returns the maximum element of an iterator.

fn min(self) -> Option<Self::Item> where Self::Item: Ord

Returns the minimum element of an iterator.

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where B: Ord, F: FnMut(&Self::Item) -> B

Returns the element that gives the maximum value from the specified function.

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where B: Ord, F: FnMut(&Self::Item) -> B

Returns the element that gives the minimum value from the specified function.

fn rev(self) -> Rev<Self> where Self: DoubleEndedIterator

Reverses an iterator's direction.

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Iterator<Item=(A, B)>

Converts an iterator of pairs into a pair of containers.

fn cloned<'a, T>(self) -> Cloned<Self> where Self: Iterator<Item=&'a T>, T: 'a + Clone

Creates an iterator which clone()s all of its elements.

fn cycle(self) -> Cycle<Self> where Self: Clone

Repeats an iterator endlessly.

fn sum<S>(self) -> S where S: Sum<Self::Item>

Sums the elements of an iterator.

fn product<P>(self) -> P where P: Product<Self::Item>

Iterates over the entire iterator, multiplying all the elements

fn cmp<I>(self, other: I) -> Ordering where I: IntoIterator<Item=Self::Item>, Self::Item: Ord

Lexicographically compares the elements of this Iterator with those of another.

fn partial_cmp<I>(self, other: I) -> Option<Ordering> where I: IntoIterator, Self::Item: PartialOrd<I::Item>

Lexicographically compares the elements of this Iterator with those of another.

fn eq<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialEq<I::Item>

Determines if the elements of this Iterator are equal to those of another.

fn ne<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialEq<I::Item>

Determines if the elements of this Iterator are unequal to those of another.

fn lt<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>

Determines if the elements of this Iterator are lexicographically less than those of another.

fn le<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>

Determines if the elements of this Iterator are lexicographically less or equal to those of another.

fn gt<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>

Determines if the elements of this Iterator are lexicographically greater than those of another.

fn ge<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another.

impl<T, W> GenericEvent for PistonWindow<T, W> where W: Window, W::Event: GenericEvent

fn event_id(&self) -> EventId

The id of this event.

fn with_args<'a, F, U>(&'a self, f: F) -> U where F: FnMut(&Any) -> U

Calls closure with arguments

fn from_args(event_id: EventId, any: &Any, old_event: &Self) -> Option<Self>

Converts from arguments to Self

impl<T, W> Window for PistonWindow<T, W> where W: Window

type Event = W::Event

The event type emitted by poll_event

fn should_close(&self) -> bool

Returns true if window should close.

fn set_should_close(&mut self, value: bool)

Tells the window to close or stay open.

fn size(&self) -> Size

Gets the size of the window in user coordinates.

fn draw_size(&self) -> Size

Gets draw size of the window. This is equal to the size of the frame buffer of the inner window, excluding the title bar and borders.

fn swap_buffers(&mut self)

Swaps render buffers.

fn poll_event(&mut self) -> Option<Self::Event>

Polls event from window.

impl<T, W> AdvancedWindow for PistonWindow<T, W> where W: AdvancedWindow

fn get_title(&self) -> String

Gets a copy of the title of the window.

fn set_title(&mut self, title: String)

Sets the title of the window.

fn get_exit_on_esc(&self) -> bool

Gets whether to exit when pressing esc.

fn set_exit_on_esc(&mut self, value: bool)

Sets whether to exit when pressing esc.

fn set_capture_cursor(&mut self, value: bool)

Sets whether to capture/grab cursor. This is used to lock and hide cursor to the window, for example in a first-person shooter game.

fn title(self, value: String) -> Self

Sets title on window.

fn exit_on_esc(self, value: bool) -> Self

Sets whether to exit when pressing esc.

fn capture_cursor(self, value: bool) -> Self

Sets whether to capture/grab cursor (see set_capture_cursor).

impl<T, W> EventLoop for PistonWindow<T, W> where W: Window

fn set_ups(&mut self, frames: u64)

The number of updates per second

fn set_max_fps(&mut self, frames: u64)

The maximum number of frames per second

fn set_swap_buffers(&mut self, enable: bool)

Enable or disable automatic swapping of buffers.

fn set_bench_mode(&mut self, enable: bool)

Enable or disable benchmark mode. When enabled, it will render and update without sleep and ignore input. Used to test performance by playing through as fast as possible.

fn ups(self, frames: u64) -> Self

The number of updates per second

fn max_fps(self, frames: u64) -> Self

The maximum number of frames per second

fn swap_buffers(self, enable: bool) -> Self

Enable or disable automatic swapping of buffers.

fn bench_mode(self, enable: bool) -> Self

Enable or disable benchmark mode. When enabled, it will render and update without sleep and ignore input. Used to test performance by playing through as fast as possible.