You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

LightInfo.hpp 675B

12345678910111213141516171819202122232425262728293031323334
  1. #pragma once
  2. #include <common.hpp>
  3. namespace rack {
  4. namespace engine {
  5. struct Module;
  6. struct LightInfo {
  7. Module* module = NULL;
  8. int lightId = -1;
  9. /** The name of the light, using sentence capitalization.
  10. e.g. "Level", "Oscillator phase", "Mode CV".
  11. Don't use the word "light" or "LED" in the name.
  12. Since this text is often prepended or appended to the name, the name will appear as e.g. "Level light light".
  13. */
  14. std::string name;
  15. /** An optional one-sentence description of the light. */
  16. std::string description;
  17. virtual ~LightInfo() {}
  18. virtual std::string getName();
  19. virtual std::string getDescription();
  20. };
  21. } // namespace engine
  22. } // namespace rack