OpenJDK 27 · java.awt.image.DataBufferFloat · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv float[][]	bankdata The array of data banks.
pack-priv float[]	data A reference to the default data bank.

Constructor Summary

Access	Constructor and Description
public	DataBufferFloat(int The number of elements in the DataBuffer. size) Constructs a `float`-based `DataBuffer` with a specified size.
public	DataBufferFloat(int The number of elements in each bank of the `DataBuffer`. size, int The number of banks in the `DataBuffer`. numBanks) Constructs a `float`-based `DataBuffer` with a specified number of banks, all of which are of a specified size.
public	DataBufferFloat(float[] An array of `float`s to be used as the first and only bank of this `DataBuffer`. dataArray, int The number of elements of the array to be used. size) Constructs a `float`-based `DataBuffer` with the specified data array.
public	DataBufferFloat(float[] An array of `float`s to be used as the first and only bank of this `DataBuffer`. dataArray, int The number of elements of the array to be used. size, int The offset of the first element of the array that will be used. offset) Constructs a `float`-based `DataBuffer` with the specified data array.
public	DataBufferFloat(float[][] An array of arrays of `float`s to be used as the banks of this `DataBuffer`. dataArray, int The number of elements of each array to be used. size) Constructs a `float`-based `DataBuffer` with the specified data arrays.
public	DataBufferFloat(float[][] An array of arrays of `float`s to be used as the banks of this `DataBuffer`. dataArray, int The number of elements of each array to be used. size, int[] An array of integer offsets, one for each bank. offsets) Constructs a `float`-based `DataBuffer` with the specified data arrays, size, and per-bank offsets.

Method Summary

Modifier and Type	Method and Description
public float[][]	Returns: all data arrays for this data buffer. getBankData() Returns the data array for all banks.
public float[]	Returns: the first float data array. getData() Returns the default (first) `float` data array.
public float[]	Returns: the data array specified by `bank`. getData(int the data array bank) Returns the data array for the specified bank.
public int	Returns: The data entry as an `int`. getElem(int The desired data array element. i) Overrides java.awt.image.DataBuffer.getElem. Returns the requested data array element from the first (default) bank as an `int`.
public int	Returns: The data entry as an `int`. getElem(int The bank number. bank, int The desired data array element. i) Implements abstract java.awt.image.DataBuffer.getElem. Returns the requested data array element from the specified bank as an `int`.
public double	Returns: The data entry as a `double`. getElemDouble(int The desired data array element. i) Overrides java.awt.image.DataBuffer.getElemDouble. Returns the requested data array element from the first (default) bank as a `double`.
public double	Returns: The data entry as a `double`. getElemDouble(int The bank number. bank, int The desired data array element. i) Overrides java.awt.image.DataBuffer.getElemDouble. Returns the requested data array element from the specified bank as a `double`.
public float	Returns: The data entry as a `float`. getElemFloat(int The desired data array element. i) Overrides java.awt.image.DataBuffer.getElemFloat. Returns the requested data array element from the first (default) bank as a `float`.
public float	Returns: The data entry as a `float`. getElemFloat(int The bank number. bank, int The desired data array element. i) Overrides java.awt.image.DataBuffer.getElemFloat. Returns the requested data array element from the specified bank as a `float`.
public void	setElem(int The desired data array element. i, int The value to be set. val) Overrides java.awt.image.DataBuffer.setElem. Sets the requested data array element in the first (default) bank to the given `int`.
public void	setElem(int The bank number. bank, int The desired data array element. i, int The value to be set. val) Implements abstract java.awt.image.DataBuffer.setElem. Sets the requested data array element in the specified bank to the given `int`.
public void	setElemDouble(int The desired data array element. i, double The value to be set. val) Overrides java.awt.image.DataBuffer.setElemDouble. Sets the requested data array element in the first (default) bank to the given `double`.
public void	setElemDouble(int The bank number. bank, int The desired data array element. i, double The value to be set. val) Overrides java.awt.image.DataBuffer.setElemDouble. Sets the requested data array element in the specified bank to the given `double`.
public void	setElemFloat(int The desired data array element. i, float The value to be set. val) Overrides java.awt.image.DataBuffer.setElemFloat. Sets the requested data array element in the first (default) bank to the given `float`.
public void	setElemFloat(int The bank number. bank, int The desired data array element. i, float The value to be set. val) Overrides java.awt.image.DataBuffer.setElemFloat. Sets the requested data array element in the specified bank to the given `float`.

