Struct pixel_engine::Engine

pub struct Engine {
    pub title: String,
    pub elapsed: f64,
    /* private fields */
}

Bone of the Engine, join everything;

Fields

title: String

Main title of the window, Window’s full title will be Title - fps You can modify it to change the title

elapsed: f64

Time between current frame and last frame, useful for movement’s calculations

Implementations

impl 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 Engine

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

Formats the value using the given formatter.

impl DecalDraw for Engine

fn draw_explicit_decal<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: [P; 4],
    uv: [P; 4],
    decal: &Decal,
    tint: Color
)

Draw A decal with given position and uv (You probably don’t want to use this)

fn draw_decal<P: Into<Vf2d> + Copy>(&mut self, pos: P, decal: &Decal)

Draw a decal from the given position

fn draw_decal_scaled<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    scale: P
)

Draw a decal with a given scale

fn draw_partial_decal<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    source_pos: P,
    source_size: P
)

Draw a partial decal from the given position

fn draw_partial_decal_scaled<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    source_pos: P,
    source_size: P,
    scale: P
)

Draw a partial decal with a given scale

fn draw_warped_decal<P: Into<Vf2d> + Copy>(&mut self, pos: [P; 4], decal: &Decal)

Draw a decal where all Corner are given, this will set the uv correctly to allow texture warping The points are in order:

fn draw_warped_partial_decal<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: [P; 4],
    source_pos: P,
    source_size: P,
    decal: &Decal
)

Draw a decal where all Corner are given, this will set the uv correctly to allow texture warping The points are in order:

fn draw_rotated_decal<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    angle: f32,
    center: P
)

Draw a decal rotated angle radians around center center is an offset in pixel from the top left corner of the decal

fn draw_rotated_decal_scaled<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    angle: f32,
    center: P,
    scale: P
)

Same as draw_rotated_decal but with scaling

fn draw_partial_rotated_decal<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    angle: f32,
    center: P,
    source_pos: P,
    source_size: P
)

Draw a zone of a decal and rotate it

fn draw_partial_rotated_decal_scaled<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    angle: f32,
    center: P,
    source_pos: P,
    source_size: P,
    scaled: P
)

Draw a zone of a decal, rotate it and scaled it

fn draw_decal_tinted<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    tint: Color
)

Same as the non tinted variant, but with an tint color parameter

fn draw_decal_scaled_tinted<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    scale: P,
    tint: Color
)

Same as the non tinted variant, but with an tint color parameter

fn draw_partial_decal_tinted<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    source_pos: P,
    source_size: P,
    tint: Color
)

Same as the non tinted variant, but with an tint color parameter

fn draw_partial_decal_scaled_tinted<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    source_pos: P,
    source_size: P,
    scale: P,
    tint: Color
)

Same as the non tinted variant, but with an tint color parameter

fn draw_warped_decal_tinted<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: [P; 4],
    decal: &Decal,
    tint: Color
)

Same as the non tinted variant, but with an tint color parameter

fn draw_warped_partial_decal_tinted<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: [P; 4],
    source_pos: P,
    source_size: P,
    decal: &Decal,
    tint: Color
)

Same as the non tinted variant, but with an tint color parameter

fn draw_rotated_decal_tinted<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    center: P,
    angle: f32,
    tint: Color
)

Same as the non tinted variant, but with an tint color parameter

fn draw_rotated_decal_scaled_tinted<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    center: P,
    angle: f32,
    scale: P,
    tint: Color
)

Same as the non tinted variant, but with an tint color parameter

fn draw_partial_rotated_decal_tinted<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    angle: f32,
    center: P,
    source_pos: P,
    source_size: P,
    tint: Color
)

Same as the non tinted variant, but with an tint color parameter

fn draw_partial_rotated_decal_scaled_tinted<P: Into<Vf2d> + Copy>(
    &mut self,
    pos: P,
    decal: &Decal,
    angle: f32,
    center: P,
    source_pos: P,
    source_size: P,
    scaled: P,
    tint: Color
)

Same as the non tinted variant, but with an tint color parameter

impl DecalText for Engine

fn draw_text_decal(
    &mut self,
    pos: impl Into<Vf2d>,
    text: impl AsRef<str>,
    scale: impl Into<Vf2d>,
    color: impl Into<Color>
)

Draw the given string starting at the position given and scaled

impl DrawSpriteTrait for Engine

fn size(&self) -> Vu2d

fn get_pixel(&self, pos: Vi2d) -> Option<Color>

fn set_pixel(&mut self, pos: Vi2d, col: Color)

unsafe fn get_pixel_unchecked(&self, pos: Vu2d) -> Color

Get the pixel at the given location, but bypassing any bounds check

unsafe fn set_pixel_unchecked(&mut self, pos: Vu2d, col: Color)

Set the pixel at the given location, but bypassing any bounds check

impl SmartDrawingTrait for Engine

fn draw<P: Into<Vi2d>>(&mut self, pos: P, col: Color)

Set the pixel data at the given coordinates to the given Color Will use the current PixelMode

fn clear(&mut self, col: Color)

Clear the Sprite With the given Color

fn get_size(&self) -> Vu2d

Get the size of the target

fn set_pixel_mode(&mut self, mode: PixelMode)

Set the PixelMode

fn get_pixel<P: Into<Vi2d>>(&self, pos: P) -> Option<Color>

Get the Pixel Data at the given coordinates

fn set_blend_factor(&mut self, f: f32)

Set the Blend Factor Used for alpha calculations

fn get_textsheet(&self) -> &'static Sprite

Get The textsheet (A Sprite)

fn get_pixel_mode(&self) -> PixelMode

Return the PixelMode

fn get_blend_factor(&self) -> f32

Get the Blend Factor Used for alpha calculations