public final class

DataBufferUShort

extends DataBuffer
java.lang.Object
   ↳ java.awt.image.DataBuffer
     ↳ java.awt.image.DataBufferUShort

Class Overview

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

Note that some implementations may function more efficiently if they can maintain control over how the data for an image is stored. For example, optimizations such as caching an image in video memory require that the implementation track all modifications to that data. Other implementations may operate better if they can store the data in locations other than a Java array. To maintain optimum compatibility with various optimizations it is best to avoid constructors and methods which expose the underlying storage as a Java array as noted below in the documentation for those methods.

Summary

[Expand]
Inherited Constants
From class java.awt.image.DataBuffer
[Expand]
Inherited Fields
From class java.awt.image.DataBuffer
Public Constructors
DataBufferUShort(int size)
Constructs an unsigned-short based DataBuffer with a single bank and the specified size.
DataBufferUShort(int size, int numBanks)
Constructs an unsigned-short based DataBuffer with the specified number of banks, all of which are the specified size.
DataBufferUShort(short[] dataArray, int size)
Constructs an unsigned-short based DataBuffer with a single bank using the specified array.
DataBufferUShort(short[] dataArray, int size, int offset)
Constructs an unsigned-short based DataBuffer with a single bank using the specified array, size, and offset.
DataBufferUShort(short[][] dataArray, int size)
Constructs an unsigned-short based DataBuffer with the specified arrays.
DataBufferUShort(short[][] dataArray, int size, int[] offsets)
Constructs an unsigned-short based DataBuffer with specified arrays, size, and offsets.
Public Methods
short[][] getBankData()
Returns the data arrays for all banks.
short[] getData()
Returns the default (first) unsigned-short data array.
short[] getData(int bank)
Returns the data array for the specified bank.
int getElem(int bank, int i)
Returns the requested data array element from the specified bank.
int getElem(int i)
Returns the requested data array element from the first (default) bank.
void setElem(int i, int val)
Sets the requested data array element in the first (default) bank to the specified value.
void setElem(int bank, int i, int val)
Sets the requested data array element in the specified bank from the given integer.
[Expand]
Inherited Methods
From class java.awt.image.DataBuffer
From class java.lang.Object

Public Constructors

public DataBufferUShort (int size)

Constructs an unsigned-short based DataBuffer with a single bank and the specified size.

Parameters
size The size of the DataBuffer.

public DataBufferUShort (int size, int numBanks)

Constructs an unsigned-short 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.

public DataBufferUShort (short[] dataArray, int size)

Constructs an unsigned-short 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.

Note that DataBuffer objects created by this constructor may be incompatible with performance optimizations used by some implementations (such as caching an associated image in video memory).

Parameters
dataArray The unsigned-short array for the DataBuffer.
size The size of the DataBuffer bank.

public DataBufferUShort (short[] dataArray, int size, int offset)

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

Note that DataBuffer objects created by this constructor may be incompatible with performance optimizations used by some implementations (such as caching an associated image in video memory).

Parameters
dataArray The unsigned-short array for the DataBuffer.
size The size of the DataBuffer bank.
offset The offset into the dataArray.

public DataBufferUShort (short[][] dataArray, int size)

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

Note that DataBuffer objects created by this constructor may be incompatible with performance optimizations used by some implementations (such as caching an associated image in video memory).

Parameters
dataArray The unsigned-short arrays for the DataBuffer.
size The size of the banks in the DataBuffer.

public DataBufferUShort (short[][] dataArray, int size, int[] offsets)

Constructs an unsigned-short based DataBuffer with 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.

Note that DataBuffer objects created by this constructor may be incompatible with performance optimizations used by some implementations (such as caching an associated image in video memory).

Parameters
dataArray The unsigned-short arrays for the DataBuffer.
size The size of the banks in the DataBuffer.
offsets The offsets into each array.

Public Methods

public short[][] getBankData ()

Returns the data arrays for all banks.

Note that calling this method may cause this DataBuffer object to be incompatible with performance optimizations used by some implementations (such as caching an associated image in video memory).

Returns
  • All of the data arrays.

public short[] getData ()

Returns the default (first) unsigned-short data array.

Note that calling this method may cause this DataBuffer object to be incompatible with performance optimizations used by some implementations (such as caching an associated image in video memory).

Returns
  • The first unsigned-short data array.

public short[] getData (int bank)

Returns the data array for the specified bank.

Note that calling this method may cause this DataBuffer object to be incompatible with performance optimizations used by some implementations (such as caching an associated image in video memory).

Parameters
bank The bank whose data array you want to get.
Returns
  • The data array for the specified bank.

public int getElem (int bank, int i)

Returns the requested data array element from the specified bank.

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

public int getElem (int i)

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

Parameters
i The data array element you want to get.
Returns
  • The requested data array element as an integer.
See Also

public void setElem (int i, int val)

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

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

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

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

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