Package heronarts.lx.output

Class LXOutput

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.output.LXOutput

All Implemented Interfaces:

LXPath, LXSerializable, LXParameterListener

Direct Known Subclasses:

LXBufferOutput, LXOutputGroup, LXStructureOutput

public abstract class LXOutput
extends LXComponent

This class represents the output stage from the LX engine to real devices. Outputs may have their own brightness, be enabled/disabled, be throttled, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LXOutput.GammaMode
static class	LXOutput.GammaTable
static interface	LXOutput.InetOutput

Nested classes/interfaces inherited from class heronarts.lx.LXComponent

LXComponent.Description, LXComponent.Hidden, LXComponent.Name, LXComponent.Placeholder, LXComponent.PluginRequired, LXComponent.Renamable

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final CompoundParameter	brightness	Brightness of the output
final BooleanParameter	enabled	Whether the output is enabled.
final BoundedParameter	framesPerSecond	Framerate throttle
final BoundedParameter	gamma	Gamma correction level
final EnumParameter<LXOutput.GammaMode>	gammaMode	Gamma table mode, whether to inherit gamma
static final float	MAX_FRAMES_PER_SECOND
final DiscreteParameter	whitePointBlue	White point scaling for blue pixels
final DiscreteParameter	whitePointGreen	White point scaling for green pixels
final DiscreteParameter	whitePointRed	White point scaling for red pixels
final DiscreteParameter	whitePointWhite	White point scaling for white pixels (if present)

Fields inherited from class heronarts.lx.LXComponent

childArrays, children, internalParameters, KEY_CHILDREN, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, lx, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LXOutput(LX lx)
protected	LXOutput(LX lx, String label)

Method Summary

Modifier and Type	Method	Description
static final void	error(Exception x, String message)
static final void	error(String message)
void	load(LX lx, JsonObject obj)	Loads the LX component.
static final void	log(String message)
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.
protected abstract void	onSend(int[] colors, LXOutput.GammaTable glut, double brightness)	Subclasses implement this to send the data.
LXOutput	send(int[] colors)	Sends data to this output, applying throttle and color correction
final LXOutput	send(int[] colors, double brightness)	Sends data to this output at the pre-corrected brightness
void	setGammaDelegate(LXOutput gammaDelegate)
void	setGammaTable(byte[][] gammaLut)	Deprecated.
void	setGammaTable(LXOutput.GammaTable gammaLut)	Assigns a custom gamma table to the output
void	setGroup(LXOutputGroup output)

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, dispose, getCategory, getChild, getComponentDescription, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, hasParameter, isValidOscParameter, loadParameters, loadPreset, removeParameter, removeParameter, removeParameter, removeParameter, save, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

MAX_FRAMES_PER_SECOND

public static final float MAX_FRAMES_PER_SECOND

See Also:

• Constant Field Values

enabled

public final BooleanParameter enabled

Whether the output is enabled.

framesPerSecond

public final BoundedParameter framesPerSecond

Framerate throttle

gamma

public final BoundedParameter gamma

Gamma correction level

gammaMode

public final EnumParameter<LXOutput.GammaMode> gammaMode

Gamma table mode, whether to inherit gamma

brightness

public final CompoundParameter brightness

Brightness of the output

whitePointRed

public final DiscreteParameter whitePointRed

White point scaling for red pixels

whitePointGreen

public final DiscreteParameter whitePointGreen

White point scaling for green pixels

whitePointBlue

public final DiscreteParameter whitePointBlue

White point scaling for blue pixels

whitePointWhite

public final DiscreteParameter whitePointWhite

White point scaling for white pixels (if present)

Constructor Details

LXOutput

protected LXOutput(LX lx)

LXOutput

protected LXOutput(LX lx,
 String label)

Method Details

setGammaTable

@Deprecated
public void setGammaTable(byte[][] gammaLut)

Deprecated.

Assigns a custom gamma table to the output

Parameters:

gammaLut - Two-dimensional array lookup of gamma curve for each precomputed brightness [0-255][0-255]

setGammaTable

public void setGammaTable(LXOutput.GammaTable gammaLut)

Assigns a custom gamma table to the output

Parameters:

gammaLut - Gamma lookup tables

setGammaDelegate

public void setGammaDelegate(LXOutput gammaDelegate)

setGroup

public void setGroup(LXOutputGroup output)

onParameterChanged

public void onParameterChanged(LXParameter p)

Description copied from class: LXComponent

Subclasses are free to override this if desired. It will automatically fire for any listenable parameter that is registered with this component.

Specified by:

onParameterChanged in interface LXParameterListener

Overrides:

onParameterChanged in class LXComponent

Parameters:

p - Parameter that has a value change

send

public LXOutput send(int[] colors)

Sends data to this output, applying throttle and color correction

Parameters:

colors - Array of color values

Returns:

this

send

public final LXOutput send(int[] colors,
 double brightness)

Sends data to this output at the pre-corrected brightness

Parameters:

colors - Color buffer

brightness - Brightness level from parent

Returns:

this

onSend

protected abstract void onSend(int[] colors,
 LXOutput.GammaTable glut,
 double brightness)

Subclasses implement this to send the data.

Parameters:

colors - Color values

glut - Look-up table for 0-255 brightness curves

brightness - Master brightness value

load

public void load(LX lx,
 JsonObject obj)

Description copied from class: LXComponent

Loads the LX component. Restores the ID of the component, as well as its internal and user-facing parameters. Any explicitly registered children will be automatically loaded, so long as they are direct descendants. Dynamic arrays will not be automatically loaded, this is left to subclasses to implement.

Specified by:

load in interface LXSerializable

Overrides:

load in class LXComponent

Parameters:

lx - LX instance

obj - Object to deserialize

log

public static final void log(String message)

error

public static final void error(String message)

error

public static final void error(Exception x,
 String message)