VCV Rack API v2
Loading...
Searching...
No Matches
rack::engine::LightInfo Struct Reference
module NULL

#include <LightInfo.hpp>

Public Member Functions

virtual ~LightInfo ()
 
virtual std::string getName ()
 
virtual std::string getDescription ()
 

Public Attributes

int lightId = -1
 
std::string name
 The name of the light, using sentence capitalization.
 
std::string description
 An optional one-sentence description of the light.
 

Constructor & Destructor Documentation

◆ ~LightInfo()

virtual rack::engine::LightInfo::~LightInfo ( )
inlinevirtual

Member Function Documentation

◆ getName()

virtual std::string rack::engine::LightInfo::getName ( )
virtual

◆ getDescription()

virtual std::string rack::engine::LightInfo::getDescription ( )
virtual

Member Data Documentation

◆ lightId

int rack::engine::LightInfo::lightId = -1

◆ name

std::string rack::engine::LightInfo::name

The name of the light, using sentence capitalization.

e.g. "Level", "Oscillator phase", "Mode CV".

Don't use the word "light" or "LED" in the name. Since this text is often prepended or appended to the name, the name will appear as e.g. "Level light light".

◆ description

std::string rack::engine::LightInfo::description

An optional one-sentence description of the light.


The documentation for this struct was generated from the following file: