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 and Description
static class	LXBufferOutput.ByteOrder Various orderings for RGB buffer data

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

LXOutput.GammaMode, LXOutput.InetOutput

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

LXComponent.Placeholder, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field and Description
protected LXBufferOutput.ByteOrder	byteOrder
protected LXBufferOutput.ByteOrder[]	byteOrderBuffer Wacky option to have a different byte-order per-pixel, which may be used in rare cases by JSONFixture.
protected int[]	indexBuffer

Fields inherited from class heronarts.lx.output.LXOutput

brightness, enabled, framesPerSecond, gamma, gammaMode

Fields inherited from class heronarts.lx.LXComponent

controlSurfaceSemaphore, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_PARAMETER_PATH, KEY_PATH, label, lx, modulationColor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LXBufferOutput(LX lx, int[] indexBuffer)
protected	LXBufferOutput(LX lx, int[] indexBuffer, LXBufferOutput.ByteOrder byteOrder)

Method Summary

Modifier and Type	Method and 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
LXBufferOutput	setByteOrder(LXBufferOutput.ByteOrder byteOrder) Sets the byte ordering of data in this buffer
LXBufferOutput	setByteOrder(LXBufferOutput.ByteOrder[] byteOrderBuffer) Sets a dynamic byte ordering on this output, where every index position may have a distinct byte ordering.
protected LXBufferOutput	updateDataBuffer(int[] colors, byte[] glut) Helper for subclasses to copy a list of points into the data buffer at a specified offset.
LXBufferOutput	updateIndexBuffer(int[] indexBuffer) Updates the values in the index buffer for this output.

Methods inherited from class heronarts.lx.output.LXOutput

error, error, getGammaLut, log, onParameterChanged, onSend, onSend, send, send, setGammaDelegate, setGroup

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addParameter, addParameter, contains, copyParameters, dispose, getChild, getComponentName, getComponentName, getComponentName, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, load, loadParameters, removeParameter, removeParameter, save, saveParameters, setParent, 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

get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter

Field Detail

byteOrder

protected LXBufferOutput.ByteOrder byteOrder

indexBuffer

protected final int[] indexBuffer

byteOrderBuffer

protected LXBufferOutput.ByteOrder[] byteOrderBuffer

Wacky option to have a different byte-order per-pixel, which may be used in rare cases by JSONFixture. This is supported but generally discouraged, as it obviously creates a great opportunity for confusion.

Constructor Detail

LXBufferOutput

protected LXBufferOutput(LX lx,
                         int[] indexBuffer)

LXBufferOutput

protected LXBufferOutput(LX lx,
                         int[] indexBuffer,
                         LXBufferOutput.ByteOrder byteOrder)

Method Detail

updateIndexBuffer

public LXBufferOutput updateIndexBuffer(int[] indexBuffer)

Updates the values in the index buffer for this output. The indices can change but the size of the output buffer cannot, the indexBuffer must have the same length. It will be copied into the index buffer object held by this output object.

Parameters:

indexBuffer - New index buffer values, must have same length as existing

Returns:

this

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

setByteOrder

public LXBufferOutput setByteOrder(LXBufferOutput.ByteOrder byteOrder)

Sets the byte ordering of data in this buffer

Parameters:

byteOrder - Byte ordering

Returns:

this

setByteOrder

public LXBufferOutput setByteOrder(LXBufferOutput.ByteOrder[] byteOrderBuffer)

Sets a dynamic byte ordering on this output, where every index position may have a distinct byte ordering. They must all have the same byte length as the original byte order. Intermixing different byte-lengths is not supported.

Parameters:

byteOrderBuffer - Array of byte orderings

Returns:

this

updateDataBuffer

protected LXBufferOutput updateDataBuffer(int[] colors,
                                          byte[] glut)

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 table of gamma-corrected brightness values

Returns:

this