Inherited from java.awt.image.DataBuffer:: checkArraySize checkArraySize checkBank checkBankSize checkIndex checkIndex checkNumBanks checkOffset checkSize getDataType getDataTypeSize getNumBanks getOffset getOffsets getSize toIntArray

Field Detail

bankdata	back to summary
pack-priv float[][] bankdata The array of data banks.

data	back to summary
pack-priv float[] data A reference to the default data bank.

Constructor Detail

DataBufferFloat back to summary

DataBufferFloat	back to summary
public DataBufferFloat(int size) Constructs a `float`-based `DataBuffer` with a specified size. Parameters size:int The number of elements in the DataBuffer. Exceptions IllegalArgumentException: if `size` is less than or equal to zero.

public DataBufferFloat(int size)

Constructs a float-based DataBuffer with a specified size.

Parameters

size:int: The number of elements in the DataBuffer.

Exceptions

IllegalArgumentException:: if size is less than or equal to zero.

DataBufferFloat back to summary

DataBufferFloat	back to summary
public DataBufferFloat(int size, int numBanks) Constructs a `float`-based `DataBuffer` with a specified number of banks, all of which are of a specified size. Parameters size:int The number of elements in each bank of the `DataBuffer`. numBanks:int The number of banks in the `DataBuffer`. Exceptions IllegalArgumentException: if `size` or `numBanks` is less than or equal to zero.

public DataBufferFloat(int size, int numBanks)

Constructs a float-based DataBuffer with a specified number of banks, all of which are of a specified size.

Parameters

size:int: The number of elements in each bank of the DataBuffer.
numBanks:int: The number of banks in the DataBuffer.

Exceptions

IllegalArgumentException:: if size or numBanks is less than or equal to zero.

DataBufferFloat back to summary

DataBufferFloat	back to summary
public DataBufferFloat(float[] dataArray, int size) Constructs a `float`-based `DataBuffer` with the specified data array. Only the first `size` elements are available for use by this `DataBuffer`. The array 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:float[] An array of `float`s to be used as the first and only bank of this `DataBuffer`. size:int The number of elements of the array to be used. Exceptions NullPointerException: if `dataArray` is `null`. IllegalArgumentException: if `size` is less than or equal to zero, or is greater than the length of `dataArray`.

public DataBufferFloat(float[] dataArray, int size)

Constructs a float-based DataBuffer with the specified data array. Only the first size elements are available for use by this DataBuffer. The array 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:float[]: An array of floats to be used as the first and only bank of this DataBuffer.
size:int: The number of elements of the array to be used.

Exceptions

NullPointerException:: if dataArray is null.
IllegalArgumentException:: if size is less than or equal to zero, or is greater than the length of dataArray.

DataBufferFloat back to summary

