Skip to main content

Renderer

Struct Renderer 

Source
pub struct Renderer { /* private fields */ }

Implementations§

Source§

impl Renderer

Source

pub fn new() -> RendererResult<Self>

Creates a new Renderer instance with no windows.

Source

pub fn create_window( &mut self, title: impl ToString, width: u32, height: u32, ) -> WindowId

Creates a new window with the given title, dimensions, and resizability. Returns a WindowId that can be used to interact with the window. Initializes the GPU context if this is the first window created.

Source

pub fn create_window_ext( &mut self, props: impl Into<AdvancedWindowProperties>, ) -> WindowId

Creates a new window with the given properties. Returns a WindowId that can be used to interact with the window. Initializes the GPU context if this is the first window created.

Use WindowProperties for normal cases and use AdvancedWindowProperties for advanced cases.

Source

pub fn create_canvas( &mut self, width: u32, height: u32, ) -> RendererResult<Canvas>

Create a new canvas with the given width and height.

Source

pub fn poll(&mut self) -> Vec<(WindowId, WindowEvent)>

Pumps the event loop and returns all window events since the last call. Resize, cursor movement, and focus events are also forwarded to their respective windows internally. Clears all queued WinitEvents.

Only available on Windows, macOS, Linux, and Android.

Source

pub fn poll_raw(&mut self) -> Vec<(WindowId, WinitEvent)>

Pumps the event loop and returns all raw winit events since the last call. Resize, cursor movement, and focus events are also forwarded to their respective windows internally. Clears all queued WindowEvents.

Only available on Windows, macOS, Linux, and Android.

Source

pub fn poll_full(&mut self) -> Vec<(WindowId, (WindowEvent, WinitEvent))>

Pumps the event loop and returns all window events and raw winit events since the last call. Resize, cursor movement, and focus events are also forwarded to their respective windows internally. Clears all queued WindowEvents.

Only available on Windows, macOS, Linux, and Android.

Source

pub fn close_window(&mut self, id: WindowId) -> bool

Closes the window with the given WindowId, removing it from the renderer. Returns true if a window with that ID existed.

Source

pub fn get_window<'a>(&'a mut self, id: WindowId) -> Option<WindowDraw<'a>>

Returns a WindowDraw for the given WindowId, if it exists.

Source

pub fn flush(&mut self) -> RendererResult<()>

Submits all queued draw calls for each open window to the GPU and presents their frames.

Source

pub fn is_running(&self) -> bool

Returns true if any windows are still open.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more