Home

Documentation

This is the official documentation of JSFML. It will guide you from setting up a basic JSFML application to understanding its very details in order to build complex applications like scene graphs (games!).

Note that the documentation is currently a work in progress before the first actual release of JSFML.

Table of Contents

1. Setup — The preparations required to setup a JSFML application. Don't worry, it's not much!
2. Windows — Creating a window and maintaining a basic refresh loop.
3. Input — Handling user input via keyboard, mouse and gamepads.
4. Vectors and Rectangles — About JSFML's vector and rectangle classes.
5. Shapes — Displaying primitive shapes.
6. Transformation and Bounds — Moving, rotating and scaling objects and retrieving their AABB.
7. Timing — Using clocks to control actions and movement.
8. Textures and Images — Loading and saving textures and images, making screenshots.
9. Sprites — Displaying textures or parts of them.
10. Fonts — Loading fonts and understanding their properties.
11. Texts — Printing texts.
12. VertexArrays — Using vertex arrays to draw custom 2D meshes and gradients.
13. Views — Using views to scroll, zoom and rotate the whole scene.
14. RenderTextures — Rendering to a texture.
15. Drawables and RenderStates — Implementing your own drawables and understanding how render states work.
16. Shaders — Using GLSL shaders for advanced effects.
17. SoundBuffers and Sounds — Loading and playing sound effects.
18. Music — Streaming music.
19. SoundBufferRecorders — Recording and saving sounds.
20. SoundStreams — Implementing your own sound stream.

Tutorials

This is a collection of useful tutorials for common tasks.

• MP3 Playback — Streaming MP3 audio files using a custom SoundStream and the MP3 SPI.