Class · aurore

aurore::Inspector

On this page
aurore/core/inspector.hpp
#include <aurore/core/inspector.hpp>

class aurore::Inspector

Description

The built-in inspector, turned on with Application::setInspectorEnabled() (docs/inspector.md). Closed, it only watches for its toggle: F12 on a keyboard, or both sticks pressed in together (L3 + R3) on a controller. Each press goes one step further:

  • live: the panel follows the focus, the app keeps every input;
  • browse: the inspector takes the controller (and the keys mapped to it) to walk the tree, the app gets none of it;
  • closed again.

The rest of this class is what the core calls; an app only needs Application::setInspectorEnabled().

Types 1

enum class Mode
Value
CLOSED
LIVE
BROWSE

inspector.hpp:37

Static functions 11

static void setEnabled(bool enabled)
static bool isEnabled()
static void setMode(Mode mode)
static Mode getMode()
static bool isOpen()
static void processInput(InputManager *input, ControllerState *state)

Reads the toggle and, when browsing, the controller, whose buttons it then clears from state so that the app does not see them.

inspector.hpp:55
static void beginFrame()
static void draw(FrameContext *ctx)
static void forgetView(View *view)
static void recordColor(const std::string &name, NVGcolor color)
static void recordMetric(const std::string &name, float value)

Static attributes 2

static View * recordTarget = nullptr
static bool recording = false

Read from Aurore's headers by Doxygen at each build · library/include