From 3e7fa51e057da8dc07ca1ff02e64814dd63b8aeb Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Wed, 18 Nov 2020 17:13:15 -0800 Subject: [PATCH] Updated NeoPixelBrightnessBus object (markdown) --- NeoPixelBrightnessBus-object.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/NeoPixelBrightnessBus-object.md b/NeoPixelBrightnessBus-object.md index 86466c7..df1db75 100644 --- a/NeoPixelBrightnessBus-object.md +++ b/NeoPixelBrightnessBus-object.md @@ -1,6 +1,8 @@ See [NeoPixeBus object](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object) for more details on the general use of this object. See [NeoPixelBrightnessBus object API Reference](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBrightnessBus-object-API) for more details on the methods exposed. +This object is provided for backward compatibility support with the Adafruit library and is not a recommended technique due to the unwanted pitfalls you will run into. See the NeoPixelBufferShader example for a better approach. + This object differs from the normal NeoPixelBus by supporting a strip wide brightness feature. This brightness allows one place to set and query a general brightness of the entire strip. When the brightness is changed, all pixels will be modified and any new colors being set will be modified. But this feature does come at a cost of sketch size and memory use. So if you don't need it; use the normal NeoPixelBus object instead.