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.

86 lines
3.2KB

  1. /**
  2. @mainpage Documentation
  3. Welcome to the BLOCKS SDK documentation.
  4. @s_break
  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. @s_break
  8. @subpage downloading_the_sdk
  9. This section describes how to get started writing LittleFoot scripts and how to obtain the SDK source code, either via the @jucegithub{JUCE framework} or @ref the_standalone_blocks_sdk.
  10. @s_break
  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. @s_break
  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. @s_break
  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. @s_break
  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. @s_break
  25. @subpage controlling_led_grids
  26. This section explains how to control the LED grid on a Lightpad.
  27. @s_break
  28. @subpage controlling_led_strips
  29. Control Blocks have a strip of lights running along one side and this section provides instructions for controlling the individual LEDs.
  30. @s_break
  31. @subpage controlling_control_buttons
  32. As well as providing button pressed and button released events, control buttons also have LEDs.
  33. This section explains how to change the colour of different buttons.
  34. @s_break
  35. @subpage getting_started_with_blocks_code
  36. Learn how to use the BLOCKS CODE IDE to develop LittleFoot programs that run on BLOCKS devices.
  37. @s_break
  38. @subpage the_littlefoot_language
  39. Advanced SDK users can specify specialised programs to run on Lightpad Blocks.
  40. These programs must be written in the LittleFoot language, which is described
  41. in this section.
  42. @s_break
  43. @subpage the_standalone_blocks_sdk
  44. The easiest way to get started using the SDK is via the @jucegithub{JUCE framework}, 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.
  45. This section gives an overview of building and using the BLOCKS SDK as a library.
  46. @s_break
  47. @subpage example_scripts
  48. This section provides examples of LittleFoot scripts that can be loaded onto the BLOCKS hardware.
  49. @s_break
  50. @subpage example_integrations
  51. This section gives an example of how to integrate BLOCKS features into an existing application.
  52. @s_break
  53. @subpage example_applications
  54. This section contains examples of BLOCKS applications that make use of the full potential of the JUCE library.
  55. */