2 unstable releases

Uses old Rust 2015

0.2.0 Mar 10, 2017
0.1.0 Feb 13, 2016

#7 in #sfml

Download history 22/week @ 2024-03-16 24/week @ 2024-03-23 62/week @ 2024-03-30 28/week @ 2024-04-06 24/week @ 2024-04-13 22/week @ 2024-04-20 22/week @ 2024-04-27 14/week @ 2024-05-04 21/week @ 2024-05-11 18/week @ 2024-05-18 17/week @ 2024-05-25 25/week @ 2024-06-01 12/week @ 2024-06-08 21/week @ 2024-06-15 25/week @ 2024-06-22 5/week @ 2024-06-29

67 downloads per month

zlib-acknowledgement

26KB
752 lines

rust-sfml Build Status crates.io Discord

Rust bindings for SFML, the Simple and Fast Multimedia Library.

Requirements

  • Linux, Windows, or OS X
  • Rust 1.70 or later
  • SFML 2.6
  • A C++ compiler for building CSFML

Environment variables

If you get errors about SFML headers not being found, or linker errors, that probably means SFML is not installed in a global location. In that case, you can set two environment variables to help rust-sfml find the required files:

  • SFML_INCLUDE_DIR. Set this to the include folder of your SFML location.
  • SFML_LIBS_DIR. Set this to the lib folder of your SFML location.

To help debugging environment variables, you can try building with cargo build -vv. If the environment variables are set correctly, you should get warnings like this:

warning: Custom SFML include dir: C:\Users\You\sfml\include
warning: Adding custom SFML libs search path C:\Users\You\sfml\lib

TIP: To set the environment variables of a cargo project, you can use the {project_dir}/.cargo/config.toml file documented here: https://doc.rust-lang.org/cargo/reference/config.html#env

Documentation

The API documentation is available at: https://docs.rs/sfml/

If you need help with setting up rust-sfml on your system, you can take a look at the wiki.
Please take note that:

  • This wiki is supported by the community
  • The rust-sfml core team doesn't review it
  • Your contribution is welcome

License

This software is a binding of the SFML library created by Laurent Gomila, which is provided under the Zlib/png license.

This software is provided under the same license as SFML, the Zlib/png license.

Discord

rust-sfml users are welcome on the Official SFML Discord server

Dependencies