All Downloads are FREE. Search and download functionalities are using the official Maven repository.

playn.super.java.nio.FloatBuffer Maven / Gradle / Ivy

There is a newer version: 2.0.8
Show newest version
/*
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package java.nio;

import com.google.gwt.typedarrays.shared.ArrayBufferView;
import com.google.gwt.typedarrays.shared.Float32Array;
import com.google.gwt.typedarrays.shared.TypedArrays;

/** A buffer of floats.
 * 

* A float buffer can be created in either of the following ways: *

*
    *
  • {@link #allocate(int) Allocate} a new float array and create a buffer based on it;
  • *
  • {@link #wrap(float[]) Wrap} an existing float array to create a new buffer;
  • *
  • Use {@link java.nio.ByteBuffer#asFloatBuffer() ByteBuffer.asFloatBuffer} to create a float buffer based on a byte buffer.
  • *
*/ public final class FloatBuffer extends Buffer implements Comparable, playn.html.HasArrayBufferView { private final ByteBuffer byteBuffer; private final Float32Array floatArray; static FloatBuffer wrap (ByteBuffer byteBuffer) { return new FloatBuffer(byteBuffer.slice()); } /** Creates a float buffer based on a newly allocated float array. * * @param capacity the capacity of the new buffer. * @return the created float buffer. * @throws IllegalArgumentException if {@code capacity} is less than zero. */ public static FloatBuffer allocate (int capacity) { if (capacity < 0) { throw new IllegalArgumentException(); } ByteBuffer bb = ByteBuffer.allocateDirect(capacity * 4); bb.order(ByteOrder.nativeOrder()); return bb.asFloatBuffer(); } FloatBuffer (ByteBuffer byteBuffer) { super((byteBuffer.capacity() >> 2)); this.byteBuffer = byteBuffer; this.byteBuffer.clear(); this.floatArray = TypedArrays.createFloat32Array( byteBuffer.byteArray.buffer(), byteBuffer.byteArray.byteOffset(), capacity); } /** 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 {@code remaining()}; the limit is set to capacity; the * mark is cleared.

* * @return this buffer. * @exception ReadOnlyBufferException if no changes may be made to the contents of this buffer. */ public FloatBuffer compact () { byteBuffer.limit(limit << 2); byteBuffer.position(position << 2); byteBuffer.compact(); byteBuffer.clear(); position = limit - position; limit = capacity; mark = UNSET_MARK; return this; } /** Compare the remaining floats of this buffer to another float buffer's remaining floats. * * @param otherBuffer another float buffer. * @return a negative value if this is less than {@code otherBuffer}; 0 if this equals to * {@code otherBuffer}; a positive value if this is greater than {@code otherBuffer}. * @exception ClassCastException if {@code otherBuffer} is not a float buffer. */ public int compareTo (FloatBuffer otherBuffer) { int compareRemaining = (remaining() < otherBuffer.remaining()) ? remaining() : otherBuffer.remaining(); int thisPos = position; int otherPos = otherBuffer.position; // BEGIN android-changed float thisFloat, otherFloat; while (compareRemaining > 0) { thisFloat = get(thisPos); otherFloat = otherBuffer.get(otherPos); // checks for float and NaN inequality if ((thisFloat != otherFloat) && ((thisFloat == thisFloat) || (otherFloat == otherFloat))) { return thisFloat < otherFloat ? -1 : 1; } thisPos++; otherPos++; compareRemaining--; } // END android-changed return remaining() - otherBuffer.remaining(); } /** 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.

* * @return a duplicated buffer that shares its content with this buffer. */ public FloatBuffer duplicate () { FloatBuffer buf = new FloatBuffer( (ByteBuffer)byteBuffer.duplicate()); buf.limit = limit; buf.position = position; buf.mark = mark; return buf; } /** Checks whether this float buffer is equal to another object. *

If {@code other} is not a float buffer then {@code 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.

* * @param other the object to compare with this float buffer. * @return {@code true} if this float buffer is equal to {@code other}, {@code false} otherwise. */ public boolean equals (Object other) { if (!(other instanceof FloatBuffer)) { return false; } FloatBuffer otherBuffer = (FloatBuffer)other; if (remaining() != otherBuffer.remaining()) { return false; } int myPosition = position; int otherPosition = otherBuffer.position; boolean equalSoFar = true; while (equalSoFar && (myPosition < limit)) { equalSoFar = get(myPosition++) == otherBuffer.get(otherPosition++); } return equalSoFar; } /** Returns the float at the current position and increases the position by 1. * * @return the float at the current position. * @exception BufferUnderflowException if the position is equal or greater than limit. */ public float get () { // if (position == limit) { // throw new BufferUnderflowException(); // } return floatArray.get(position++); } /** 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 {@code get(dest, 0, dest.length)}.

* * @param dest the destination float array. * @return this buffer. * @exception BufferUnderflowException if {@code dest.length} is greater than {@code remaining()}. */ public FloatBuffer get (float[] dest) { return get(dest, 0, dest.length); } /** 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. * * @param dest the target float array. * @param off the offset of the float array, must not be negative and no greater than {@code * dest.length}. * @param len the number of floats to read, must be no less than zero and no greater than * {@code dest.length - off}. * @return this buffer. * @exception IndexOutOfBoundsException if either {@code off} or {@code len} is invalid. * @exception BufferUnderflowException if {@code len} is greater than {@code remaining()}. */ public FloatBuffer get (float[] dest, int off, int len) { int length = dest.length; if (off < 0 || len < 0 || (long)off + (long)len > length) { throw new IndexOutOfBoundsException(); } if (len > remaining()) { throw new BufferUnderflowException(); } for (int i = off; i < off + len; i++) { dest[i] = get(); } return this; } /** Returns a float at the specified index; the position is not changed. * * @param index the index, must not be negative and less than limit. * @return a float at the specified index. * @exception IndexOutOfBoundsException if index is invalid. */ public float get (int index) { // if (index < 0 || index >= limit) { // throw new IndexOutOfBoundsException(); // } return floatArray.get(index); } /** Indicates whether this buffer is based on a float array and is read/write. * * @return {@code true} if this buffer is based on a float array and provides read/write * access, {@code false} otherwise. */ public final boolean hasArray () { return false; } // /** // * Calculates this buffer's hash code from the remaining chars. The // * position, limit, capacity and mark don't affect the hash code. // * // * @return the hash code calculated from the remaining floats. // * @since Android 1.0 // */ // public int hashCode() { // int myPosition = position; // int hash = 0; // while (myPosition < limit) { // hash = hash + Float.floatToIntBits(get(myPosition++)); // } // return hash; // } /** 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. *

* * @return {@code true} if this buffer is direct, {@code false} otherwise. */ public boolean isDirect () { return true; } /** 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.

* * @return the byte order used by this buffer when converting floats from/to bytes. */ public ByteOrder order () { return ByteOrder.nativeOrder(); } /** Writes the given float to the current position and increases the position by 1. * * @param f the float to write. * @return this buffer. * @exception BufferOverflowException if position is equal or greater than limit. * @exception ReadOnlyBufferException if no changes may be made to the contents of this buffer. */ public FloatBuffer put (float c) { // if (position == limit) { // throw new BufferOverflowException(); // } floatArray.set(position++, c); return this; } /** 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 {@code put(src, 0, src.length)}.

* * @param src the source float array. * @return this buffer. * @exception BufferOverflowException if {@code remaining()} is less than {@code src.length}. * @exception ReadOnlyBufferException if no changes may be made to the contents of this buffer. */ public final FloatBuffer put (float[] src) { return put(src, 0, src.length); } /** 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. * * @param src the source float array. * @param off the offset of float array, must not be negative and not greater than {@code src.length}. * @param len the number of floats to write, must be no less than zero and no greater than * {@code src.length - off}. * @return this buffer. * @exception BufferOverflowException if {@code remaining()} is less than {@code len}. * @exception IndexOutOfBoundsException if either {@code off} or {@code len} is invalid. * @exception ReadOnlyBufferException if no changes may be made to the contents of this buffer. */ public FloatBuffer put (float[] src, int off, int len) { int length = src.length; if (off < 0 || len < 0 || (long)off + (long)len > length) { throw new IndexOutOfBoundsException(); } if (len > remaining()) { throw new BufferOverflowException(); } for (int i = off; i < off + len; i++) { put(src[i]); } return this; } /** Writes all the remaining floats of the {@code src} float buffer to this buffer's current * position, and increases both buffers' position by the number of floats copied. * * @param src the source float buffer. * @return this buffer. * @exception BufferOverflowException if {@code src.remaining()} is greater than this buffer's * {@code remaining()}. * @exception IllegalArgumentException if {@code src} is this buffer. * @exception ReadOnlyBufferException if no changes may be made to the contents of this buffer. */ public FloatBuffer put (FloatBuffer src) { if (src == this) { throw new IllegalArgumentException(); } if (src.remaining() > remaining()) { throw new BufferOverflowException(); } float[] contents = new float[src.remaining()]; src.get(contents); put(contents); return this; } /** Writes a float to the specified index of this buffer; the position is not changed. * * @param index the index, must not be negative and less than the limit. * @param f the float to write. * @return this buffer. * @exception IndexOutOfBoundsException if index is invalid. * @exception ReadOnlyBufferException if no changes may be made to the contents of this buffer. */ public FloatBuffer put (int index, float c) { // if (index < 0 || index >= limit) { // throw new IndexOutOfBoundsException(); // } floatArray.set(index, c); return this; } /** Returns a sliced buffer that shares its content with this buffer. *

The sliced buffer's capacity will be this buffer's {@code 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.

* * @return a sliced buffer that shares its content with this buffer. */ public FloatBuffer slice () { byteBuffer.limit(limit << 2); byteBuffer.position(position << 2); FloatBuffer result = new FloatBuffer(byteBuffer.slice()); byteBuffer.clear(); return result; } /** Returns a string representing the state of this float buffer. * * @return a string representing the state of this float buffer. */ public String toString () { StringBuffer buf = new StringBuffer(); buf.append(getClass().getName()); buf.append(", status: capacity="); //$NON-NLS-1$ buf.append(capacity()); buf.append(" position="); //$NON-NLS-1$ buf.append(position()); buf.append(" limit="); //$NON-NLS-1$ buf.append(limit()); return buf.toString(); } public ArrayBufferView getTypedArray () { return floatArray; } public int getElementSize () { return 4; } public int getElementType() { return 0x1406; // GL_FLOAT } public boolean isReadOnly() { return false; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy