Package heronarts.lx.output

Class LXBufferOutput

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.output.LXOutput

heronarts.lx.output.LXBufferOutput

All Implemented Interfaces:

LXPath, LXSerializable, LXParameterListener

Direct Known Subclasses:

LXDatagram, LXSocket

public abstract class LXBufferOutput
extends LXOutput

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LXBufferOutput.ByteEncoder
static enum	LXBufferOutput.ByteOrder	Most common static orderings for RGB buffer data

Nested classes/interfaces inherited from class heronarts.lx.output.LXOutput

LXOutput.GammaMode, LXOutput.GammaTable, LXOutput.InetOutput

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

LXComponent.Hidden, LXComponent.Placeholder, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
protected final IndexBuffer	indexBuffer

Fields inherited from class heronarts.lx.output.LXOutput

brightness, enabled, framesPerSecond, gamma, gammaMode, MAX_FRAMES_PER_SECOND, whitePointBlue, whitePointGreen, whitePointRed, whitePointWhite

Fields inherited from class heronarts.lx.LXComponent

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

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LXBufferOutput(LX lx, IndexBuffer indexBuffer)

Method Summary

Modifier and Type	Method	Description
protected abstract byte[]	getDataBuffer()	Subclasses should provide a handle to a raw byte buffer
protected abstract int	getDataBufferOffset()	Offset into raw byte buffer where color data is written
protected LXBufferOutput	updateDataBuffer(int[] colors, LXOutput.GammaTable glut, double brightness)	Helper for subclasses to copy a list of points into the data buffer at a specified offset.

Methods inherited from class heronarts.lx.output.LXOutput

error, error, load, log, onParameterChanged, onSend, send, send, setGammaDelegate, setGammaTable, setGammaTable, setGroup

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, contains, copyParameters, dispose, getCategory, getChild, 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, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

indexBuffer

protected final IndexBuffer indexBuffer

Constructor Details

LXBufferOutput

protected LXBufferOutput(LX lx,
 IndexBuffer indexBuffer)

Method Details

getDataBuffer

protected abstract byte[] getDataBuffer()

Subclasses should provide a handle to a raw byte buffer

Returns:

Raw byte buffer for output data

getDataBufferOffset

protected abstract int getDataBufferOffset()

Offset into raw byte buffer where color data is written

Returns:

Offset into raw byte buffer for color data

updateDataBuffer

protected LXBufferOutput updateDataBuffer(int[] colors,
 LXOutput.GammaTable glut,
 double brightness)

Helper for subclasses to copy a list of points into the data buffer at a specified offset. For many subclasses which wrap RGB buffers, onSend() will be a simple call to this method with the right parameters.

Parameters:

colors - Array of color values

glut - Look-up tables for gamma-corrected brightness values by brightness

brightness - Master brightness

Returns:

this