|
SDL3pp
A slim C++ wrapper for SDL3
|
| Category SDLMixer | SDL_mixer is a library to make complicated audio processing tasks easier |
| Categories | You probably want to see API by Category |
| 3D Rendering and GPU Compute | The GPU API offers a cross-platform way for apps to talk to modern graphics hardware |
| Basics | |
| Application entry points | Redefine main() if necessary so that it is called by SDL |
| Initialization and Shutdown | All SDL programs need to initialize the library before starting to work with it |
| Initialization flags | |
| Configuration Variables | This file contains functions to set and get configuration hints, as well as listing each of them alphabetically |
| Object Properties | A property is a variable that can be created and retrieved by name at runtime |
| Error Handling | Simple error message routines for SDL |
| Log Handling | Simple log messages with priorities and categories |
| Assertions | A helpful assertion macro! |
| Querying SDL Version | Functionality to query the current SDL version, both as headers the app was compiled against, and a library the app is linked to |
| Video | |
| Display and Window Management | SDL's video subsystem is largely interested in abstracting window management from the underlying operating system |
| 2D Accelerated Rendering | Header file for SDL 2D rendering functions |
| Pixel Formats and Conversion Routines | SDL offers facilities for pixel management |
| Blend modes | Blend modes decide how two colors will mix together |
| Rectangle Functions | Some helper functions for managing rectangles and 2D points, in both integer and floating point versions |
| Surface Creation and Simple Drawing | SDL surfaces are buffers of pixels in system RAM |
| Clipboard Handling | SDL provides access to the system clipboard, both for reading information from other processes and publishing information of its own |
| Vulkan Support | Functions for creating Vulkan surfaces on SDL windows |
| Metal Support | Functions to creating Metal layers and views on SDL windows |
| Camera Support | Video capture for the SDL library |
| Force Feedback Support | The SDL haptic subsystem manages haptic (force feedback) devices |
| Audio Playback, Recording, and Mixing | Audio functionality for the SDL library |
| Input Events | |
| Event Handling | Event queue management |
| Event Types | Event types for Event |
| Keyboard Support | SDL keyboard management |
| Keyboard Keycodes | Defines constants which identify keyboard keys and modifiers |
| Keyboard Scancodes | Defines keyboard scancodes |
| Mouse Support | Any GUI application has to deal with the mouse, and SDL provides functions to manage mouse input and the displayed cursor |
| Joystick Support | SDL joystick support |
| Gamepad Support | SDL provides a low-level joystick API, which just treats joysticks as an arbitrary pile of buttons, axes, and hat switches |
| Touch Support | SDL offers touch input, on platforms that support it |
| Pen Support | SDL pen event handling |
| Sensors | SDL sensor management |
| HIDAPI | Header file for SDL HIDAPI functions |
| Threads | This is provided for compatibility and completeness, we advise you to use std's thread facilities |
| Thread Management | SDL offers cross-platform thread management functions |
| Thread Synchronization Primitives | SDL offers several thread synchronization primitives |
| Atomic Operations | Atomic operations |
| Time | |
| Timer Support | SDL provides time management functionality |
| Date and Time | SDL realtime clock and date/time routines |
| File and I/O Abstractions | |
| Filesystem Access | SDL offers an API for examining and manipulating the system's filesystem |
| Storage Abstraction | The storage API is a high-level API designed to abstract away the portability issues that come up when using something lower-level (in SDL's case, this sits on top of the [Filesystem](CategoryFilesystem) and [IOStream](CategoryIOStream) subsystems) |
| I/O Streams | SDL provides an abstract interface for reading and writing data streams |
| Async I/O | SDL offers a way to perform I/O asynchronously |
| Platform and CPU Information | |
| Platform Detection | SDL provides a means to identify the app's platform, both at compile time and runtime |
| CPU Feature Detection | CPU feature detection for SDL |
| Compiler Intrinsics Detection | SDL does some preprocessor gymnastics to determine if any CPU-specific compiler intrinsics are available, as this is not necessarily an easy thing to calculate, and sometimes depends on quirks of a system, versions of build tools, and other external forces |
| Byte Order and Byte Swapping | Functions converting endian-specific values to different byte orders |
| Bit Manipulation | Functions for fiddling with bits and bitmasks |
| Additional Functionality | |
| Shared Object/DLL Management | System-dependent library loading routines |
| Process Control | Process control support |
| Power Management Status | SDL power management routines |
| Message Boxes | SDL offers a simple message box API, which is useful for simple alerts, such as informing the user when something fatal happens at startup without the need to build a UI for it (or informing the user before your UI is ready) |
| File Dialogs | SDL offers file dialogs, to let users select files with native GUI interfaces |
| System Tray | SDL offers a way to add items to the "system tray" (more correctly called the "notification area" on Windows) |
| Locale Info | SDL locale services |
| Platform-specific Functionality | Platform-specific SDL API functions |
| Standard Library Functionality | SDL provides its own implementation of some of the most important C runtime functions |
| GUIDs | A GUID is a 128-bit value that represents something that is uniquely identifiable by this value: "globally unique." |
| Miscellaneous | SDL API functions that don't fit elsewhere |
| Satellite Libraries | |
| Load images from several formats | Header file for SDL_image library |
| True type font support | Header file for SDL_ttf library |
| C++ Support | |
| Async callback helpers | Async callback wrapper helper functions and types |
| Pointer wrapper to SDL::free() | Wraps SDL generated pointers to automatically freeing them |
| Helpers to wrap SDL Resources. | A resource is any SDL object that is created and destroyed by SDL, such as a Window, a Renderer, a Texture, etc |
| Helpers to use C++ strings and byte arrays. | It has StringParam to use on parameters and StringResult to have a simple std::string-like interface for SDL allocated strings |