java.lang.Object | ||
↳ | java.nio.Buffer | |
↳ | java.nio.FloatBuffer |
A buffer of floats.
A float buffer can be created in either of the following ways:
Allocate
a new float array and create a buffer
based on it;Wrap
an existing float array to create a new
buffer;ByteBuffer.asFloatBuffer
to create a float buffer based on a byte buffer.Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a float buffer based on a newly allocated float array.
| |||||||||||
Returns the array that backs this buffer (optional operation).
| |||||||||||
Returns the offset into the array returned by
array of the first
element of the buffer (optional operation). | |||||||||||
Returns a read-only buffer that shares its content with this buffer.
| |||||||||||
Compacts this float buffer.
| |||||||||||
Compare the remaining floats of this buffer to another float buffer's
remaining floats.
| |||||||||||
Returns a duplicated buffer that shares its content with this buffer.
| |||||||||||
Checks whether this float buffer is equal to another object.
| |||||||||||
Returns a float at the specified index; the position is not changed.
| |||||||||||
Reads floats from the current position into the specified float array,
starting from the specified offset, and increases the position by the
number of floats read.
| |||||||||||
Returns the float at the current position and increases the position by
1.
| |||||||||||
Reads floats from the current position into the specified float array and
increases the position by the number of floats read.
| |||||||||||
Returns true if
array and arrayOffset won't throw. | |||||||||||
Calculates this buffer's hash code from the remaining chars.
| |||||||||||
Indicates whether this buffer is direct.
| |||||||||||
Returns the byte order used by this buffer when converting floats from/to
bytes.
| |||||||||||
Writes a float to the specified index of this buffer; the position is not
changed.
| |||||||||||
Writes floats from the given float array, starting from the specified
offset, to the current position and increases the position by the number
of floats written.
| |||||||||||
Writes all the remaining floats of the
src float buffer to this
buffer's current position, and increases both buffers' position by the
number of floats copied. | |||||||||||
Writes floats from the given float array to the current position and
increases the position by the number of floats written.
| |||||||||||
Writes the given float to the current position and increases the position
by 1.
| |||||||||||
Returns a sliced buffer that shares its content with this buffer.
| |||||||||||
Creates a new float buffer by wrapping the given float array.
| |||||||||||
Creates a new float buffer by wrapping the given float array.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.nio.Buffer
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Comparable
|
Creates a float buffer based on a newly allocated float array.
capacity | the capacity of the new buffer. |
---|
IllegalArgumentException | if capacity is less than zero.
|
---|
Returns the array that backs this buffer (optional operation). The returned value is the actual array, not a copy, so modifications to the array write through to the buffer.
Subclasses should override this method with a covariant return type to provide the exact type of the array.
Use hasArray
to ensure this method won't throw.
(A separate call to isReadOnly
is not necessary.)
Returns the offset into the array returned by array
of the first
element of the buffer (optional operation). The backing array (if there is one)
is not necessarily the same size as the buffer, and position 0 in the buffer is
not necessarily the 0th element in the array. Use
buffer.array()[offset + buffer.arrayOffset()
to access element offset
in buffer
.
Use hasArray
to ensure this method won't throw.
(A separate call to isReadOnly
is not necessary.)
Returns a read-only buffer that shares its content with this buffer.
The returned buffer is guaranteed to be a new instance, even if this buffer is read-only itself. The new buffer's position, limit, capacity and mark are the same as this buffer.
The new buffer shares its content with this buffer, which means this buffer's change of content will be visible to the new buffer. The two buffer's position, limit and mark are independent.
Compacts this float buffer.
The remaining floats will be moved to the head of the buffer, starting
from position zero. Then the position is set to remaining()
; the
limit is set to capacity; the mark is cleared.
ReadOnlyBufferException | if no changes may be made to the contents of this buffer. |
---|
Compare the remaining floats of this buffer to another float buffer's remaining floats.
otherBuffer | another float buffer. |
---|
otherBuffer
; 0 if
this equals to otherBuffer
; a positive value if this is
greater than otherBuffer
.ClassCastException | if otherBuffer is not a float buffer.
|
---|
Returns a duplicated buffer that shares its content with this buffer.
The duplicated buffer's position, limit, capacity and mark are the same as this buffer. The duplicated buffer's read-only property and byte order are same as this buffer too.
The new buffer shares its content with this buffer, which means either buffer's change of content will be visible to the other. The two buffers' position, limit and mark are independent.
Checks whether this float buffer is equal to another object. If other
is not a FloatBuffer
then false
is returned.
Two float buffers are equal if their remaining floats are equal. Position, limit, capacity and mark are not considered.
This method considers two floats a
and b
to be equal
if a == b
or if a
and b
are both NaN
.
Unlike equals(Object)
, this method considers -0.0
and
+0.0
to be equal.
other | the object to compare with this float buffer. |
---|
true
if this float buffer is equal to other
,
false
otherwise.
Returns a float at the specified index; the position is not changed.
index | the index, must not be negative and less than limit. |
---|
IndexOutOfBoundsException | if index is invalid. |
---|
Reads floats from the current position into the specified float array, starting from the specified offset, and increases the position by the number of floats read.
dst | the target float array. |
---|---|
dstOffset | the offset of the float array, must not be negative and no
greater than dst.length . |
floatCount | the number of floats to read, must be no less than zero and no
greater than dst.length - dstOffset . |
IndexOutOfBoundsException | if either dstOffset or floatCount is invalid. |
---|---|
BufferUnderflowException | if floatCount is greater than remaining() .
|
Returns the float at the current position and increases the position by 1.
BufferUnderflowException | if the position is equal or greater than limit. |
---|
Reads floats from the current position into the specified float array and increases the position by the number of floats read.
Calling this method has the same effect as
get(dst, 0, dst.length)
.
dst | the destination float array. |
---|
BufferUnderflowException | if dst.length is greater than remaining() .
|
---|
Returns true if array
and arrayOffset
won't throw. This method does not
return true for buffers not backed by arrays because the other methods would throw
UnsupportedOperationException
, nor does it return true for buffers backed by
read-only arrays, because the other methods would throw ReadOnlyBufferException
.
Calculates this buffer's hash code from the remaining chars. The position, limit, capacity and mark don't affect the hash code.
Indicates whether this buffer is direct. A direct buffer will try its best to take advantage of native memory APIs and it may not stay in the Java heap, so it is not affected by garbage collection.
A float buffer is direct if it is based on a byte buffer and the byte buffer is direct.
true
if this buffer is direct, false
otherwise.
Returns the byte order used by this buffer when converting floats from/to bytes.
If this buffer is not based on a byte buffer, then always return the platform's native byte order.
Writes a float to the specified index of this buffer; the position is not changed.
index | the index, must not be negative and less than the limit. |
---|---|
f | the float to write. |
IndexOutOfBoundsException | if index is invalid. |
---|---|
ReadOnlyBufferException | if no changes may be made to the contents of this buffer. |
Writes floats from the given float array, starting from the specified offset, to the current position and increases the position by the number of floats written.
src | the source float array. |
---|---|
srcOffset | the offset of float array, must not be negative and not
greater than src.length . |
floatCount | the number of floats to write, must be no less than zero and
no greater than src.length - srcOffset . |
BufferOverflowException | if remaining() is less than floatCount . |
---|---|
IndexOutOfBoundsException | if either srcOffset or floatCount is invalid. |
ReadOnlyBufferException | if no changes may be made to the contents of this buffer. |
Writes all the remaining floats of the src
float buffer to this
buffer's current position, and increases both buffers' position by the
number of floats copied.
src | the source float buffer. |
---|
BufferOverflowException | if src.remaining() is greater than this buffer's
remaining() . |
---|---|
IllegalArgumentException | if src is this buffer. |
ReadOnlyBufferException | if no changes may be made to the contents of this buffer. |
Writes floats from the given float array to the current position and increases the position by the number of floats written.
Calling this method has the same effect as
put(src, 0, src.length)
.
src | the source float array. |
---|
BufferOverflowException | if remaining() is less than src.length . |
---|---|
ReadOnlyBufferException | if no changes may be made to the contents of this buffer. |
Writes the given float to the current position and increases the position by 1.
f | the float to write. |
---|
BufferOverflowException | if position is equal or greater than limit. |
---|---|
ReadOnlyBufferException | if no changes may be made to the contents of this buffer. |
Returns a sliced buffer that shares its content with this buffer.
The sliced buffer's capacity will be this buffer's remaining()
,
and its zero position will correspond to this buffer's current position.
The new buffer's position will be 0, limit will be its capacity, and its
mark is cleared. The new buffer's read-only property and byte order are
same as this buffer's.
The new buffer shares its content with this buffer, which means either buffer's change of content will be visible to the other. The two buffers' position, limit and mark are independent.
Creates a new float buffer by wrapping the given float array.
Calling this method has the same effect as
wrap(array, 0, array.length)
.
array | the float array which the new buffer will be based on. |
---|
Creates a new float buffer by wrapping the given float array.
The new buffer's position will be start
, limit will be
start + floatCount
, capacity will be the length of the array.
array | the float array which the new buffer will be based on. |
---|---|
start | the start index, must not be negative and not greater than
array.length . |
floatCount | the length, must not be negative and not greater than
array.length - start . |
IndexOutOfBoundsException | if either start or floatCount is invalid. |
---|---|
NullPointerException | if array is null.
|