ShortBuffer.Get Method

Definition

Namespace:

Java.Nio

Assembly:

Mono.Android.dll

Overloads

Get()	Relative get method.
Get(Int16[])	Relative bulk get method.
Get(Int32)	Absolute get method.
Get(Int16[], Int32, Int32)	Relative bulk get method.

Get()

Relative get method.

[Android.Runtime.Register("get", "()S", "GetGetHandler")]
public abstract short Get ();

[<Android.Runtime.Register("get", "()S", "GetGetHandler")>]
abstract member Get : unit -> int16

Returns

Int16

The short at the buffer's current position

Attributes

RegisterAttribute

Exceptions

BufferUnderflowException

if the position is equal or greater than limit.

Remarks

Relative get method. Reads the short at this buffer's current position, and then increments the position.

Java documentation for java.nio.ShortBuffer.get().

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Get(Int16[])

Relative bulk get method.

[Android.Runtime.Register("get", "([S)Ljava/nio/ShortBuffer;", "GetGet_arraySHandler")]
public virtual Java.Nio.ShortBuffer? Get (short[]? dst);

[<Android.Runtime.Register("get", "([S)Ljava/nio/ShortBuffer;", "GetGet_arraySHandler")>]
abstract member Get : int16[] -> Java.Nio.ShortBuffer
override this.Get : int16[] -> Java.Nio.ShortBuffer

Parameters

dst

Int16[]

The destination array

Returns

ShortBuffer

This buffer

Attributes

RegisterAttribute

Exceptions

BufferUnderflowException

if dst.length is greater than remaining().

Remarks

Relative bulk get method.

This method transfers shorts from this buffer into the given destination array. An invocation of this method of the form src.get(a) behaves in exactly the same way as the invocation

src.get(a, 0, a.length)

Java documentation for java.nio.ShortBuffer.get(short[]).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Get(Int32)

Absolute get method.

[Android.Runtime.Register("get", "(I)S", "GetGet_IHandler")]
public abstract short Get (int index);

[<Android.Runtime.Register("get", "(I)S", "GetGet_IHandler")>]
abstract member Get : int -> int16

Parameters

index

Int32

The index from which the short will be read

Returns

Int16

The short at the given index

Attributes

RegisterAttribute

Exceptions

IndexOutOfBoundsException

if index is invalid.

Remarks

Absolute get method. Reads the short at the given index.

Java documentation for java.nio.ShortBuffer.get(int).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Get(Int16[], Int32, Int32)

Relative bulk get method.

[Android.Runtime.Register("get", "([SII)Ljava/nio/ShortBuffer;", "GetGet_arraySIIHandler")]
public virtual Java.Nio.ShortBuffer? Get (short[]? dst, int offset, int length);

[<Android.Runtime.Register("get", "([SII)Ljava/nio/ShortBuffer;", "GetGet_arraySIIHandler")>]
abstract member Get : int16[] * int * int -> Java.Nio.ShortBuffer
override this.Get : int16[] * int * int -> Java.Nio.ShortBuffer

Parameters

dst

Int16[]

The array into which shorts are to be written

offset

Int32

The offset within the array of the first short to be written; must be non-negative and no larger than dst.length

length

Int32

The maximum number of shorts to be written to the given array; must be non-negative and no larger than dst.length - offset

Returns

ShortBuffer

This buffer

Attributes

RegisterAttribute

Exceptions

IndexOutOfBoundsException

if either dstOffset or shortCount is invalid.

BufferUnderflowException

if shortCount is greater than remaining().

Remarks

Relative bulk get method.

This method transfers shorts from this buffer into the given destination array. If there are fewer shorts remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no shorts are transferred and a BufferUnderflowException is thrown.

Otherwise, this method copies length shorts from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form src.get(dst, off, len) has exactly the same effect as the loop

{@code
                for (int i = off; i < off + len; i++)
                    dst[i] = src.get();
            }

except that it first checks that there are sufficient shorts in this buffer and it is potentially much more efficient.

Java documentation for java.nio.ShortBuffer.get(short[], int, int).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.