Created API Referece (markdown)

Michael Miller
2016-04-22 15:07:02 -07:00
parent e3a71d106d
commit e28f316b51

18
API-Referece.md Normal file

@@ -0,0 +1,18 @@
The following are quick links to the APIs to all the objects with user callable methods. There are a few "method" objects in the system that are used to construct other objects, but there is no need to call any of their exposed functions directly so they are not included in this list.
[NeoPixelBus](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object-API) - The primary interface to the NeoPixels.
Color Objects - These objects are used to define and reference colors.
* [RgbColor](https://github.com/Makuna/NeoPixelBus/wiki/RgbColor-object-API)
* [RgbwColor](https://github.com/Makuna/NeoPixelBus/wiki/RgbwColor-object-API)
* [HtmlColor](https://github.com/Makuna/NeoPixelBus/wiki/HtmlColor-object-API)
* [HslColor](https://github.com/Makuna/NeoPixelBus/wiki/HslColor-object-API)
* [HsbColor (aka HsvColor)](https://github.com/Makuna/NeoPixelBus/wiki/HsbColor-object-API)
[NeoPixelAnimator](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelAnimator-object-API) - The primary interface for running animations.
[NeoGamma](https://github.com/Makuna/NeoPixelBus/wiki/NeoGamma-object) - Color conversion for better gradient color matching.
Raster Objects - These objects are used to store images and render them to the NeoPixelBus.
* [NeoBuffer](https://github.com/Makuna/NeoPixelBus/wiki/NeoBuffer-object-API) - simple image buffer
* [NeoVerticalSpriteSheet](https://github.com/Makuna/NeoPixelBus/wiki/NeoVerticalSpriteSheet-object-API) - sprite image sheet