c91973fdd1
Compiler warnings are a tool we enable as developers to detect issues with our source code that go beyond the basic requirements of compiling C++ code. For example, many implicit conversions are perfectly correct, and defined behavior in C++ but we choose to disallow them with -Wconversion. This is something only us devs have to care about. Someone using SFML wants the library to work well but does not need to concern themselves with such low level details about its implementation. By disabling warnings in non-developer builds, we ensure that non- developer users of SFML are not going to see console noise due to warnings and it prevents issues like GCC's bug 82952 which causes compilation to halt indefitely due to a bug in how a compiler warning is implemented. This also improves compatibility with older compilers. If we enable warnings in all builds no matter what, we have to protect against compilers we don't expect. Perhaps someone uses an older version of GCC that we haven't tested with. This compiler is perfectly fine compiling our C++ but we happen to use a warning flag it does not recognize so the build fails. This is not a good reason for a build to fail but nevertheless it's something we have to deal with so long as we always enable warnings. SFML_WARNINGS_AS_ERRORS is now named somewhat incorrectly but I retained the name for compatibility's sake. We can rename it to SFML_ENABLE_WARNINGS or something similar in SFML 4.
SFML — Simple and Fast Multimedia Library
SFML is a simple, fast, cross-platform and object-oriented multimedia API. It provides access to windowing, graphics, audio and network. It is written in C++, and has bindings for various languages such as C, .Net, Ruby, Python.
State of Development
Development is focused on version 3 in the master branch.
No more features are planned for the 2.x release series.
CMake Template
The easiest way to get started with SFML is our CMake-based project template. This template will automatically download and build SFML alongside your own application. Read the README for full instructions on how to use it.
Download
- You can get the latest official release on SFML's website.
- You can also get the source code of the current development version from the Git repository.
- Alternatively, you can get the latest snapshot / artifact builds from the artifacts storage.
Install
Follow the instructions of the tutorials, there is one for each platform/compiler that SFML supports.
Learn
There are several places to learn SFML:
- The official tutorials
- The online API documentation
- The community wiki
Community
Here are some useful community links:
Contribute
SFML is an open-source project, and it needs your help to go on growing and improving. If you want to get involved and suggest some additional features, file a bug report or submit a patch, please have a look at the contribution guidelines.
Authors
- Laurent Gomila (laurent@sfml-dev.org)
- Marco Antognini (hiura@sfml-dev.org)
- binary1248 (binary1248@hotmail.com)
- Lukas Dürrenberger (eXpl0it3r@sfml-dev.org)
- Jonathan De Wachter (dewachter.jonathan@gmail.com)
- Jan Haller (bromeon@sfml-dev.org)
- Mario Liebisch (mario@sfml-dev.org)
- Stefan Schindler (tank@sfml-dev.org)
- Artur Moreira (artturmoreira@gmail.com)
- Vittorio Romeo (vittorioromeo@sfml-dev.org)
- Chris Thrasher (thrasher@sfml-dev.org)
- And many other members of the SFML community
License
The SFML libraries and source code are distributed under the zlib/libpng license. See license.md. External libraries used by SFML are distributed under their own licenses.
In short, SFML is free for any use (commercial or personal, proprietary or open-source). You can use SFML in your project without any restriction. You can even omit to mention that you use SFML -- although it would be appreciated.
External libraries used by SFML
- stb_image and stb_image_write are public domain
- freetype is under the FreeType license or the GPL license
- libogg is under the BSD license
- libvorbis is under the BSD license
- libflac is under the BSD license
- minimp3 is under the CC0 license
- miniaudio is public domain or under the MIT No Attribution license