Makuna/NeoPixelBus
1
0
Fork 1
mirror of https://github.com/Makuna/NeoPixelBus.git synced 2025-08-07 12:54:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Normalize API doc styling

Nick Benik
2018-12-21 19:24:58 -05:00
parent e4781b1ce1
commit 12b102ae47
1 changed files with 19 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
NeoVerticalSpriteSheet-object-API.md

@@ -1,4 +1,4 @@
NeoVerticalSpriteSheet represents a image container object that stores the data in a NeoPixel native format for faster rendering. The primary use of this class is to contain an vertical series of sprites as one image and have it rendered to a NeoPixelBus.
NeoVerticalSpriteSheet represents an image container object that stores the data in a NeoPixel native format for faster rendering. The primary use of this class is to contain a vertical series of sprites as one image and have it rendered to a NeoPixelBus.
## Constructors
@@ -9,7 +9,6 @@ The optional pixels will either be copied into the Ram buffer (for NeoBufferMeth
```
NeoVerticalSpriteSheet<NeoPixelBufferProgmemMethod<NeoGrbFeature>> spriteSheet(myImageWidth, myImageHeight, mySpriteHeight, myImage);
```
## Methods
@@ -24,35 +23,35 @@ This will return the height in pixels of a single sprite.
### void SetPixelColor(uint16_t indexSprite, int16_t x, int16_t y, ColorObject color)
This will set the color of the given pixel on the given sprite
indexSprite - the sprite to write to
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.
> * _indexSprite_ - the sprite to write to.
> * _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(uint16_t indexSprite, int16_t x, int16_t y)
This will return the color of the given pixel from the given sprite
indexSprite - the sprite to read from
x - the horizontal pixel position
y - the vertical pixel position
\<return\>, a color object, RgbColor or RgbwColor.
> * _indexSprite_ - the sprite to read from.
> * _x_ - the horizontal pixel position.
> * _y_ - the vertical pixel position.
> * _\<return\>_, a color object, RgbColor or RgbwColor.
### void ClearTo(ColorObject color)
This will clear all pixels on all sprites 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, uint16_t indexSprite)
This will render the sprite 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
indexSprite - the sprite to Blt from
> * _destBuffer_ - Another NeoBuffer or NeoPixelBus.
> * _indexPixel_ - the location to start the render at.
> * _indexSprite_ - the sprite to Blt from.
### void Blt(NeoBufferContext destBuffer, int16_t xDest, int16_t yDest, uint16_t indexSprite, LayoutMapCallback layoutMap)
This will render all of a sprite 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
indexSprite - the sprite to Blt from
layoutMap - a layoutMap callback that implements the destinations mapping routine (see below)
This will render all of a sprite 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.
> * _indexSprite_ - the sprite to Blt from.
> * _layoutMap_ - a layoutMap callback that implements the destinations mapping routine (see below).
## Callbacks
### uint16_t LayoutMapCallback(int16_t x, int16_t y)