79 breaking releases

Uses old Rust 2015

0.81.0 May 21, 2024
0.80.0 Sep 26, 2023
0.79.0 Nov 18, 2022
0.76.0 Feb 23, 2022
0.4.0 Jul 9, 2015

#90 in Graphics APIs

Download history 3265/week @ 2024-02-26 3185/week @ 2024-03-04 3526/week @ 2024-03-11 3772/week @ 2024-03-18 2937/week @ 2024-03-25 4647/week @ 2024-04-01 2806/week @ 2024-04-08 3915/week @ 2024-04-15 3666/week @ 2024-04-22 3472/week @ 2024-04-29 3130/week @ 2024-05-06 3301/week @ 2024-05-13 3924/week @ 2024-05-20 3529/week @ 2024-05-27 3138/week @ 2024-06-03 2456/week @ 2024-06-10

13,299 downloads per month
Used in 71 crates (3 directly)

MIT license

34KB
742 lines

gfx_graphics Build Status

Maintainers: @Potpourri, @kvark, @bvssvni

The implementation of a piston-graphics back-end using Gfx.

API Documentation

screenshot

Dependency graph

dependencies

How to contribute


lib.rs:

A Piston 2D graphics back-end using gfx-rs.

Piston-Graphics is a generic library for 2D, part of the Piston ecosystem. The generic abstraction creates triangles that are sent to the back-end. Triangles are sent through the Graphics trait.

How to use gfx_graphics

If you are using the piston_window library, a Gfx2d object is created for you. All you need to do is call e.draw_2d(|c, g| { ... });

If you are not using a window wrapper, you need to create Gfx2d and GfxGraphics.

  1. Create a Gfx2d object before the event loop
  2. Call Gfx2d::draw with args.viewport() from the render event.

Example:

let mut g2d = Gfx2d::new(api_version, &mut factory);
let mut events = window.events();
while let Some(e) = events.next(&mut window) {
    if let Some(args) = e.render_args() {
        g2d.draw(&mut encoder, &output_color, &output_stencil, args.viewport(), |c, g| {
            ...
        }
    }
}

For a working example, see "examples/draw_state.rs".

The closure |c, g| passes a Context and &mut GfxGraphics object. Context contains viewport, transform and draw state information.

When passing this to other functions, you usually write them as:

fn draw_something<G: Graphics>(c: &Context, g: &mut G) {
    ...
}

The purpose is to make code reusable across Piston 2D back-ends.

For more information, consult the documentation of Piston-Graphics.

Dependencies

~13MB
~88K SLoC