Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
Def.hpp File Reference
#include "Cable.hpp"
#include "Channel.hpp"
#include <AH/Containers/Array.hpp>
#include <AH/Hardware/Arduino-Hardware-Types.hpp>
#include <AH/Hardware/Hardware-Types.hpp>
#include <AH/STL/limits>
#include <Settings/NamespaceSettings.hpp>
#include <stddef.h>
#include <stdint.h>
Include dependency graph for Def.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  EncoderSwitchPinList
 A struct for the pins of a rotary (quadrature) encoder with a switch. More...
struct  EncoderPinList
 A struct for the pins of a rotary (quadrature) encoder without a switch. More...
struct  Potentiometer
struct  MotorFader
struct  Display
struct  PixelLocation
 A simple struct representing a pixel with integer coordinates. More...
struct  pin_t
 Type for storing pin numbers of Extended Input/Output elements. More...
struct  Array< T, N >
 An array wrapper for easy copying, comparing, and iterating. More...

Typedefs

using MappingFunction = analog_t (*)(analog_t)
template<uint8_t NumRows, uint8_t NumCols>
using AddressMatrix = Array2D<uint8_t, NumRows, NumCols>
using setting_t = uint8_t
 The type used for Selectors.
using ArduinoPin_t
using analog_t
 The type returned from analogRead and similar functions.
template<size_t N>
using PinList
 An easy alias for arrays of pins.
template<class T, size_t NumRows, size_t NumCols>
using Array2D
 An easy alias for two-dimensional Arrays.

Variables

constexpr setting_t NoSetting
 A special setting that indicates an unused or invalid setting.
constexpr pin_t NO_PIN
 A special pin number that indicates an unused or invalid pin.

Typedef Documentation

◆ MappingFunction

Definition at line 23 of file Def.hpp.

◆ AddressMatrix

template<uint8_t NumRows, uint8_t NumCols>
using AddressMatrix = Array2D<uint8_t, NumRows, NumCols>

◆ setting_t

using setting_t = uint8_t

The type used for Selectors.

Examples
Custom-Selector-Callback.ino.

Definition at line 53 of file Def.hpp.

◆ ArduinoPin_t

using ArduinoPin_t

Definition at line 23 of file Arduino-Hardware-Types.hpp.

◆ analog_t

using analog_t

The type returned from analogRead and similar functions.

Definition at line 14 of file Hardware-Types.hpp.

◆ PinList

template<size_t N>
using PinList

An easy alias for arrays of pins.

Definition at line 100 of file Hardware-Types.hpp.

◆ Array2D

template<class T, size_t NumRows, size_t NumCols>
using Array2D

An easy alias for two-dimensional Arrays.

Definition at line 529 of file Array.hpp.

Variable Documentation

◆ NoSetting

setting_t NoSetting
constexpr
Initial value:
=
(std::numeric_limits<setting_t>::max() >> 1) + 1

A special setting that indicates an unused or invalid setting.

Definition at line 55 of file Def.hpp.

◆ NO_PIN

pin_t NO_PIN
constexpr

A special pin number that indicates an unused or invalid pin.

Definition at line 96 of file Hardware-Types.hpp.