Struct mage_core::app::PresentInput

source ·
pub struct PresentInput<'textures> {
    pub width: u32,
    pub height: u32,
    pub fore_image: &'textures mut [u32],
    pub back_image: &'textures mut [u32],
    pub text_image: &'textures mut [u32],
}
Expand description

The PresentInput struct is passed to the [present] method of the App trait to provide information about the current frame.

Fields§

§width: u32

The width of the window in characters.

§height: u32

The height of the window in characters.

§fore_image: &'textures mut [u32]

The foreground color of each character. Each 32-bit RGBA value represents a single character. The least significant 8 bits are the red value, the next 8 bits are the green value, the next 8 bits are the blue value, and the most significant 8 bits are the alpha value. The alpha value is currently unused.

§back_image: &'textures mut [u32]

The background color of each character. Each 32-bit RGBA value represents a single character. The least significant 8 bits are the red value, the next 8 bits are the green value, the next 8 bits are the blue value, and the most significant 8 bits are the alpha value. The alpha value is currently unused.

§text_image: &'textures mut [u32]

The character buffer. Each 32-bit RGBA value represents a single character. The least significant 8 bits are the ASCII value of the character, and the most significant 24 bits are unused by the engine but are available for use by the game.

Implementations§

source§

impl<'t> PresentInput<'t>

source

pub fn rect(&self) -> Rect

source

pub fn new_image(&self) -> Image

source

pub fn blit( &mut self, dst_rect: Rect, src_rect: Rect, src_image: &Image, paper: u32 )

Blit the an area of the source image to the screen.

The source rectangle is clipped to the source image.

Arguments
  • dst_rect - Where to blit the source image to on the screen.
  • src_rect - The area of the source image to blit.
  • src_image - The source image to blit from.
  • paper - The paper colour to use outside the source image. This will also be used as the ink colour.
source

pub fn clear(&mut self, rect: Rect, paper: u32)

source

pub fn blit_internal( &mut self, dst_rect: Rect, src_rect: Rect, src_image: &Image )

Trait Implementations§

source§

impl<'textures> Debug for PresentInput<'textures>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'textures> PartialEq for PresentInput<'textures>

source§

fn eq(&self, other: &PresentInput<'textures>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'textures> Eq for PresentInput<'textures>

source§

impl<'textures> StructuralEq for PresentInput<'textures>

source§

impl<'textures> StructuralPartialEq for PresentInput<'textures>

Auto Trait Implementations§

§

impl<'textures> RefUnwindSafe for PresentInput<'textures>

§

impl<'textures> Send for PresentInput<'textures>

§

impl<'textures> Sync for PresentInput<'textures>

§

impl<'textures> Unpin for PresentInput<'textures>

§

impl<'textures> !UnwindSafe for PresentInput<'textures>

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

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

§

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.
§

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.
§

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.
§

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.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

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

§

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>,

§

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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

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
§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSync for T
where T: Sync,