Skip to content

Version 0.4.2

Pre-release
Pre-release
Compare
Choose a tag to compare
@lukexor lukexor released this 02 Oct 23:35
· 622 commits to main since this release
v0.4.2
9c6c99b

Overview

This release is a major refactor of the library with a renewed architecture, a ton of new features, ergonomics and performance improvements.

[0.4.2] - 2021-09-02

Added

Core

  • crate::prelude and crate::prelude_3d for common imports.
  • Copy, Clone, Debug, Default, PartialEq, Eq, and Hash
    implementations for many/most structs where appropriate.
  • Serialize and Deserialize implemented for most structs with with the serde
    feature enabled.
  • New optional AppState methods:
    • on_key_pressed(): Called on key press and key repeat.
    • on_key_released(): Called on key release.
    • on_key_typed(): Called on character typed (ignores special keys like Ctrl and Backspace).
    • on_mouse_dragged(): Called on mouse motion while button is being heled.
    • on_mouse_pressed(): Called on mouse button press.
    • on_mouse_released(): Called on mouse button release.
    • on_mouse_clicked(): Called on mouse button released followed by a press.
    • on_mouse_dbl_clicked(): Called on mouse button double click.
    • on_mouse_motion(): Called on mouse motion.
    • on_mouse_wheel(): Called on mouse wheel scroll.
    • on_window_event(): Called on a window event (e.g. closed, resized, moved).
    • on_event(): Called for every user or system event as a catch-all.
  • PixEngineBuilder struct added with several settings for configuring the
    PixEngine initialization.

State

  • PixState methods for interacting with the window and PixEngine state:
    • delta_time(): Time elapsed since last frame.
    • frame_count() Total number of frame since application start.
    • frame_rate(): Average frames per second rendered.
    • target_frame_rate(): Target frame rate.
    • set_frame_rate(): Set target frame rate.
    • clear_frame_rate(): Clear target frame rate.
    • quit(): Quit the application.
    • abort_quit(): Abort quitting the application (useful in
      AppState::on_stop() as a confirmation).
  • PixState methods for controlling drawing and the PixEngine render loop:
    • background(): Set the color for clearing the screen and clear to it immediately.
    • fill(): Set the fill color for drawing operations.
    • no_fill(): Clear the fill color to transparent.
    • stroke(): Set the stroke color for drawing operations.
    • no_stroke(): Clear the stroke color to transparent.
    • clip(): Set a clipping rectangle for drawing to the canvas.
    • no_clip(): Clear the clipping rectangle.
    • running(): Whether the engine loop is running and calling
      AppState::on_update() or not.
    • run(): Start the engine loop if it's not already running.
    • no_run(): Disable the engine loop if it's currently running.
    • redraw(): Run render loop one time if it's not currently running.
    • runtimes(): Run render loop N times if it's not currently running.
    • show_frame_rate(): Set whether to show the average frame rate in the title
      bar or not.
    • scale(): Set the X, Y rendering scale for the canvas. Note this is
      different than PixEngineBuilder::scale which scales the window dimensions.
    • font_size(): Set the font size.
    • size_of(): Get the dimensions of a given string with the current font_size.
    • font_style(): Set the font style (e.g. NORMAL, BOLD, ITALIC, UNDERLINE,
      STRIKETHROUGH).
    • font_family(): Set the font family. (e.g. "courier_new.ttf").
    • rect_mode(): Set how (x, y) coordinates are treated for drawing squares
      and rectangles.
    • ellipse_mode(): Set how (x, y) coordinates are treated
      for drawing circles and ellipses.
    • image_mode(): Set how (x, y) coordinates are treated for drawing images.
    • angle_mode(): Set whether angles are interpreted as Radians or Degrees.
    • blend_mode(): Set drawing blend mode for images and textures.
    • push(): Save the current drawing settings to a stack.
    • pop(): Restore previous drawing settings from the stack.

