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

Updated Raster Image Support (markdown)

Michael Miller
2020-11-28 09:39:27 -08:00
parent 3e7fa51e05
commit 72121c222c
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Raster-Image-Support.md

@@ -1,15 +1,16 @@
There are three objects exposed that help manage images. They each provide a solution to managing and rendering image data onto the strip. Their internal memory storage matches the pixel layout of the NeoPixelBus which provides a fast rendering.
There are several objects exposed that help manage images. They each provide a solution to managing and rendering image data onto the strip.
### [NeoBuffer object](https://github.com/Makuna/NeoPixelBus/wiki/NeoBuffer-object)
The NeoBuffer is basic image storage object. It can store the image data in RAM or reference image data stored in PROGMEM. It provides direct x,y access to set and get pixels along with a render method `Blt()` that will copy bits to the NeoPixelBus or other Raster objects.
The NeoBuffer is basic image storage object. It can store the image data in RAM or reference image data stored in PROGMEM. It provides direct x,y access to set and get pixels along with a render method `Blt()` that will copy bits to the NeoPixelBus or other Raster objects. The internal memory storage matches the pixel layout of the NeoPixelBus which provides a fast moving of pixels to the strip.
### [NeoVerticalSpriteSheet object](https://github.com/Makuna/NeoPixelBus/wiki/NeoVerticalSpriteSheet-object)
The NeoVerticalSpriteSheet is used to abstract that the image actually contains a series of sprites of the same size. It can store the image data in RAM or reference image data stored in PROGMEM. It provides direct sprite,x,y access to set and get pixels along with a render method `Blt()` that will copy a sprite to the NeoPixelBus or other Raster objects.
The NeoVerticalSpriteSheet is used to abstract that the image actually contains a series of sprites of the same size. It can store the image data in RAM or reference image data stored in PROGMEM. It provides direct sprite,x,y access to set and get pixels along with a render method `Blt()` that will copy a sprite to the NeoPixelBus or other Raster objects. The internal memory storage matches the pixel layout of the NeoPixelBus which provides a fast rendering.
### [NeoBitmapFile](https://github.com/Makuna/NeoPixelBus/wiki/NeoBitmapFile-object)
The NeoBitmapFile is used to "stream" parts of a bmp file to a target. It does not store image data in memory. It provides direct x,y access to get pixels along with a render method `Blt()` that will copy the image bits to the NeoPixelBus or other Raster objects.
### NeoDib
The NeoDib is used to contain an image in memory as a Device Independent Bitmap. The internal memory is in RgbColor/RgbwColor format. While it is not a raster (x,y) format, it is listed here for completeness.
## Image Plug In
To create the PROGMEM data structure that contains your image, you can use the [free Paint.Net](http://www.getpaint.net/download.html) program with the [Arduino NeoPixel Sketch Exporter Paint.Net plugin](http://forums.getpaint.net/index.php?/topic/107921-arduino-neopixel-sketch-exporter/?p=515063). These tools will export your images into a .h file. An example image and files are present with the NeoPixelBufferCylon example.