Deploying to gh-pages from master @ b835171008 🚀
tzarc
3 years ago
parent
4604845d7d
commit
b92151d6fb
@ -0,0 +1,216 @@ |
||||
# QMK Breaking Changes - 2022 May 28 Changelog |
||||
|
||||
## Notable Features :id=notable-features |
||||
|
||||
### Caps Word ([#16588](https://github.com/qmk/qmk_firmware/pull/16588)) :id=caps-word |
||||
|
||||
This is a new feature that allows for capslock-like functionality that turns itself off at the end of the word. |
||||
|
||||
For instance, if you wish to type "QMK" without holding shift the entire time, you can either tap both left and right shift, or double-tap shift, to turn on _Caps Word_ -- then type `qmk` (lowercase) without holding shift. Once you hit any key other than `a`--`z`, `0`--`9`, `-`, `_`, delete, or backspace, this will go back to normal typing! |
||||
|
||||
There are other activation mechanisms as well as configurable options like timeout and the like -- see the [Caps Word documentation](feature_caps_word.md) for more information. |
||||
|
||||
### Quantum Painter ([#10174](https://github.com/qmk/qmk_firmware/pull/10174)) :id=quantum-painter |
||||
|
||||
QMK has had support for small OLED displays for some time now, but hasn't really gained too much ability to draw to panels other than the SSD1306 or SH1106 panels. |
||||
|
||||
Quantum Painter is a new drawing subsystem available to suitable ARM and RISC-V boards that is capable of drawing to large panel RGB LCDs and RGB OLEDs. It also allows for a lot more flexibility with a larger set of drawing APIs -- lines, rectangles, circles, ellipses, text, images, and even animations. |
||||
|
||||
The QMK CLI has new commands added to be able to generate images and fonts for Quantum Painter to digest -- it's even capable of converting animated gifs for display on screen. |
||||
|
||||
See the [Quantum Painter documentation](quantum_painter.md) for more information on how to set up the displays as well as how to convert images and fonts. |
||||
|
||||
!> Quantum Painter is not supported on AVR due to complexity and size constraints. Boards based on AVR such as ProMicro or Elite-C builds will not be able to leverage Quantum Painter. |
||||
|
||||
### Encoder Mapping ([#13286](https://github.com/qmk/qmk_firmware/pull/13286)) :id=encoder-mapping |
||||
|
||||
One of the long-standing complaints with Encoders is that there has been no easy way to configure them in user keymaps. [#13286](https://github.com/qmk/qmk_firmware/pull/13286) added support for [Encoder Mapping](feature_encoders.md#encoder-map), which allows users to define encoder functionality in a similar way to their normal keymap. |
||||
|
||||
!> This is not yet supported by QMK Configurator. It is also unlikely to ever be supported by VIA. |
||||
|
||||
## Changes Requiring User Action :id=changes-requiring-user-action |
||||
|
||||
### `RESET` => `QK_BOOT` ([#17037](https://github.com/qmk/qmk_firmware/pull/17037)) :id=reset-2-qk_boot |
||||
|
||||
QMK is always in the process of picking up support for new hardware platforms. One of the side-effects for future integrations has shown that QMK's usage of `RESET` as a keycode is causing naming collisions. As a result, [#17037](https://github.com/qmk/qmk_firmware/pull/17037) changed usages of `RESET` to the new keycode `QK_BOOT` in the majority of default-like keymaps. At this stage the old keycode is still usable but will likely be removed in the next breaking changes cycle. Users with keymaps containing `RESET` should also move to `QK_BOOT`. |
||||
|
||||
### Sendstring keycode overhaul ([#16941](https://github.com/qmk/qmk_firmware/pull/16941)) :id=sendstring-keycodes |
||||
|
||||
Some keycodes used with `SEND_STRING` and its relatives have been deprecated and may have their old keycode usages removed at a later date. The list of [deprecated keycodes](https://github.com/qmk/qmk_firmware/blob/ebd402788346aa6e88bde1486b2a835684d40d39/quantum/send_string_keycodes.h#L456-L505) should be consulted to determine if you're using one of the older names (the first identifier after `#define`) -- you should swap to the newer variant (the second identifier on the same line). |
||||
|
||||
### Pillow Installation ([#17133](https://github.com/qmk/qmk_firmware/pull/17133)) :id=pillow-install |
||||
|
||||
The merge of Quantum Painter added some new dependencies in the QMK CLI, most notably _Pillow_, which requires some installation in order for the CLI to function. If you've got an existing installation, you'll need to run some commands in order to get things working: |
||||
|
||||
On Windows, if using _QMK MSYS_ or _msys2_, you'll need to run the following command: |
||||
|
||||
```sh |
||||
pacman --needed --noconfirm --disable-download-timeout -S mingw-w64-x86_64-python-pillow |
||||
python3 -m pip install --upgrade qmk |
||||
``` |
||||
|
||||
On macOS: |
||||
|
||||
```sh |
||||
brew update |
||||
brew upgrade qmk/qmk/qmk |
||||
``` |
||||
|
||||
On Linux or WSL: |
||||
|
||||
```sh |
||||
python3 -m pip install --user --upgrade qmk |
||||
``` |
||||
|
||||
### Updated Keyboard Codebases :id=updated-keyboard-codebases |
||||
|
||||
The following keyboards have had their source moved within QMK: |
||||
|
||||
| Old Keyboard Name | New Keyboard Name | |
||||
|----------------------|--------------------| |
||||
| absinthe | keyhive/absinthe | |
||||
| amj40 | amjkeyboard/amj40 | |
||||
| amj60 | amjkeyboard/amj60 | |
||||
| amj96 | amjkeyboard/amj96 | |
||||
| amjpad | amjkeyboard/amjpad | |
||||
| at101_bh | viktus/at101_bh | |
||||
| ergosaurus | keyhive/ergosaurus | |
||||
| gmmk/pro/ansi | gmmk/pro/rev1/ansi | |
||||
| gmmk/pro/iso | gmmk/pro/rev1/iso | |
||||
| honeycomb | keyhive/honeycomb | |
||||
| lattice60 | keyhive/lattice60 | |
||||
| melody96 | ymdk/melody96 | |
||||
| mt40 | mt/mt40 | |
||||
| mt64rgb | mt/mt64rgb | |
||||
| mt84 | mt/mt84 | |
||||
| mt980 | mt/mt980 | |
||||
| navi10 | keyhive/navi10 | |
||||
| omnikey_bh | viktus/omnikey_bh | |
||||
| opus | keyhive/opus | |
||||
| smallice | keyhive/smallice | |
||||
| southpole | keyhive/southpole | |
||||
| uno | keyhive/uno | |
||||
| ut472 | keyhive/ut472 | |
||||
| wheatfield/blocked65 | mt/blocked65 | |
||||
| wheatfield/split75 | mt/split75 | |
||||
| z150_bh | viktus/z150_bh | |
||||
|
||||
--- |
||||
|
||||
## Full changelist :id=full-changelist |
||||
|
||||
Core: |
||||
* Quantum Painter ([#10174](https://github.com/qmk/qmk_firmware/pull/10174)) |
||||
* Add support for encoder mapping. ([#13286](https://github.com/qmk/qmk_firmware/pull/13286)) |
||||
* Add support for multiple switchs/solenoids to Haptic Feedback engine ([#15657](https://github.com/qmk/qmk_firmware/pull/15657)) |
||||
* Add compile/make macro to core ([#15959](https://github.com/qmk/qmk_firmware/pull/15959)) |
||||
* Add Reboot keycode to core ([#15990](https://github.com/qmk/qmk_firmware/pull/15990)) |
||||
* Add support for multiple sensors to pmw3360 ([#15996](https://github.com/qmk/qmk_firmware/pull/15996)) |
||||
* Asymmetric encoders, encoder tests. ([#16068](https://github.com/qmk/qmk_firmware/pull/16068)) |
||||
* Add hacky via support for RGB Matrix ([#16086](https://github.com/qmk/qmk_firmware/pull/16086)) |
||||
* Allow usage of AVRs minimal printf library ([#16266](https://github.com/qmk/qmk_firmware/pull/16266)) |
||||
* Squeeze AVR some more with `-mrelax` and `-mcall-prologues` ([#16269](https://github.com/qmk/qmk_firmware/pull/16269)) |
||||
* Heatmap incorrect matrix effect workaround ([#16315](https://github.com/qmk/qmk_firmware/pull/16315)) |
||||
* Add SN74x154 driver and convert AL1 custom matrix ([#16331](https://github.com/qmk/qmk_firmware/pull/16331)) |
||||
* Add customizable snake and knight animation increments ([#16337](https://github.com/qmk/qmk_firmware/pull/16337)) |
||||
* Chibios USB protocol: allow overriding RAW Capacity ([#16339](https://github.com/qmk/qmk_firmware/pull/16339)) |
||||
* HD44780 driver rework ([#16370](https://github.com/qmk/qmk_firmware/pull/16370)) |
||||
* Update wb32-dfu ([#16438](https://github.com/qmk/qmk_firmware/pull/16438)) |
||||
* Remove `send_unicode_hex_string()` ([#16518](https://github.com/qmk/qmk_firmware/pull/16518)) |
||||
* Add :flash target for UF2 bootloaders ([#16525](https://github.com/qmk/qmk_firmware/pull/16525)) |
||||
* Move `has_mouse_report_changed` function to `report.c` ([#16543](https://github.com/qmk/qmk_firmware/pull/16543)) |
||||
* Move Doxygen docs to subdirectory ([#16561](https://github.com/qmk/qmk_firmware/pull/16561)) |
||||
* Add Caps Word feature to core ([#16588](https://github.com/qmk/qmk_firmware/pull/16588)) |
||||
* Add non blackpill F4x1 config files ([#16600](https://github.com/qmk/qmk_firmware/pull/16600)) |
||||
* Force platform pin defs to be included ([#16611](https://github.com/qmk/qmk_firmware/pull/16611)) |
||||
* Refactor CTPC logic to allow future converters ([#16621](https://github.com/qmk/qmk_firmware/pull/16621)) |
||||
* Use a mutex guard for split shared memory ([#16647](https://github.com/qmk/qmk_firmware/pull/16647)) |
||||
* Rename TICK to TICK_EVENT ([#16649](https://github.com/qmk/qmk_firmware/pull/16649)) |
||||
* Add GET_TAPPING_TERM macro to reduce duplicate code ([#16681](https://github.com/qmk/qmk_firmware/pull/16681)) |
||||
* add the ability to change the pwm frequency for the IS31FL3737B ([#16718](https://github.com/qmk/qmk_firmware/pull/16718)) |
||||
* Joystick feature updates ([#16732](https://github.com/qmk/qmk_firmware/pull/16732)) |
||||
* Add emulated eeprom support for STM32F303xE ([#16737](https://github.com/qmk/qmk_firmware/pull/16737)) |
||||
* Refactor writePin to work with statements ([#16738](https://github.com/qmk/qmk_firmware/pull/16738)) |
||||
* Add mechanism to limit available converters ([#16783](https://github.com/qmk/qmk_firmware/pull/16783)) |
||||
* Implement XAP 'secure' core requirements ([#16843](https://github.com/qmk/qmk_firmware/pull/16843)) |
||||
* rgblight: Add functions to stop blinking one or all but one layer ([#16859](https://github.com/qmk/qmk_firmware/pull/16859)) |
||||
* Expose API for hardware unique ID ([#16869](https://github.com/qmk/qmk_firmware/pull/16869)) |
||||
* Added support for Wb32fq95 ([#16871](https://github.com/qmk/qmk_firmware/pull/16871)) |
||||
* Provide better config defaults for bluepill boards ([#16909](https://github.com/qmk/qmk_firmware/pull/16909)) |
||||
* Joystick: Simplify report descriptor and clean up error messages ([#16926](https://github.com/qmk/qmk_firmware/pull/16926)) |
||||
* Rename keymap_extras headers for consistency ([#16939](https://github.com/qmk/qmk_firmware/pull/16939)) |
||||
* Sendstring keycode overhaul ([#16941](https://github.com/qmk/qmk_firmware/pull/16941)) |
||||
* Move disable_jtag to platforms ([#16960](https://github.com/qmk/qmk_firmware/pull/16960)) |
||||
* Remove ARM pgm_read_word workaround in rgblight ([#16961](https://github.com/qmk/qmk_firmware/pull/16961)) |
||||
* Warn about LTO with arm_atsam, not ChibiOS. ([#17106](https://github.com/qmk/qmk_firmware/pull/17106)) |
||||
|
||||
CLI: |
||||
* Rework generate-api CLI command to use .build directory ([#16441](https://github.com/qmk/qmk_firmware/pull/16441)) |
||||
* Change data driven "str" type to represent a quoted string literal ([#16516](https://github.com/qmk/qmk_firmware/pull/16516)) |
||||
* Bump the 'jsonschema' version ([#16635](https://github.com/qmk/qmk_firmware/pull/16635)) |
||||
* Add frameworking for development board presets ([#16637](https://github.com/qmk/qmk_firmware/pull/16637)) |
||||
* Extend 'qmk info' to handle keymap level overrides ([#16702](https://github.com/qmk/qmk_firmware/pull/16702)) |
||||
* Data driven `g_led_config` ([#16728](https://github.com/qmk/qmk_firmware/pull/16728)) |
||||
* Allow new-keyboard to use development_board presets ([#16785](https://github.com/qmk/qmk_firmware/pull/16785)) |
||||
* Also format *.hpp files. ([#16997](https://github.com/qmk/qmk_firmware/pull/16997)) |
||||
|
||||
Submodule updates: |
||||
* ChibiOS 21.11.1 update. ([#16251](https://github.com/qmk/qmk_firmware/pull/16251)) |
||||
* Update ChibiOS-Contrib ([#16915](https://github.com/qmk/qmk_firmware/pull/16915)) |
||||
|
||||
Keyboards: |
||||
* chore: Add personal GMMK Pro keymap ([#15320](https://github.com/qmk/qmk_firmware/pull/15320)) |
||||
* move melody96 to ymdk vendor folder ([#15680](https://github.com/qmk/qmk_firmware/pull/15680)) |
||||
* move amj keyboards into amjkeyboard vendor folder ([#15733](https://github.com/qmk/qmk_firmware/pull/15733)) |
||||
* move z150_bh at101_bh omnikey_bh to viktus/ ([#16004](https://github.com/qmk/qmk_firmware/pull/16004)) |
||||
* MS Sculpt Mobile refactor ([#16038](https://github.com/qmk/qmk_firmware/pull/16038)) |
||||
* move keyhive exclusive boards into /keyhive ([#16084](https://github.com/qmk/qmk_firmware/pull/16084)) |
||||
* move 麦田 boards into /mt ([#16095](https://github.com/qmk/qmk_firmware/pull/16095)) |
||||
* Convert Wasdat Code custom matrix to SN74x138 driver ([#16257](https://github.com/qmk/qmk_firmware/pull/16257)) |
||||
* Move GMMK Pro to allow for multiple revisions ([#16423](https://github.com/qmk/qmk_firmware/pull/16423)) |
||||
* Updated pin mapping and readme. ([#16505](https://github.com/qmk/qmk_firmware/pull/16505)) |
||||
* Map data driven `DESCRIPTION` as string literal ([#16523](https://github.com/qmk/qmk_firmware/pull/16523)) |
||||
* remove unecessary layers ([#16559](https://github.com/qmk/qmk_firmware/pull/16559)) |
||||
* Helix/rev2 move to split common ([#16723](https://github.com/qmk/qmk_firmware/pull/16723)) |
||||
* Remove some layout exceptions ([#16957](https://github.com/qmk/qmk_firmware/pull/16957)) |
||||
* Refactor legacy quantum keycodes in default-ish keymaps ([#17037](https://github.com/qmk/qmk_firmware/pull/17037)) |
||||
* Refactor legacy quantum keycodes in default-ish keymaps ([#17150](https://github.com/qmk/qmk_firmware/pull/17150)) |
||||
|
||||
Keyboard fixes: |
||||
* gboards/gergoplex: move `COMBO_ENABLE` to keymap level ([#16667](https://github.com/qmk/qmk_firmware/pull/16667)) |
||||
* usb-usb converter: community layout support ([#16773](https://github.com/qmk/qmk_firmware/pull/16773)) |
||||
* Fix build of `keyhive/uno`. ([#16891](https://github.com/qmk/qmk_firmware/pull/16891)) |
||||
* Fix uno ([#16892](https://github.com/qmk/qmk_firmware/pull/16892)) |
||||
* converter/usb_usb: remove surplus commas ([#17024](https://github.com/qmk/qmk_firmware/pull/17024)) |
||||
* Various fixes for g_led_config lint warnings ([#17104](https://github.com/qmk/qmk_firmware/pull/17104)) |
||||
|
||||
Others: |
||||
* Add warning for CTPC/CONVERT_TO_PROTON_C. ([#16782](https://github.com/qmk/qmk_firmware/pull/16782)) |
||||
* Add bluepill/blackpill development board presets ([#16806](https://github.com/qmk/qmk_firmware/pull/16806)) |
||||
* Recommend pillow as part of manual MSYS install ([#17133](https://github.com/qmk/qmk_firmware/pull/17133)) |
||||
|
||||
Bugs: |
||||
* Fix one-shot locked modifiers ([#16114](https://github.com/qmk/qmk_firmware/pull/16114)) |
||||
* Fix missing definition for non-encoder case. ([#16593](https://github.com/qmk/qmk_firmware/pull/16593)) |
||||
* Fixup builds. ([#16596](https://github.com/qmk/qmk_firmware/pull/16596)) |
||||
* Missed some erroneous prints. ([#16597](https://github.com/qmk/qmk_firmware/pull/16597)) |
||||
* Workaround for pin_def errors on KINETIS based builds ([#16614](https://github.com/qmk/qmk_firmware/pull/16614)) |
||||
* Fix flipped logic bug with One Shot `OS_ON` / `OS_OFF` keys ([#16617](https://github.com/qmk/qmk_firmware/pull/16617)) |
||||
* Redo workaround for pin_def errors on KINETIS ([#16620](https://github.com/qmk/qmk_firmware/pull/16620)) |
||||
* Fix oneshot toggle logic ([#16630](https://github.com/qmk/qmk_firmware/pull/16630)) |
||||
* Mousekeys fix ([#16640](https://github.com/qmk/qmk_firmware/pull/16640)) |
||||
* Ignore transport defaults if SPLIT_KEYBOARD is unset ([#16706](https://github.com/qmk/qmk_firmware/pull/16706)) |
||||
* Fixes #16705 : digital rain follows val ([#16716](https://github.com/qmk/qmk_firmware/pull/16716)) |
||||
* Fix AVR backlight breathing: low brightness limit & exceeding breathing table max index ([#16770](https://github.com/qmk/qmk_firmware/pull/16770)) |
||||
* Fixed usb read loops not reading until timeout ([#16827](https://github.com/qmk/qmk_firmware/pull/16827)) |
||||
* [QP] Check BPP capabilities before loading the palette ([#16863](https://github.com/qmk/qmk_firmware/pull/16863)) |
||||
* Fix #16859. ([#16865](https://github.com/qmk/qmk_firmware/pull/16865)) |
||||
* Preinstall python dependencies before executing `qmk`. ([#16874](https://github.com/qmk/qmk_firmware/pull/16874)) |
||||
* Fixup AVR builds. ([#16875](https://github.com/qmk/qmk_firmware/pull/16875)) |
||||
* Fix kinetic mouse mode ([#16951](https://github.com/qmk/qmk_firmware/pull/16951)) |
||||
* Enhancement and fixes of "Secure" feature ([#16958](https://github.com/qmk/qmk_firmware/pull/16958)) |
||||
* Check for ongoing transfers on the OUT endpoint ([#16974](https://github.com/qmk/qmk_firmware/pull/16974)) |
||||
* MSYS2 install: add some Python dependencies through Pacman ([#17025](https://github.com/qmk/qmk_firmware/pull/17025)) |
||||
* Revert "Fix kinetic mouse mode (#16951)" ([#17095](https://github.com/qmk/qmk_firmware/pull/17095)) |
||||
* Workaround for recent -Werror=array-bounds AVR issues ([#17136](https://github.com/qmk/qmk_firmware/pull/17136)) |
||||
* Bug fix: Continue Caps Word when AltGr (right Alt) is held. ([#17156](https://github.com/qmk/qmk_firmware/pull/17156)) |
||||
@ -0,0 +1,156 @@ |
||||
# Caps Word |
||||
|
||||
It is often useful to type a single word in all capitals, for instance |
||||
abbreviations like "QMK", or in code, identifiers like `KC_SPC`. "Caps Word" is |
||||
a modern alternative to Caps Lock: |
||||
|
||||
* Letters are capitalized while active, and Caps Word automatically disables |
||||
itself at the end of the word. That is, it stops by default once a space or |
||||
any key other than `a`--`z`, `0`--`9`, `-`, `_`, delete, or backspace is |
||||
pressed. Caps Word also disables itself if the keyboard is idle for 5 seconds. |
||||
This is configurable, see below. |
||||
|
||||
* To avoid requiring a dedicated key for Caps Word, there is an option |
||||
(`BOTH_SHIFTS_TURNS_ON_CAPS_WORD`) to activate Caps Word by simultaneously |
||||
pressing both shift keys. See below for other options. |
||||
|
||||
* The implementation does not use the Caps Lock (`KC_CAPS`) keycode. Caps Word |
||||
works even if you're remapping Caps Lock at the OS level to Ctrl or something |
||||
else, as Emacs and Vim users often do. |
||||
|
||||
|
||||
## How do I enable Caps Word :id=how-do-i-enable-caps-word |
||||
|
||||
In your `rules.mk`, add: |
||||
|
||||
```make |
||||
CAPS_WORD_ENABLE = yes |
||||
``` |
||||
|
||||
Next, use one the following methods to activate Caps Word: |
||||
|
||||
* **Activate by pressing a key**: Use the `CAPS_WORD` keycode (short |
||||
alias `CAPSWRD`) in your keymap. |
||||
|
||||
* **Activate by pressing Left Shift + Right Shift**: Add `#define |
||||
BOTH_SHIFTS_TURNS_ON_CAPS_WORD` to config.h. You may also need to disable or |
||||
reconfigure Command, details below. Then, simultaneously pressing both left |
||||
and right shifts turns on Caps Word. This method works with the plain |
||||
`KC_LSFT` and `KC_RSFT` keycodes as well as one-shot shifts and Space Cadet |
||||
shifts. If your shift keys are mod-taps, hold both shift mod-tap keys until |
||||
the tapping term, then release them. |
||||
|
||||
* **Activate by double tapping Left Shift**: Add `#define |
||||
DOUBLE_TAP_SHIFT_TURNS_ON_CAPS_WORD` config.h. Then, double tapping Left Shift |
||||
turns on Caps Word. This method works with `KC_LSFT` or one-shot Left Shift |
||||
`OSM(MOD_LSFT)`. To count as a double tap, the maximum time in milliseconds |
||||
between taps is `TAPPING_TERM`, or if using `TAPPING_TERM_PER_KEY`, the time |
||||
returned by `get_tapping_term()` for the shift keycode being tapped. |
||||
|
||||
* **Custom activation**: You can activate Caps Word from code by calling |
||||
`caps_word_on()`. This may be used to activate Caps Word through [a |
||||
combo](feature_combo.md) or [tap dance](feature_tap_dance.md) or any means |
||||
you like. |
||||
|
||||
### Troubleshooting: Command :id=troubleshooting-command |
||||
|
||||
When using `BOTH_SHIFTS_TURNS_ON_CAPS_WORD`, you might see a compile message |
||||
**"BOTH_SHIFTS_TURNS_ON_CAPS_WORD and Command should not be enabled at the same |
||||
time, since both use the Left Shift + Right Shift key combination."** |
||||
|
||||
Many keyboards enable the [Command feature](feature_command.md), which by |
||||
default is also activated using the Left Shift + Right Shift key combination. To |
||||
fix this conflict, please disable Command by adding in rules.mk: |
||||
|
||||
```make |
||||
COMMAND_ENABLE = no |
||||
``` |
||||
|
||||
Or configure Command to use another key combination like Left Ctrl + Right Ctrl |
||||
by defining `IS_COMMAND()` in config.h: |
||||
|
||||
```c |
||||
// Activate Command with Left Ctrl + Right Ctrl. |
||||
#define IS_COMMAND() (get_mods() == MOD_MASK_CTRL) |
||||
``` |
||||
|
||||
|
||||
## Customizing Caps Word :id=customizing-caps-word |
||||
|
||||
### Idle timeout :id=idle-timeout |
||||
|
||||
Caps Word turns off automatically if no keys are pressed for |
||||
`CAPS_WORD_IDLE_TIMEOUT` milliseconds. The default is 5000 (5 seconds). |
||||
Configure the timeout duration in config.h, for instance |
||||
|
||||
```c |
||||
#define CAPS_WORD_IDLE_TIMEOUT 3000 // 3 seconds. |
||||
``` |
||||
|
||||
Setting `CAPS_WORD_IDLE_TIMEOUT` to 0 configures Caps Word to never time out. |
||||
Caps Word then remains active indefinitely until a word breaking key is pressed. |
||||
|
||||
|
||||
### Functions :id=functions |
||||
|
||||
Functions to manipulate Caps Word: |
||||
|
||||
| Function | Description | |
||||
|-------------------------|------------------------------------------------| |
||||
| `caps_word_on()` | Turns Caps Word on. | |
||||
| `caps_word_off()` | Turns Caps Word off. | |
||||
| `caps_word_toggle()` | Toggles Caps Word. | |
||||
| `is_caps_word_on()` | Returns true if Caps Word is currently on. | |
||||
|
||||
|
||||
### Configure which keys are "word breaking" :id=configure-which-keys-are-word-breaking |
||||
|
||||
You can define the `caps_word_press_user(uint16_t keycode)` callback to |
||||
configure which keys should be shifted and which keys are considered "word |
||||
breaking" and stop Caps Word. |
||||
|
||||
The callback is called on every key press while Caps Word is active. When the |
||||
key should be shifted (that is, a letter key), the callback should call |
||||
`add_weak_mods(MOD_BIT(KC_LSFT))` to shift the key. Returning true continues the |
||||
current "word," while returning false is "word breaking" and deactivates Caps |
||||
Word. The default callback is |
||||
|
||||
```c |
||||
bool caps_word_press_user(uint16_t keycode) { |
||||
switch (keycode) { |
||||
// Keycodes that continue Caps Word, with shift applied. |
||||
case KC_A ... KC_Z: |
||||
case KC_MINS: |
||||
add_weak_mods(MOD_BIT(KC_LSFT)); // Apply shift to next key. |
||||
return true; |
||||
|
||||
// Keycodes that continue Caps Word, without shifting. |
||||
case KC_1 ... KC_0: |
||||
case KC_BSPC: |
||||
case KC_DEL: |
||||
case KC_UNDS: |
||||
return true; |
||||
|
||||
default: |
||||
return false; // Deactivate Caps Word. |
||||
} |
||||
} |
||||
``` |
||||
|
||||
|
||||
### Representing Caps Word state :id=representing-caps-word-state |
||||
|
||||
Define `caps_word_set_user(bool active)` to get callbacks when Caps Word turns |
||||
on or off. This is useful to represent the current Caps Word state, e.g. by |
||||
setting an LED or playing a sound. In your keymap, define |
||||
|
||||
```c |
||||
void caps_word_set_user(bool active) { |
||||
if (active) { |
||||
// Do something when Caps Word activates. |
||||
} else { |
||||
// Do something when Caps Word deactivates. |
||||
} |
||||
} |
||||
``` |
||||
|
||||
@ -1,57 +1,298 @@ |
||||
# HD44780 LCD Displays |
||||
|
||||
This is an integration of Peter Fleury's LCD library. This page will explain the basics. [For in depth documentation visit his page.](http://www.peterfleury.epizy.com/doxygen/avr-gcc-libraries/group__pfleury__lcd.html) |
||||
|
||||
You can enable support for HD44780 Displays by setting the `HD44780_ENABLE` flag in your keyboards `rules.mk` to yes. |
||||
|
||||
## Configuration |
||||
|
||||
You will need to configure the pins used by your display, and its number of lines and columns in your keyboard's `config.h`. |
||||
|
||||
|
||||
Uncomment the section labled HD44780 and change the parameters as needed. |
||||
```` |
||||
/* |
||||
* HD44780 LCD Display Configuration |
||||
*/ |
||||
|
||||
#define LCD_LINES 2 //< number of visible lines of the display |
||||
#define LCD_DISP_LENGTH 16 //< visibles characters per line of the display |
||||
#define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode |
||||
#if LCD_IO_MODE |
||||
#define LCD_PORT PORTB //< port for the LCD lines |
||||
#define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0 |
||||
#define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1 |
||||
#define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2 |
||||
#define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3 |
||||
#define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0 |
||||
#define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1 |
||||
#define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2 |
||||
#define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3 |
||||
#define LCD_RS_PORT LCD_PORT //< port for RS line |
||||
#define LCD_RS_PIN 3 //< pin for RS line |
||||
#define LCD_RW_PORT LCD_PORT //< port for RW line |
||||
#define LCD_RW_PIN 2 //< pin for RW line |
||||
#define LCD_E_PORT LCD_PORT //< port for Enable line |
||||
#define LCD_E_PIN 1 //< pin for Enable line |
||||
#endif |
||||
```` |
||||
|
||||
Should you need to configure other properties you can copy them from `quantum/hd44780.h` and set them in your `config.h` |
||||
# HD44780 LCD Driver |
||||
|
||||
## Supported Hardware |
||||
|
||||
LCD modules using [HD44780U](https://www.sparkfun.com/datasheets/LCD/HD44780.pdf) IC or equivalent, communicating in 4-bit mode. |
||||
|
||||
|Module|Size |Notes | |
||||
|------|--------------|---------------------------------| |
||||
|1602A |16x2, 5x8 dots| | |
||||
|2004A |20x4, 5x8 dots|Untested, not currently supported| |
||||
|
||||
To run these modules at 3.3V, an additional MAX660 voltage converter IC must be soldered on, along with two 10µF capacitors. See [this page](https://www.codrey.com/electronic-circuits/hack-your-16x2-lcd/) for more details. |
||||
|
||||
## Usage |
||||
|
||||
To initialize your display, call `lcd_init()` with one of these parameters: |
||||
```` |
||||
LCD_DISP_OFF : display off |
||||
LCD_DISP_ON : display on, cursor off |
||||
LCD_DISP_ON_CURSOR : display on, cursor on |
||||
LCD_DISP_ON_CURSOR_BLINK : display on, cursor on flashing |
||||
```` |
||||
This is best done in your keyboards `matrix_init_kb` or your keymaps `matrix_init_user`. |
||||
It is advised to clear the display before use. |
||||
To do so call `lcd_clrscr()`. |
||||
Add the following to your `rules.mk`: |
||||
|
||||
```make |
||||
HD44780_ENABLE = yes |
||||
``` |
||||
|
||||
## Basic Configuration |
||||
|
||||
Add the following to your `config.h`: |
||||
|
||||
|Define |Default |Description | |
||||
|-----------------------|--------------|-----------------------------------------------------------------------------------------------------| |
||||
|`HD44780_DATA_PINS` |*Not defined* |(Required) An array of four GPIO pins connected to the display's D4-D7 pins, eg. `{ B1, B3, B2, B6 }`| |
||||
|`HD44780_RS_PIN` |*Not defined* |(Required) The GPIO connected to the display's RS pin | |
||||
|`HD44780_RW_PIN` |*Not defined* |(Required) The GPIO connected to the display's RW pin | |
||||
|`HD44780_E_PIN` |*Not defined* |(Required) The GPIO connected to the display's E pin | |
||||
|`HD44780_DISPLAY_COLS` |`16` |The number of visible characters on a single line of the display | |
||||
|`HD44780_DISPLAY_LINES`|`2` |The number of visible lines on the display | |
||||
|`HD44780_WRAP_LINES` |*Not defined* |If defined, input characters will wrap to the next line | |
||||
|
||||
## Examples |
||||
|
||||
### Hello World |
||||
|
||||
Add the following to your `keymap.c`: |
||||
|
||||
```c |
||||
void keyboard_post_init_user(void) { |
||||
hd44780_init(true, true); // Show blinking cursor |
||||
hd44780_puts_P(PSTR("Hello, world!\n")); |
||||
} |
||||
``` |
||||
|
||||
### Custom Character Definition |
||||
|
||||
Up to eight custom characters can be defined. This data is stored in the Character Generator RAM (CGRAM), and is not persistent across power cycles. |
||||
|
||||
This example defines the QMK Psi as the first custom character. The first 16 positions in the character set are reserved for the eight custom characters duplicated. |
||||
|
||||
``` |
||||
Byte | 16 8 4 2 1 |
||||
1 | x x x ■ □ ■ □ ■ |
||||
2 | x x x ■ □ ■ □ ■ |
||||
3 | x x x ■ □ ■ □ ■ |
||||
4 | x x x □ ■ ■ ■ □ |
||||
5 | x x x □ □ ■ □ □ |
||||
6 | x x x □ □ ■ □ □ |
||||
7 | x x x □ □ ■ □ □ |
||||
8 | x x x □ □ □ □ □ |
||||
``` |
||||
|
||||
```c |
||||
const uint8_t PROGMEM psi[8] = { 0x15, 0x15, 0x15, 0x0E, 0x04, 0x04, 0x04, 0x00 }; |
||||
|
||||
void keyboard_post_init_user(void) { |
||||
hd44780_init(false, false); |
||||
hd44780_define_char_P(0, psi); |
||||
// Cursor is incremented while defining characters so must be reset |
||||
hd44780_home(); |
||||
// 0x08 to avoid null terminator |
||||
hd44780_puts_P(PSTR("\x08 QMK Firmware")); |
||||
} |
||||
``` |
||||
|
||||
## API |
||||
|
||||
### `void hd44780_init(bool cursor, bool blink)` |
||||
|
||||
Initialize the display. |
||||
|
||||
This function should be called only once, before any of the other functions can be called. |
||||
|
||||
#### Arguments |
||||
|
||||
- `bool cursor` |
||||
Whether to show the cursor. |
||||
- `bool blink` |
||||
Whether to blink the cursor, if shown. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_clear(void)` |
||||
|
||||
Clear the display. |
||||
|
||||
This function is called on init. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_home(void)` |
||||
|
||||
Move the cursor to the home position. |
||||
|
||||
This function is called on init. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_on(bool cursor, bool blink)` |
||||
|
||||
Turn the display on, and/or set the cursor properties. |
||||
|
||||
This function is called on init. |
||||
|
||||
#### Arguments |
||||
|
||||
- `bool cursor` |
||||
Whether to show the cursor. |
||||
- `bool blink` |
||||
Whether to blink the cursor, if shown. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_off(void)` |
||||
|
||||
Turn the display off. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_set_cursor(uint8_t col, uint8_t line)` |
||||
|
||||
Move the cursor to the specified position on the display. |
||||
|
||||
#### Arguments |
||||
|
||||
- `uint8_t col` |
||||
The column number to move to, from 0 to 15 on 16x2 displays. |
||||
- `bool line` |
||||
The line number to move to, either 0 or 1 on 16x2 displays. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_putc(char c)` |
||||
|
||||
Print a character to the display. The newline character `\n` will move the cursor to the start of the next line. |
||||
|
||||
The exact character shown may depend on the ROM code of your particular display - refer to the datasheet for the full character set. |
||||
|
||||
#### Arguments |
||||
|
||||
- `char c` |
||||
The character to print. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_puts(const char *s)` |
||||
|
||||
Print a string of characters to the display. |
||||
|
||||
#### Arguments |
||||
|
||||
- `const char *s` |
||||
The string to print. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_puts_P(const char *s)` |
||||
|
||||
Print a string of characters from PROGMEM to the display. |
||||
|
||||
On ARM devices, this function is simply an alias of `hd44780_puts()`. |
||||
|
||||
#### Arguments |
||||
|
||||
- `const char *s` |
||||
The PROGMEM string to print (ie. `PSTR("Hello")`). |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_define_char(uint8_t index, uint8_t *data)` |
||||
|
||||
Define a custom character. |
||||
|
||||
#### Arguments |
||||
|
||||
- `uint8_t index` |
||||
The index of the custom character to define, from 0 to 7. |
||||
- `uint8_t *data` |
||||
An array of 8 bytes containing the 5-bit row data of the character, where the first byte is the topmost row, and the least significant bit of each byte is the rightmost column. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_define_char_P(uint8_t index, const uint8_t *data)` |
||||
|
||||
Define a custom character from PROGMEM. |
||||
|
||||
On ARM devices, this function is simply an alias of `hd44780_define_char()`. |
||||
|
||||
#### Arguments |
||||
|
||||
- `uint8_t index` |
||||
The index of the custom character to define, from 0 to 7. |
||||
- `const uint8_t *data` |
||||
A PROGMEM array of 8 bytes containing the 5-bit row data of the character, where the first byte is the topmost row, and the least significant bit of each byte is the rightmost column. |
||||
|
||||
--- |
||||
|
||||
### `bool hd44780_busy(void)` |
||||
|
||||
Indicates whether the display is currently processing, and cannot accept instructions. |
||||
|
||||
#### Return Value |
||||
|
||||
`true` if the display is busy. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_write(uint8_t data, bool isData)` |
||||
|
||||
Write a byte to the display. |
||||
|
||||
#### Arguments |
||||
|
||||
- `uint8_t data` |
||||
The byte to send to the display. |
||||
- `bool isData` |
||||
Whether the byte is an instruction or character data. |
||||
|
||||
--- |
||||
|
||||
### `uint8_t hd44780_read(bool isData)` |
||||
|
||||
Read a byte from the display. |
||||
|
||||
#### Arguments |
||||
|
||||
- `bool isData` |
||||
Whether to read the current cursor position, or the character at the cursor. |
||||
|
||||
#### Return Value |
||||
|
||||
If `isData` is `true`, the returned byte will be the character at the current DDRAM address. Otherwise, it will be the current DDRAM address and the busy flag. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_command(uint8_t command)` |
||||
|
||||
Send a command to the display. Refer to the datasheet and `hd44780.h` for the valid commands and defines. |
||||
|
||||
This function waits for the display to clear the busy flag before sending the command. |
||||
|
||||
#### Arguments |
||||
|
||||
- `uint8_t command` |
||||
The command to send. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_data(uint8_t data)` |
||||
|
||||
Send a byte of data to the display. |
||||
|
||||
This function waits for the display to clear the busy flag before sending the data. |
||||
|
||||
#### Arguments |
||||
|
||||
- `uint8_t data` |
||||
The byte of data to send. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_set_cgram_address(uint8_t address)` |
||||
|
||||
Set the CGRAM address. |
||||
|
||||
This function is used when defining custom characters. |
||||
|
||||
#### Arguments |
||||
|
||||
- `uint8_t address` |
||||
The CGRAM address to move to, from `0x00` to `0x3F`. |
||||
|
||||
--- |
||||
|
||||
### `void hd44780_set_ddram_address(uint8_t address)` |
||||
|
||||
Set the DDRAM address. |
||||
|
||||
This function is used when printing characters to the display, and setting the cursor. |
||||
|
||||
To now print something to your Display you first call `lcd_gotoxy(column, line)`. To go to the start of the first line you would call `lcd_gotoxy(0, 0)` and then print a string with `lcd_puts("example string")`. |
||||
#### Arguments |
||||
|
||||
There are more methods available to control the display. [For in depth documentation please visit the linked page.](http://www.peterfleury.epizy.com/doxygen/avr-gcc-libraries/group__pfleury__lcd.html) |
||||
- `uint8_t address` |
||||
The DDRAM address to move to, from `0x00` to `0x7F`. |
||||
|
||||
@ -0,0 +1,240 @@ |
||||
# group `hd44780` |
||||
|
||||
HD44780 Character LCD Driver |
||||
|
||||
## Summary |
||||
|
||||
Members | Descriptions |
||||
--------------------------------|--------------------------------------------- |
||||
`define `[`HD44780_CMD_CLEAR_DISPLAY`](#group__hd44780_1ga317a0fa779dcbd40d04095e1c3b16447) | |
||||
`define `[`HD44780_CMD_RETURN_HOME`](#group__hd44780_1ga64cd4e167d1a9cd65b32d5dcd7ac1bb8) | |
||||
`define `[`HD44780_CMD_ENTRY_MODE`](#group__hd44780_1ga6a4bd39ff528e4b7c7cc556095466158) | |
||||
`define `[`HD44780_ENTRY_MODE_INC`](#group__hd44780_1ga8def8b2eb6120f932fc5831e3fbb3377) | |
||||
`define `[`HD44780_ENTRY_MODE_SHIFT`](#group__hd44780_1gac58c05aa3eae28e88272bfb7ee7f5c40) | |
||||
`define `[`HD44780_CMD_DISPLAY`](#group__hd44780_1gafb9f17134eb0765671ea8f43b188ae1e) | |
||||
`define `[`HD44780_DISPLAY_ON`](#group__hd44780_1gaefd6f75e3454ecbe00950c818e9e9420) | |
||||
`define `[`HD44780_DISPLAY_CURSOR`](#group__hd44780_1gad125b60be30b2cd0e0bfb23f949238ec) | |
||||
`define `[`HD44780_DISPLAY_BLINK`](#group__hd44780_1gadb288f3996fafc6537c5e413eff39df8) | |
||||
`define `[`HD44780_CMD_MOVE`](#group__hd44780_1gac1f843079f60718d770b34b1d9e080a1) | |
||||
`define `[`HD44780_MOVE_DISPLAY`](#group__hd44780_1ga7f5aead3ce92c0bb8eef4afb6ec03fdc) | |
||||
`define `[`HD44780_MOVE_RIGHT`](#group__hd44780_1ga5b8911c499925d126afd681d19e16985) | |
||||
`define `[`HD44780_CMD_FUNCTION`](#group__hd44780_1ga66e53be765239225f30b35689edcc7f1) | |
||||
`define `[`HD44780_FUNCTION_8_BIT`](#group__hd44780_1gab4760a025661db140bd7df635bbd67e7) | |
||||
`define `[`HD44780_FUNCTION_2_LINES`](#group__hd44780_1ga88dbd8646d5fad0456e4685239404da3) | |
||||
`define `[`HD44780_FUNCTION_5X10_DOTS`](#group__hd44780_1ga66002af4238dd0830e3dbe7780143492) | |
||||
`define `[`HD44780_CMD_SET_CGRAM_ADDRESS`](#group__hd44780_1ga73397fed8f690a6508fb5967a76bcd3f) | |
||||
`define `[`HD44780_CMD_SET_DDRAM_ADDRESS`](#group__hd44780_1ga32d29769e79b9843c284f98a9bc6ad2a) | |
||||
`define `[`HD44780_BUSY_FLAG`](#group__hd44780_1gae22e5ab2bb9069fb265a6ff8ca5d0254) | |
||||
`public void `[`hd44780_write`](#group__hd44780_1ga3a41d7df58b5856c629f8181e93b7c00)`(uint8_t data,bool isData)` | Write a byte to the display. |
||||
`public uint8_t `[`hd44780_read`](#group__hd44780_1ga855e31aeb778f32efbd75be995797d1b)`(bool isData)` | Read a byte from the display. |
||||
`public bool `[`hd44780_busy`](#group__hd44780_1gadcb1634221c116247735e3312637edc1)`(void)` | Indicates whether the display is currently processing, and cannot accept instructions. |
||||
`public void `[`hd44780_command`](#group__hd44780_1gacd6ba5f8ecc8e6776e6617312b60d28e)`(uint8_t command)` | Send a command to the display. Refer to the datasheet for the valid commands. |
||||
`public void `[`hd44780_data`](#group__hd44780_1ga8bc010c20fd8026b0d98bce13066b049)`(uint8_t data)` | Send a byte of data to the display. |
||||
`public void `[`hd44780_clear`](#group__hd44780_1gaa358b83b37987e488b8f47d48a896ef8)`(void)` | Clear the display. |
||||
`public void `[`hd44780_home`](#group__hd44780_1gac59e0708629529fee41ae215abd1e954)`(void)` | Move the cursor to the home position. |
||||
`public void `[`hd44780_on`](#group__hd44780_1ga86f7413fd10963734e7d00cc475a8aba)`(bool cursor,bool blink)` | Turn the display on, and/or set the cursor position. |
||||
`public void `[`hd44780_off`](#group__hd44780_1gaa236bcd35da58b8d3a9c5347358d3560)`(void)` | Turn the display off. |
||||
`public void `[`hd44780_set_cgram_address`](#group__hd44780_1gacd561522fddf2ec8833325fd10e3a924)`(uint8_t address)` | Set the CGRAM address. |
||||
`public void `[`hd44780_set_ddram_address`](#group__hd44780_1ga8de3a1df53c6481652683d1a6df31948)`(uint8_t address)` | Set the DDRAM address. |
||||
`public void `[`hd44780_init`](#group__hd44780_1ga16611b90107639921a68efd503949db8)`(bool cursor,bool blink)` | Initialize the display. |
||||
`public void `[`hd44780_set_cursor`](#group__hd44780_1ga0144f1c7e1de7745862f991451efa614)`(uint8_t col,uint8_t line)` | Move the cursor to the specified position on the display. |
||||
`public void `[`hd44780_define_char`](#group__hd44780_1gaa167a2e4398a665658597f328ea08736)`(uint8_t index,uint8_t * data)` | Define a custom character. |
||||
`public void `[`hd44780_putc`](#group__hd44780_1gaf9578702c16938a2abbb8c6becc9915f)`(char c)` | Print a character to the display. The newline character will move the cursor to the start of the next line. |
||||
`public void `[`hd44780_puts`](#group__hd44780_1gaefe6076f55a4619cd8279765e125e513)`(const char * s)` | Print a string of characters to the display. |
||||
`public void `[`hd44780_define_char_P`](#group__hd44780_1ga8d31109c8c7ef295511145c490cdba7d)`(uint8_t index,const uint8_t * data)` | Define a custom character from PROGMEM. |
||||
`public void `[`hd44780_puts_P`](#group__hd44780_1gad999de4c8c443783542aece3c5ffaefc)`(const char * s)` | Print a string of characters from PROGMEM to the display. |
||||
|
||||
## Members |
||||
|
||||
#### `define `[`HD44780_CMD_CLEAR_DISPLAY`](#group__hd44780_1ga317a0fa779dcbd40d04095e1c3b16447) |
||||
|
||||
#### `define `[`HD44780_CMD_RETURN_HOME`](#group__hd44780_1ga64cd4e167d1a9cd65b32d5dcd7ac1bb8) |
||||
|
||||
#### `define `[`HD44780_CMD_ENTRY_MODE`](#group__hd44780_1ga6a4bd39ff528e4b7c7cc556095466158) |
||||
|
||||
#### `define `[`HD44780_ENTRY_MODE_INC`](#group__hd44780_1ga8def8b2eb6120f932fc5831e3fbb3377) |
||||
|
||||
#### `define `[`HD44780_ENTRY_MODE_SHIFT`](#group__hd44780_1gac58c05aa3eae28e88272bfb7ee7f5c40) |
||||
|
||||
#### `define `[`HD44780_CMD_DISPLAY`](#group__hd44780_1gafb9f17134eb0765671ea8f43b188ae1e) |
||||
|
||||
#### `define `[`HD44780_DISPLAY_ON`](#group__hd44780_1gaefd6f75e3454ecbe00950c818e9e9420) |
||||
|
||||
#### `define `[`HD44780_DISPLAY_CURSOR`](#group__hd44780_1gad125b60be30b2cd0e0bfb23f949238ec) |
||||
|
||||
#### `define `[`HD44780_DISPLAY_BLINK`](#group__hd44780_1gadb288f3996fafc6537c5e413eff39df8) |
||||
|
||||
#### `define `[`HD44780_CMD_MOVE`](#group__hd44780_1gac1f843079f60718d770b34b1d9e080a1) |
||||
|
||||
#### `define `[`HD44780_MOVE_DISPLAY`](#group__hd44780_1ga7f5aead3ce92c0bb8eef4afb6ec03fdc) |
||||
|
||||
#### `define `[`HD44780_MOVE_RIGHT`](#group__hd44780_1ga5b8911c499925d126afd681d19e16985) |
||||
|
||||
#### `define `[`HD44780_CMD_FUNCTION`](#group__hd44780_1ga66e53be765239225f30b35689edcc7f1) |
||||
|
||||
#### `define `[`HD44780_FUNCTION_8_BIT`](#group__hd44780_1gab4760a025661db140bd7df635bbd67e7) |
||||
|
||||
#### `define `[`HD44780_FUNCTION_2_LINES`](#group__hd44780_1ga88dbd8646d5fad0456e4685239404da3) |
||||
|
||||
#### `define `[`HD44780_FUNCTION_5X10_DOTS`](#group__hd44780_1ga66002af4238dd0830e3dbe7780143492) |
||||
|
||||
#### `define `[`HD44780_CMD_SET_CGRAM_ADDRESS`](#group__hd44780_1ga73397fed8f690a6508fb5967a76bcd3f) |
||||
|
||||
#### `define `[`HD44780_CMD_SET_DDRAM_ADDRESS`](#group__hd44780_1ga32d29769e79b9843c284f98a9bc6ad2a) |
||||
|
||||
#### `define `[`HD44780_BUSY_FLAG`](#group__hd44780_1gae22e5ab2bb9069fb265a6ff8ca5d0254) |
||||
|
||||
#### `public void `[`hd44780_write`](#group__hd44780_1ga3a41d7df58b5856c629f8181e93b7c00)`(uint8_t data,bool isData)` |
||||
|
||||
Write a byte to the display. |
||||
|
||||
#### Parameters |
||||
* `data` The byte to send to the display. |
||||
|
||||
* `isData` Whether the byte is an instruction or character data. |
||||
|
||||
#### `public uint8_t `[`hd44780_read`](#group__hd44780_1ga855e31aeb778f32efbd75be995797d1b)`(bool isData)` |
||||
|
||||
Read a byte from the display. |
||||
|
||||
#### Parameters |
||||
* `isData` Whether to read the current cursor position, or the character at the cursor. |
||||
|
||||
#### Returns |
||||
If `isData` is `true`, the returned byte will be the character at the current DDRAM address. Otherwise, it will be the current DDRAM address and the busy flag. |
||||
|
||||
#### `public bool `[`hd44780_busy`](#group__hd44780_1gadcb1634221c116247735e3312637edc1)`(void)` |
||||
|
||||
Indicates whether the display is currently processing, and cannot accept instructions. |
||||
|
||||
#### Returns |
||||
`true` if the display is busy. |
||||
|
||||
#### `public void `[`hd44780_command`](#group__hd44780_1gacd6ba5f8ecc8e6776e6617312b60d28e)`(uint8_t command)` |
||||
|
||||
Send a command to the display. Refer to the datasheet for the valid commands. |
||||
|
||||
This function waits for the display to clear the busy flag before sending the command. |
||||
|
||||
#### Parameters |
||||
* `command` The command to send. |
||||
|
||||
#### `public void `[`hd44780_data`](#group__hd44780_1ga8bc010c20fd8026b0d98bce13066b049)`(uint8_t data)` |
||||
|
||||
Send a byte of data to the display. |
||||
|
||||
This function waits for the display to clear the busy flag before sending the data. |
||||
|
||||
#### Parameters |
||||
* `data` The byte of data to send. |
||||
|
||||
#### `public void `[`hd44780_clear`](#group__hd44780_1gaa358b83b37987e488b8f47d48a896ef8)`(void)` |
||||
|
||||
Clear the display. |
||||
|
||||
This function is called on init. |
||||
|
||||
#### `public void `[`hd44780_home`](#group__hd44780_1gac59e0708629529fee41ae215abd1e954)`(void)` |
||||
|
||||
Move the cursor to the home position. |
||||
|
||||
This function is called on init. |
||||
|
||||
#### `public void `[`hd44780_on`](#group__hd44780_1ga86f7413fd10963734e7d00cc475a8aba)`(bool cursor,bool blink)` |
||||
|
||||
Turn the display on, and/or set the cursor position. |
||||
|
||||
This function is called on init. |
||||
|
||||
#### Parameters |
||||
* `cursor` Whether to show the cursor. |
||||
|
||||
* `blink` Whether to blink the cursor, if shown. |
||||
|
||||
#### `public void `[`hd44780_off`](#group__hd44780_1gaa236bcd35da58b8d3a9c5347358d3560)`(void)` |
||||
|
||||
Turn the display off. |
||||
|
||||
#### `public void `[`hd44780_set_cgram_address`](#group__hd44780_1gacd561522fddf2ec8833325fd10e3a924)`(uint8_t address)` |
||||
|
||||
Set the CGRAM address. |
||||
|
||||
This function is used when defining custom characters. |
||||
|
||||
#### Parameters |
||||
* `address` The CGRAM address to move to, from `0x00` to `0x3F`. |
||||
|
||||
#### `public void `[`hd44780_set_ddram_address`](#group__hd44780_1ga8de3a1df53c6481652683d1a6df31948)`(uint8_t address)` |
||||
|
||||
Set the DDRAM address. |
||||
|
||||
This function is used when printing characters to the display, and setting the cursor. |
||||
|
||||
#### Parameters |
||||
* `address` The DDRAM address to move to, from `0x00` to `0x7F`. |
||||
|
||||
#### `public void `[`hd44780_init`](#group__hd44780_1ga16611b90107639921a68efd503949db8)`(bool cursor,bool blink)` |
||||
|
||||
Initialize the display. |
||||
|
||||
This function should be called only once, before any of the other functions can be called. |
||||
|
||||
#### Parameters |
||||
* `cursor` Whether to show the cursor. |
||||
|
||||
* `blink` Whether to blink the cursor, if shown. |
||||
|
||||
#### `public void `[`hd44780_set_cursor`](#group__hd44780_1ga0144f1c7e1de7745862f991451efa614)`(uint8_t col,uint8_t line)` |
||||
|
||||
Move the cursor to the specified position on the display. |
||||
|
||||
#### Parameters |
||||
* `col` The column number to move to, from 0 to 15 on 16x2 displays. |
||||
|
||||
* `line` The line number to move to, either 0 or 1 on 16x2 displays. |
||||
|
||||
#### `public void `[`hd44780_define_char`](#group__hd44780_1gaa167a2e4398a665658597f328ea08736)`(uint8_t index,uint8_t * data)` |
||||
|
||||
Define a custom character. |
||||
|
||||
#### Parameters |
||||
* `index` The index of the custom character to define, from 0 to 7. |
||||
|
||||
* `data` An array of 8 bytes containing the 5-bit row data of the character, where the first byte is the topmost row, and the least significant bit of each byte is the rightmost column. |
||||
|
||||
#### `public void `[`hd44780_putc`](#group__hd44780_1gaf9578702c16938a2abbb8c6becc9915f)`(char c)` |
||||
|
||||
Print a character to the display. The newline character will move the cursor to the start of the next line. |
||||
|
||||
The exact character shown may depend on the ROM code of your particular display - refer to the datasheet for the full character set. |
||||
|
||||
#### Parameters |
||||
* `c` The character to print. |
||||
|
||||
#### `public void `[`hd44780_puts`](#group__hd44780_1gaefe6076f55a4619cd8279765e125e513)`(const char * s)` |
||||
|
||||
Print a string of characters to the display. |
||||
|
||||
#### Parameters |
||||
* `s` The string to print. |
||||
|
||||
#### `public void `[`hd44780_define_char_P`](#group__hd44780_1ga8d31109c8c7ef295511145c490cdba7d)`(uint8_t index,const uint8_t * data)` |
||||
|
||||
Define a custom character from PROGMEM. |
||||
|
||||
On ARM devices, this function is simply an alias of [hd44780_define_char()](.build/docs/internals/undefined.md#group__hd44780_1gaa167a2e4398a665658597f328ea08736). |
||||
|
||||
#### Parameters |
||||
* `index` The index of the custom character to define, from 0 to 7. |
||||
|
||||
* `data` A PROGMEM array of 8 bytes containing the 5-bit row data of the character, where the first byte is the topmost row, and the least significant bit of each byte is the rightmost column. |
||||
|
||||
#### `public void `[`hd44780_puts_P`](#group__hd44780_1gad999de4c8c443783542aece3c5ffaefc)`(const char * s)` |
||||
|
||||
Print a string of characters from PROGMEM to the display. |
||||
|
||||
On ARM devices, this function is simply an alias of [hd44780_puts()](.build/docs/internals/undefined.md#group__hd44780_1gaefe6076f55a4619cd8279765e125e513). |
||||
|
||||
#### Parameters |
||||
* `s` The PROGMEM string to print. |
||||
|
||||
@ -1,8 +1,8 @@ |
||||
# GPIO 制御 :id=gpio-control |
||||
|
||||
<!--- |
||||
original document: 0.13.15:docs/internals_gpio_control.md |
||||
git diff 0.13.15 HEAD -- docs/internals_gpio_control.md | cat |
||||
original document: 0.13.15:docs/gpio_control.md |
||||
git diff 0.13.15 HEAD -- docs/gpio_control.md | cat |
||||
--> |
||||
|
||||
QMK には、マイクロコントローラに依存しない GPIO 制御抽象レイヤーがあります。これは異なるプラットフォーム間でピン制御に簡単にアクセスできるようにするためのものです。 |
||||
@ -1,78 +0,0 @@ |
||||
# `defines` グループ {#group__defines} |
||||
|
||||
## 概要 |
||||
|
||||
メンバー | 説明 |
||||
--------------------------------|--------------------------------------------- |
||||
`define `[`SYSEX_BEGIN`](#group__defines_1ga1a3c39bb790dda8a368c4247caabcf79) | |
||||
`define `[`SYSEX_END`](#group__defines_1ga753706d1d28e6f96d7caf1973e80feed) | |
||||
`define `[`MIDI_STATUSMASK`](#group__defines_1gab78a1c818a5f5dab7a8946543f126c69) | |
||||
`define `[`MIDI_CHANMASK`](#group__defines_1ga239edc0a6f8405d3a8f2804f1590b909) | |
||||
`define `[`MIDI_CC`](#group__defines_1ga45f116a1daab76b3c930c2cecfaef215) | |
||||
`define `[`MIDI_NOTEON`](#group__defines_1gafd416f27bf3590868c0c1f55c30be4c7) | |
||||
`define `[`MIDI_NOTEOFF`](#group__defines_1gabed24bea2d989fd655e2ef2ad0765adc) | |
||||
`define `[`MIDI_AFTERTOUCH`](#group__defines_1ga3a322d8cfd53576a2e167c1840551b0f) | |
||||
`define `[`MIDI_PITCHBEND`](#group__defines_1gabcc799504e8064679bca03f232223af4) | |
||||
`define `[`MIDI_PROGCHANGE`](#group__defines_1gaefb3f1595ffbb9db66b46c2c919a3d42) | |
||||
`define `[`MIDI_CHANPRESSURE`](#group__defines_1gaeb3281cc7fcd0daade8ed3d2dfc33dbe) | |
||||
`define `[`MIDI_CLOCK`](#group__defines_1gafa5e4e295aafd15ab7893344599b3b89) | |
||||
`define `[`MIDI_TICK`](#group__defines_1ga3b99408ff864613765d4c3c2ceb52aa7) | |
||||
`define `[`MIDI_START`](#group__defines_1ga8233631c85823aa546f932ad8975caa4) | |
||||
`define `[`MIDI_CONTINUE`](#group__defines_1gab24430f0081e27215b0da84dd0ee745c) | |
||||
`define `[`MIDI_STOP`](#group__defines_1ga3af9271d4b1f0d22904a0b055f48cf62) | |
||||
`define `[`MIDI_ACTIVESENSE`](#group__defines_1gacd88ed42dba52bb4b2052c5656362677) | |
||||
`define `[`MIDI_RESET`](#group__defines_1ga02947f30ca62dc332fdeb10c5868323b) | |
||||
`define `[`MIDI_TC_QUARTERFRAME`](#group__defines_1gaaa072f33590e236d1bfd8f28e833ae31) | |
||||
`define `[`MIDI_SONGPOSITION`](#group__defines_1ga412f6ed33a2150051374bee334ee1705) | |
||||
`define `[`MIDI_SONGSELECT`](#group__defines_1gafcab254838b028365ae0259729e72c4e) | |
||||
`define `[`MIDI_TUNEREQUEST`](#group__defines_1ga8100b907b8c0a84e58b1c53dcd9bd795) | |
||||
`define `[`SYSEX_EDUMANUFID`](#group__defines_1ga5ef855ed955b00a2239ca16afbeb164f) | |
||||
|
||||
## メンバー |
||||
|
||||
#### `define `[`SYSEX_BEGIN`](#group__defines_1ga1a3c39bb790dda8a368c4247caabcf79) {#group__defines_1ga1a3c39bb790dda8a368c4247caabcf79} |
||||
|
||||
#### `define `[`SYSEX_END`](#group__defines_1ga753706d1d28e6f96d7caf1973e80feed) {#group__defines_1ga753706d1d28e6f96d7caf1973e80feed} |
||||
|
||||
#### `define `[`MIDI_STATUSMASK`](#group__defines_1gab78a1c818a5f5dab7a8946543f126c69) {#group__defines_1gab78a1c818a5f5dab7a8946543f126c69} |
||||
|
||||
#### `define `[`MIDI_CHANMASK`](#group__defines_1ga239edc0a6f8405d3a8f2804f1590b909) {#group__defines_1ga239edc0a6f8405d3a8f2804f1590b909} |
||||
|
||||
#### `define `[`MIDI_CC`](#group__defines_1ga45f116a1daab76b3c930c2cecfaef215) {#group__defines_1ga45f116a1daab76b3c930c2cecfaef215} |
||||
|
||||
#### `define `[`MIDI_NOTEON`](#group__defines_1gafd416f27bf3590868c0c1f55c30be4c7) {#group__defines_1gafd416f27bf3590868c0c1f55c30be4c7} |
||||
|
||||
#### `define `[`MIDI_NOTEOFF`](#group__defines_1gabed24bea2d989fd655e2ef2ad0765adc) {#group__defines_1gabed24bea2d989fd655e2ef2ad0765adc} |
||||
|
||||
#### `define `[`MIDI_AFTERTOUCH`](#group__defines_1ga3a322d8cfd53576a2e167c1840551b0f) {#group__defines_1ga3a322d8cfd53576a2e167c1840551b0f} |
||||
|
||||
#### `define `[`MIDI_PITCHBEND`](#group__defines_1gabcc799504e8064679bca03f232223af4) {#group__defines_1gabcc799504e8064679bca03f232223af4} |
||||
|
||||
#### `define `[`MIDI_PROGCHANGE`](#group__defines_1gaefb3f1595ffbb9db66b46c2c919a3d42) {#group__defines_1gaefb3f1595ffbb9db66b46c2c919a3d42} |
||||
|
||||
#### `define `[`MIDI_CHANPRESSURE`](#group__defines_1gaeb3281cc7fcd0daade8ed3d2dfc33dbe) {#group__defines_1gaeb3281cc7fcd0daade8ed3d2dfc33dbe} |
||||
|
||||
#### `define `[`MIDI_CLOCK`](#group__defines_1gafa5e4e295aafd15ab7893344599b3b89) {#group__defines_1gafa5e4e295aafd15ab7893344599b3b89} |
||||
|
||||
#### `define `[`MIDI_TICK`](#group__defines_1ga3b99408ff864613765d4c3c2ceb52aa7) {#group__defines_1ga3b99408ff864613765d4c3c2ceb52aa7} |
||||
|
||||
#### `define `[`MIDI_START`](#group__defines_1ga8233631c85823aa546f932ad8975caa4) {#group__defines_1ga8233631c85823aa546f932ad8975caa4} |
||||
|
||||
#### `define `[`MIDI_CONTINUE`](#group__defines_1gab24430f0081e27215b0da84dd0ee745c) {#group__defines_1gab24430f0081e27215b0da84dd0ee745c} |
||||
|
||||
#### `define `[`MIDI_STOP`](#group__defines_1ga3af9271d4b1f0d22904a0b055f48cf62) {#group__defines_1ga3af9271d4b1f0d22904a0b055f48cf62} |
||||
|
||||
#### `define `[`MIDI_ACTIVESENSE`](#group__defines_1gacd88ed42dba52bb4b2052c5656362677) {#group__defines_1gacd88ed42dba52bb4b2052c5656362677} |
||||
|
||||
#### `define `[`MIDI_RESET`](#group__defines_1ga02947f30ca62dc332fdeb10c5868323b) {#group__defines_1ga02947f30ca62dc332fdeb10c5868323b} |
||||
|
||||
#### `define `[`MIDI_TC_QUARTERFRAME`](#group__defines_1gaaa072f33590e236d1bfd8f28e833ae31) {#group__defines_1gaaa072f33590e236d1bfd8f28e833ae31} |
||||
|
||||
#### `define `[`MIDI_SONGPOSITION`](#group__defines_1ga412f6ed33a2150051374bee334ee1705) {#group__defines_1ga412f6ed33a2150051374bee334ee1705} |
||||
|
||||
#### `define `[`MIDI_SONGSELECT`](#group__defines_1gafcab254838b028365ae0259729e72c4e) {#group__defines_1gafcab254838b028365ae0259729e72c4e} |
||||
|
||||
#### `define `[`MIDI_TUNEREQUEST`](#group__defines_1ga8100b907b8c0a84e58b1c53dcd9bd795) {#group__defines_1ga8100b907b8c0a84e58b1c53dcd9bd795} |
||||
|
||||
#### `define `[`SYSEX_EDUMANUFID`](#group__defines_1ga5ef855ed955b00a2239ca16afbeb164f) {#group__defines_1ga5ef855ed955b00a2239ca16afbeb164f} |
||||
|
||||
@ -1,173 +0,0 @@ |
||||
# group `input_callback_reg` {#group__input__callback__reg} |
||||
|
||||
<!--- |
||||
original document: 0.9.34:docs/internals_input_callback_reg.md |
||||
git diff 0.9.34 HEAD -- docs/internals_input_callback_reg.md | cat |
||||
--> |
||||
|
||||
これらは受信コールバックを登録するために使用する関数です。 |
||||
|
||||
関数は、適切な midi メッセージが関連するデバイスの入力と一致した場合に呼び出されます。 |
||||
|
||||
## 概要 |
||||
|
||||
| メンバー | 説明 | |
||||
--------------------------------|--------------------------------------------- |
||||
| `public void `[`midi_register_cc_callback`](#group__input__callback__reg_1ga64ab672abbbe393c9c4a83110c8df718)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` | コントロールチェンジメッセージ受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_noteon_callback`](#group__input__callback__reg_1ga3962f276c17618923f1152779552103e)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` | ノートオン受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_noteoff_callback`](#group__input__callback__reg_1gac847b66051bd6d53b762958be0ec4c6d)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` | ノートオフ受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_aftertouch_callback`](#group__input__callback__reg_1gaa95bc901bd9edff956a667c9a69dd01f)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` | アフタータッチ受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_pitchbend_callback`](#group__input__callback__reg_1ga071a28f02ba14f53de219be70ebd9a48)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` | ピッチベンド受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_songposition_callback`](#group__input__callback__reg_1gaf2adfd79637f3553d8f26deb1ca22ed6)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` | ソングポジション受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_progchange_callback`](#group__input__callback__reg_1gae6ba1a35a4cde9bd15dd42f87401d127)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` | プログラムチェンジ受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_chanpressure_callback`](#group__input__callback__reg_1ga39b31f1f4fb93917ce039b958f21b4f5)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` | チャンネルプレッシャー受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_songselect_callback`](#group__input__callback__reg_1gaf9aafc76a2dc4b9fdbb4106cbda6ce72)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` | ソングセレクト受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_tc_quarterframe_callback`](#group__input__callback__reg_1ga0a119fada2becc628cb15d753b257e6e)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` | タイムコードクォータフレーム受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_realtime_callback`](#group__input__callback__reg_1ga764f440e857b89084b1a07f9da2ff93a)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_one_byte_func_t func)` | リアルタイム受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_tunerequest_callback`](#group__input__callback__reg_1gae40ff3ce20bda79fef87da24b8321cb1)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_one_byte_func_t func)` | チューンリクエスト受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_sysex_callback`](#group__input__callback__reg_1ga63ce9631b025785c1848d0122d4c4c48)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_sysex_func_t func)` | システムエクスクルーシブ受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_fallthrough_callback`](#group__input__callback__reg_1ga7ed189164aa9682862b3181153afbd94)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_var_byte_func_t func)` | フォールスルー受信コールバックを登録する。 | |
||||
| `public void `[`midi_register_catchall_callback`](#group__input__callback__reg_1ga9dbfed568d047a6cd05708f11fe39e99)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_var_byte_func_t func)` | キャッチオール受信コールバックを登録する。 | |
||||
|
||||
## メンバー |
||||
|
||||
#### `public void `[`midi_register_cc_callback`](#group__input__callback__reg_1ga64ab672abbbe393c9c4a83110c8df718)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` {#group__input__callback__reg_1ga64ab672abbbe393c9c4a83110c8df718} |
||||
|
||||
コントロールチェンジメッセージ受信コールバックを登録する。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_noteon_callback`](#group__input__callback__reg_1ga3962f276c17618923f1152779552103e)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` {#group__input__callback__reg_1ga3962f276c17618923f1152779552103e} |
||||
|
||||
ノートオン受信コールバックを登録する。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_noteoff_callback`](#group__input__callback__reg_1gac847b66051bd6d53b762958be0ec4c6d)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` {#group__input__callback__reg_1gac847b66051bd6d53b762958be0ec4c6d} |
||||
|
||||
ノートオフ受信コールバックを登録する。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_aftertouch_callback`](#group__input__callback__reg_1gaa95bc901bd9edff956a667c9a69dd01f)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` {#group__input__callback__reg_1gaa95bc901bd9edff956a667c9a69dd01f} |
||||
|
||||
アフタータッチ受信コールバックを登録する。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_pitchbend_callback`](#group__input__callback__reg_1ga071a28f02ba14f53de219be70ebd9a48)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` {#group__input__callback__reg_1ga071a28f02ba14f53de219be70ebd9a48} |
||||
|
||||
ピッチベンド受信コールバックを登録する。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_songposition_callback`](#group__input__callback__reg_1gaf2adfd79637f3553d8f26deb1ca22ed6)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_three_byte_func_t func)` {#group__input__callback__reg_1gaf2adfd79637f3553d8f26deb1ca22ed6} |
||||
|
||||
ソングポジション受信コールバックを登録する。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_progchange_callback`](#group__input__callback__reg_1gae6ba1a35a4cde9bd15dd42f87401d127)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` {#group__input__callback__reg_1gae6ba1a35a4cde9bd15dd42f87401d127} |
||||
|
||||
プログラムチェンジ受信コールバックを登録する。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_chanpressure_callback`](#group__input__callback__reg_1ga39b31f1f4fb93917ce039b958f21b4f5)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` {#group__input__callback__reg_1ga39b31f1f4fb93917ce039b958f21b4f5} |
||||
|
||||
チャンネルプレッシャー受信コールバックを登録する。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_songselect_callback`](#group__input__callback__reg_1gaf9aafc76a2dc4b9fdbb4106cbda6ce72)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` {#group__input__callback__reg_1gaf9aafc76a2dc4b9fdbb4106cbda6ce72} |
||||
|
||||
ソングセレクト受信コールバックを登録する。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_tc_quarterframe_callback`](#group__input__callback__reg_1ga0a119fada2becc628cb15d753b257e6e)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_two_byte_func_t func)` {#group__input__callback__reg_1ga0a119fada2becc628cb15d753b257e6e} |
||||
|
||||
タイムコードクォータフレーム受信コールバックを登録する。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_realtime_callback`](#group__input__callback__reg_1ga764f440e857b89084b1a07f9da2ff93a)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_one_byte_func_t func)` {#group__input__callback__reg_1ga764f440e857b89084b1a07f9da2ff93a} |
||||
|
||||
リアルタイム受信コールバックを登録する。 |
||||
|
||||
全てのリアルタイムメッセージ型に対してコールバックが呼ばれます。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_tunerequest_callback`](#group__input__callback__reg_1gae40ff3ce20bda79fef87da24b8321cb1)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_one_byte_func_t func)` {#group__input__callback__reg_1gae40ff3ce20bda79fef87da24b8321cb1} |
||||
|
||||
チューンリクエスト受信コールバックを登録する。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_sysex_callback`](#group__input__callback__reg_1ga63ce9631b025785c1848d0122d4c4c48)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_sysex_func_t func)` {#group__input__callback__reg_1ga63ce9631b025785c1848d0122d4c4c48} |
||||
|
||||
システムエクスクルーシブ受信コールバックを登録する。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_fallthrough_callback`](#group__input__callback__reg_1ga7ed189164aa9682862b3181153afbd94)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_var_byte_func_t func)` {#group__input__callback__reg_1ga7ed189164aa9682862b3181153afbd94} |
||||
|
||||
フォールスルー受信コールバックを登録する。 |
||||
|
||||
より具体的なコールバックが見つからない場合にのみ呼ばれます。例えば、ノートオン受信コールバックを登録していないがノートオンメッセージを受け取った場合、フォールスルー受信コールバックが登録されている場合はそれが呼ばれます。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
|
||||
#### `public void `[`midi_register_catchall_callback`](#group__input__callback__reg_1ga9dbfed568d047a6cd05708f11fe39e99)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_var_byte_func_t func)` {#group__input__callback__reg_1ga9dbfed568d047a6cd05708f11fe39e99} |
||||
|
||||
キャッチオール受信コールバックを登録する。 |
||||
|
||||
登録されている場合は、より具体的なコールバックあるいはフォールスルー受信コールバックが登録されている場合でも、一致する全てのメッセージに対してキャッチオール受信コールバックが呼ばれます。 |
||||
|
||||
#### パラメータ |
||||
* `device` 関連するデバイス |
||||
|
||||
* `func` 登録するコールバック関数 |
||||
@ -1,148 +0,0 @@ |
||||
# `midi_device` グループ {#group__midi__device} |
||||
|
||||
<!--- |
||||
original document: 0.10.9:docs/internals_midi_device.md |
||||
git diff 0.10.9 HEAD -- docs/internals_midi_device.md | cat |
||||
--> |
||||
|
||||
独自の MIDI デバイスを実装する時に、関数を使います。 |
||||
|
||||
実際にデバイスを介してバイトを送信するために、送信関数を設定します。このメソッドは、このデバイスで例えば midi_send_cc のような送信関数を呼ぶ時に呼ばれます。 |
||||
|
||||
midi_device_input を使ってデバイスからの入力データを処理し、それをデバイスに関連付けられたコールバックで渡します。 |
||||
|
||||
デバイスのプロセス関数の最初に呼び出される関数が必要な場合、midi_device_set_pre_input_process_func を使います。通常、入力をポーリングして midi_device_input に渡します。 |
||||
|
||||
## 概要 |
||||
|
||||
メンバー | 説明 |
||||
--------------------------------|--------------------------------------------- |
||||
`define `[`MIDI_INPUT_QUEUE_LENGTH`](#group__midi__device_1ga4aaa419caebdca2bbdfc1331e79781a8) | |
||||
`enum `[`input_state_t`](#group__midi__device_1gac203e877d3df4275ceb8e7180a61f621) | |
||||
`public void `[`midi_device_input`](#group__midi__device_1gad8d3db8eb35d9cfa51ef036a0a9d70db)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t cnt,uint8_t * input)` | 入力バイトを処理します。この関数はバイトを解析し、指定されたデバイスに関連する適切なコールバックを呼びます。この関数は、カスタムデバイスを作成していて、MIDI 入力が必要な場合に使います。 |
||||
`public void `[`midi_device_set_send_func`](#group__midi__device_1ga59f5a46bdd4452f186cc73d9e96d4673)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_var_byte_func_t send_func)` | 出力データバイトの送信に使われるコールバック関数を設定します。これは、カスタムデバイスを作成している場合のみ使われます。ロックを気にすることなく様々な MIDI 送信関数を呼び出すことができるように、コールバック関数で割り込みを無効にすることができます。 |
||||
`public void `[`midi_device_set_pre_input_process_func`](#group__midi__device_1ga4de0841b87c04fc23cb56b6451f33b69)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_no_byte_func_t pre_process_func)` | midi_device_process 呼び出しの最初に呼ばれるコールバックを設定します。これは入力データをポーリングし、midi_device_input 関数を介してデータを送信できます。カスタムデバイスを作成している場合のみ、これを使う可能性があります。 |
||||
`struct `[`_midi_device`](docs/api_midi_device.md#struct__midi__device) | この構造体は、MIDI デバイスの入出力関数と処理データを表します。 |
||||
|
||||
## メンバー |
||||
|
||||
#### `define `[`MIDI_INPUT_QUEUE_LENGTH`](#group__midi__device_1ga4aaa419caebdca2bbdfc1331e79781a8) {#group__midi__device_1ga4aaa419caebdca2bbdfc1331e79781a8} |
||||
|
||||
#### `enum `[`input_state_t`](#group__midi__device_1gac203e877d3df4275ceb8e7180a61f621) {#group__midi__device_1gac203e877d3df4275ceb8e7180a61f621} |
||||
|
||||
値 | 説明 |
||||
--------------------------------|--------------------------------------------- |
||||
IDLE | |
||||
ONE_BYTE_MESSAGE | |
||||
TWO_BYTE_MESSAGE | |
||||
THREE_BYTE_MESSAGE | |
||||
SYSEX_MESSAGE | |
||||
|
||||
#### `public void `[`midi_device_input`](#group__midi__device_1gad8d3db8eb35d9cfa51ef036a0a9d70db)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t cnt,uint8_t * input)` {#group__midi__device_1gad8d3db8eb35d9cfa51ef036a0a9d70db} |
||||
|
||||
入力バイトを処理します。この関数はバイトを解析し、指定されたデバイスに関連する適切なコールバックを呼びます。この関数は、カスタムデバイスを作成していて、MIDI 入力が必要な場合に使います。 |
||||
|
||||
#### パラメータ |
||||
* `device` 入力を関連付ける MIDI デバイス |
||||
|
||||
* `cnt` 処理中のバイト数 |
||||
|
||||
* `input` 処理するバイトデータ |
||||
|
||||
#### `public void `[`midi_device_set_send_func`](#group__midi__device_1ga59f5a46bdd4452f186cc73d9e96d4673)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_var_byte_func_t send_func)` {#group__midi__device_1ga59f5a46bdd4452f186cc73d9e96d4673} |
||||
|
||||
出力データバイトの送信に使われるコールバック関数を設定します。これは、カスタムデバイスを作成している場合のみ使われます。ロックを気にすることなく様々な MIDI 送信関数を呼び出すことができるように、コールバック関数で割り込みを無効にすることができます。 |
||||
|
||||
#### パラメータ |
||||
* `device` このコールバックを関連付ける MIDI デバイス |
||||
|
||||
* `send_func` 送信を行うコールバック関数 |
||||
|
||||
#### `public void `[`midi_device_set_pre_input_process_func`](#group__midi__device_1ga4de0841b87c04fc23cb56b6451f33b69)`(`[`MidiDevice`](#struct__midi__device)` * device,midi_no_byte_func_t pre_process_func)` {#group__midi__device_1ga4de0841b87c04fc23cb56b6451f33b69} |
||||
|
||||
midi_device_process 呼び出しの最初に呼ばれるコールバックを設定します。これは入力データをポーリングし、midi_device_input 関数を介してデータを送信できます。カスタムデバイスを作成している場合のみ、これを使う可能性があります。 |
||||
|
||||
#### パラメータ |
||||
* `device` このコールバックを関連付ける MIDI デバイス |
||||
|
||||
* `midi_no_byte_func_t` 実際のコールバック関数 |
||||
|
||||
# `_midi_device` 構造体 {#struct__midi__device} |
||||
|
||||
この構造体は、MIDI デバイスの入出力関数と処理データを表します。 |
||||
|
||||
デバイスは、実際の物理デバイス [シリアルポート、USB ポート]、または仮想デバイスを表すことができます。この構造体を直接変更する必要はありません。 |
||||
|
||||
## 概要 |
||||
|
||||
| メンバー | 説明 |
||||
--------------------------------|--------------------------------------------- |
||||
`public midi_var_byte_func_t `[`send_func`](docs/api_midi_device.md#struct__midi__device_1a25d4c94b4bbccd5b98f1032b469f3ff9) | |
||||
`public midi_three_byte_func_t `[`input_cc_callback`](docs/api_midi_device.md#struct__midi__device_1a6da5236c1bc73877728df92d213a78d1) | |
||||
`public midi_three_byte_func_t `[`input_noteon_callback`](docs/api_midi_device.md#struct__midi__device_1aa10b15cf1a7fb825a5df0d2abbe34a1c) | |
||||
`public midi_three_byte_func_t `[`input_noteoff_callback`](docs/api_midi_device.md#struct__midi__device_1aaf290043078534d3a5a0ea4c840eba84) | |
||||
`public midi_three_byte_func_t `[`input_aftertouch_callback`](docs/api_midi_device.md#struct__midi__device_1acb0b4901c545cec4b28b126f2d8c315f) | |
||||
`public midi_three_byte_func_t `[`input_pitchbend_callback`](docs/api_midi_device.md#struct__midi__device_1a305fea672caeb996f2233bf8cd2bef18) | |
||||
`public midi_three_byte_func_t `[`input_songposition_callback`](docs/api_midi_device.md#struct__midi__device_1a5f3f13638b3fef3fc561ed1bf301d586) | |
||||
`public midi_two_byte_func_t `[`input_progchange_callback`](docs/api_midi_device.md#struct__midi__device_1adaf1da617c9a10a9dcad00ab1959d3da) | |
||||
`public midi_two_byte_func_t `[`input_chanpressure_callback`](docs/api_midi_device.md#struct__midi__device_1ab7ca2925c539915d43974eff604d85f7) | |
||||
`public midi_two_byte_func_t `[`input_songselect_callback`](docs/api_midi_device.md#struct__midi__device_1a89bed8a5a55376120cfc0a62b42f057f) | |
||||
`public midi_two_byte_func_t `[`input_tc_quarterframe_callback`](docs/api_midi_device.md#struct__midi__device_1ad9813e75d22e284f9f65a907d20600f0) | |
||||
`public midi_one_byte_func_t `[`input_realtime_callback`](docs/api_midi_device.md#struct__midi__device_1a9448eba4afb7e43650434748db3777be) | |
||||
`public midi_one_byte_func_t `[`input_tunerequest_callback`](docs/api_midi_device.md#struct__midi__device_1a0cb8fd53e00cf1d4202d4fa04d038e8d) | |
||||
`public midi_sysex_func_t `[`input_sysex_callback`](docs/api_midi_device.md#struct__midi__device_1afff9a0ce641762aaef24c1e6953ec9a2) | |
||||
`public midi_var_byte_func_t `[`input_fallthrough_callback`](docs/api_midi_device.md#struct__midi__device_1abb974ec6d734001b4a0e370f292be503) | |
||||
`public midi_var_byte_func_t `[`input_catchall_callback`](docs/api_midi_device.md#struct__midi__device_1aae0d535129d4fd650edc98eb3f7584f8) | |
||||
`public midi_no_byte_func_t `[`pre_input_process_callback`](docs/api_midi_device.md#struct__midi__device_1aeb0bb8923d66c23d874e177dc4265754) | |
||||
`public uint8_t `[`input_buffer`](docs/api_midi_device.md#struct__midi__device_1a7c5684857d6af4ebc4dc12da27bd6b2a) | |
||||
`public input_state_t `[`input_state`](docs/api_midi_device.md#struct__midi__device_1a69a687d2d1c449ec15a11c07a5722e39) | |
||||
`public uint16_t `[`input_count`](docs/api_midi_device.md#struct__midi__device_1a68dea8e7b6151e89c85c95caa612ee5d) | |
||||
`public uint8_t `[`input_queue_data`](docs/api_midi_device.md#struct__midi__device_1ada41de021135dc423abedcbb30f366ff) | |
||||
`public `[`byteQueue_t`](#structbyte_queue__t)` `[`input_queue`](#struct__midi__device_1a49c8538a8a02193c58e28a56eb695d8f) | |
||||
|
||||
## メンバー |
||||
|
||||
#### `public midi_var_byte_func_t `[`send_func`](docs/api_midi_device.md#struct__midi__device_1a25d4c94b4bbccd5b98f1032b469f3ff9) {#struct__midi__device_1a25d4c94b4bbccd5b98f1032b469f3ff9} |
||||
|
||||
#### `public midi_three_byte_func_t `[`input_cc_callback`](docs/api_midi_device.md#struct__midi__device_1a6da5236c1bc73877728df92d213a78d1) {#struct__midi__device_1a6da5236c1bc73877728df92d213a78d1} |
||||
|
||||
#### `public midi_three_byte_func_t `[`input_noteon_callback`](docs/api_midi_device.md#struct__midi__device_1aa10b15cf1a7fb825a5df0d2abbe34a1c) {#struct__midi__device_1aa10b15cf1a7fb825a5df0d2abbe34a1c} |
||||
|
||||
#### `public midi_three_byte_func_t `[`input_noteoff_callback`](docs/api_midi_device.md#struct__midi__device_1aaf290043078534d3a5a0ea4c840eba84) {#struct__midi__device_1aaf290043078534d3a5a0ea4c840eba84} |
||||
|
||||
#### `public midi_three_byte_func_t `[`input_aftertouch_callback`](docs/api_midi_device.md#struct__midi__device_1acb0b4901c545cec4b28b126f2d8c315f) {#struct__midi__device_1acb0b4901c545cec4b28b126f2d8c315f} |
||||
|
||||
#### `public midi_three_byte_func_t `[`input_pitchbend_callback`](docs/api_midi_device.md#struct__midi__device_1a305fea672caeb996f2233bf8cd2bef18) {#struct__midi__device_1a305fea672caeb996f2233bf8cd2bef18} |
||||
|
||||
#### `public midi_three_byte_func_t `[`input_songposition_callback`](docs/api_midi_device.md#struct__midi__device_1a5f3f13638b3fef3fc561ed1bf301d586) {#struct__midi__device_1a5f3f13638b3fef3fc561ed1bf301d586} |
||||
|
||||
#### `public midi_two_byte_func_t `[`input_progchange_callback`](docs/api_midi_device.md#struct__midi__device_1adaf1da617c9a10a9dcad00ab1959d3da) {#struct__midi__device_1adaf1da617c9a10a9dcad00ab1959d3da} |
||||
|
||||
#### `public midi_two_byte_func_t `[`input_chanpressure_callback`](docs/api_midi_device.md#struct__midi__device_1ab7ca2925c539915d43974eff604d85f7) {#struct__midi__device_1ab7ca2925c539915d43974eff604d85f7} |
||||
|
||||
#### `public midi_two_byte_func_t `[`input_songselect_callback`](docs/api_midi_device.md#struct__midi__device_1a89bed8a5a55376120cfc0a62b42f057f) {#struct__midi__device_1a89bed8a5a55376120cfc0a62b42f057f} |
||||
|
||||
#### `public midi_two_byte_func_t `[`input_tc_quarterframe_callback`](docs/api_midi_device.md#struct__midi__device_1ad9813e75d22e284f9f65a907d20600f0) {#struct__midi__device_1ad9813e75d22e284f9f65a907d20600f0} |
||||
|
||||
#### `public midi_one_byte_func_t `[`input_realtime_callback`](docs/api_midi_device.md#struct__midi__device_1a9448eba4afb7e43650434748db3777be) {#struct__midi__device_1a9448eba4afb7e43650434748db3777be} |
||||
|
||||
#### `public midi_one_byte_func_t `[`input_tunerequest_callback`](docs/api_midi_device.md#struct__midi__device_1a0cb8fd53e00cf1d4202d4fa04d038e8d) {#struct__midi__device_1a0cb8fd53e00cf1d4202d4fa04d038e8d} |
||||
|
||||
#### `public midi_sysex_func_t `[`input_sysex_callback`](docs/api_midi_device.md#struct__midi__device_1afff9a0ce641762aaef24c1e6953ec9a2) {#struct__midi__device_1afff9a0ce641762aaef24c1e6953ec9a2} |
||||
|
||||
#### `public midi_var_byte_func_t `[`input_fallthrough_callback`](docs/api_midi_device.md#struct__midi__device_1abb974ec6d734001b4a0e370f292be503) {#struct__midi__device_1abb974ec6d734001b4a0e370f292be503} |
||||
|
||||
#### `public midi_var_byte_func_t `[`input_catchall_callback`](docs/api_midi_device.md#struct__midi__device_1aae0d535129d4fd650edc98eb3f7584f8) {#struct__midi__device_1aae0d535129d4fd650edc98eb3f7584f8} |
||||
|
||||
#### `public midi_no_byte_func_t `[`pre_input_process_callback`](docs/api_midi_device.md#struct__midi__device_1aeb0bb8923d66c23d874e177dc4265754) {#struct__midi__device_1aeb0bb8923d66c23d874e177dc4265754} |
||||
|
||||
#### `public uint8_t `[`input_buffer`](docs/api_midi_device.md#struct__midi__device_1a7c5684857d6af4ebc4dc12da27bd6b2a) {#struct__midi__device_1a7c5684857d6af4ebc4dc12da27bd6b2a} |
||||
|
||||
#### `public input_state_t `[`input_state`](docs/api_midi_device.md#struct__midi__device_1a69a687d2d1c449ec15a11c07a5722e39) {#struct__midi__device_1a69a687d2d1c449ec15a11c07a5722e39} |
||||
|
||||
#### `public uint16_t `[`input_count`](docs/api_midi_device.md#struct__midi__device_1a68dea8e7b6151e89c85c95caa612ee5d) {#struct__midi__device_1a68dea8e7b6151e89c85c95caa612ee5d} |
||||
|
||||
#### `public uint8_t `[`input_queue_data`](docs/api_midi_device.md#struct__midi__device_1ada41de021135dc423abedcbb30f366ff) {#struct__midi__device_1ada41de021135dc423abedcbb30f366ff} |
||||
|
||||
#### `public `[`byteQueue_t`](#structbyte_queue__t)` `[`input_queue`](#struct__midi__device_1a49c8538a8a02193c58e28a56eb695d8f) {#struct__midi__device_1a49c8538a8a02193c58e28a56eb695d8f} |
||||
|
||||
@ -1,36 +0,0 @@ |
||||
# `midi_device_setup_process` グループ {#group__midi__device__setup__process} |
||||
|
||||
<!--- |
||||
original document: 0.10.9:docs/internals_midi_device_setup_process.md |
||||
git diff 0.10.9 HEAD -- docs/internals_midi_device_setup_process.md | cat |
||||
--> |
||||
|
||||
これらは、デバイスを初期化して実行するために使う必要があるメソッドです。 |
||||
|
||||
## 概要 |
||||
|
||||
メンバー | 説明 |
||||
--------------------------------|--------------------------------------------- |
||||
`public void `[`midi_device_init`](#group__midi__device__setup__process_1gaf29deddc94ea98a59daa0bde1aefd9d9)`(`[`MidiDevice`](#struct__midi__device)` * device)` | デバイスを初期化します。 |
||||
`public void `[`midi_device_process`](#group__midi__device__setup__process_1gaa3d5993d0e998a1b59bbf5ab9c7b492b)`(`[`MidiDevice`](#struct__midi__device)` * device)` | 入力データを処理します。 |
||||
|
||||
## メンバー |
||||
|
||||
#### `public void `[`midi_device_init`](#group__midi__device__setup__process_1gaf29deddc94ea98a59daa0bde1aefd9d9)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__midi__device__setup__process_1gaf29deddc94ea98a59daa0bde1aefd9d9} |
||||
|
||||
デバイスを初期化します。 |
||||
|
||||
問題のデバイスを使う前にこれを呼び出す必要があります。 |
||||
|
||||
#### パラメータ |
||||
* `device` 初期化するデバイス |
||||
|
||||
#### `public void `[`midi_device_process`](#group__midi__device__setup__process_1gaa3d5993d0e998a1b59bbf5ab9c7b492b)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__midi__device__setup__process_1gaa3d5993d0e998a1b59bbf5ab9c7b492b} |
||||
|
||||
入力データを処理します。 |
||||
|
||||
このメソッドは入力処理を駆動します。入力コールバックが呼び出されることが予想される場合は、このメソッドを頻繁に呼び出す必要があります。 |
||||
|
||||
#### パラメータ |
||||
* `device` 処理するデバイス |
||||
|
||||
@ -1,59 +0,0 @@ |
||||
# `midi_util` グループ {#group__midi__util} |
||||
|
||||
<!--- |
||||
original document: 0.10.9:docs/internals_midi_util.md |
||||
git diff 0.10.9 HEAD -- docs/internals_midi_util.md | cat |
||||
--> |
||||
|
||||
## 概要 |
||||
|
||||
| メンバー | 説明 |
||||
--------------------------------|--------------------------------------------- |
||||
| `enum `[`midi_packet_length_t`](#group__midi__util_1gae29ff56aee2b430ffe53933b97e5e79e) | 可能なパケット長の値の列挙型。 |
||||
| `public bool `[`midi_is_statusbyte`](#group__midi__util_1ga12e3b42ff9cbb4b4f2bc455fc8743ee5)`(uint8_t theByte)` | 指定されたバイトがステータスバイトであるかどうかを検査します。 |
||||
| `public bool `[`midi_is_realtime`](#group__midi__util_1gad2f52c363e34a8000d80c983c324e2d7)`(uint8_t theByte)` | 指定されたバイトがリアルタイムメッセージであるかどうかを検査します。 |
||||
| `public `[`midi_packet_length_t`](#group__midi__util_1gae29ff56aee2b430ffe53933b97e5e79e)` `[`midi_packet_length`](#group__midi__util_1gaa168b43af6ae9de0debce1625e4b8175)`(uint8_t status)` | 指定されたステータスバイトに関連付けられたパケットの長さを調べます。 |
||||
|
||||
## メンバー |
||||
|
||||
#### `enum `[`midi_packet_length_t`](#group__midi__util_1gae29ff56aee2b430ffe53933b97e5e79e) {#group__midi__util_1gae29ff56aee2b430ffe53933b97e5e79e} |
||||
|
||||
| 値 | 説明 |
||||
--------------------------------|--------------------------------------------- |
||||
UNDEFINED | |
||||
ONE | |
||||
TWO | |
||||
THREE | |
||||
|
||||
可能なパケット長の値の列挙型。 |
||||
|
||||
#### `public bool `[`midi_is_statusbyte`](#group__midi__util_1ga12e3b42ff9cbb4b4f2bc455fc8743ee5)`(uint8_t theByte)` {#group__midi__util_1ga12e3b42ff9cbb4b4f2bc455fc8743ee5} |
||||
|
||||
指定されたバイトがステータスバイトであるかどうかを検査します。 |
||||
|
||||
#### パラメータ |
||||
* `theByte` 検査するバイト |
||||
|
||||
#### 返り値 |
||||
指定されたバイトが MIDI ステータスバイトの場合は true |
||||
|
||||
#### `public bool `[`midi_is_realtime`](#group__midi__util_1gad2f52c363e34a8000d80c983c324e2d7)`(uint8_t theByte)` {#group__midi__util_1gad2f52c363e34a8000d80c983c324e2d7} |
||||
|
||||
指定されたバイトがリアルタイムメッセージであるかどうかを検査します。 |
||||
|
||||
#### パラメータ |
||||
* `theByte` 検査するバイト |
||||
|
||||
#### 返り値 |
||||
リアルタイムメッセージの場合は true、それ以外の場合は false |
||||
|
||||
#### `public `[`midi_packet_length_t`](#group__midi__util_1gae29ff56aee2b430ffe53933b97e5e79e)` `[`midi_packet_length`](#group__midi__util_1gaa168b43af6ae9de0debce1625e4b8175)`(uint8_t status)` {#group__midi__util_1gaa168b43af6ae9de0debce1625e4b8175} |
||||
|
||||
指定されたステータスバイトに関連付けられたパケットの長さを調べます。 |
||||
|
||||
#### パラメータ |
||||
* `status` ステータスバイト |
||||
|
||||
#### 返り値 |
||||
パケットの長さ。バイトがステータスバイトではない場合、あるいは sysex ステータスバイトの場合は、UNDEFINED を返します。 |
||||
|
||||
@ -1,246 +0,0 @@ |
||||
# `send_functions` グループ {#group__send__functions} |
||||
|
||||
<!--- |
||||
original document: 0.10.9:docs/internals_send_functions.md |
||||
git diff 0.10.9 HEAD -- docs/internals_send_functions.md | cat |
||||
--> |
||||
|
||||
これらは、デバイスを介して MIDI データを送信するために使う関数です。 |
||||
|
||||
## 概要 |
||||
|
||||
メンバー | 説明 |
||||
--------------------------------|--------------------------------------------- |
||||
`public void `[`midi_send_cc`](#group__send__functions_1gaaf884811c92df405ca8fe1a00082f960)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,uint8_t num,uint8_t val)` | 指定されたデバイスを介して、コントロールチェンジメッセージを送信します。 |
||||
`public void `[`midi_send_noteon`](#group__send__functions_1ga467bcf46dbf03ec269ce565b46bc2775)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,uint8_t num,uint8_t vel)` | 指定されたデバイスを介してノートオンメッセージを送信します。 |
||||
`public void `[`midi_send_noteoff`](#group__send__functions_1gaedb7d8805425eef5d47d57ddcb4c7a49)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,uint8_t num,uint8_t vel)` | 指定されたデバイスを介してノートオフメッセージを送信します。 |
||||
`public void `[`midi_send_aftertouch`](#group__send__functions_1ga0014847571317a0e34b2ef46a6bc584f)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,uint8_t note_num,uint8_t amt)` | 指定されたデバイスを介してアフタータッチメッセージを送信します。 |
||||
`public void `[`midi_send_pitchbend`](#group__send__functions_1gae5a4a1e71611e7534be80af9ce3d3491)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,int16_t amt)` | 指定されたデバイスを介してピッチベンドメッセージを送信します。 |
||||
`public void `[`midi_send_programchange`](#group__send__functions_1ga7b15588ef25e5e1ff09c2afc3151ce86)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,uint8_t num)` | 指定されたデバイスを介してプログラムチェンジメッセージを送信します。 |
||||
`public void `[`midi_send_channelpressure`](#group__send__functions_1gaf23e69fdf812e89c0036f51f88ab2e1b)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,uint8_t amt)` | 指定されたデバイスを介してチャンネルプレッシャーメッセージを送信します。 |
||||
`public void `[`midi_send_clock`](#group__send__functions_1ga4e1b11a7cdb0875f6e03ce7c79c581aa)`(`[`MidiDevice`](#struct__midi__device)` * device)` | 指定されたデバイスを介してクロックメッセージを送信します。 |
||||
`public void `[`midi_send_tick`](#group__send__functions_1ga2b43c7d433d940c5b907595aac947972)`(`[`MidiDevice`](#struct__midi__device)` * device)` | 指定されたデバイスを介してティックメッセージを送信します。 |
||||
`public void `[`midi_send_start`](#group__send__functions_1ga1569749a8d58ccc56789289d7c7245cc)`(`[`MidiDevice`](#struct__midi__device)` * device)` | 指定されたデバイスを介してスタートメッセージを送信します。 |
||||
`public void `[`midi_send_continue`](#group__send__functions_1gaed5dc29d754a27372e89ab8bc20ee120)`(`[`MidiDevice`](#struct__midi__device)` * device)` | 指定されたデバイスを介してコンティニューメッセージを送信します。 |
||||
`public void `[`midi_send_stop`](#group__send__functions_1ga026e1a620276cb653ac501aa0d12a988)`(`[`MidiDevice`](#struct__midi__device)` * device)` | 指定されたデバイスを介してストップメッセージを送信します。 |
||||
`public void `[`midi_send_activesense`](#group__send__functions_1ga9b6e4c6ce4719d2604187b325620db37)`(`[`MidiDevice`](#struct__midi__device)` * device)` | 指定されたデバイスを介してアクティブセンスメッセージを送信します。 |
||||
`public void `[`midi_send_reset`](#group__send__functions_1ga3671e39a6d93ca9568fc493001af1b1b)`(`[`MidiDevice`](#struct__midi__device)` * device)` | 指定されたデバイスを介してリセットメッセージを送信します。 |
||||
`public void `[`midi_send_tcquarterframe`](#group__send__functions_1ga5b85639910eec280bb744c934d0fd45a)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t time)` | 指定されたデバイスを介してタイムコードクォータフレームメッセージを送信します。 |
||||
`public void `[`midi_send_songposition`](#group__send__functions_1gab1c9eeef3b57a8cd2e6128d18e85eb7f)`(`[`MidiDevice`](#struct__midi__device)` * device,uint16_t pos)` | 指定されたデバイスを介してソングポジションメッセージを送信します。 |
||||
`public void `[`midi_send_songselect`](#group__send__functions_1ga42de7838ba70d949af9a50f9facc3c50)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t song)` | 指定されたデバイスを介してソングセレクトメッセージを送信します。 |
||||
`public void `[`midi_send_tunerequest`](#group__send__functions_1ga8db6c7e04d48e4d2266dd59118ca0656)`(`[`MidiDevice`](#struct__midi__device)` * device)` | 指定されたデバイスを介してチューンリクエストメッセージを送信します。 |
||||
`public void `[`midi_send_byte`](#group__send__functions_1ga857e85eb90b288385642d4d991e09881)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t b)` | 指定されたデバイスを介してバイトを送信します。 |
||||
`public void `[`midi_send_data`](#group__send__functions_1ga36e2f2e45369d911b76969361679054b)`(`[`MidiDevice`](#struct__midi__device)` * device,uint16_t count,uint8_t byte0,uint8_t byte1,uint8_t byte2)` | 最大3バイトのデータを送信します。 |
||||
`public void `[`midi_send_array`](#group__send__functions_1ga245243cb1da18d2cea18d4b18d846ead)`(`[`MidiDevice`](#struct__midi__device)` * device,uint16_t count,uint8_t * array)` | フォーマットされた MIDI データの配列を送信します。 |
||||
|
||||
## メンバー |
||||
|
||||
#### `public void `[`midi_send_cc`](#group__send__functions_1gaaf884811c92df405ca8fe1a00082f960)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,uint8_t num,uint8_t val)` {#group__send__functions_1gaaf884811c92df405ca8fe1a00082f960} |
||||
|
||||
指定されたデバイスを介して、コントロールチェンジメッセージ(cc)を送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `chan` 送信するチャンネル、0-15 |
||||
|
||||
* `num` コントロールチェンジナンバー |
||||
|
||||
* `val` コントロールチェンジナンバーの値 |
||||
|
||||
#### `public void `[`midi_send_noteon`](#group__send__functions_1ga467bcf46dbf03ec269ce565b46bc2775)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,uint8_t num,uint8_t vel)` {#group__send__functions_1ga467bcf46dbf03ec269ce565b46bc2775} |
||||
|
||||
指定されたデバイスを介してノートオンメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `chan` 送信するチャンネル、0-15 |
||||
|
||||
* `num` ノート番号 |
||||
|
||||
* `vel` ノートベロシティ |
||||
|
||||
#### `public void `[`midi_send_noteoff`](#group__send__functions_1gaedb7d8805425eef5d47d57ddcb4c7a49)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,uint8_t num,uint8_t vel)` {#group__send__functions_1gaedb7d8805425eef5d47d57ddcb4c7a49} |
||||
|
||||
指定されたデバイスを介してノートオフメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `chan` 送信するチャンネル、0-15 |
||||
|
||||
* `num` ノート番号 |
||||
|
||||
* `vel` ノートベロシティ |
||||
|
||||
#### `public void `[`midi_send_aftertouch`](#group__send__functions_1ga0014847571317a0e34b2ef46a6bc584f)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,uint8_t note_num,uint8_t amt)` {#group__send__functions_1ga0014847571317a0e34b2ef46a6bc584f} |
||||
|
||||
指定されたデバイスを介してアフタータッチメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `chan` 送信するチャンネル、0-15 |
||||
|
||||
* `note_num` ノート番号 |
||||
|
||||
* `amt` アフタータッチ量 |
||||
|
||||
#### `public void `[`midi_send_pitchbend`](#group__send__functions_1gae5a4a1e71611e7534be80af9ce3d3491)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,int16_t amt)` {#group__send__functions_1gae5a4a1e71611e7534be80af9ce3d3491} |
||||
|
||||
指定されたデバイスを介してピッチベンドメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `chan` 送信するチャンネル、0-15 |
||||
|
||||
* `amt` ベンド量の範囲: -8192..8191、0 はベンドしないことを意味します |
||||
|
||||
#### `public void `[`midi_send_programchange`](#group__send__functions_1ga7b15588ef25e5e1ff09c2afc3151ce86)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,uint8_t num)` {#group__send__functions_1ga7b15588ef25e5e1ff09c2afc3151ce86} |
||||
|
||||
指定されたデバイスを介してプログラムチェンジメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `chan` 送信するチャンネル、0-15 |
||||
|
||||
* `num` 変更先のプログラム |
||||
|
||||
#### `public void `[`midi_send_channelpressure`](#group__send__functions_1gaf23e69fdf812e89c0036f51f88ab2e1b)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t chan,uint8_t amt)` {#group__send__functions_1gaf23e69fdf812e89c0036f51f88ab2e1b} |
||||
|
||||
指定されたデバイスを介してチャンネルプレッシャーメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `chan` 送信するチャンネル、0-15 |
||||
|
||||
* `amt` チャンネルプレッシャーの量 |
||||
|
||||
#### `public void `[`midi_send_clock`](#group__send__functions_1ga4e1b11a7cdb0875f6e03ce7c79c581aa)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__send__functions_1ga4e1b11a7cdb0875f6e03ce7c79c581aa} |
||||
|
||||
指定されたデバイスを介してクロックメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
#### `public void `[`midi_send_tick`](#group__send__functions_1ga2b43c7d433d940c5b907595aac947972)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__send__functions_1ga2b43c7d433d940c5b907595aac947972} |
||||
|
||||
指定されたデバイスを介してティックメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
#### `public void `[`midi_send_start`](#group__send__functions_1ga1569749a8d58ccc56789289d7c7245cc)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__send__functions_1ga1569749a8d58ccc56789289d7c7245cc} |
||||
|
||||
指定されたデバイスを介してスタートメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
#### `public void `[`midi_send_continue`](#group__send__functions_1gaed5dc29d754a27372e89ab8bc20ee120)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__send__functions_1gaed5dc29d754a27372e89ab8bc20ee120} |
||||
|
||||
指定されたデバイスを介してコンティニューメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
#### `public void `[`midi_send_stop`](#group__send__functions_1ga026e1a620276cb653ac501aa0d12a988)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__send__functions_1ga026e1a620276cb653ac501aa0d12a988} |
||||
|
||||
指定されたデバイスを介してストップメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
#### `public void `[`midi_send_activesense`](#group__send__functions_1ga9b6e4c6ce4719d2604187b325620db37)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__send__functions_1ga9b6e4c6ce4719d2604187b325620db37} |
||||
|
||||
指定されたデバイスを介してアクティブセンスメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
#### `public void `[`midi_send_reset`](#group__send__functions_1ga3671e39a6d93ca9568fc493001af1b1b)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__send__functions_1ga3671e39a6d93ca9568fc493001af1b1b} |
||||
|
||||
指定されたデバイスを介してリセットメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
#### `public void `[`midi_send_tcquarterframe`](#group__send__functions_1ga5b85639910eec280bb744c934d0fd45a)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t time)` {#group__send__functions_1ga5b85639910eec280bb744c934d0fd45a} |
||||
|
||||
指定されたデバイスを介してタイムコードクォータフレームメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `time` このクォータフレームの時間。範囲は、0..16383 |
||||
|
||||
#### `public void `[`midi_send_songposition`](#group__send__functions_1gab1c9eeef3b57a8cd2e6128d18e85eb7f)`(`[`MidiDevice`](#struct__midi__device)` * device,uint16_t pos)` {#group__send__functions_1gab1c9eeef3b57a8cd2e6128d18e85eb7f} |
||||
|
||||
指定されたデバイスを介してソングポジションメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `pos` ソングポジション |
||||
|
||||
#### `public void `[`midi_send_songselect`](#group__send__functions_1ga42de7838ba70d949af9a50f9facc3c50)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t song)` {#group__send__functions_1ga42de7838ba70d949af9a50f9facc3c50} |
||||
|
||||
指定されたデバイスを介してソングセレクトメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `song` 選択するソング |
||||
|
||||
#### `public void `[`midi_send_tunerequest`](#group__send__functions_1ga8db6c7e04d48e4d2266dd59118ca0656)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__send__functions_1ga8db6c7e04d48e4d2266dd59118ca0656} |
||||
|
||||
指定されたデバイスを介してチューンリクエストメッセージを送信します。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
#### `public void `[`midi_send_byte`](#group__send__functions_1ga857e85eb90b288385642d4d991e09881)`(`[`MidiDevice`](#struct__midi__device)` * device,uint8_t b)` {#group__send__functions_1ga857e85eb90b288385642d4d991e09881} |
||||
|
||||
指定されたデバイスを介してバイトを送信します。 |
||||
|
||||
これは、指定された MIDI デバイスを介してデータを送信する一般的なメソッドです。これは、この API に実装されていない sysex データまたはメッセージがある場合、それらを送信するのに役立ちます。そのようなものを見つけた場合は、私たちがそれらを追加できるように、作者に連絡してください。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `b` 送信するバイト |
||||
|
||||
#### `public void `[`midi_send_data`](#group__send__functions_1ga36e2f2e45369d911b76969361679054b)`(`[`MidiDevice`](#struct__midi__device)` * device,uint16_t count,uint8_t byte0,uint8_t byte1,uint8_t byte2)` {#group__send__functions_1ga36e2f2e45369d911b76969361679054b} |
||||
|
||||
最大3バイトのデータを送信します。 |
||||
|
||||
これを使って sysex を通過できるように count に4の剰余が適用されます。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `count` 送信するバイト数、4の剰余が適用されます |
||||
|
||||
* `byte0` 最初のバイト |
||||
|
||||
* `byte1` 2番目のバイト。cnt % 4 != 2 の場合は無視されます |
||||
|
||||
* `byte2` 3番目のバイト。cnt % 4 != 3 の場合は無視されます |
||||
|
||||
#### `public void `[`midi_send_array`](#group__send__functions_1ga245243cb1da18d2cea18d4b18d846ead)`(`[`MidiDevice`](#struct__midi__device)` * device,uint16_t count,uint8_t * array)` {#group__send__functions_1ga245243cb1da18d2cea18d4b18d846ead} |
||||
|
||||
フォーマットされた MIDI データの配列を送信します。 |
||||
|
||||
sysex に使うことができます。 |
||||
|
||||
#### パラメータ |
||||
* `device` 送信に使うデバイス |
||||
|
||||
* `count` 送信するバイト数 |
||||
|
||||
* `array` バイトの配列 |
||||
|
||||
@ -1,66 +0,0 @@ |
||||
# `sysex_tools` グループ {#group__sysex__tools} |
||||
|
||||
<!--- |
||||
original document: 0.10.9:docs/internals_sysex_tools.md |
||||
git diff 0.10.9 HEAD -- docs/internals_sysex_tools.md | cat |
||||
--> |
||||
|
||||
## 概要 |
||||
|
||||
| メンバー | 説明 |
||||
--------------------------------|--------------------------------------------- |
||||
| `public uint16_t `[`sysex_encoded_length`](#group__sysex__tools_1ga061e5607030412d6e62e2390d8013f0a)`(uint16_t decoded_length)` | エンコード後のメッセージの長さを計算します。 |
||||
| `public uint16_t `[`sysex_decoded_length`](#group__sysex__tools_1ga121fc227d3acc1c0ea08c9a5c26fa3b0)`(uint16_t encoded_length)` | デコード後のメッセージの長さを計算します。 |
||||
| `public uint16_t `[`sysex_encode`](#group__sysex__tools_1ga54d77f8d32f92a6f329daefa2b314742)`(uint8_t * encoded,const uint8_t * source,uint16_t length)` | sysex メッセージで安全に送信できるようにデータをエンコードします。 |
||||
| `public uint16_t `[`sysex_decode`](#group__sysex__tools_1gaaad1d9ba2d5eca709a0ab4ba40662229)`(uint8_t * decoded,const uint8_t * source,uint16_t length)` | エンコードされたデータをデコードします。 |
||||
|
||||
## メンバー |
||||
|
||||
#### `public uint16_t `[`sysex_encoded_length`](#group__sysex__tools_1ga061e5607030412d6e62e2390d8013f0a)`(uint16_t decoded_length)` {#group__sysex__tools_1ga061e5607030412d6e62e2390d8013f0a} |
||||
|
||||
エンコード後のメッセージの長さを計算します。 |
||||
|
||||
#### パラメータ |
||||
* `decoded_length` エンコードするメッセージの長さのバイト数。 |
||||
|
||||
#### 返り値 |
||||
エンコード後のメッセージの長さのバイト数。 |
||||
|
||||
#### `public uint16_t `[`sysex_decoded_length`](#group__sysex__tools_1ga121fc227d3acc1c0ea08c9a5c26fa3b0)`(uint16_t encoded_length)` {#group__sysex__tools_1ga121fc227d3acc1c0ea08c9a5c26fa3b0} |
||||
|
||||
デコード後のメッセージの長さを計算します。 |
||||
|
||||
#### パラメータ |
||||
* `encoded_length` エンコードされたメッセージの長さのバイト数。 |
||||
|
||||
#### 返り値 |
||||
デコードされた後のメッセージの長さのバイト数。 |
||||
|
||||
#### `public uint16_t `[`sysex_encode`](#group__sysex__tools_1ga54d77f8d32f92a6f329daefa2b314742)`(uint8_t * encoded,const uint8_t * source,uint16_t length)` {#group__sysex__tools_1ga54d77f8d32f92a6f329daefa2b314742} |
||||
|
||||
sysex メッセージで安全に送信できるようにデータをエンコードします。 |
||||
|
||||
#### パラメータ |
||||
* `encoded` 出力データバッファは、少なくとも sysex_encoded_length(length) バイトの長さが必要です。 |
||||
|
||||
* `source` エンコードされるデータの入力バッファ。 |
||||
|
||||
* `length` 入力バッファからエンコードするバイト数。 |
||||
|
||||
#### 返り値 |
||||
エンコードされたバイト数。 |
||||
|
||||
#### `public uint16_t `[`sysex_decode`](#group__sysex__tools_1gaaad1d9ba2d5eca709a0ab4ba40662229)`(uint8_t * decoded,const uint8_t * source,uint16_t length)` {#group__sysex__tools_1gaaad1d9ba2d5eca709a0ab4ba40662229} |
||||
|
||||
エンコードされたデータをデコードします。 |
||||
|
||||
#### パラメータ |
||||
* `decoded` 出力データバッファは、少なくとも sysex_decoded_length(length) バイトの長さが必要です。 |
||||
|
||||
* `source` デコードされるデータの入力バッファ。 |
||||
|
||||
* `length` 入力バッファからデコードするバイト数。 |
||||
|
||||
#### 返り値 |
||||
デコードされたバイト数。 |
||||
|
||||
@ -0,0 +1,705 @@ |
||||
# Quantum Painter :id=quantum-painter |
||||
|
||||
Quantum Painter is the standardised API for graphical displays. It currently includes support for basic drawing primitives, as well as custom images, animations, and fonts. |
||||
|
||||
Due to the complexity, there is no support for Quantum Painter on AVR-based boards. |
||||
|
||||
To enable overall Quantum Painter to be built into your firmware, add the following to `rules.mk`: |
||||
|
||||
```make |
||||
QUANTUM_PAINTER_ENABLE = yes |
||||
QUANTUM_PAINTER_DRIVERS = ...... |
||||
``` |
||||
|
||||
You will also likely need to select an appropriate driver in `rules.mk`, which is listed below. |
||||
|
||||
!> Quantum Painter is not currently integrated with system-level operations such as disabling displays after a configurable timeout, or when the keyboard goes into suspend. Users will need to handle this manually at the current time. |
||||
|
||||
The QMK CLI can be used to convert from normal images such as PNG files or animated GIFs, as well as fonts from TTF files. |
||||
|
||||
Hardware supported: |
||||
|
||||
| Display Panel | Panel Type | Size | Comms Transport | Driver | |
||||
|---------------|--------------------|------------------|-----------------|-----------------------------------------| |
||||
| GC9A01 | RGB LCD (circular) | 240x240 | SPI + D/C + RST | `QUANTUM_PAINTER_DRIVERS = gc9a01_spi` | |
||||
| ILI9163 | RGB LCD | 128x128 | SPI + D/C + RST | `QUANTUM_PAINTER_DRIVERS = ili9163_spi` | |
||||
| ILI9341 | RGB LCD | 240x320 | SPI + D/C + RST | `QUANTUM_PAINTER_DRIVERS = ili9341_spi` | |
||||
| SSD1351 | RGB OLED | 128x128 | SPI + D/C + RST | `QUANTUM_PAINTER_DRIVERS = ssd1351_spi` | |
||||
| ST7789 | RGB LCD | 240x320, 240x240 | SPI + D/C + RST | `QUANTUM_PAINTER_DRIVERS = st7789_spi` | |
||||
|
||||
## Quantum Painter Configuration :id=quantum-painter-config |
||||
|
||||
| Option | Default | Purpose | |
||||
|-----------------------------------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------| |
||||
| `QUANTUM_PAINTER_NUM_IMAGES` | `8` | The maximum number of images/animations that can be loaded at any one time. | |
||||
| `QUANTUM_PAINTER_NUM_FONTS` | `4` | The maximum number of fonts that can be loaded at any one time. | |
||||
| `QUANTUM_PAINTER_CONCURRENT_ANIMATIONS` | `4` | The maximum number of animations that can be executed at the same time. | |
||||
| `QUANTUM_PAINTER_LOAD_FONTS_TO_RAM` | `FALSE` | Whether or not fonts should be loaded to RAM. Relevant for fonts stored in off-chip persistent storage, such as external flash. | |
||||
| `QUANTUM_PAINTER_PIXDATA_BUFFER_SIZE` | `32` | The limit of the amount of pixel data that can be transmitted in one transaction to the display. Higher values require more RAM on the MCU. | |
||||
| `QUANTUM_PAINTER_SUPPORTS_256_PALETTE` | `FALSE` | If 256-color palettes are supported. Requires significantly more RAM on the MCU. | |
||||
| `QUANTUM_PAINTER_DEBUG` | _unset_ | Prints out significant amounts of debugging information to CONSOLE output. Significant performance degradation, use only for debugging. | |
||||
|
||||
Drivers have their own set of configurable options, and are described in their respective sections. |
||||
|
||||
## Quantum Painter CLI Commands :id=quantum-painter-cli |
||||
|
||||
### `qmk painter-convert-graphics` |
||||
|
||||
This command converts images to a format usable by QMK, i.e. the QGF File Format. |
||||
|
||||
**Usage**: |
||||
|
||||
``` |
||||
usage: qmk painter-convert-graphics [-h] [-d] [-r] -f FORMAT [-o OUTPUT] -i INPUT [-v] |
||||
|
||||
optional arguments: |
||||
-h, --help show this help message and exit |
||||
-d, --no-deltas Disables the use of delta frames when encoding animations. |
||||
-r, --no-rle Disables the use of RLE when encoding images. |
||||
-f FORMAT, --format FORMAT |
||||
Output format, valid types: pal256, pal16, pal4, pal2, mono256, mono16, mono4, mono2 |
||||
-o OUTPUT, --output OUTPUT |
||||
Specify output directory. Defaults to same directory as input. |
||||
-i INPUT, --input INPUT |
||||
Specify input graphic file. |
||||
-v, --verbose Turns on verbose output. |
||||
``` |
||||
|
||||
The `INPUT` argument can be any image file loadable by Python's Pillow module. Common formats include PNG, or Animated GIF. |
||||
|
||||
The `OUTPUT` argument needs to be a directory, and will default to the same directory as the input argument. |
||||
|
||||
The `FORMAT` argument can be any of the following: |
||||
|
||||
| Format | Meaning | |
||||
|-----------|-----------------------------------------------------------------------| |
||||
| `pal256` | 256-color palette (requires `QUANTUM_PAINTER_SUPPORTS_256_PALETTE`) | |
||||
| `pal16` | 16-color palette | |
||||
| `pal4` | 4-color palette | |
||||
| `pal2` | 2-color palette | |
||||
| `mono256` | 256-shade grayscale (requires `QUANTUM_PAINTER_SUPPORTS_256_PALETTE`) | |
||||
| `mono16` | 16-shade grayscale | |
||||
| `mono4` | 4-shade grayscale | |
||||
| `mono2` | 2-shade grayscale | |
||||
|
||||
**Examples**: |
||||
|
||||
``` |
||||
$ cd /home/qmk/qmk_firmware/keyboards/my_keeb |
||||
$ qmk painter-convert-graphics -f mono16 -i my_image.gif -o ./generated/ |
||||
Writing /home/qmk/qmk_firmware/keyboards/my_keeb/generated/my_image.qgf.h... |
||||
Writing /home/qmk/qmk_firmware/keyboards/my_keeb/generated/my_image.qgf.c... |
||||
``` |
||||
|
||||
### `qmk painter-make-font-image` |
||||
|
||||
This command converts a TTF font to an intermediate format for editing, before converting to the QFF File Format. |
||||
|
||||
**Usage**: |
||||
|
||||
``` |
||||
usage: qmk painter-make-font-image [-h] [-a] [-u UNICODE_GLYPHS] [-n] [-s SIZE] -o OUTPUT -f FONT |
||||
|
||||
optional arguments: |
||||
-h, --help show this help message and exit |
||||
-a, --no-aa Disable anti-aliasing on fonts. |
||||
-u UNICODE_GLYPHS, --unicode-glyphs UNICODE_GLYPHS |
||||
Also generate the specified unicode glyphs. |
||||
-n, --no-ascii Disables output of the full ASCII character set (0x20..0x7E), exporting only the glyphs specified. |
||||
-s SIZE, --size SIZE Specify font size. Default 12. |
||||
-o OUTPUT, --output OUTPUT |
||||
Specify output image path. |
||||
-f FONT, --font FONT Specify input font file. |
||||
``` |
||||
|
||||
The `FONT` argument is generally a TrueType Font file (TTF). |
||||
|
||||
The `OUTPUT` argument is the output image to generate, generally something like `my_font.png`. |
||||
|
||||
The `UNICODE_GLYPHS` argument allows for specifying extra unicode glyphs to generate, and accepts a string. |
||||
|
||||
**Examples**: |
||||
|
||||
``` |
||||
$ qmk painter-make-font-image --font NotoSans-ExtraCondensedBold.ttf --size 11 -o noto11.png --unicode-glyphs "ĄȽɂɻɣɈʣ" |
||||
``` |
||||
|
||||
### `qmk painter-convert-font-image` |
||||
|
||||
This command converts an intermediate font image to the QFF File Format. |
||||
|
||||
This command expects an image that conforms to the following format: |
||||
|
||||
* Top-left pixel (at `0,0`) is the "delimiter" color: |
||||
* Each glyph in the font starts when a pixel of this color is found on the first row |
||||
* The first row is discarded when converting to the QFF format |
||||
* The number of delimited glyphs must match the supplied arguments to the command: |
||||
* The full ASCII set `0x20..0x7E` (if `--no-ascii` was not specified) |
||||
* The corresponding number of unicode glyphs if any were specified with `--unicode-glyphs` |
||||
* The order of the glyphs matches the ASCII set, if any, followed by the Unicode glyph set, if any. |
||||
|
||||
**Usage**: |
||||
|
||||
``` |
||||
usage: qmk painter-convert-font-image [-h] [-r] -f FORMAT [-u UNICODE_GLYPHS] [-n] [-o OUTPUT] [-i INPUT] |
||||
|
||||
optional arguments: |
||||
-h, --help show this help message and exit |
||||
-r, --no-rle Disable the use of RLE to minimise converted image size. |
||||
-f FORMAT, --format FORMAT |
||||
Output format, valid types: pal256, pal16, pal4, pal2, mono256, mono16, mono4, mono2 |
||||
-u UNICODE_GLYPHS, --unicode-glyphs UNICODE_GLYPHS |
||||
Also generate the specified unicode glyphs. |
||||
-n, --no-ascii Disables output of the full ASCII character set (0x20..0x7E), exporting only the glyphs specified. |
||||
-o OUTPUT, --output OUTPUT |
||||
Specify output directory. Defaults to same directory as input. |
||||
-i INPUT, --input INPUT |
||||
Specify input graphic file. |
||||
``` |
||||
|
||||
The same arguments for `--no-ascii` and `--unicode-glyphs` need to be specified, as per `qmk painter-make-font-image`. |
||||
|
||||
**Examples**: |
||||
|
||||
``` |
||||
$ cd /home/qmk/qmk_firmware/keyboards/my_keeb |
||||
$ qmk painter-convert-font-image --input noto11.png -f mono4 --unicode-glyphs "ĄȽɂɻɣɈʣ" |
||||
Writing /home/qmk/qmk_firmware/keyboards/my_keeb/generated/noto11.qff.h... |
||||
Writing /home/qmk/qmk_firmware/keyboards/my_keeb/generated/noto11.qff.c... |
||||
``` |
||||
|
||||
## Quantum Painter Drawing API :id=quantum-painter-api |
||||
|
||||
All APIs require a `painter_device_t` object as their first parameter -- this object comes from the specific device initialisation, and instructions on creating it can be found in each driver's respective section. |
||||
|
||||
To use any of the APIs, you need to include `qp.h`: |
||||
```c |
||||
#include <qp.h> |
||||
``` |
||||
|
||||
### General Notes :id=quantum-painter-api-general |
||||
|
||||
The coordinate system used in Quantum Painter generally accepts `left`, `top`, `right`, and `bottom` instead of x/y/width/height, and each coordinate is inclusive of where pixels should be drawn. This is required as some datatypes used by display panels have a maximum value of `255` -- for any value or geometry extent that matches `256`, this would be represented as a `0`, instead. |
||||
|
||||
?> Drawing a horizontal line 8 pixels long, starting from 4 pixels inside the left side of the display, will need `left=4`, `right=11`. |
||||
|
||||
All color data matches the standard QMK HSV triplet definitions: |
||||
|
||||
* Hue is of the range `0...255` and is internally mapped to 0...360 degrees. |
||||
* Saturation is of the range `0...255` and is internally mapped to 0...100% saturation. |
||||
* Value is of the range `0...255` and is internally mapped to 0...100% brightness. |
||||
|
||||
?> Colors used in Quantum Painter are not subject to the RGB lighting CIE curve, if it is enabled. |
||||
|
||||
### Device Control :id=quantum-painter-api-device-control |
||||
|
||||
#### Display Initialisation :id=quantum-painter-api-init |
||||
|
||||
```c |
||||
bool qp_init(painter_device_t device, painter_rotation_t rotation); |
||||
``` |
||||
|
||||
The `qp_init` function is used to initialise a display device after it has been created. This accepts a rotation parameter (`QP_ROTATION_0`, `QP_ROTATION_90`, `QP_ROTATION_180`, `QP_ROTATION_270`), which makes sure that the orientation of what's drawn on the display is correct. |
||||
|
||||
```c |
||||
static painter_device_t display; |
||||
void keyboard_post_init_kb(void) { |
||||
display = qp_make_.......; // Create the display |
||||
qp_init(display, QP_ROTATION_0); // Initialise the display |
||||
} |
||||
``` |
||||
|
||||
#### Display Power :id=quantum-painter-api-power |
||||
|
||||
```c |
||||
bool qp_power(painter_device_t device, bool power_on); |
||||
``` |
||||
|
||||
The `qp_power` function instructs the display whether or not the display panel should be on or off. |
||||
|
||||
!> If there is a separate backlight controlled through the normal QMK backlight API, this is not controlled by the `qp_power` function and needs to be manually handled elsewhere. |
||||
|
||||
```c |
||||
static uint8_t last_backlight = 255; |
||||
void suspend_power_down_user(void) { |
||||
if (last_backlight == 255) { |
||||
last_backlight = get_backlight_level(); |
||||
} |
||||
backlight_set(0); |
||||
rgb_matrix_set_suspend_state(true); |
||||
qp_power(display, false); |
||||
} |
||||
|
||||
void suspend_wakeup_init_user(void) { |
||||
qp_power(display, true); |
||||
rgb_matrix_set_suspend_state(false); |
||||
if (last_backlight != 255) { |
||||
backlight_set(last_backlight); |
||||
} |
||||
last_backlight = 255; |
||||
} |
||||
``` |
||||
|
||||
#### Display Clear :id=quantum-painter-api-clear |
||||
|
||||
```c |
||||
bool qp_clear(painter_device_t device); |
||||
``` |
||||
|
||||
The `qp_clear` function clears the display's screen. |
||||
|
||||
#### Display Flush :id=quantum-painter-api-flush |
||||
|
||||
```c |
||||
bool qp_flush(painter_device_t device); |
||||
``` |
||||
|
||||
The `qp_flush` function ensures that all drawing operations are "pushed" to the display. This should be done as the last operation whenever a sequence of draws occur, and guarantees that any changes are applied. |
||||
|
||||
!> Some display panels may seem to work even without a call to `qp_flush` -- this may be because the driver cannot queue drawing operations and needs to display them immediately when invoked. In general, calling `qp_flush` at the end is still considered "best practice". |
||||
|
||||
```c |
||||
void housekeeping_task_user(void) { |
||||
static uint32_t last_draw = 0; |
||||
if (timer_elapsed32(last_draw) > 33) { // Throttle to 30fps |
||||
last_draw = timer_read32(); |
||||
// Draw a rect based off the current RGB color |
||||
qp_rect(display, 0, 7, 0, 239, rgb_matrix_get_hue(), 255, 255); |
||||
qp_flush(display); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
### Drawing Primitives :id=quantum-painter-api-primitives |
||||
|
||||
#### Set Pixel :id=quantum-painter-api-setpixel |
||||
|
||||
```c |
||||
bool qp_setpixel(painter_device_t device, uint16_t x, uint16_t y, uint8_t hue, uint8_t sat, uint8_t val); |
||||
``` |
||||
|
||||
The `qp_setpixel` can be used to set a specific pixel on the screen to the supplied color. |
||||
|
||||
?> Using `qp_setpixel` for large amounts of drawing operations is inefficient and should be avoided unless they cannot be achieved with other drawing APIs. |
||||
|
||||
```c |
||||
void housekeeping_task_user(void) { |
||||
static uint32_t last_draw = 0; |
||||
if (timer_elapsed32(last_draw) > 33) { // Throttle to 30fps |
||||
last_draw = timer_read32(); |
||||
// Draw a 240px high vertical rainbow line on X=0: |
||||
for (int i = 0; i < 239; ++i) { |
||||
qp_setpixel(display, 0, i, i, 255, 255); |
||||
} |
||||
qp_flush(display); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Draw Line :id=quantum-painter-api-line |
||||
|
||||
```c |
||||
bool qp_line(painter_device_t device, uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, uint8_t hue, uint8_t sat, uint8_t val); |
||||
``` |
||||
|
||||
The `qp_line` can be used to draw lines on the screen with the supplied color. |
||||
|
||||
```c |
||||
void housekeeping_task_user(void) { |
||||
static uint32_t last_draw = 0; |
||||
if (timer_elapsed32(last_draw) > 33) { // Throttle to 30fps |
||||
last_draw = timer_read32(); |
||||
// Draw 8px-wide rainbow down the left side of the display |
||||
for (int i = 0; i < 239; ++i) { |
||||
qp_line(display, 0, i, 7, i, i, 255, 255); |
||||
} |
||||
qp_flush(display); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Draw Rect :id=quantum-painter-api-rect |
||||
|
||||
```c |
||||
bool qp_rect(painter_device_t device, uint16_t left, uint16_t top, uint16_t right, uint16_t bottom, uint8_t hue, uint8_t sat, uint8_t val, bool filled); |
||||
``` |
||||
|
||||
The `qp_rect` can be used to draw rectangles on the screen with the supplied color, with or without a background fill. If not filled, any pixels inside the rectangle will be left as-is. |
||||
|
||||
```c |
||||
void housekeeping_task_user(void) { |
||||
static uint32_t last_draw = 0; |
||||
if (timer_elapsed32(last_draw) > 33) { // Throttle to 30fps |
||||
last_draw = timer_read32(); |
||||
// Draw 8px-wide rainbow filled rectangles down the left side of the display |
||||
for (int i = 0; i < 239; i+=8) { |
||||
qp_rect(display, 0, i, 7, i+7, i, 255, 255, true); |
||||
} |
||||
qp_flush(display); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Draw Circle :id=quantum-painter-api-circle |
||||
|
||||
```c |
||||
bool qp_circle(painter_device_t device, uint16_t x, uint16_t y, uint16_t radius, uint8_t hue, uint8_t sat, uint8_t val, bool filled); |
||||
``` |
||||
|
||||
The `qp_circle` can be used to draw circles on the screen with the supplied color, with or without a background fill. If not filled, any pixels inside the circle will be left as-is. |
||||
|
||||
```c |
||||
void housekeeping_task_user(void) { |
||||
static uint32_t last_draw = 0; |
||||
if (timer_elapsed32(last_draw) > 33) { // Throttle to 30fps |
||||
last_draw = timer_read32(); |
||||
// Draw r=4 filled circles down the left side of the display |
||||
for (int i = 0; i < 239; i+=8) { |
||||
qp_circle(display, 4, 4+i, 4, i, 255, 255, true); |
||||
} |
||||
qp_flush(display); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Draw Ellipse :id=quantum-painter-api-ellipse |
||||
|
||||
```c |
||||
bool qp_ellipse(painter_device_t device, uint16_t x, uint16_t y, uint16_t sizex, uint16_t sizey, uint8_t hue, uint8_t sat, uint8_t val, bool filled); |
||||
``` |
||||
|
||||
The `qp_ellipse` can be used to draw ellipses on the screen with the supplied color, with or without a background fill. If not filled, any pixels inside the ellipses will be left as-is. |
||||
|
||||
```c |
||||
void housekeeping_task_user(void) { |
||||
static uint32_t last_draw = 0; |
||||
if (timer_elapsed32(last_draw) > 33) { // Throttle to 30fps |
||||
last_draw = timer_read32(); |
||||
// Draw 16x8 filled ellipses down the left side of the display |
||||
for (int i = 0; i < 239; i+=8) { |
||||
qp_ellipse(display, 8, 4+i, 16, 8, i, 255, 255, true); |
||||
} |
||||
qp_flush(display); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
### Image Functions :id=quantum-painter-api-images |
||||
|
||||
#### Load Image :id=quantum-painter-api-load-image |
||||
|
||||
```c |
||||
painter_image_handle_t qp_load_image_mem(const void *buffer); |
||||
``` |
||||
|
||||
The `qp_load_image_mem` function loads a QGF image from memory or flash. |
||||
|
||||
`qp_load_image_mem` returns a handle to the loaded image, which can then be used to draw to the screen using `qp_drawimage`, `qp_drawimage_recolor`, `qp_animate`, or `qp_animate_recolor`. If an image is no longer required, it can be unloaded by calling `qp_close_image` below. |
||||
|
||||
See the [CLI Commands](quantum_painter.md?id=quantum-painter-cli) for instructions on how to convert images to [QGF](quantum_painter_qgf.md). |
||||
|
||||
?> The total number of images available to load at any one time is controlled by the configurable option `QUANTUM_PAINTER_NUM_IMAGES` in the table above. If more images are required, the number should be increased in `config.h`. |
||||
|
||||
Image information is available through accessing the handle: |
||||
|
||||
| Property | Accessor | |
||||
|-------------|----------------------| |
||||
| Width | `image->width` | |
||||
| Height | `image->height` | |
||||
| Frame Count | `image->frame_count` | |
||||
|
||||
#### Unload Image :id=quantum-painter-api-close-image |
||||
|
||||
```c |
||||
bool qp_close_image(painter_image_handle_t image); |
||||
``` |
||||
|
||||
The `qp_close_image` function releases resources related to the loading of the supplied image. |
||||
|
||||
#### Draw image :id=quantum-painter-api-draw-image |
||||
|
||||
```c |
||||
bool qp_drawimage(painter_device_t device, uint16_t x, uint16_t y, painter_image_handle_t image); |
||||
bool qp_drawimage_recolor(painter_device_t device, uint16_t x, uint16_t y, painter_image_handle_t image, uint8_t hue_fg, uint8_t sat_fg, uint8_t val_fg, uint8_t hue_bg, uint8_t sat_bg, uint8_t val_bg); |
||||
``` |
||||
|
||||
The `qp_drawimage` and `qp_drawimage_recolor` functions draw the supplied image to the screen at the supplied location, with the latter function allowing for monochrome-based images to be recolored. |
||||
|
||||
```c |
||||
// Draw an image on the bottom-right of the 240x320 display on initialisation |
||||
static painter_image_handle_t my_image; |
||||
void keyboard_post_init_kb(void) { |
||||
my_image = qp_load_image_mem(gfx_my_image); |
||||
if (my_image != NULL) { |
||||
qp_drawimage(display, (239 - my_image->width), (319 - my_image->height), my_image); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Animate Image :id=quantum-painter-api-animate-image |
||||
|
||||
```c |
||||
deferred_token qp_animate(painter_device_t device, uint16_t x, uint16_t y, painter_image_handle_t image); |
||||
deferred_token qp_animate_recolor(painter_device_t device, uint16_t x, uint16_t y, painter_image_handle_t image, uint8_t hue_fg, uint8_t sat_fg, uint8_t val_fg, uint8_t hue_bg, uint8_t sat_bg, uint8_t val_bg); |
||||
``` |
||||
|
||||
The `qp_animate` and `qp_animate_recolor` functions draw the supplied image to the screen at the supplied location, with the latter function allowing for monochrome-based animations to be recolored. They also set up internal timing such that each frame is rendered at the correct time as per the animated image. |
||||
|
||||
Once an image has been set to animate, it will loop indefinitely until stopped, with no user intervention required. |
||||
|
||||
Both functions return a `deferred_token`, which can then be used to stop the animation, using `qp_stop_animation` below. |
||||
|
||||
```c |
||||
// Animate an image on the bottom-right of the 240x320 display on initialisation |
||||
static painter_image_handle_t my_image; |
||||
static deferred_token my_anim; |
||||
void keyboard_post_init_kb(void) { |
||||
my_image = qp_load_image_mem(gfx_my_image); |
||||
if (my_image != NULL) { |
||||
my_anim = qp_animate(display, (239 - my_image->width), (319 - my_image->height), my_image); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Stop Animation :id=quantum-painter-api-stop-animation |
||||
|
||||
```c |
||||
void qp_stop_animation(deferred_token anim_token); |
||||
``` |
||||
|
||||
The `qp_stop_animation` function stops the previously-started animation. |
||||
```c |
||||
void housekeeping_task_user(void) { |
||||
if (some_random_stop_reason) { |
||||
qp_stop_animation(my_anim); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
### Font Functions :id=quantum-painter-api-fonts |
||||
|
||||
#### Load Font :id=quantum-painter-api-load-font |
||||
|
||||
```c |
||||
painter_font_handle_t qp_load_font_mem(const void *buffer); |
||||
``` |
||||
|
||||
The `qp_load_font_mem` function loads a QFF font from memory or flash. |
||||
|
||||
`qp_load_font_mem` returns a handle to the loaded font, which can then be measured using `qp_textwidth`, or drawn to the screen using `qp_drawtext`, or `qp_drawtext_recolor`. If a font is no longer required, it can be unloaded by calling `qp_close_font` below. |
||||
|
||||
See the [CLI Commands](quantum_painter.md?id=quantum-painter-cli) for instructions on how to convert TTF fonts to [QFF](quantum_painter_qff.md). |
||||
|
||||
?> The total number of fonts available to load at any one time is controlled by the configurable option `QUANTUM_PAINTER_NUM_FONTS` in the table above. If more fonts are required, the number should be increased in `config.h`. |
||||
|
||||
Font information is available through accessing the handle: |
||||
|
||||
| Property | Accessor | |
||||
|-------------|----------------------| |
||||
| Line Height | `image->line_height` | |
||||
|
||||
#### Unload Font :id=quantum-painter-api-close-font |
||||
|
||||
```c |
||||
bool qp_close_font(painter_font_handle_t font); |
||||
``` |
||||
|
||||
The `qp_close_font` function releases resources related to the loading of the supplied font. |
||||
|
||||
#### Measure Text :id=quantum-painter-api-textwidth |
||||
|
||||
```c |
||||
int16_t qp_textwidth(painter_font_handle_t font, const char *str); |
||||
``` |
||||
|
||||
The `qp_textwidth` function allows measurement of how many pixels wide the supplied string would result in, for the given font. |
||||
|
||||
#### Draw Text :id=quantum-painter-api-drawtext |
||||
|
||||
```c |
||||
int16_t qp_drawtext(painter_device_t device, uint16_t x, uint16_t y, painter_font_handle_t font, const char *str); |
||||
int16_t qp_drawtext_recolor(painter_device_t device, uint16_t x, uint16_t y, painter_font_handle_t font, const char *str, uint8_t hue_fg, uint8_t sat_fg, uint8_t val_fg, uint8_t hue_bg, uint8_t sat_bg, uint8_t val_bg); |
||||
``` |
||||
|
||||
The `qp_drawtext` and `qp_drawtext_recolor` functions draw the supplied string to the screen at the given location using the font supplied, with the latter function allowing for monochrome-based fonts to be recolored. |
||||
|
||||
```c |
||||
// Draw a text message on the bottom-right of the 240x320 display on initialisation |
||||
static painter_font_handle_t my_font; |
||||
void keyboard_post_init_kb(void) { |
||||
my_font = qp_load_font_mem(font_opensans); |
||||
if (my_font != NULL) { |
||||
static const char *text = "Hello from QMK!"; |
||||
int16_t width = qp_textwidth(my_font, text); |
||||
qp_drawtext(display, (239 - width), (319 - my_font->line_height), my_font, text); |
||||
} |
||||
} |
||||
``` |
||||
|
||||
### Advanced Functions :id=quantum-painter-api-advanced |
||||
|
||||
#### Get Geometry :id=quantum-painter-api-get-geometry |
||||
|
||||
```c |
||||
void qp_get_geometry(painter_device_t device, uint16_t *width, uint16_t *height, painter_rotation_t *rotation, uint16_t *offset_x, uint16_t *offset_y); |
||||
``` |
||||
|
||||
The `qp_get_geometry` function allows external code to retrieve the current width, height, rotation, and drawing offsets. |
||||
|
||||
#### Set Viewport Offsets :id=quantum-painter-api-set-viewport |
||||
|
||||
```c |
||||
void qp_set_viewport_offsets(painter_device_t device, uint16_t offset_x, uint16_t offset_y); |
||||
``` |
||||
|
||||
The `qp_set_viewport_offsets` function can be used to offset all subsequent drawing operations. For example, if a display controller is internally 240x320, but the display panel is 240x240 and has a Y offset of 80 pixels, you could invoke `qp_set_viewport_offsets(display, 0, 80);` and the drawing positioning would be corrected. |
||||
|
||||
#### Set Viewport :id=quantum-painter-api-viewport |
||||
|
||||
```c |
||||
bool qp_viewport(painter_device_t device, uint16_t left, uint16_t top, uint16_t right, uint16_t bottom); |
||||
``` |
||||
|
||||
The `qp_viewport` function controls where raw pixel data is written to. |
||||
|
||||
#### Stream Pixel Data :id=quantum-painter-api-pixdata |
||||
|
||||
```c |
||||
bool qp_pixdata(painter_device_t device, const void *pixel_data, uint32_t native_pixel_count); |
||||
``` |
||||
|
||||
The `qp_pixdata` function allows raw pixel data to be streamed to the display. It requires a native pixel count rather than the number of bytes to transfer, to ensure display panel data alignment is respected. E.g. for display panels using RGB565 internal format, sending 10 pixels will result in 20 bytes of transfer. |
||||
|
||||
!> Under normal circumstances, users will not need to manually call either `qp_viewport` or `qp_pixdata`. These allow for writing of raw pixel information, in the display panel's native format, to the area defined by the viewport. |
||||
|
||||
## Quantum Painter Display Drivers :id=quantum-painter-drivers |
||||
|
||||
### Common: Standard TFT (SPI + D/C + RST) |
||||
|
||||
Most TFT display panels use a 5-pin interface -- SPI SCK, SPI MOSI, SPI CS, D/C, and RST pins. |
||||
|
||||
For these displays, QMK's `spi_master` must already be correctly configured for the platform you're building for. |
||||
|
||||
The pin assignments for SPI CS, D/C, and RST are specified during device construction. |
||||
|
||||
### GC9A01 :id=qp-driver-gc9a01 |
||||
|
||||
Enabling support for the GC9A01 in Quantum Painter is done by adding the following to `rules.mk`: |
||||
|
||||
```make |
||||
QUANTUM_PAINTER_ENABLE = yes |
||||
QUANTUM_PAINTER_DRIVERS = gc9a01_spi |
||||
``` |
||||
|
||||
Creating a GC9A01 device in firmware can then be done with the following API: |
||||
|
||||
```c |
||||
painter_device_t qp_gc9a01_make_spi_device(uint16_t panel_width, uint16_t panel_height, pin_t chip_select_pin, pin_t dc_pin, pin_t reset_pin, uint16_t spi_divisor, int spi_mode); |
||||
``` |
||||
|
||||
The device handle returned from the `qp_gc9a01_make_spi_device` function can be used to perform all other drawing operations. |
||||
|
||||
The maximum number of displays can be configured by changing the following in your `config.h` (default is 1): |
||||
|
||||
```c |
||||
// 3 displays: |
||||
#define GC9A01_NUM_DEVICES 3 |
||||
``` |
||||
|
||||
### ILI9163 :id=qp-driver-ili9163 |
||||
|
||||
Enabling support for the ILI9163 in Quantum Painter is done by adding the following to `rules.mk`: |
||||
|
||||
```make |
||||
QUANTUM_PAINTER_ENABLE = yes |
||||
QUANTUM_PAINTER_DRIVERS = ili9163_spi |
||||
``` |
||||
|
||||
Creating a ILI9163 device in firmware can then be done with the following API: |
||||
|
||||
```c |
||||
painter_device_t qp_ili9163_make_spi_device(uint16_t panel_width, uint16_t panel_height, pin_t chip_select_pin, pin_t dc_pin, pin_t reset_pin, uint16_t spi_divisor, int spi_mode); |
||||
``` |
||||
|
||||
The device handle returned from the `qp_ili9163_make_spi_device` function can be used to perform all other drawing operations. |
||||
|
||||
The maximum number of displays can be configured by changing the following in your `config.h` (default is 1): |
||||
|
||||
```c |
||||
// 3 displays: |
||||
#define ILI9163_NUM_DEVICES 3 |
||||
``` |
||||
|
||||
### ILI9341 :id=qp-driver-ili9341 |
||||
|
||||
Enabling support for the ILI9341 in Quantum Painter is done by adding the following to `rules.mk`: |
||||
|
||||
```make |
||||
QUANTUM_PAINTER_ENABLE = yes |
||||
QUANTUM_PAINTER_DRIVERS = ili9341_spi |
||||
``` |
||||
|
||||
Creating a ILI9341 device in firmware can then be done with the following API: |
||||
|
||||
```c |
||||
painter_device_t qp_ili9341_make_spi_device(uint16_t panel_width, uint16_t panel_height, pin_t chip_select_pin, pin_t dc_pin, pin_t reset_pin, uint16_t spi_divisor, int spi_mode); |
||||
``` |
||||
|
||||
The device handle returned from the `qp_ili9341_make_spi_device` function can be used to perform all other drawing operations. |
||||
|
||||
The maximum number of displays can be configured by changing the following in your `config.h` (default is 1): |
||||
|
||||
```c |
||||
// 3 displays: |
||||
#define ILI9341_NUM_DEVICES 3 |
||||
``` |
||||
|
||||
### SSD1351 :id=qp-driver-ssd1351 |
||||
|
||||
Enabling support for the SSD1351 in Quantum Painter is done by adding the following to `rules.mk`: |
||||
|
||||
```make |
||||
QUANTUM_PAINTER_ENABLE = yes |
||||
QUANTUM_PAINTER_DRIVERS = ssd1351_spi |
||||
``` |
||||
|
||||
Creating a SSD1351 device in firmware can then be done with the following API: |
||||
|
||||
```c |
||||
painter_device_t qp_ssd1351_make_spi_device(uint16_t panel_width, uint16_t panel_height, pin_t chip_select_pin, pin_t dc_pin, pin_t reset_pin, uint16_t spi_divisor, int spi_mode); |
||||
``` |
||||
|
||||
The device handle returned from the `qp_ssd1351_make_spi_device` function can be used to perform all other drawing operations. |
||||
|
||||
The maximum number of displays can be configured by changing the following in your `config.h` (default is 1): |
||||
|
||||
```c |
||||
// 3 displays: |
||||
#define SSD1351_NUM_DEVICES 3 |
||||
``` |
||||
|
||||
### ST7789 :id=qp-driver-st7789 |
||||
|
||||
Enabling support for the ST7789 in Quantum Painter is done by adding the following to `rules.mk`: |
||||
|
||||
```make |
||||
QUANTUM_PAINTER_ENABLE = yes |
||||
QUANTUM_PAINTER_DRIVERS = st7789_spi |
||||
``` |
||||
|
||||
Creating a ST7789 device in firmware can then be done with the following API: |
||||
|
||||
```c |
||||
painter_device_t qp_st7789_make_spi_device(uint16_t panel_width, uint16_t panel_height, pin_t chip_select_pin, pin_t dc_pin, pin_t reset_pin, uint16_t spi_divisor, int spi_mode); |
||||
``` |
||||
|
||||
The device handle returned from the `qp_st7789_make_spi_device` function can be used to perform all other drawing operations. |
||||
|
||||
The maximum number of displays can be configured by changing the following in your `config.h` (default is 1): |
||||
|
||||
```c |
||||
// 3 displays: |
||||
#define ST7789_NUM_DEVICES 3 |
||||
``` |
||||
|
||||
!> Some ST7789 devices are known to have different drawing offsets -- despite being a 240x320 pixel display controller internally, some display panels are only 240x240, or smaller. These may require an offset to be applied; see `qp_set_viewport_offsets` above for information on how to override the offsets if they aren't correctly rendered. |
||||
@ -0,0 +1,103 @@ |
||||
# QMK Font Format :id=qmk-font-format |
||||
|
||||
QMK uses a font format _("Quantum Font Format" - QFF)_ specifically for resource-constrained systems. |
||||
|
||||
This format is capable of encoding 1-, 2-, 4-, and 8-bit-per-pixel greyscale- and palette-based images into a font. It also includes RLE for pixel data for some basic compression. |
||||
|
||||
All integer values are in little-endian format. |
||||
|
||||
The QFF is defined in terms of _blocks_ -- each _block_ contains a _header_ and an optional _blob_ of data. The _header_ contains the block's _typeid_, and the length of the _blob_ that follows. Each block type is denoted by a different _typeid_ has its own block definition below. All blocks are defined as packed structs, containing zero padding between fields. |
||||
|
||||
The general structure of the file is: |
||||
|
||||
* _Font descriptor block_ |
||||
* _ASCII glyph block_ (optional, only if ASCII glyphs are included) |
||||
* _Unicode glyph block_ (optional, only if Unicode glyphs are included) |
||||
* _Font palette block_ (optional, depending on frame format) |
||||
* _Font data block_ |
||||
|
||||
## Block Header :id=qff-block-header |
||||
|
||||
The block header is identical to [QGF's block header](quantum_painter_qgf.md#qgf-block-header), and is present for all blocks, including the font descriptor. |
||||
|
||||
## Font descriptor block :id=qff-font-descriptor |
||||
|
||||
* _typeid_ = 0x00 |
||||
* _length_ = 20 |
||||
|
||||
This block must be located at the start of the file contents, and can exist a maximum of once in an entire QGF file. It is always followed by either the _ASCII glyph table_ or the _Unicode glyph table_, depending on which glyphs are included in the font. |
||||
|
||||
_Block_ format: |
||||
|
||||
```c |
||||
typedef struct __attribute__((packed)) qff_font_descriptor_v1_t { |
||||
qgf_block_header_v1_t header; // = { .type_id = 0x00, .neg_type_id = (~0x00), .length = 20 } |
||||
uint24_t magic; // constant, equal to 0x464651 ("QFF") |
||||
uint8_t qff_version; // constant, equal to 0x01 |
||||
uint32_t total_file_size; // total size of the entire file, starting at offset zero |
||||
uint32_t neg_total_file_size; // negated value of total_file_size, used for detecting parsing errors |
||||
uint8_t line_height; // glyph height in pixels |
||||
bool has_ascii_table; // whether the font has an ascii table of glyphs (0x20...0x7E) |
||||
uint16_t num_unicode_glyphs; // the number of glyphs in the unicode table -- no table specified if zero |
||||
uint8_t format; // frame format, see below. |
||||
uint8_t flags; // frame flags, see below. |
||||
uint8_t compression_scheme; // compression scheme, see below. |
||||
uint8_t transparency_index; // palette index used for transparent pixels (not yet implemented) |
||||
} qff_font_descriptor_v1_t; |
||||
// _Static_assert(sizeof(qff_font_descriptor_v1_t) == (sizeof(qgf_block_header_v1_t) + 20), "qff_font_descriptor_v1_t must be 25 bytes in v1 of QFF"); |
||||
``` |
||||
|
||||
The values for `format`, `flags`, `compression_scheme`, and `transparency_index` match [QGF's frame descriptor block](quantum_painter_qgf.md#qgf-frame-descriptor), with the exception that the `delta` flag is ignored by QFF. |
||||
|
||||
## ASCII glyph table :id=qff-ascii-table |
||||
|
||||
* _typeid_ = 0x01 |
||||
* _length_ = 290 |
||||
|
||||
If the font contains ascii characters, the _ASCII glyph block_ must be located directly after the _font descriptor block_. |
||||
|
||||
```c |
||||
#define QFF_GLYPH_WIDTH_BITS 6 |
||||
#define QFF_GLYPH_WIDTH_MASK ((1<<QFF_GLYPH_WIDTH_BITS)-1) |
||||
#define QFF_GLYPH_OFFSET_BITS 18 |
||||
#define QFF_GLYPH_OFFSET_MASK (((1<<QFF_GLYPH_OFFSET_BITS)-1) << QFF_GLYPH_WIDTH_BITS) |
||||
|
||||
typedef struct __attribute__((packed)) qff_ascii_glyph_table_v1_t { |
||||
qgf_block_header_v1_t header; // = { .type_id = 0x01, .neg_type_id = (~0x01), .length = 285 } |
||||
uint24_t glyph[95]; // 95 glyphs, 0x20..0x7E, see bits/masks above for values |
||||
} qff_ascii_glyph_table_v1_t; |
||||
// _Static_assert(sizeof(qff_ascii_glyph_table_v1_t) == (sizeof(qgf_block_header_v1_t) + 285), "qff_ascii_glyph_table_v1_t must be 290 bytes in v1 of QFF"); |
||||
``` |
||||
|
||||
## Unicode glyph table :id=qff-unicode-table |
||||
|
||||
* _typeid_ = 0x02 |
||||
* _length_ = variable |
||||
|
||||
If this font contains unicode characters, the _unicode glyph block_ must be located directly after the _ASCII glyph table block_, or the _font descriptor block_ if the font does not contain ASCII characters. |
||||
|
||||
```c |
||||
typedef struct __attribute__((packed)) qff_unicode_glyph_table_v1_t { |
||||
qgf_block_header_v1_t header; // = { .type_id = 0x02, .neg_type_id = (~0x02), .length = (N * 6) } |
||||
struct __attribute__((packed)) { // container for a single unicode glyph |
||||
uint24_t code_point; // the unicode code point |
||||
uint24_t glyph; // the glyph information, as per ASCII glyphs above |
||||
} glyph[N]; // N glyphs worth of data |
||||
} qff_unicode_glyph_table_v1_t; |
||||
``` |
||||
|
||||
## Font palette block :id=qff-palette-descriptor |
||||
|
||||
* _typeid_ = 0x03 |
||||
* _length_ = variable |
||||
|
||||
The _font palette block_ is identical to [QGF's frame palette block](quantum_painter_qgf.md#qgf-frame-palette-descriptor), retaining the same _typeid_ of 0x03. |
||||
|
||||
It is only specified in the QFF if the font is palette-based, and follows the _unicode glyph block_ if the font contains any Unicode glyphs, or the _ASCII glyph block_ if the font contains only ASCII glyphs. |
||||
|
||||
## Font data block :id=qff-data-descriptor |
||||
|
||||
* _typeid_ = 0x04 |
||||
* _length_ = variable |
||||
|
||||
The _font data block_ is the last block in the file and is identical to [QGF's frame data block](quantum_painter_qgf.md#qgf-frame-data-descriptor), however has a different _typeid_ of 0x04 in QFF. |
||||
@ -0,0 +1,178 @@ |
||||
# QMK Graphics Format :id=qmk-graphics-format |
||||
|
||||
QMK uses a graphics format _("Quantum Graphics Format" - QGF)_ specifically for resource-constrained systems. |
||||
|
||||
This format is capable of encoding 1-, 2-, 4-, and 8-bit-per-pixel greyscale- and palette-based images. It also includes RLE for pixel data for some basic compression. |
||||
|
||||
All integer values are in little-endian format. |
||||
|
||||
The QGF is defined in terms of _blocks_ -- each _block_ contains a _header_ and an optional _blob_ of data. The _header_ contains the block's _typeid_, and the length of the _blob_ that follows. Each block type is denoted by a different _typeid_ has its own block definition below. All blocks are defined as packed structs, containing zero padding between fields. |
||||
|
||||
The general structure of the file is: |
||||
|
||||
* _Graphics descriptor block_ |
||||
* _Frame offset block_ |
||||
* Repeating list of frames: |
||||
* _Frame descriptor block_ |
||||
* _Frame palette block_ (optional, depending on frame format) |
||||
* _Frame delta block_ (optional, depending on delta flag) |
||||
* _Frame data block_ |
||||
|
||||
Different frames within the file should be considered "isolated" and may have their own image format and/or palette. |
||||
|
||||
## Block Header :id=qgf-block-header |
||||
|
||||
This block header is present for all blocks, including the graphics descriptor. |
||||
|
||||
_Block header_ format: |
||||
|
||||
```c |
||||
typedef struct __attribute__((packed)) qgf_block_header_v1_t { |
||||
uint8_t type_id; // See each respective block type |
||||
uint8_t neg_type_id; // Negated type ID, used for detecting parsing errors |
||||
uint24_t length; // 24-bit blob length, allowing for block sizes of a maximum of 16MB |
||||
} qgf_block_header_v1_t; |
||||
// _Static_assert(sizeof(qgf_block_header_v1_t) == 5, "qgf_block_header_v1_t must be 5 bytes in v1 of QGF"); |
||||
``` |
||||
The _length_ describes the number of octets in the data following the block header -- a block header may specify a _length_ of `0` if no blob is specified. |
||||
|
||||
## Graphics descriptor block :id=qgf-graphics-descriptor |
||||
|
||||
* _typeid_ = 0x00 |
||||
* _length_ = 18 |
||||
|
||||
This block must be located at the start of the file contents, and can exist a maximum of once in an entire QGF file. It is always followed by the _frame offset block_. |
||||
|
||||
_Block_ format: |
||||
|
||||
```c |
||||
typedef struct __attribute__((packed)) qgf_graphics_descriptor_v1_t { |
||||
qgf_block_header_v1_t header; // = { .type_id = 0x00, .neg_type_id = (~0x00), .length = 18 } |
||||
uint24_t magic; // constant, equal to 0x464751 ("QGF") |
||||
uint8_t qgf_version; // constant, equal to 0x01 |
||||
uint32_t total_file_size; // total size of the entire file, starting at offset zero |
||||
uint32_t neg_total_file_size; // negated value of total_file_size, used for detecting parsing errors |
||||
uint16_t image_width; // in pixels |
||||
uint16_t image_height; // in pixels |
||||
uint16_t frame_count; // minimum of 1 |
||||
} qgf_graphics_descriptor_v1_t; |
||||
// _Static_assert(sizeof(qgf_graphics_descriptor_v1_t) == (sizeof(qgf_block_header_v1_t) + 18), "qgf_graphics_descriptor_v1_t must be 23 bytes in v1 of QGF"); |
||||
``` |
||||
|
||||
## Frame offset block :id=qgf-frame-offset-descriptor |
||||
|
||||
* _typeid_ = 0x01 |
||||
* _length_ = variable |
||||
|
||||
This block denotes the offsets within the file to each frame's _frame descriptor block_, relative to the start of the file. The _frame offset block_ always immediately follows the _graphics descriptor block_. The contents of this block are an array of U32's, with one entry for each frame. |
||||
|
||||
Duplicate frame offsets in this block are allowed, if a certain frame is to be shown multiple times during animation. |
||||
|
||||
_Block_ format: |
||||
|
||||
```c |
||||
typedef struct __attribute__((packed)) qgf_frame_offsets_v1_t { |
||||
qgf_block_header_v1_t header; // = { .type_id = 0x01, .neg_type_id = (~0x01), .length = (N * sizeof(uint32_t)) } |
||||
uint32_t offset[N]; // where 'N' is the number of frames in the file |
||||
} qgf_frame_offsets_v1_t; |
||||
``` |
||||
|
||||
## Frame descriptor block :id=qgf-frame-descriptor |
||||
|
||||
* _typeid_ = 0x02 |
||||
* _length_ = 5 |
||||
|
||||
This block denotes the start of a frame. |
||||
|
||||
_Block_ format: |
||||
|
||||
```c |
||||
typedef struct __attribute__((packed)) qgf_frame_v1_t { |
||||
qgf_block_header_v1_t header; // = { .type_id = 0x02, .neg_type_id = (~0x02), .length = 5 } |
||||
uint8_t format; // Frame format, see below. |
||||
uint8_t flags; // Frame flags, see below. |
||||
uint8_t compression_scheme; // Compression scheme, see below. |
||||
uint8_t transparency_index; // palette index used for transparent pixels (not yet implemented) |
||||
uint16_t delay; // frame delay time for animations (in units of milliseconds) |
||||
} qgf_frame_v1_t; |
||||
// _Static_assert(sizeof(qgf_frame_v1_t) == (sizeof(qgf_block_header_v1_t) + 6), "qgf_frame_v1_t must be 11 bytes in v1 of QGF"); |
||||
``` |
||||
|
||||
If this frame is grayscale, the _frame descriptor block_ (or _frame delta block_ if flags denote a delta frame) is immediately followed by this frame's corresponding _frame data block_. |
||||
|
||||
If the frame uses an indexed palette, the _frame descriptor block_ (or _frame delta block_ if flags denote a delta frame) is immediately followed by this frame's corresponding _frame palette block_. |
||||
|
||||
Frame format possible values: |
||||
|
||||
* `0x00`: 1bpp grayscale, no palette, `0` = black, `1` = white, LSb first pixel |
||||
* `0x01`: 2bpp grayscale, no palette, `0` = black, `3` = white, linear interpolation of brightness, LSb first pixel |
||||
* `0x02`: 4bpp grayscale, no palette, `0` = black, `15` = white, linear interpolation of brightness, LSb first pixel |
||||
* `0x03`: 8bpp grayscale, no palette, `0` = black, `255` = white, linear interpolation of brightness, LSb first pixel |
||||
* `0x04`: 1bpp indexed palette, 2 colors, LSb first pixel |
||||
* `0x05`: 2bpp indexed palette, 4 colors, LSb first pixel |
||||
* `0x06`: 4bpp indexed palette, 16 colors, LSb first pixel |
||||
* `0x07`: 8bpp indexed palette, 256 colors, LSb first pixel |
||||
|
||||
Frame flags is a bitmask with the following format: |
||||
|
||||
| `bit 7` | `bit 6` | `bit 5` | `bit 4` | `bit 3` | `bit 2` | `bit 1` | `bit 0` | |
||||
|---------|---------|---------|---------|---------|---------|---------|--------------| |
||||
| - | - | - | - | - | - | Delta | Transparency | |
||||
|
||||
* `[1]` -- Delta: Signifies that the current frame is a delta frame, which specifies only a sub-image. The _frame delta block_ follows the _frame palette block_ if the image format specifies a palette, otherwise it directly follows the _frame descriptor block_. |
||||
* `[0]` -- Transparency: The transparent palette index in the _blob_ is considered valid and should be used when considering which pixels should be transparent during rendering this frame, if possible. |
||||
|
||||
Compression scheme possible values: |
||||
|
||||
* `0x00`: No compression |
||||
* `0x01`: [QMK RLE](quantum_painter_rle.md) |
||||
|
||||
## Frame palette block :id=qgf-frame-palette-descriptor |
||||
|
||||
* _typeid_ = 0x03 |
||||
* _length_ = variable |
||||
|
||||
This block describes the palette used for the frame. The _blob_ contains an array of palette entries -- one palette entry is present for each color used -- each palette entry is in QMK HSV888 format: |
||||
|
||||
```c |
||||
typedef struct __attribute__((packed)) qgf_palette_v1_t { |
||||
qgf_block_header_v1_t header; // = { .type_id = 0x03, .neg_type_id = (~0x03), .length = (N * 3 * sizeof(uint8_t)) } |
||||
struct { // container for a single HSV palette entry |
||||
uint8_t h; // hue component: `[0,360)` degrees is mapped to `[0,255]` uint8_t. |
||||
uint8_t s; // saturation component: `[0,1]` is mapped to `[0,255]` uint8_t. |
||||
uint8_t v; // value component: `[0,1]` is mapped to `[0,255]` uint8_t. |
||||
} hsv[N]; // N * hsv, where N is the number of palette entries depending on the frame format in the descriptor |
||||
} qgf_palette_v1_t; |
||||
``` |
||||
|
||||
## Frame delta block :id=qgf-frame-delta-descriptor |
||||
|
||||
* _typeid_ = 0x04 |
||||
* _length_ = 8 |
||||
|
||||
This block describes where the delta frame should be drawn, with respect to the top left location of the image. |
||||
|
||||
```c |
||||
typedef struct __attribute__((packed)) qgf_delta_v1_t { |
||||
qgf_block_header_v1_t header; // = { .type_id = 0x04, .neg_type_id = (~0x04), .length = 8 } |
||||
uint16_t left; // The left pixel location to draw the delta image |
||||
uint16_t top; // The top pixel location to draw the delta image |
||||
uint16_t right; // The right pixel location to to draw the delta image |
||||
uint16_t bottom; // The bottom pixel location to to draw the delta image |
||||
} qgf_delta_v1_t; |
||||
// _Static_assert(sizeof(qgf_delta_v1_t) == 13, "qgf_delta_v1_t must be 13 bytes in v1 of QGF"); |
||||
``` |
||||
|
||||
## Frame data block :id=qgf-frame-data-descriptor |
||||
|
||||
* _typeid_ = 0x05 |
||||
* _length_ = variable |
||||
|
||||
This block describes the data associated with the frame. The _blob_ contains an array of bytes containing the data corresponding to the frame's image format: |
||||
|
||||
```c |
||||
typedef struct __attribute__((packed)) qgf_data_v1_t { |
||||
qgf_block_header_v1_t header; // = { .type_id = 0x05, .neg_type_id = (~0x05), .length = N } |
||||
uint8_t data[N]; // N data octets |
||||
} qgf_data_v1_t; |
||||
``` |
||||
@ -0,0 +1,29 @@ |
||||
# QMK QGF/QFF RLE data schema :id=qmk-qp-rle-schema |
||||
|
||||
There are two "modes" to the RLE algorithm used in both [QGF](quantum_painter_qgf.md)/[QFF](quantum_painter_qff.md): |
||||
|
||||
* Non-repeating sections of octets, with associated length of up to `128` octets |
||||
* `length` = `marker - 128` |
||||
* A corresponding `length` number of octets follow directly after the marker octet |
||||
* Repeated octet with associated length, with associated length of up to `128` |
||||
* `length` = `marker` |
||||
* A single octet follows the marker that should be repeated `length` times. |
||||
|
||||
Decoder pseudocode: |
||||
``` |
||||
while !EOF |
||||
marker = READ_OCTET() |
||||
|
||||
if marker >= 128 |
||||
length = marker - 128 |
||||
for i = 0 ... length-1 |
||||
c = READ_OCTET() |
||||
WRITE_OCTET(c) |
||||
|
||||
else |
||||
length = marker |
||||
c = READ_OCTET() |
||||
for i = 0 ... length-1 |
||||
WRITE_OCTET(c) |
||||
|
||||
``` |
||||
Loading…
Reference in new issue