Window

  • WindowBuilder struct for opening windows:
    • new(): Create a new WindowBuilder instance.
    • with_dimensions(): Set window (width, height).
    • with_title(): Set window title.
    • position(): Set window (x, y) position.
    • position_centered(): Center window in the display.
    • fullscreen(): Make the window fullscreen.
    • resizable(): Allow window resizing.
    • borderless(): Disable window border.
    • scale(): Set window dimension scale.
    • icon(): Set window icon.
    • build(): Build window from WindowBuilder and open it.
  • PixState window methods:
    • focused(): Wether the current window target has focus.
    • primary_window_id(): The primary window ID.
    • window_id(): The current window target ID.
    • window(): Create a new WindowBuilder.
    • close_window(): Close a given window.
    • dimensions(): The current window target (width, height) dimensions.
    • set_dimensions(): Set the current window target (width, height) dimensions.
    • width(): The current window target width.
    • set_width(): Set the current window target width.
    • height(): The current window target height.
    • set_height(): Set the current window target height.
    • display_dimensionsc(): The current display (width, height) dimensions.
    • display_width(): The current display width.
    • display_height(): The current display height.
    • show_window(): Show the current window target if hidden.
    • hide_window(): Hide the current window target if shown.
    • fullscreen(): Whether the application is currently in fullscreen mode.
    • set_fullscreen(): Set fullscreen to true or false.
    • vsync(): Whether vertical sync is enabled.
    • set_vsync(): Set vertical sync to true or false.
    • cursor(): Set the mouse cursor icon to either a system icon or custom image.
    • no_cursor(): Clear mouse cursor back to default.
    • with_window(): Target a window for drawing operations with a closure.
  • window::Result and window::Error for window related failures.

Drawing

  • ColorMode enum with Rgb, Hsb, and Hsl variants.
  • Color struct with several methods for creating and converting between color
    modes.
  • Color macros rgb!(), hsb!(), and hsl!().
  • Additional Color constants matching the SVG 1.0 Color
    Keywords    .
  • color::Result and color::Error types for conversion failures.
  • Draw trait for types that can be drawn using PixState.
  • Several new shape drawing methods on PixState.
  • New Texture struct and methods for hardware-accelerated rendering.
  • Light and LightSource structs for doing basic 3D light rendering.

UI

  • New Immediate-mode UI drawing methods for buttons. More to come in future
    versions.

Shapes

  • Made shape structs generic over their type and number of dimensions using new
    const generics.
  • Conversion implementations to convert shapes between units for better
    ergonomics.
  • Deref and DerefMut into an array of values representing a shape.
  • IntoIterator for structs where applicable.
  • Contains and Intersects traits and implementations for defining collision
    detection.
  • Draw implementations.
  • Rect struct extended with several constructor and utility methods.
  • Several new shape structs: Ellipse, Line, Point, Quad, Sphere, and
    Tri with convenience macros.

Image

  • New Image methods for converting and manipulating images.
  • image::Result and image::Error for image failures.

Events

  • WindowEvent struct.
  • KeyMod struct for detecting key modifiers on key press and release events.

Misc

  • math module for noise and randomization utilities.
  • Num trait for generic number handling.
  • Vector type for doing N-dimensional vector math.
  • Attribution for Emulogic font.
  • New katakana provided font along with default unicode fonts for fallbacks.
  • Several new examples:
    • 2d_raycasting
    • 3d_raytracing
    • colors
    • flocking
    • fluid_simulation
    • image
    • matrix
    • maze
    • textures
  • Extensive documentation additions and README improvements.

Changed

  • description, category and keywords updated in Cargo.toml.
  • Updated to resolver 2
    in Cargo.toml
  • Updated LICENSE.md to MIT/Apache-2.0.
  • Updated README, documentation and usage examples.
  • Updated and refined examples.

Breaking

