These pages cover the headers the Build an app recipes use, grouped by task. They are generated from the crosspad-core and crosspad-gui headers. Each member links the recipes whose code uses it.
| Page | What it covers | Header |
|---|
| AppRegistrar | Registration helpers and REGISTER_APP macros. | crosspad/app/AppRegistrar.hpp |
| AppBase | The base class of every app’s App object, with its lifecycle, back handler and destroyAppAsync(). | crosspad-gui/app/AppBase.hpp |
| Page | What it covers | Header |
|---|
| IPadLogicHandler | The callbacks an app implements to own the pads, from onActivate to pressure and pan. | crosspad/pad/IPadLogicHandler.hpp |
| PadManager | The pads, with pad colours, note mapping and the pad logic that receives presses. | crosspad/pad/PadManager.hpp |
| PadLedController | Per-pad LED colours, feedback modes and brightness. | crosspad/pad/PadLedController.hpp |
| PadAnimator | Whole-grid LED animations, from progress and charging to single frames. | crosspad/pad/PadAnimator.hpp |
| RgbColor | An RGB colour, with dimming and blending. | crosspad/led/RgbColor.hpp |
| Page | What it covers | Header |
|---|
| IEventBus | Platform-agnostic event bus interface for CrossPad. | crosspad/event/IEventBus.hpp |
| EventTypes | Portable event type and source enumerations for CrossPad event system. | crosspad/event/EventTypes.hpp |
| EventData | Portable event data structures for CrossPad event system. | crosspad/event/EventData.hpp |
| Page | What it covers | Header |
|---|
| IAudioNode | A unit in the audio chain that makes or processes sound, and its real-time rules. | crosspad/audio/IAudioNode.hpp |
| IOutputLevels | The board’s audio outputs, with a level and a mute for each. | crosspad/audio/IOutputLevels.hpp |
| IKitManager | Kits, to list, select, load and save. | crosspad/kit/IKitManager.hpp |
| ISampleTools | Recording, looking at and cutting samples, the platform side of the Recorder and the Slicer. | crosspad/sampletools/ISampleTools.hpp |
| IInstrumentHost | Lends the pitched sample engine to an app that plays its own instrument. | crosspad/instrument/IInstrumentHost.hpp |
| Page | What it covers | Header |
|---|
| IMidiOutput | MIDI out, with notes, control change, pitch bend, aftertouch, program change and SysEx. | crosspad/midi/IMidiOutput.hpp |
| Page | What it covers | Header |
|---|
| Transport | One transport for the whole instrument. | crosspad/transport/Transport.hpp |
| transport_bar | The transport, always at the top of the screen. | crosspad-gui/components/transport_bar.h |
| Page | What it covers | Header |
|---|
| ui_toast | A short message at the bottom of the screen. | crosspad-gui/components/ui_toast.h |
| ui_modal | Dialogs (confirm, choice and selection) that the encoder drives. | crosspad-gui/components/ui_modal.h |
| mode_overlay | MODE + pad: switch between apps from the pad grid. | crosspad-gui/components/mode_overlay.h |
| power_gesture | Portable resolution of the hardware power button’s two GUI gestures. | crosspad-gui/components/power_gesture.h |
| gui_helpers | LVGL helpers to hide an object and to restore or delete encoder groups safely. | crosspad-gui/widgets/gui_helpers.h |
| cp_design | The CrossPad design language as the firmware uses it: palette, pixel fonts and icons. | crosspad-gui/design/cp_design.h |
| IGuiPlatform | What the platform gives the screen code, from the encoder and asset paths to postToGui(). | crosspad-gui/platform/IGuiPlatform.h |
| Page | What it covers | Header |
|---|
| PlatformServices | Centralized service registry for all CrossPad platform services. | crosspad/platform/PlatformServices.hpp |
| PlatformCapabilities | Platform capability flags — query what the current platform supports. | crosspad/platform/PlatformCapabilities.hpp |
| IImu | The motion sensor, with readings, orientation, shake and free fall. | crosspad/platform/IImu.hpp |
| IVibration | The vibration motor, with presets and audio-driven vibration. | crosspad/platform/IVibration.hpp |
| VibrationPreset | The vibration effects you can play. | crosspad/platform/VibrationPreset.hpp |
| IClock | A microsecond clock. | crosspad/platform/IClock.hpp |
| IKeyValueStore | Small saved settings (bool, 8-bit and 32-bit values) by namespace and key. | crosspad/settings/IKeyValueStore.hpp |
A badge under a member’s heading marks a rule for app code; the note next to it says what to do.
| Badge | Meaning |
|---|
| Platform only | The firmware, the simulator or the framework calls it for you. |
| Do not call | The framework manages it; your app never calls it. |