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 for time measurement, timers and procedural animation.
8. Textures and Sprites — Loading and displaying textures, and frame animation.
9. Fonts and Texts — Loading fonts and printing texts using them.
10. VertexArrays — Using vertex arrays to draw custom 2D meshes and gradients.
11. Views — Using views to scroll, zoom and rotate the whole scene.
12. RenderTextures — Rendering to a texture.
13. Drawables and RenderStates — Implementing your own drawables and understanding how render states work.
14. Shaders — Using GLSL shaders for advanced effects.
15. Images — Loading, manipulating and saving images.
16. SoundBuffers and Sounds — Loading and playing sound effects.
17. Music — Streaming music.
18. SoundBufferRecorders — Recording and saving sounds.
19. SoundStreams — Implementing your own sound stream.

Tutorials

This is a collection of useful tutorials for common tasks that do not really fit into the basic documentation. These range from beginner to advanced experience levels.

• MP3 — Streaming MP3 audio files using a custom SoundStream and the MP3 SPI.
• Screenshots — Taking screenshots using Textures and Images.