The JUCE cross-platform C++ framework, with DISTRHO/KXStudio specific changes
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.

66 lines
2.5KB

  1. /**
  2. @mainpage Documentation
  3. Welcome to the BLOCKS SDK documentation.
  4. <br>
  5. Here you will find all the information required to start creating BLOCKS applications.
  6. A brief summary of the main sections is below.
  7. <br>
  8. @subpage downloading_the_sdk
  9. This section describes how to obtain the SDK source code, either via the <a href="https://github.com/julianstorer/JUCE">JUCE framework</a> or @ref the_standalone_blocks_sdk.
  10. <br>
  11. @subpage connecting_blocks
  12. Lightpad and Control Blocks communicate with a computer over USB-C or Bluetooth, and communicate with each other via magnetic connections on their sides.
  13. This section contains instructions for configuring your setup so that all the components can communicate with each other.
  14. <br>
  15. @subpage discovering_blocks
  16. Once you have connected your device to your computer you need to be able to discover it from your application.
  17. This section outlines the procedure for Lightpad and Control %Block discovery and provides some simple example code which monitors for new connections.
  18. <br>
  19. @subpage getting_touch_events
  20. This section explains how to capture touch events from a compatible device and, building on the @ref discovering_blocks section, displays some example code.
  21. <br>
  22. @subpage getting_control_button_events
  23. Lightpad and Control Blocks have control buttons, either a mode button on their side or labelled buttons on top, and this section shows you how to obtain button pressed and button released events.
  24. <br>
  25. @subpage controlling_led_grids
  26. This section explains how to control the LED grid on a Lightpad.
  27. <br>
  28. @subpage the_littlefoot_language
  29. Advanced SDK users can specify specialised programs to run on Lightpad Blocks.
  30. These programs must be written in the LittleFoot language, which is described
  31. in this section.
  32. <br>
  33. @subpage controlling_led_strips
  34. Control Blocks have a strip of lights running along one side and this section provides instructions for controling the individual LEDs.
  35. <br>
  36. @subpage controlling_control_buttons
  37. As well as providing button pressed and button released events, control buttons also have LEDs.
  38. This section explains how to change the colour of different buttons.
  39. <br>
  40. @subpage the_standalone_blocks_sdk
  41. The easiest way to get started using the SDK is via the <a href="https://github.com/julianstorer/JUCE">JUCE framework</a>, but if you want to integrate BLOCKS functionality into your existing application then it may be more convenient to use @ref the_standalone_blocks_sdk.
  42. This section gives an overview of building and using the BLOCKS SDK as a library.
  43. */