DataBufferByte (Java 2 Platform SE 5.0) (original) (raw)

java.awt.image

Class DataBufferByte

java.lang.Object extended by java.awt.image.DataBuffer java.awt.image.DataBufferByte

public final class DataBufferByte

This class extends DataBuffer and stores data internally as bytes. Values stored in the byte array(s) of this DataBuffer are treated as unsigned values.

Field Summary

Fields inherited from class java.awt.image.DataBuffer
banks, dataType, offset, offsets, size, TYPE_BYTE, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INT, TYPE_SHORT, TYPE_UNDEFINED, TYPE_USHORT

Constructor Summary
[DataBufferByte](../../../java/awt/image/DataBufferByte.html#DataBufferByte%28byte[][], int%29)(byte[][] dataArray, int size) Constructs a byte-based DataBuffer with the specified arrays.
[DataBufferByte](../../../java/awt/image/DataBufferByte.html#DataBufferByte%28byte[][], int, int[]%29)(byte[][] dataArray, int size, int[] offsets) Constructs a byte-based DataBuffer with the specified arrays, size, and offsets.
[DataBufferByte](../../../java/awt/image/DataBufferByte.html#DataBufferByte%28byte[], int%29)(byte[] dataArray, int size) Constructs a byte-based DataBuffer with a single bank using the specified array.
[DataBufferByte](../../../java/awt/image/DataBufferByte.html#DataBufferByte%28byte[], int, int%29)(byte[] dataArray, int size, int offset) Constructs a byte-based DataBuffer with a single bank using the specified array, size, and offset.
DataBufferByte(int size) Constructs a byte-based DataBuffer with a single bank and the specified size.
[DataBufferByte](../../../java/awt/image/DataBufferByte.html#DataBufferByte%28int, int%29)(int size, int numBanks) Constructs a byte based DataBuffer with the specified number of banks all of which are the specified size.

Method Summary
byte[][]	getBankData() Returns the data arrays for all banks.
byte[]	getData() Returns the default (first) byte data array.
byte[]	getData(int bank) Returns the data array for the specified bank.
int	getElem(int i) Returns the requested data array element from the first (default) bank.
int	[getElem](../../../java/awt/image/DataBufferByte.html#getElem%28int, int%29)(int bank, int i) Returns the requested data array element from the specified bank.
void	[setElem](../../../java/awt/image/DataBufferByte.html#setElem%28int, int%29)(int i, int val) Sets the requested data array element in the first (default) bank to the specified value.
void	[setElem](../../../java/awt/image/DataBufferByte.html#setElem%28int, int, int%29)(int bank, int i, int val) Sets the requested data array element in the specified bank from the given integer.

Methods inherited from class java.awt.image.DataBuffer
getDataType, getDataTypeSize, getElemDouble, [getElemDouble](../../../java/awt/image/DataBuffer.html#getElemDouble%28int, int%29), getElemFloat, [getElemFloat](../../../java/awt/image/DataBuffer.html#getElemFloat%28int, int%29), getNumBanks, getOffset, getOffsets, getSize, [setElemDouble](../../../java/awt/image/DataBuffer.html#setElemDouble%28int, double%29), [setElemDouble](../../../java/awt/image/DataBuffer.html#setElemDouble%28int, int, double%29), [setElemFloat](../../../java/awt/image/DataBuffer.html#setElemFloat%28int, float%29), [setElemFloat](../../../java/awt/image/DataBuffer.html#setElemFloat%28int, int, float%29)

Methods inherited from class java.awt.image.DataBuffer

getDataType, getDataTypeSize, getElemDouble, [getElemDouble](../../../java/awt/image/DataBuffer.html#getElemDouble%28int, int%29), getElemFloat, [getElemFloat](../../../java/awt/image/DataBuffer.html#getElemFloat%28int, int%29), getNumBanks, getOffset, getOffsets, getSize, [setElemDouble](../../../java/awt/image/DataBuffer.html#setElemDouble%28int, double%29), [setElemDouble](../../../java/awt/image/DataBuffer.html#setElemDouble%28int, int, double%29), [setElemFloat](../../../java/awt/image/DataBuffer.html#setElemFloat%28int, float%29), [setElemFloat](../../../java/awt/image/DataBuffer.html#setElemFloat%28int, int, float%29)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

DataBufferByte

public DataBufferByte(int size)

Constructs a byte-based DataBuffer with a single bank and the specified size.

Parameters:

size - The size of the DataBuffer.

DataBufferByte

public DataBufferByte(int size, int numBanks)

Constructs a byte based DataBuffer with the specified number of banks all of which are the specified size.

Parameters:

size - The size of the banks in the DataBuffer.

numBanks - The number of banks in the aDataBuffer.

DataBufferByte

public DataBufferByte(byte[] dataArray, int size)

Constructs a byte-based DataBuffer with a single bank using the specified array. Only the first size elements should be used by accessors of this DataBuffer. dataArray must be large enough to hold size elements.

Parameters:

dataArray - The byte array for the DataBuffer.

size - The size of the DataBuffer bank.

DataBufferByte

public DataBufferByte(byte[] dataArray, int size, int offset)

Constructs a byte-based DataBuffer with a single bank using the specified array, size, and offset. dataArray must have at leastoffset + size elements. Only elements offset through offset + size - 1 should be used by accessors of this DataBuffer.

Parameters:

dataArray - The byte array for the DataBuffer.

size - The size of the DataBuffer bank.

offset - The offset into the dataArray. dataArray must have at least offset + size elements.

DataBufferByte

public DataBufferByte(byte[][] dataArray, int size)

Constructs a byte-based DataBuffer with the specified arrays. The number of banks is equal to dataArray.length. Only the first size elements of each array should be used by accessors of this DataBuffer.

Parameters:

dataArray - The byte arrays for the DataBuffer.

size - The size of the banks in the DataBuffer.

DataBufferByte

public DataBufferByte(byte[][] dataArray, int size, int[] offsets)

Constructs a byte-based DataBuffer with the specified arrays, size, and offsets. The number of banks is equal to dataArray.length. Each array must be at least as large as size + the corresponding offset. There must be an entry in the offset array for each dataArray entry. For each bank, only elements offset through offset + size - 1 should be used by accessors of this DataBuffer.

Parameters:

dataArray - The byte arrays for the DataBuffer.

size - The size of the banks in the DataBuffer.

offsets - The offsets into each array.

Method Detail

getData

public byte[] getData()

Returns the default (first) byte data array.

Returns:

The first byte data array.

getData

public byte[] getData(int bank)

Returns the data array for the specified bank.

Parameters:

bank - The bank whose data array you want to get.

Returns:

The data array for the specified bank.

getBankData

public byte[][] getBankData()

Returns the data arrays for all banks.

Returns:

All of the data arrays.

getElem

public int getElem(int i)

Returns the requested data array element from the first (default) bank.

Overrides:

[getElem](../../../java/awt/image/DataBuffer.html#getElem%28int%29) in class [DataBuffer](../../../java/awt/image/DataBuffer.html "class in java.awt.image")

Parameters:

i - The data array element you want to get.

Returns:

The requested data array element as an integer.

See Also:

[setElem(int, int)](../../../java/awt/image/DataBufferByte.html#setElem%28int, int%29), [setElem(int, int, int)](../../../java/awt/image/DataBufferByte.html#setElem%28int, int, int%29)

getElem

public int getElem(int bank, int i)

Returns the requested data array element from the specified bank.

Specified by:

[getElem](../../../java/awt/image/DataBuffer.html#getElem%28int, int%29) in class [DataBuffer](../../../java/awt/image/DataBuffer.html "class in java.awt.image")

Parameters:

bank - The bank from which you want to get a data array element.

i - The data array element you want to get.

Returns:

The requested data array element as an integer.

See Also:

[setElem(int, int)](../../../java/awt/image/DataBufferByte.html#setElem%28int, int%29), [setElem(int, int, int)](../../../java/awt/image/DataBufferByte.html#setElem%28int, int, int%29)

setElem

public void setElem(int i, int val)

Sets the requested data array element in the first (default) bank to the specified value.

Overrides:

[setElem](../../../java/awt/image/DataBuffer.html#setElem%28int, int%29) in class [DataBuffer](../../../java/awt/image/DataBuffer.html "class in java.awt.image")

Parameters:

i - The data array element you want to set.

val - The integer value to which you want to set the data array element.

See Also:

getElem(int), [getElem(int, int)](../../../java/awt/image/DataBufferByte.html#getElem%28int, int%29)

setElem

public void setElem(int bank, int i, int val)

Sets the requested data array element in the specified bank from the given integer.

Specified by:

[setElem](../../../java/awt/image/DataBuffer.html#setElem%28int, int, int%29) in class [DataBuffer](../../../java/awt/image/DataBuffer.html "class in java.awt.image")

Parameters:

bank - The bank in which you want to set the data array element.

i - The data array element you want to set.

val - The integer value to which you want to set the specified data array element.

See Also:

getElem(int), [getElem(int, int)](../../../java/awt/image/DataBufferByte.html#getElem%28int, int%29)

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.