BuGUI
BUtton Grid User Interface
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
 Nbugui
 CcolorGeneric colour class holding RGBA coloour values. The blinking and pulsing states indicate discrete or smooth cycling between the LED lit with the specified colour, and the LED turned off (set to black)
 Cbase_converterProvides base functionalities for converting color objects to devices specific colour values
 Ccolor_converterPovides convertion of color objects to device specific integer values
 Ccolor_converter< T, color::rgba >Basic wrapper for devices supporting RGBA colours
 Ccolor_converter< T, uint8_t >Converts color objects for grayscal only devices
 CpaletteProvides access to the device's colour palette
 Cpalette< T >Provides access to the device's colour palette and converts it from HEX to RGB values
 Cbase_controllerServes as the root of the widget tree. Also provides access to buttons componnents
 CcontrollerMain class to inherit from. Acts ast the root of the widget tree, and provides generic access to the hardware through the painter and presser objects
 Cctrlr_deleterEnsures that buttons labeled Delete triggers the delete funcitonlaity on the widget tree, even if on_Delete is not defined by the user
 Cctrlr_deleter< T >Basic wrapper to handle user defined on_Delete funtction
 Cctrlr_shifterEnsures that buttons labeled Shift are registered on press and can be queried with Shift_held, event if on_Shift is not defined by the user
 Cctrlr_shifter< T >Basic wrapper to handle user defined on_Shift function
 CpointProvides the basics of 2D geometry. Primarily used as the top left and bottom right corners of the rectangle class
 CrectangleProvides the geometric structure of widgets
 Cbase_hardwareProvides base functionalities of the hardware object, and enables access from the base_controller
 ChardwareInherits from all type of hardware components like grid, buttons... Provides the hardware type with the functionalities to interact with each components
 CcommonInherits from all type of hardware components like grid, buttons... Provides the hardware type with the functionalities to interact with each components
 CbuttonsEmpty struct for devices that do not feature labelled buttons
 Cbuttons< Device, Controller >Handles presses and enables painting on the device's labelled buttons
 CclearEmpty struct for devices or componants that do not provide a command to clear all feedback (LED's, sceen...)
 Cclear< Device >Enables calling the device's 'clear' command if it provides one
 Cclear< Component >Enables calling the 'clear' command of a specific component on the device, if one is featued
 CgridEmpty struct for devices that do not feature a button grid
 Cgrid< Device, Controller >Handle presses and enables painting on the device's button grid
 CinitEmpty struct for devices that do not provide an initialisation command
 Cinit< Device >Enables calling the device's 'init' command if it provides one
 Cinit< Component >Enables calling the 'init' command of a specific component on the device, if one is featued
 Chardware_factoryInstantiate a hardware object specialised with a specific device
 CmidiEmpty struct for devices that do not support MIDI
 Cmidi< Component >Allows for sending and receiving MIDI messages
 Cmidi_commonHolds MIDI port objects for access by derived classes. It also enables components to register their callback funcitons
 Csysex_formaterProvides funcitons to retrieve the prefix size for a specific componenet's SYSEX messages. The SYSEX prefix is usually comprised of a specific device number and manufacturer's ID
 Cbase_midi_formaterProvides underlying functionalities to format and store MIDI messages, before applying blinking or pulsing effects
 Cmidi_formaterEmpty enum for devices that do not feature anny blinking or pulsing functionalities
 Cdual_blinkerEnables the use of multiple buffers targetting diferent midi Channels. This method is used for devices and components expecting MIDI messages on 2 diffrent channels to blink LED's
 Cmidi_formater< Component >Provides necesary functionalities to format and store MIDI messages. A Blinking effect can also be applied by storing a color value in a diferent MIDI buffer, to be sent to the dedicated channel
 Cdual_pulserEnables the use of multiple buffers targetting diferent midi Channels. This method is used for devices and components expecting MIDI messages on 2 diffrent channels to pulse LED's
 CprotocolInherits from different protocols, depending on the device's specification
 Cbase_painterHolds a color object and provides the relevant setters
 Cbutton_painterConveys button colors from the controller to the base_hardware
 Cbutton_presserProvides a generic interface to represent a button press event by the user on the device
 CpainterAdds 2D information on top of a base_painter. The painter is used in user defined paint funcions to draw on the device. Meant to traverse the entire widget tree, each widget temporarly applies a coordinate offset to the painter, reflecting their relative position in the scene
 CpresserAdds 2D information on top of a button_presser. Meant to traverse the entire widget tree, each widget temporarly applies a coordinate offset to the paresser, reflecting their relative position in the scene
 Ccolor_tPrimary template for a Device and a Component that do not feature a color nested type
 Ccolor_t< Device, Component >Provides a type alias for the nested color type of the Device, only if the Component does not also feature a nested color type
 Cprotocol_tPrimary template providing a type alias for the Device only if the Component type does not feature a protocol declaration
 Cprotocol_t< Device, Component >Provides a type alias for a Component featuring a prtocol declaration
 Cclear_tPrimary template. To be specialized
 Cclear_t< Device, Component >Provides a type alias for the clear nested type of the Device, only if the Component type does not also feature a clear nested type
 Cinit_tProvides a type alias for the init nested type of the Component
 Cinit_t< Device, Component >Provides a type alias for the init nested type of the Device, only if the Component does not also feature an init nested type
 CcomponentPrimary template. To be specialized
 Cin_message_tPrimary template for a Device and a Component that do not feature an in declaration
 Cin_message_t< Device, Component >Provides an alias for the Component
 Cout_message_tPrimary template for a Device and a Component that do not feature an out declaration
 Cout_message_t< Device, Component >Provides an alias for the Component
 Ccomponent< Device, Component >Providestype aliases for all MIDI relevant parts of a Device and a specific Component
 Cbase_container_widgetProvides functionalities for 2D widget that can hold other widgets as children
 Cbase_widgetProvides the minimum required 2D widget functionalities
 Ccontainer_widgetTo be inherited to create custom wigets whcih can hold other widgets as children. Derived classes must be passeed as the template type
 CdeleterAllows derived class to call a user defined on_Delete function
 Cdeleter< T, H, false >Allows derived class to call a user defined on_Delete function.
 CwidgetTo be inherited for creating custom wigets. Derived classes must be passeed as the template type