Struct pixel_engine::EngineWrapper

pub struct EngineWrapper(_);

A Wrapper around an Engine

Implementations

impl EngineWrapper

pub async fn new(title: String, size: (u32, u32, u32)) -> Self

Create the Engine and the Wrapper

pub fn new_sync(title: String, size: (u32, u32, u32)) -> Self

Create the Engine and the Wrapper

pub fn run_init<G: Game + 'static>(self) -> !

This will first create the game instance, then run the main loop of the game

pub fn run<G: Game + 'static>(self, game: G) -> !

The core of your program, This takes an already existing implementation of a Game G

Methods from Deref<Target = Engine>

pub fn size(&self) -> Vu2d

Return the current Target size in pixel

pub fn scale(&self) -> u32

Return the pixel scale factor

pub fn get_key(&self, keycode: Keycodes) -> Input

Get The status of a key

pub fn get_mouse_btn(&self, btn: MouseBtn) -> Input

Get the status of a Mouse Button

pub fn get_mouse_location(&self) -> Vu2d

Get the mouse location (in pixel) on the screen Will be defaulted to (0,0) at the start of the program

pub fn get_mouse_wheel(&self) -> MouseWheel

Get the scroll wheel direction (If Any) during the frame

pub fn get_pressed(&self) -> HashSet<Keycodes>

Get all Keys pressed during the last frame

pub fn get_held(&self) -> HashSet<Keycodes>

Get all the keys that were held during the last frame

pub fn get_released(&self) -> HashSet<Keycodes>

Get all the keys that were released during the last frame

pub fn create_decal(&mut self, sprite: &Sprite) -> Decal

Create a GPU version of Sprite

pub fn clear_input_buffer(&mut self)

Will clear the input buffer and set the cursor to 0

pub fn set_input_buffer(&mut self, value: impl AsRef<str>)

Set the input buffer to the desired value and put the input cursor at the end of the text

Warning

The value must be an ascii string

pub fn insert_input_buffer(&mut self, value: impl AsRef<str>)

Insert the given string into the input buffer at the input cursor

Warning

if the string is not only ASCII characters it will silently do nothing

pub fn append_input_buffer(&mut self, value: impl AsRef<str>)

Append the given string onto the input buffer

Warning

if the string is not only ASCII characters it will silently do nothing

pub fn add_input_passthrough(&mut self, iterator: impl Iterator<Item = Keycodes>)

Add keys onto the input pass through list

pub fn remove_input_passthrough(
    &mut self,
    iterator: impl Iterator<Item = Keycodes>
)

Remove keys onto the input pass through list

pub fn set_input_passthrough(&mut self, iterator: impl Iterator<Item = Keycodes>)

Set the input to the iterator

pub fn set_ignore_passthrough_chars(&mut self, val: bool)

If set to true, any key that is passed through when in input mode won’t have the char appended to the input buffer

pub fn get_input_buffer(&self) -> &str

Return a view into the input buffer

pub fn get_input_cursor(&self) -> usize

Return the input cursor

pub fn start_input(&mut self)

Switch to text input mode, return true if it wasn’t in this mode before

pub fn force_stop_input_mode(&mut self)

This will clear the input buffer, reset the input cursor and stop the input mode

pub fn is_in_input_mode(&self) -> bool

Is the engine in input mode

pub fn end_input_mode(&mut self) -> &str

Stop the input mode right there, and return a &str to the current buffer. This is if you need to leave the mode but retain the input buffer for a later re-entry

Trait Implementations

impl Debug for EngineWrapper

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

Formats the value using the given formatter.

impl Deref for EngineWrapper

type Target = Engine

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for EngineWrapper

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.