diff --git a/NeoBuffer-object-API.md b/NeoBuffer-object-API.md index f5a624e..e19c548 100644 --- a/NeoBuffer-object-API.md +++ b/NeoBuffer-object-API.md @@ -9,7 +9,6 @@ The optional pixels will either be copied into the Ram buffer (for NeoBufferMeth ``` NeoPixelBuffer> image(myImageWidth, myImageHeight, myImage); - ``` ## 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) This will set the color to the given pixel. - x - the horizontal 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. +> * _x_- the horizontal 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. ### 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 - \, a color object, RgbColor or RgbwColor. +> * _x_ - the horizontal pixel position. +> * _y_ - the vertical pixel position. +> * _\_, a color object, RgbColor or RgbwColor. ### void ClearTo(ColorObject 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) 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 +> * _destBuffer_ - Another NeoBuffer or NeoPixelBus. +> * _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) 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). ### 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. - 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 - layoutMap - a layoutMap callback that implements the destinations mapping routine (see below) +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. +> * _xDest_ - 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). ## Callbacks ### uint16_t LayoutMapCallback(int16_t x, int16_t y)