com.diozero.ws281xj.LedDriverInterface Maven / Gradle / Ivy
package com.diozero.ws281xj;
/*-
* #%L
* Organisation: diozero
* Project: Device I/O Zero - WS281x Java Wrapper
* Filename: LedDriverInterface.java
*
* This file is part of the diozero project. More information about this project
* can be found at https://www.diozero.com/.
* %%
* Copyright (C) 2016 - 2021 diozero
* %%
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* #L%
*/
public interface LedDriverInterface extends AutoCloseable {
@Override
void close();
int getNumPixels();
/**
* Push any updated colours to the LED strip.
*/
void render();
/**
* Turn off all pixels and render.
*/
void allOff();
/**
* Get the current colour for the specified pixel.
* @param pixel Pixel number.
* @return 24-bit RGB colour value.
*/
int getPixelColour(int pixel);
/**
* Set the colour for the specified pixel.
* @param pixel Pixel number.
* @param colour Colour represented as a 24bit RGB integer (0x0RGB).
*/
void setPixelColour(int pixel, int colour);
/**
* Set the colour for the specified pixel using individual red / green / blue 8-bit values.
* @param pixel Pixel number.
* @param red 8-bit value for the red component.
* @param green 8-bit value for the green component.
* @param blue 8-bit value for the blue component.
*/
default void setPixelColourRGB(int pixel, int red, int green, int blue) {
setPixelColour(pixel, PixelColour.createColourRGB(red, green, blue));
}
/**
* Set the colour for the specified pixel using Hue Saturation Brightness (HSB) values.
* @param pixel Pixel number.
* @param hue Float value in the range 0..1 representing the hue.
* @param saturation Float value in the range 0..1 representing the colour saturation.
* @param brightness Float value in the range 0..1 representing the colour brightness.
*/
default void setPixelColourHSB(int pixel, float hue, float saturation, float brightness) {
setPixelColour(pixel, PixelColour.createColourHSB(hue, saturation, brightness));
}
/**
* Set the colour for the specified pixel using Hue Saturation Luminance (HSL) values.
* HSL colour mapping code taken from this HSL Color class by Rob Camick.
* @param pixel Pixel number.
* @param hue Represents the colour (think colours of the rainbow), specified in degrees from 0 - 360. Red is 0, green is 120 and blue is 240.
* @param saturation Represents the purity of the colour. Range is 0..1 with 1 fully saturated and 0 gray.
* @param luminance Represents the brightness of the colour. Range is 0..1 with 1 white 0 black.
*/
default void setPixelColourHSL(int pixel, float hue, float saturation, float luminance) {
setPixelColour(pixel, PixelColour.createColourHSL(hue, saturation, luminance));
}
/**
* Get the 8-bit red component value for the specified pixel.
* @param pixel Pixel number.
* @return 8-bit red component value.
*/
default int getRedComponent(int pixel) {
return PixelColour.getRedComponent(getPixelColour(pixel));
}
/**
* Set the 8-bit red component value for the specified pixel.
* @param pixel Pixel number.
* @param red 8-bit red component value.
*/
default void setRedComponent(int pixel, int red) {
setPixelColour(pixel, PixelColour.setRedComponent(getPixelColour(pixel), red));
}
/**
* Get the 8-bit green component value for the specified pixel.
* @param pixel Pixel number.
* @return 8-bit green component value.
*/
default int getGreenComponent(int pixel) {
return PixelColour.getGreenComponent(getPixelColour(pixel));
}
/**
* Set the 8-bit green component value for the specified pixel.
* @param pixel Pixel number.
* @param green 8-bit green component value.
*/
default void setGreenComponent(int pixel, int green) {
setPixelColour(pixel, PixelColour.setGreenComponent(getPixelColour(pixel), green));
}
/**
* Get the 8-bit blue component value for the specified pixel.
* @param pixel Pixel number.
* @return 8-bit blue component value.
*/
default int getBlueComponent(int pixel) {
return PixelColour.getBlueComponent(getPixelColour(pixel));
}
/**
* Set the 8-bit blue component value for the specified pixel.
* @param pixel Pixel number.
* @param blue 8-bit blue component value.
*/
default void setBlueComponent(int pixel, int blue) {
setPixelColour(pixel, PixelColour.setBlueComponent(getPixelColour(pixel), blue));
}
}