DataBufferFloat	back to summary
public DataBufferFloat(float[] dataArray, int size, int offset) Constructs a `float`-based `DataBuffer` with the specified data array. Only the elements between `offset` and `offset + size - 1` are available for use by this `DataBuffer`. The array must be large enough to hold `offset + 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:float[] An array of `float`s to be used as the first and only bank of this `DataBuffer`. size:int The number of elements of the array to be used. offset:int The offset of the first element of the array that will be used. Exceptions NullPointerException: if `dataArray` is `null`. IllegalArgumentException: if `size` is less than or equal to zero, or `offset` is less than zero, or `(offset + size)` is greater than the length of `dataArray`.

public DataBufferFloat(float[] dataArray, int size, int offset)

Constructs a float-based DataBuffer with the specified data array. Only the elements between offset and offset + size - 1 are available for use by this DataBuffer. The array must be large enough to hold offset + 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:float[]: An array of floats to be used as the first and only bank of this DataBuffer.
size:int: The number of elements of the array to be used.
offset:int: The offset of the first element of the array that will be used.

Exceptions

NullPointerException:: if dataArray is null.
IllegalArgumentException:: if size is less than or equal to zero, or offset is less than zero, or (offset + size) is greater than the length of dataArray.

DataBufferFloat back to summary

DataBufferFloat	back to summary
public DataBufferFloat(float[][] dataArray, int size) Constructs a `float`-based `DataBuffer` with the specified data arrays. Only the first `size` elements of each array are available for use by this `DataBuffer`. The number of banks will be equal to `dataArray.length`. 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:float[][] An array of arrays of `float`s to be used as the banks of this `DataBuffer`. size:int The number of elements of each array to be used. Exceptions NullPointerException: if `dataArray` is `null`. if any bank of `dataArray` is `null`. IllegalArgumentException: if `size` is less than or equal to zero. if `dataArray` does not have at least one bank. if the length of any bank of `dataArray` is less than `size`.

public DataBufferFloat(float[][] dataArray, int size)

Constructs a float-based DataBuffer with the specified data arrays. Only the first size elements of each array are available for use by this DataBuffer. The number of banks will be equal to dataArray.length.

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:float[][]: An array of arrays of floats to be used as the banks of this DataBuffer.
size:int: The number of elements of each array to be used.

Exceptions

NullPointerException:

if dataArray is null.
if any bank of dataArray is null.

IllegalArgumentException:

if size is less than or equal to zero.
if dataArray does not have at least one bank.
if the length of any bank of dataArray is less than size.

DataBufferFloat back to summary

DataBufferFloat	back to summary
public DataBufferFloat(float[][] dataArray, int size, int[] offsets) Constructs a `float`-based `DataBuffer` with the specified data arrays, size, and per-bank offsets. The number of banks is equal to `dataArray.length`. Each array must be at least as large as `size` plus the corresponding offset. There must be an entry in the offsets array for each data array. 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:float[][] An array of arrays of `float`s to be used as the banks of this `DataBuffer`. size:int The number of elements of each array to be used. offsets:int[] An array of integer offsets, one for each bank. Exceptions IllegalArgumentException: if `size` is less than or equal to zero. if `dataArray` does not have at least one bank. if any element of `offsets` is less than zero. if the length of any bank of `dataArray` is less than `(size + offsets[bankIndex])`. NullPointerException: if `dataArray` is `null`. if any bank of `dataArray` is `null`. if `offsets` is `null`. ArrayIndexOutOfBoundsException: if the lengths of `dataArray` and `offsets` differ.

public DataBufferFloat(float[][] dataArray, int size, int[] offsets)

Constructs a float-based DataBuffer with the specified data arrays, size, and per-bank offsets. The number of banks is equal to dataArray.length. Each array must be at least as large as size plus the corresponding offset. There must be an entry in the offsets array for each data array.

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:float[][]: An array of arrays of floats to be used as the banks of this DataBuffer.
size:int: The number of elements of each array to be used.
offsets:int[]: An array of integer offsets, one for each bank.

Exceptions

IllegalArgumentException:

if size is less than or equal to zero.
if dataArray does not have at least one bank.
if any element of offsets is less than zero.
if the length of any bank of dataArray is less than (size + offsets[bankIndex]).

NullPointerException:

if dataArray is null.
if any bank of dataArray is null.
if offsets is null.

ArrayIndexOutOfBoundsException:

if the lengths of dataArray and offsets differ.

Method Detail

getBankData back to summary

getBankData	back to summary
public float[][] getBankData() Returns the data array 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:float[][] all data arrays for this data buffer.

public float[][] getBankData()

Returns the data array 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:float[][]: all data arrays for this data buffer.

getData back to summary

getData	back to summary
public float[] getData() Returns the default (first) `float` 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:float[] the first float data array.

public float[] getData()

Returns the default (first) float 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:float[]: the first float data array.

getData back to summary

getData	back to summary
public float[] 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:int the data array Returns:float[] the data array specified by `bank`. Exceptions ArrayIndexOutOfBoundsException: if `bank` is not a valid bank index.

public float[] 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:int: the data array

Returns:float[]

the data array specified by bank.

Exceptions

ArrayIndexOutOfBoundsException:: if bank is not a valid bank index.

getElem back to summary

getElem	back to summary
public int getElem(int i) Overrides java.awt.image.DataBuffer.getElem. Returns the requested data array element from the first (default) bank as an `int`. Parameters i:int The desired data array element. Returns:int The data entry as an `int`. Exceptions ArrayIndexOutOfBoundsException: if `(i + getOffset())` is not a valid index. See Also `setElem(int, int)`, `setElem(int, int, int)`

public int getElem(int i)

Overrides java.awt.image.DataBuffer.getElem.

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

Parameters

i:int: The desired data array element.

Returns:int

The data entry as an int.

Exceptions

ArrayIndexOutOfBoundsException:: if (i + getOffset()) is not a valid index.

getElem back to summary

getElem	back to summary
public int getElem(int bank, int i) Implements abstract java.awt.image.DataBuffer.getElem. Returns the requested data array element from the specified bank as an `int`. Parameters bank:int The bank number. i:int The desired data array element. Returns:int The data entry as an `int`. Exceptions ArrayIndexOutOfBoundsException: if `bank` is not a valid bank index, or `(i + getOffsets()[bank])` is not a valid index into the bank. See Also `setElem(int, int)`, `setElem(int, int, int)`

public int getElem(int bank, int i)

Implements abstract java.awt.image.DataBuffer.getElem.

Returns the requested data array element from the specified bank as an int.

Parameters

bank:int: The bank number.
i:int: The desired data array element.

Returns:int

The data entry as an int.

Exceptions

ArrayIndexOutOfBoundsException:: if bank is not a valid bank index, or (i + getOffsets()[bank]) is not a valid index into the bank.

getElemDouble back to summary

getElemDouble	back to summary
public double getElemDouble(int i) Overrides java.awt.image.DataBuffer.getElemDouble. Returns the requested data array element from the first (default) bank as a `double`. Parameters i:int The desired data array element. Returns:double The data entry as a `double`. Exceptions ArrayIndexOutOfBoundsException: if `(i + getOffset())` is not a valid index. See Also `setElemDouble(int, double)`, `setElemDouble(int, int, double)`

public double getElemDouble(int i)

Overrides java.awt.image.DataBuffer.getElemDouble.

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

Parameters

i:int: The desired data array element.

Returns:double

The data entry as a double.

Exceptions

ArrayIndexOutOfBoundsException:: if (i + getOffset()) is not a valid index.

getElemDouble back to summary

getElemDouble	back to summary
public double getElemDouble(int bank, int i) Overrides java.awt.image.DataBuffer.getElemDouble. Returns the requested data array element from the specified bank as a `double`. Parameters bank:int The bank number. i:int The desired data array element. Returns:double The data entry as a `double`. Exceptions ArrayIndexOutOfBoundsException: if `bank` is not a valid bank index, or `(i + getOffsets()[bank])` is not a valid index into the bank. See Also `setElemDouble(int, double)`, `setElemDouble(int, int, double)`

public double getElemDouble(int bank, int i)

Overrides java.awt.image.DataBuffer.getElemDouble.

Returns the requested data array element from the specified bank as a double.

Parameters

bank:int: The bank number.
i:int: The desired data array element.

Returns:double

The data entry as a double.

Exceptions

ArrayIndexOutOfBoundsException:: if bank is not a valid bank index, or (i + getOffsets()[bank]) is not a valid index into the bank.

getElemFloat back to summary

getElemFloat	back to summary
public float getElemFloat(int i) Overrides java.awt.image.DataBuffer.getElemFloat. Returns the requested data array element from the first (default) bank as a `float`. Parameters i:int The desired data array element. Returns:float The data entry as a `float`. Exceptions ArrayIndexOutOfBoundsException: if `(i + getOffset())` is not a valid index. See Also `setElemFloat(int, float)`, `setElemFloat(int, int, float)`

public float getElemFloat(int i)

Overrides java.awt.image.DataBuffer.getElemFloat.

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

Parameters

i:int: The desired data array element.

Returns:float

The data entry as a float.

Exceptions

ArrayIndexOutOfBoundsException:: if (i + getOffset()) is not a valid index.

getElemFloat back to summary

getElemFloat	back to summary
public float getElemFloat(int bank, int i) Overrides java.awt.image.DataBuffer.getElemFloat. Returns the requested data array element from the specified bank as a `float`. Parameters bank:int The bank number. i:int The desired data array element. Returns:float The data entry as a `float`. Exceptions ArrayIndexOutOfBoundsException: if `bank` is not a valid bank index, or `(i + getOffsets()[bank])` is not a valid index into the bank. See Also `setElemFloat(int, float)`, `setElemFloat(int, int, float)`

public float getElemFloat(int bank, int i)

Overrides java.awt.image.DataBuffer.getElemFloat.

Returns the requested data array element from the specified bank as a float.

Parameters

bank:int: The bank number.
i:int: The desired data array element.

Returns:float

The data entry as a float.

Exceptions

ArrayIndexOutOfBoundsException:: if bank is not a valid bank index, or (i + getOffsets()[bank]) is not a valid index into the bank.

setElem back to summary

setElem	back to summary
public void setElem(int i, int val) Overrides java.awt.image.DataBuffer.setElem. Sets the requested data array element in the first (default) bank to the given `int`. Parameters i:int The desired data array element. val:int The value to be set. Exceptions ArrayIndexOutOfBoundsException: if `(i + getOffset())` is not a valid index. See Also `getElem(int)`, `getElem(int, int)`

public void setElem(int i, int val)

Overrides java.awt.image.DataBuffer.setElem.

Sets the requested data array element in the first (default) bank to the given int.

Parameters

i:int: The desired data array element.
val:int: The value to be set.

Exceptions

ArrayIndexOutOfBoundsException:: if (i + getOffset()) is not a valid index.

See Also

getElem(int), getElem(int, int)

setElem back to summary

setElem	back to summary
public void setElem(int bank, int i, int val) Implements abstract java.awt.image.DataBuffer.setElem. Sets the requested data array element in the specified bank to the given `int`. Parameters bank:int The bank number. i:int The desired data array element. val:int The value to be set. Exceptions ArrayIndexOutOfBoundsException: if `bank` is not a valid bank index, or `(i + getOffsets()[bank])` is not a valid index into the bank. See Also `getElem(int)`, `getElem(int, int)`

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

Implements abstract java.awt.image.DataBuffer.setElem.

Sets the requested data array element in the specified bank to the given int.

Parameters

bank:int: The bank number.
i:int: The desired data array element.
val:int: The value to be set.

Exceptions

ArrayIndexOutOfBoundsException:: if bank is not a valid bank index, or (i + getOffsets()[bank]) is not a valid index into the bank.

See Also

getElem(int), getElem(int, int)

setElemDouble back to summary

setElemDouble	back to summary
public void setElemDouble(int i, double val) Overrides java.awt.image.DataBuffer.setElemDouble. Sets the requested data array element in the first (default) bank to the given `double`. Parameters i:int The desired data array element. val:double The value to be set. Exceptions ArrayIndexOutOfBoundsException: if `(i + getOffset())` is not a valid index. See Also `getElemDouble(int)`, `getElemDouble(int, int)`

public void setElemDouble(int i, double val)

Overrides java.awt.image.DataBuffer.setElemDouble.

Sets the requested data array element in the first (default) bank to the given double.

Parameters

i:int: The desired data array element.
val:double: The value to be set.

Exceptions

ArrayIndexOutOfBoundsException:: if (i + getOffset()) is not a valid index.

setElemDouble back to summary

setElemDouble	back to summary
public void setElemDouble(int bank, int i, double val) Overrides java.awt.image.DataBuffer.setElemDouble. Sets the requested data array element in the specified bank to the given `double`. Parameters bank:int The bank number. i:int The desired data array element. val:double The value to be set. Exceptions ArrayIndexOutOfBoundsException: if `bank` is not a valid bank index, or `(i + getOffsets()[bank])` is not a valid index into the bank. See Also `getElemDouble(int)`, `getElemDouble(int, int)`

public void setElemDouble(int bank, int i, double val)

Overrides java.awt.image.DataBuffer.setElemDouble.

Sets the requested data array element in the specified bank to the given double.

Parameters

bank:int: The bank number.
i:int: The desired data array element.
val:double: The value to be set.

Exceptions

ArrayIndexOutOfBoundsException:: if bank is not a valid bank index, or (i + getOffsets()[bank]) is not a valid index into the bank.

setElemFloat back to summary

setElemFloat	back to summary
public void setElemFloat(int i, float val) Overrides java.awt.image.DataBuffer.setElemFloat. Sets the requested data array element in the first (default) bank to the given `float`. Parameters i:int The desired data array element. val:float The value to be set. Exceptions ArrayIndexOutOfBoundsException: if `(i + getOffset())` is not a valid index. See Also `getElemFloat(int)`, `getElemFloat(int, int)`

public void setElemFloat(int i, float val)

Overrides java.awt.image.DataBuffer.setElemFloat.

Sets the requested data array element in the first (default) bank to the given float.

Parameters

i:int: The desired data array element.
val:float: The value to be set.

Exceptions

ArrayIndexOutOfBoundsException:: if (i + getOffset()) is not a valid index.

setElemFloat back to summary

setElemFloat	back to summary
public void setElemFloat(int bank, int i, float val) Overrides java.awt.image.DataBuffer.setElemFloat. Sets the requested data array element in the specified bank to the given `float`. Parameters bank:int The bank number. i:int The desired data array element. val:float The value to be set. Exceptions ArrayIndexOutOfBoundsException: if `bank` is not a valid bank index, or `(i + getOffsets()[bank])` is not a valid index into the bank. See Also `getElemFloat(int)`, `getElemFloat(int, int)`

public void setElemFloat(int bank, int i, float val)

Overrides java.awt.image.DataBuffer.setElemFloat.

Sets the requested data array element in the specified bank to the given float.

Parameters

bank:int: The bank number.
i:int: The desired data array element.
val:float: The value to be set.

Exceptions

ArrayIndexOutOfBoundsException:: if bank is not a valid bank index, or (i + getOffsets()[bank]) is not a valid index into the bank.

public final Class DataBufferFloat

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail