FloatBuffer (gwt-nio 0.1 API)

java.lang.Object
- java.nio.Buffer
- - java.nio.FloatBuffer

All Implemented Interfaces:

Comparable<FloatBuffer>, HasArrayBufferView
```
public final class FloatBuffer
extends Buffer
implements Comparable<FloatBuffer>, HasArrayBufferView
```
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;
- Use ByteBuffer.asFloatBuffer to create a float buffer based on a byte buffer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FloatBuffer`	`allocate(int capacity)` Creates a float buffer based on a newly allocated float array.
`FloatBuffer`	`compact()` Compacts this float buffer.
`int`	`compareTo(FloatBuffer otherBuffer)` Compare the remaining floats of this buffer to another float buffer's remaining floats.
`FloatBuffer`	`duplicate()` Returns a duplicated buffer that shares its content with this buffer.
`boolean`	`equals(Object other)` Checks whether this float buffer is equal to another object.
`float`	`get()` Returns the float at the current position and increases the position by 1.
`FloatBuffer`	`get(float[] dest)` Reads floats from the current position into the specified float array and increases the position by the number of floats read.
`FloatBuffer`	`get(float[] dest, int off, int len)` 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.
`float`	`get(int index)` Returns a float at the specified index; the position is not changed.
`int`	`getElementSize()` Returns the element size in bytes (e.g.
`int`	`getElementType()` Returns the open GL element type constant corresponding to the buffer contents.
`elemental2.core.ArrayBufferView`	`getTypedArray()`
`boolean`	`hasArray()` Indicates whether this buffer is based on a float array and is read/write.
`boolean`	`isDirect()` Indicates whether this buffer is direct.
`boolean`	`isReadOnly()` Indicates whether this buffer is read-only.
`ByteOrder`	`order()` Returns the byte order used by this buffer when converting floats from/to bytes.
`FloatBuffer`	`put(float c)` Writes the given float to the current position and increases the position by 1.
`FloatBuffer`	`put(float[] src)` Writes floats from the given float array to the current position and increases the position by the number of floats written.
`FloatBuffer`	`put(float[] src, int off, int len)` 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.
`FloatBuffer`	`put(FloatBuffer src)` 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.
`FloatBuffer`	`put(int index, float c)` Writes a float to the specified index of this buffer; the position is not changed.
`FloatBuffer`	`slice()` Returns a sliced buffer that shares its content with this buffer.
`String`	`toString()` Returns a string representing the state of this float buffer.

Methods inherited from class java.nio.Buffer
capacity, clear, flip, hasRemaining, limit, limit, mark, position, position, remaining, reset, rewind

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - allocate
```
public static FloatBuffer allocate(int capacity)
```
    Creates a float buffer based on a newly allocated float array.
    
    Parameters:
    
    capacity - the capacity of the new buffer.
    
    Returns:
    
    the created float buffer.
    
    Throws:
    
    IllegalArgumentException - if capacity is less than zero.
  - compact
```
public FloatBuffer compact()
```
    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.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - compareTo
```
public int compareTo(FloatBuffer otherBuffer)
```
    Compare the remaining floats of this buffer to another float buffer's remaining floats.
    
    Specified by:
    
    compareTo in interface Comparable<FloatBuffer>
    
    Parameters:
    
    otherBuffer - another float buffer.
    
    Returns:
    
    a negative value if this is less than otherBuffer; 0 if this equals to otherBuffer; a positive value if this is greater than otherBuffer.
    
    Throws:
    
    ClassCastException - if otherBuffer is not a float buffer.
  - duplicate
```
public FloatBuffer duplicate()
```
    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 buffer's position, limit and mark are independent.
    
    Returns:
    
    a duplicated buffer that shares its content with this buffer.
  - equals
```
public boolean equals(Object other)
```
    Checks whether this float buffer is equal to another object.
    If other is not a float buffer then false is returned. Two float buffers are equal if and only if their remaining floats are exactly the same. Position, limit, capacity and mark are not considered.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - the object to compare with this float buffer.
    
    Returns:
    
    true if this float buffer is equal to other, false otherwise.
  - get
```
public float get()
```
    Returns the float at the current position and increases the position by 1.
    
    Returns:
    
    the float at the current position.
    
    Throws:
    
    BufferUnderflowException - if the position is equal or greater than limit.
  - get
```
public FloatBuffer get(float[] dest)
```
    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(dest, 0, dest.length).
    
    Parameters:
    
    dest - the destination float array.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    BufferUnderflowException - if dest.length is greater than remaining().
  - get
```
public FloatBuffer get(float[] dest,
                       int off,
                       int len)
```
    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.
    
    Parameters:
    
    dest - the target float array.
    
    off - the offset of the float array, must not be negative and no greater than dest.length.
    
    len - the number of floats to read, must be no less than zero and no greater than dest.length - off.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    IndexOutOfBoundsException - if either off or len is invalid.
    
    BufferUnderflowException - if len is greater than remaining().
  - get
```
public float get(int index)
```
    Returns a float at the specified index; the position is not changed.
    
    Parameters:
    
    index - the index, must not be negative and less than limit.
    
    Returns:
    
    a float at the specified index.
    
    Throws:
    
    IndexOutOfBoundsException - if index is invalid.
  - hasArray
```
public final boolean hasArray()
```
    Indicates whether this buffer is based on a float array and is read/write.
    
    Returns:
    
    true if this buffer is based on a float array and provides read/write access, false otherwise.
  - isDirect
```
public boolean isDirect()
```
    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.
    
    Returns:
    
    true if this buffer is direct, false otherwise.
  - order
```
public ByteOrder order()
```
    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.
    
    Returns:
    
    the byte order used by this buffer when converting floats from/to bytes.
  - put
```
public FloatBuffer put(float c)
```
    Writes the given float to the current position and increases the position by 1.
    
    Parameters:
    
    f - the float to write.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    BufferOverflowException - if position is equal or greater than limit.
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - put
```
public final FloatBuffer put(float[] src)
```
    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).
    
    Parameters:
    
    src - the source float array.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    BufferOverflowException - if remaining() is less than src.length.
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - put
```
public FloatBuffer put(float[] src,
                       int off,
                       int len)
```
    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.
    
    Parameters:
    
    src - the source float array.
    
    off - the offset of float array, must not be negative and not greater than src.length.
    
    len - the number of floats to write, must be no less than zero and no greater than src.length - off.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    BufferOverflowException - if remaining() is less than len.
    
    IndexOutOfBoundsException - if either off or len is invalid.
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - put
```
public FloatBuffer put(FloatBuffer src)
```
    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.
    
    Parameters:
    
    src - the source float buffer.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    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.
  - put
```
public FloatBuffer put(int index,
                       float c)
```
    Writes a float to the specified index of this buffer; the position is not changed.
    
    Parameters:
    
    index - the index, must not be negative and less than the limit.
    
    f - the float to write.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    IndexOutOfBoundsException - if index is invalid.
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - slice
```
public FloatBuffer slice()
```
    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 buffer's position, limit and mark are independent.
    
    Returns:
    
    a sliced buffer that shares its content with this buffer.
  - toString
```
public String toString()
```
    Returns a string representing the state of this float buffer.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representing the state of this float buffer.
  - getTypedArray
```
public elemental2.core.ArrayBufferView getTypedArray()
```
    Specified by:
    
    getTypedArray in interface HasArrayBufferView
  - getElementSize
```
public int getElementSize()
```
    Description copied from interface: HasArrayBufferView
    
    Returns the element size in bytes (e.g. 4 for a FloatBuffer and 1 for a ByteBuffer).
    
    Specified by:
    
    getElementSize in interface HasArrayBufferView
  - getElementType
```
public int getElementType()
```
    Description copied from interface: HasArrayBufferView
    
    Returns the open GL element type constant corresponding to the buffer contents.
    
    Specified by:
    
    getElementType in interface HasArrayBufferView
  - isReadOnly
```
public boolean isReadOnly()
```
    Description copied from class: Buffer
    
    Indicates whether this buffer is read-only.
    
    Specified by:
    
    isReadOnly in class Buffer
    
    Returns:
    
    true if this buffer is read-only, false otherwise.

Class FloatBuffer

Method Summary

Methods inherited from class java.nio.Buffer

Methods inherited from class java.lang.Object

Method Detail

allocate

compact

compareTo

duplicate

equals

get

get

get

get

hasArray

isDirect

order

put

put

put

put

put

slice

toString

getTypedArray

getElementSize

getElementType

isReadOnly