- java.lang.Object
-
- java.awt.image.DataBuffer
-
- java.awt.image.DataBufferUShort
-
public final class DataBufferUShort extends DataBuffer
This class extendsDataBuffer
and stores data internally as shorts. Values stored in the short array(s) of thisDataBuffer
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
Constructors Constructor and Description DataBufferUShort(int size)
Constructs an unsigned-short basedDataBuffer
with a single bank and the specified size.DataBufferUShort(int size, int numBanks)
Constructs an unsigned-short basedDataBuffer
with the specified number of banks, all of which are the specified size.DataBufferUShort(short[][] dataArray, int size)
Constructs an unsigned-short basedDataBuffer
with the specified arrays.DataBufferUShort(short[][] dataArray, int size, int[] offsets)
Constructs an unsigned-short basedDataBuffer
with specified arrays, size, and offsets.DataBufferUShort(short[] dataArray, int size)
Constructs an unsigned-short basedDataBuffer
with a single bank using the specified array.DataBufferUShort(short[] dataArray, int size, int offset)
Constructs an unsigned-short basedDataBuffer
with a single bank using the specified array, size, and offset.
-
Method Summary
Methods Modifier and Type Method and Description 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 i)
Returns the requested data array element from the first (default) bank.int
getElem(int bank, int i)
Returns the requested data array element from the specified 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.-
Methods inherited from class java.awt.image.DataBuffer
getDataType, getDataTypeSize, getElemDouble, getElemDouble, getElemFloat, getElemFloat, getNumBanks, getOffset, getOffsets, getSize, setElemDouble, setElemDouble, setElemFloat, setElemFloat
-
-
-
-
Constructor Detail
-
DataBufferUShort
public DataBufferUShort(int size)
Constructs an unsigned-short basedDataBuffer
with a single bank and the specified size.- Parameters:
size
- The size of theDataBuffer
.
-
DataBufferUShort
public DataBufferUShort(int size, int numBanks)
Constructs an unsigned-short basedDataBuffer
with the specified number of banks, all of which are the specified size.- Parameters:
size
- The size of the banks in theDataBuffer
.numBanks
- The number of banks in the aDataBuffer
.
-
DataBufferUShort
public DataBufferUShort(short[] dataArray, int size)
Constructs an unsigned-short basedDataBuffer
with a single bank using the specified array. Only the firstsize
elements should be used by accessors of thisDataBuffer
.dataArray
must be large enough to holdsize
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 theDataBuffer
.size
- The size of theDataBuffer
bank.
-
DataBufferUShort
public DataBufferUShort(short[] dataArray, int size, int offset)
Constructs an unsigned-short basedDataBuffer
with a single bank using the specified array, size, and offset.dataArray
must have at leastoffset
+size
elements. Only elementsoffset
throughoffset
+size
- 1 should be used by accessors of thisDataBuffer
.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 theDataBuffer
.size
- The size of theDataBuffer
bank.offset
- The offset into thedataArray
.
-
DataBufferUShort
public DataBufferUShort(short[][] dataArray, int size)
Constructs an unsigned-short basedDataBuffer
with the specified arrays. The number of banks will be equal todataArray.length
. Only the firstsize
elements of each array should be used by accessors of thisDataBuffer
.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 theDataBuffer
.size
- The size of the banks in theDataBuffer
.
-
DataBufferUShort
public DataBufferUShort(short[][] dataArray, int size, int[] offsets)
Constructs an unsigned-short basedDataBuffer
with specified arrays, size, and offsets. The number of banks is equal todataArray.length
. Each array must be at least as large assize
+ the corresponding offset. There must be an entry in the offset array for eachdataArray
entry. For each bank, only elementsoffset
throughoffset
+size
- 1 should be used by accessors of thisDataBuffer
.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 theDataBuffer
.size
- The size of the banks in theDataBuffer
.offsets
- The offsets into each array.
-
-
Method Detail
-
getData
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.
-
getData
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.
-
getBankData
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.
-
getElem
public int getElem(int i)
Returns the requested data array element from the first (default) bank.- Overrides:
getElem
in classDataBuffer
- Parameters:
i
- The data array element you want to get.- Returns:
- The requested data array element as an integer.
- See Also:
setElem(int, int)
,setElem(int, int, int)
-
getElem
public int getElem(int bank, int i)
Returns the requested data array element from the specified bank.- Specified by:
getElem
in classDataBuffer
- 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)
,setElem(int, int, int)
-
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
in classDataBuffer
- 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)
-
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
in classDataBuffer
- 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)
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/awt/image/DataBufferUShort.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.