Core

  • Root imports have been removed in favor of crate::prelude.
  • PixEngineResult renamed to PixResult.
  • PixEngineErr renamed to PixError and PixEngineErr::new() removed.
  • PixEngine State generic parameter removed in favor of passing application
    to PixEngine::run().
  • PixEngine::new() removed. Use PixEngine::builder() instead.
  • PixEngine::set_icon() moved to PixEngineBuilder::icon() and changed to
    take AsRef<Path>.
  • PixEngine::fullscreen() moved to PixEngineBuilder::fullscreen().
  • PixEngine::vsync() moved to PixEngineBuilder::vsync().
  • PixEngine::set_audio_sample_rate() moved to
    PixEngineBuilder::audio_sample_rate().
  • PixEngine::run() now takes a type that implements AppState and returns
    PixResult instead of PixEngineResult.

State

  • State trait renamed to AppState.
  • StateData struct renamed to PixState. Affects all methods from the State
    trait which was renamed to PixState.
  • AppState::on_start, AppState::on_update, and AppState::on_stop changed
    to return PixResult<()>. Use PixState::quit() instead of returning false
    in order to terminate the application.
  • AppState::on_update no longer takes elapsed. Use PixState::delta_time()
    instead.
  • StateData::enable_coord_wrapping() removed. Use Point::wrap() and
    Vector::wrap() methods instead.
  • StateData::wrap_coords() removed in favor of Point::wrap() and
    Vector::wrap() methods.
  • StateData::create_texture() changed to take width, height and optional PixelFormat.
  • StateData::copy_draw_target() removed.
  • StateData::copy_texture() renamed to PixState::update_texture() and
    parameters changed to take &mut Texture, Into<Option<Rect<i32>>>,
    AsRef<[u8]>, and pitch.
  • StateData::is_inside_circle() removed. Use Ellipse::contains_point() instead.

Window

  • WindowId type changed from u32 to usize.
  • StateData::open_window() renamed to PixState::create_window() which creates a WindowBuilder.
  • StateData::close_window() renamed to PixState::close_window().
  • StateData::main_window_id() renamed to PixState::primary_window_id().
  • StateData::screen_width() renamed to PixState::width().
  • StateData::screen_height() renamed to PixState::height().
  • StateData::set_screen_size() renamed to PixState::set_dimensions() and now
    takes a tuple (u32, u32).
  • StateData::is_focused() renamed to PixState::focused().
  • StateData::fullscreen() renamed to PixState::fullscreen() and changed to
    return the current fullscreen state. Use PixState::set_fullscreen() to change
    state.
  • StateData::vsync() renamed to PixState::vsync() and changed to return the
    current vsync state. Use PixState::set_vsync() to change state.
  • StateData::create_window_texture() removed.
  • StateData::copy_window_draw_target() removed.
  • StateData::copy_window_texture() removed.

