IGuiPlatform
#include "crosspad-gui/platform/IGuiPlatform.h"Generated from crosspad-gui/platform/IGuiPlatform.h in crosspad-gui. Edit the header’s doxygen comments to change this page.
Recipes that use it: Hello screen, Tempo and transport, UI kit
Functions
Section titled “Functions”setGuiPlatform
Section titled “setGuiPlatform”void setGuiPlatform(IGuiPlatform *platform)Declared in crosspad-gui/platform/IGuiPlatform.h:196.
getGuiPlatform
Section titled “getGuiPlatform”IGuiPlatform & getGuiPlatform()Used in Hello screen, Tempo and transport, UI kit.
Declared in crosspad-gui/platform/IGuiPlatform.h:199.
crosspad_gui::HeapStats
Section titled “crosspad_gui::HeapStats”| Field | Type | Description |
|---|---|---|
sram_free | uint32_t | |
sram_total | uint32_t | |
psram_free | uint32_t | |
psram_total | uint32_t |
Declared in crosspad-gui/platform/IGuiPlatform.h:10.
crosspad_gui::PerfStats
Section titled “crosspad_gui::PerfStats”| Field | Type | Description |
|---|---|---|
fps | uint32_t | |
cpu0_pct | uint32_t | |
cpu1_pct | uint32_t | |
sram_pct | uint32_t | |
psram_pct | uint32_t | |
stm32_mps | uint32_t |
Declared in crosspad-gui/platform/IGuiPlatform.h:17.
crosspad_gui::VoiceMeter
Section titled “crosspad_gui::VoiceMeter”| Field | Type | Description |
|---|---|---|
active | uint8_t | |
streaming | uint8_t | |
limit | uint8_t |
Declared in crosspad-gui/platform/IGuiPlatform.h:38.
crosspad_gui::AudioRouteState
Section titled “crosspad_gui::AudioRouteState”| Field | Type | Description |
|---|---|---|
captureCodec | uint8_t | |
adcInput | uint8_t[2] | |
dacOutput | uint8_t[2] | |
mute | uint8_t[2] | |
preset | uint8_t |
Declared in crosspad-gui/platform/IGuiPlatform.h:47.
InteractionEvent
Section titled “InteractionEvent”| Value | Value | Description |
|---|---|---|
Pressed | ||
Released | ||
PressLost | ||
LongPressed | ||
LongPressedRepeat |
Declared in crosspad-gui/platform/IGuiPlatform.h:59.
crosspad_gui::IGuiPlatform
Section titled “crosspad_gui::IGuiPlatform”Used in Hello screen, Tempo and transport, UI kit.
Members
| Member | Description |
|---|---|
getHeapStats | |
millis | |
assetPathPrefix | |
delayMs | |
sendPowerOff | |
getNavigationEncoder | |
getPerfStats | |
getVoiceMeter | Voices sounding and the ceiling that applies. |
onUserInteraction | |
setLcdBrightness | |
setSpeakerVolume | |
setHeadphoneVolume | |
usbAudioSupported | |
setUsbAudioEnabled | |
hasStmConfigWrite | |
writeStmConfig8 | |
writeStmConfig16 | |
writeStmConfigPad | |
readStmPadVelRaw | |
readStmPadLive | |
audioRouteSupported | |
getAudioRoute | |
setAudioRoutePreset | |
setAudioCaptureCodec | |
setAudioAdcInput | |
setAudioDacOutput | |
setAudioCodecMute | |
setDawOutputGain | Gain on the bus the USB mic endpoint carries, in dB above unity. |
usbTransferSupported | |
requestUsbTransfer | |
onFactoryReset | |
setTouchSensitivity | |
postToGui | Posts cb to the GUI task; call it from any task. |
Methods
getHeapStats
Section titled “getHeapStats”virtual HeapStats getHeapStats() = 0millis
Section titled “millis”virtual uint32_t millis() = 0assetPathPrefix
Section titled “assetPathPrefix”virtual const char * assetPathPrefix() = 0delayMs
Section titled “delayMs”virtual void delayMs(uint32_t ms) = 0sendPowerOff
Section titled “sendPowerOff”virtual void sendPowerOff() = 0getNavigationEncoder
Section titled “getNavigationEncoder”virtual lv_indev_t * getNavigationEncoder()Used in Hello screen, Tempo and transport, UI kit.
getPerfStats
Section titled “getPerfStats”virtual PerfStats getPerfStats()getVoiceMeter
Section titled “getVoiceMeter”virtual VoiceMeter getVoiceMeter()Voices sounding and the ceiling that applies.
Polled by the status bar; a platform with no sample engine leaves limit at 0 and nothing is drawn.
onUserInteraction
Section titled “onUserInteraction”virtual void onUserInteraction(InteractionEvent)setLcdBrightness
Section titled “setLcdBrightness”virtual void setLcdBrightness(uint8_t)setSpeakerVolume
Section titled “setSpeakerVolume”virtual void setSpeakerVolume(uint8_t)setHeadphoneVolume
Section titled “setHeadphoneVolume”virtual void setHeadphoneVolume(uint8_t)usbAudioSupported
Section titled “usbAudioSupported”virtual bool usbAudioSupported()setUsbAudioEnabled
Section titled “setUsbAudioEnabled”virtual void setUsbAudioEnabled(bool)hasStmConfigWrite
Section titled “hasStmConfigWrite”virtual bool hasStmConfigWrite()writeStmConfig8
Section titled “writeStmConfig8”virtual void writeStmConfig8(uint16_t, uint8_t)writeStmConfig16
Section titled “writeStmConfig16”virtual void writeStmConfig16(uint16_t, uint16_t)writeStmConfigPad
Section titled “writeStmConfigPad”virtual void writeStmConfigPad(uint8_t)readStmPadVelRaw
Section titled “readStmPadVelRaw”virtual bool readStmPadVelRaw(uint8_t, uint8_t &)readStmPadLive
Section titled “readStmPadLive”virtual bool readStmPadLive(uint8_t, crosspad::Stm32PadLive &)audioRouteSupported
Section titled “audioRouteSupported”virtual bool audioRouteSupported()getAudioRoute
Section titled “getAudioRoute”virtual bool getAudioRoute(AudioRouteState &)setAudioRoutePreset
Section titled “setAudioRoutePreset”virtual void setAudioRoutePreset(uint8_t)setAudioCaptureCodec
Section titled “setAudioCaptureCodec”virtual void setAudioCaptureCodec(uint8_t)setAudioAdcInput
Section titled “setAudioAdcInput”virtual void setAudioAdcInput(uint8_t, uint8_t)setAudioDacOutput
Section titled “setAudioDacOutput”virtual void setAudioDacOutput(uint8_t, uint8_t)setAudioCodecMute
Section titled “setAudioCodecMute”virtual void setAudioCodecMute(uint8_t, bool)setDawOutputGain
Section titled “setDawOutputGain”virtual void setDawOutputGain(uint8_t)Gain on the bus the USB mic endpoint carries, in dB above unity.
Separate from the codec volumes on purpose: it changes what a DAW records without changing what comes out of the speakers.
usbTransferSupported
Section titled “usbTransferSupported”virtual bool usbTransferSupported()requestUsbTransfer
Section titled “requestUsbTransfer”virtual void requestUsbTransfer()onFactoryReset
Section titled “onFactoryReset”virtual void onFactoryReset()setTouchSensitivity
Section titled “setTouchSensitivity”virtual void setTouchSensitivity(crosspad::TouchSensitivity)postToGui
Section titled “postToGui”Posts cb to the GUI task; call it from any task.
virtual void postToGui(lv_async_cb_t cb, void *user_data)Used in UI kit.
Declared in crosspad-gui/platform/IGuiPlatform.h:67.
Variables
Section titled “Variables”| Declaration | Description |
|---|---|
constexpr uint8_t kAudioRoutePresetCustom |