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:29:29 -05:00
parent 12b102ae47
commit b5942f0af0
1 changed files with 16 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
NeoBitmapFile-object-API.md

@@ -9,7 +9,6 @@ Valid classes for FILE are any class that exposes the same API as the `File` cla
```
NeoBitmapFile<NeoGrbFeature, File> image;
```
## Methods
@@ -31,28 +30,28 @@ This will return the height in pixels of the file.
### ColorObject GetPixelColor(int16_t x, int16_t y)
This will return the color of the given pixel.
x - the horizontal pixel position
y - the vertical pixel position
\<return\>, a color object, RgbColor or RgbwColor.
> * _x_ - the horizontal pixel position.
> * _y_ - the vertical pixel position.
> * _\<return\>_, a color object, RgbColor or RgbwColor.
### void Blt(NeoBufferContext destBuffer, uint16_t indexPixel, int16_t xSrc, int16_t ySrc, int16_t wSrc)
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.
indexPixel - the location to start the render at
xSrc - the horizontal location in the bitmap to render from
ySrc - the vertical location in the bitmap to render from
wSrc - the number of pixels to render
> * _destBuffer_ - Another NeoBuffer or NeoPixelBus.
> * _indexPixel_ - the location to start the render at.
> * _xSrc_ - the horizontal location in the bitmap to render from.
> * _ySrc_ - the vertical location in the bitmap to render from.
> * _wSrc_ - the number of pixels to render.
### 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.
destBuffer - Another NeoBuffer or NeoPixelBus.
xDest - 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
ySrc - the upper left location in the source to render from
wSrc - the width to render
hSrc - the height to render
layoutMap - a layoutMap callback that implements the destinations mapping routine (see below)
> * _destBuffer_ - Another NeoBuffer or NeoPixelBus.
> * _xDest_- 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
> * _ySrc_ - the upper left location in the source to render from
> * _wSrc_ - the width to render
> * _hSrc_ - the height to render
> * _layoutMap_ - a layoutMap callback that implements the destinations mapping routine (see below)
## Callbacks
### uint16_t LayoutMapCallback(int16_t x, int16_t y)