Drawing

  • Pixel renamed to Color with members made private.
  • AlphaMode renamed to BlendMode. Normal renamed to None. Mask
    removed. Add and Mod added.
  • StateData::construct_font() removed in favor of sdl2::ttf.
  • StateData::get_draw_target() removed.
  • StateData::set_draw_target() removed. Use PixState::with_texture() instead.
  • StateData::get_draw_target_dims() removed. Use Texture::dimensions() instead.
  • StateData::clear_draw_target() removed. Draw target is only set within
    PixState::with_texture() callback.
  • StateData::get_alpha_mode() removed.
  • StateData::set_alpha_mode() renamed to PixState::blend_mode().
  • StateData::set_alpha_blend() removed.
  • StateData::get_draw_color() removed.
  • StateData::set_draw_color() replaced with PixState::background(),
    PixState::fill() and PixState::stroke().
  • StateData::reset_draw_color() removed.
  • StateData::set_draw_scale() removed. Use PixEngineBuilder::scale() or
    PixState::scale() methods instead.
  • StateData::fill() renamed to PixState::background().
  • StateData::clear() renamed to PixState::clear() and updated to fill screen
    with current background color.
  • StateData::draw() renamed to PixState::point() which now takes an
    Into<Point> to draw with the current stroke color.
  • StateData::draw_line() renamed to PixState::line() which now takes an
    Into<Line> to draw with the current stroke color.
  • StateData::draw_line_i32() removed.
  • StateData::draw_line_pattern() removed.
  • StateData::draw_circle() renamed to PixState::circle() which now takes an
    Into<Ellipse> to draw with the current stroke color.
  • StateData::draw_partial_circle() renamed to PixState::arc() which now takes an
    Into<Point>, radius, start, and end to draw with the current fill and
    stroke colors.
  • StateData::fill_circle() renamed to PixState::circle() which now takes an
    Into<Ellipse> to draw with the current fill color.
  • StateData::draw_elipse() renamed to PixState::ellipse() which now takes an
    Into<Ellipse> to draw with the current stroke color.
  • StateData::fill_elipse() renamed to PixState::ellipse() which now takes an
    Into<Ellipse> to draw with the current fill color.
  • StateData::draw_rect() renamed to PixState::rect() which now takes an
    Into<Rect> to draw with the current stroke color.
  • StateData::fill_rect() renamed to PixState::rect() which now takes an
    Into<Rect> to draw with the current fill color.
  • StateData::draw_triangle() renamed to PixState::triangle() which now takes an
    Into<Triangle> to draw with the current stroke color.
  • StateData::fill_triangle() renamed to PixState::triangle() which now takes an
    Into<Triangle> to draw with the current fill color.
  • StateData::draw_image() renamed to PixState::image() which now takes an
    Into<Point>.
  • StateData::draw_partial_image() removed.
  • StateData::draw_string() renamed to PixState::text() which now takes a
    Into<Point> to draw with the current fill color.
  • StateData::draw_wireframe() renamed to PixState::wireframe() which now takes a
    &[Vector] and an Into<Vector>in addition to angle and scale to draw a
    polygon with the current stroke and fill colors.
  • StateData::draw_transform() removed.

Shapes

  • Rect members made private. Use getter/setter methods to access x, y,
    width, and height instead.

Image

  • ImageRef struct removed along with all related methods: new_ref(),
    ref_from(), rgb_ref(), and rgba_ref().
  • rgb() renamed to with_rgb().
  • rgba() renamed to with_rgba().
  • from_bytes() updated to take PixelFormat parameter and now returns
    image::Result.
  • put_pixel() renamed to set_pixel().
  • get_pixel() and put_pixel() updated to return and accept Color.
  • ColorType renamed to PixelFormat.
  • color_type() renamed to format() and returns PixelFormat.
  • bytes() renamed to as_bytes(). bytes() now returns an Iterator of u8
    instead of Vec<u8>.
  • bytes_mut() renamed to as_mut_bytes() and changed to return &mut [u8] instead of &mut Vec<u8>.
  • from_file() updated to take AsRef<Path> instead of &str and returns
    image::Result.
  • save_to_file() renamed to save(), updated to take AsRef<Path> instead of
    &str and returns image::Result.

Events

  • Input renamed to KeyEvent. released removed. held changed to
    repeat. key and keymod added.
  • Axis::Unknown added and Axis made [non_exhaustive].
  • Button renamed to ControllerButton. ControllerButton::Unknown added and
    ControllerButton made [non_exhaustive].
  • Key made [non_exhaustive].
  • Mouse::X1 and Mouse::X2 removed and Mouse made [non_exhaustive].
  • PixEvent renamed to Event and made [non_exhaustive]. Several new events
    added or changed.
  • State::get_key() removed in favor of PixState::keys(),
    PixState::key_pressed(), PixState::key_down() and AppState::on_key_*
    methods.
  • State::get_mouse() removed in favor of PixState::mouse_pos(),
    PixState::mouse_pressed(), PixState::mouse_down(),
    PixState::mouse_buttons() and AppState::on_mouse_* methods.
  • State::get_mouse_x() removed.
  • State::get_mouse_y() removed.
  • State::get_mouse_wheel() removed in favor of AppState::on_mouse_wheel().
  • State::poll() removed. Use the AppState::on_* methods to respond to events.
Assets 2
Loading