Makuna/NeoPixelBus
1
0
Fork 1
mirror of https://github.com/Makuna/NeoPixelBus.git synced 2025-08-06 20:34:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Normalize API doc styling

Nick Benik
2018-12-21 19:13:51 -05:00
parent a044c6dff1
commit e4781b1ce1
1 changed files with 22 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
NeoBuffer-object-API.md

@@ -9,7 +9,6 @@ The optional pixels will either be copied into the Ram buffer (for NeoBufferMeth
``` ```
NeoPixelBuffer<NeoPixelBufferProgmemMethod<NeoGrbFeature>> image(myImageWidth, myImageHeight, myImage); NeoPixelBuffer<NeoPixelBufferProgmemMethod<NeoGrbFeature>> image(myImageWidth, myImageHeight, myImage);
``` ```
## Methods ## Methods
@@ -24,42 +23,42 @@ This will return the height in pixels of the buffer.
### void SetPixelColor(int16_t x, int16_t y, ColorObject color) ### void SetPixelColor(int16_t x, int16_t y, ColorObject color)
This will set the color to the given pixel. This will set the color to the given pixel.
x - the horizontal pixel position > * _x_- the horizontal pixel position.
y - the vertical pixel position > * _y_ - the vertical pixel position.
color - a color object to use, RgbColor, HslColor, and HsbColor will all work and if the NeoPixelBus object was created with the NeoRgbwFeature the RgbwColor will also work. > * _color_ - a color object to use, RgbColor, HslColor, and HsbColor will all work and if the NeoPixelBus object was created with the NeoRgbwFeature the RgbwColor will also work.
### ColorObject GetPixelColor(int16_t x, int16_t y) ### ColorObject GetPixelColor(int16_t x, int16_t y)
This will return the color of the given pixel. This will return the color of the given pixel.
x - the horizontal pixel position > * _x_ - the horizontal pixel position.
y - the vertical pixel position > * _y_ - the vertical pixel position.
\<return\>, a color object, RgbColor or RgbwColor. > * _\<return\>_, a color object, RgbColor or RgbwColor.
### void ClearTo(ColorObject color) ### void ClearTo(ColorObject color)
This will clear all pixels to the given color. This will clear all pixels to the given color.
color - a color object to use, RgbColor, HslColor, and HsbColor will all work and if the NeoPixelBus object was created with the NeoRgbwFeature the RgbwColor will also work. > * _color_ - a color object to use, RgbColor, HslColor, and HsbColor will all work and if the NeoPixelBus object was created with the NeoRgbwFeature the RgbwColor will also work.
### void Blt(NeoBufferContext destBuffer, uint16_t indexPixel) ### void Blt(NeoBufferContext destBuffer, uint16_t indexPixel)
This will render this image to the destBuffer at indexPixel. This is a linear rendering, not a 2D image rendering. This will render this image to the destBuffer at indexPixel. This is a linear rendering, not a 2D image rendering.
destBuffer - Another NeoBuffer or NeoPixelBus. > * _destBuffer_ - Another NeoBuffer or NeoPixelBus.
indexPixel - the location to start the render at > * _indexPixel_ - the location to start the render at.
### void Blt(NeoBufferContext destBuffer, int16_t xDest, int16_t yDest, int16_t xSrc, int16_t ySrc, int16_t wSrc, int16_t hSrc, LayoutMapCallback layoutMap) ### void Blt(NeoBufferContext destBuffer, int16_t xDest, int16_t yDest, int16_t xSrc, int16_t ySrc, int16_t wSrc, int16_t hSrc, LayoutMapCallback layoutMap)
This will render part of this image to the destBuffer at given location. This is a 2d image rendering. This will render part of this image to the destBuffer at given location. This is a 2d image rendering.
destBuffer - Another NeoBuffer or NeoPixelBus. > * _destBuffer_ - Another NeoBuffer or NeoPixelBus.
xDest - the upper left location in the destination to render to > * _xDest_ - the upper left location in the destination to render to.
yDest - the upper left location in the destination to render to > * _yDest_- the upper left location in the destination to render to.
xSrc - the upper left location in the source to render from > * _xSrc_ - the upper left location in the source to render from.
ySrc - the upper left location in the source to render from > * _ySrc_ - the upper left location in the source to render from.
wSrc - the width to render > * _wSrc_ - the width to render.
hSrc - the height to render > * _hSrc_ - the height to render.
layoutMap - a layoutMap callback that implements the destinations mapping routine (see below) > * _layoutMap_ - a layoutMap callback that implements the destinations mapping routine (see below).
### void Blt(NeoBufferContext destBuffer, int16_t xDest, int16_t yDest, LayoutMapCallback layoutMap) ### void Blt(NeoBufferContext destBuffer, int16_t xDest, int16_t yDest, LayoutMapCallback layoutMap)
This will render all of this image to the destBuffer at given location. This is a 2d image rendering. This will render all of this image to the destBuffer at a given location. This is a 2d image rendering.
destBuffer - Another NeoBuffer or NeoPixelBus. > * _destBuffer_ - Another NeoBuffer or NeoPixelBus.
xDest - the upper left location in the destination to render to > * _xDest_ - the upper left location in the destination to render to.
yDest - the upper left location in the destination to render to > * _yDest_ - the upper left location in the destination to render to.
layoutMap - a layoutMap callback that implements the destinations mapping routine (see below) > * _layoutMap_ - a layoutMap callback that implements the destinations mapping routine (see below).
## Callbacks ## Callbacks
### uint16_t LayoutMapCallback(int16_t x, int16_t y) ### uint16_t LayoutMapCallback(int16_t x, int16_t y)