elemental.html

Interface Uint8Array

All Superinterfaces:

ArrayBufferView, IndexableInt, IndexableNumber

All Known Subinterfaces:

Uint8ClampedArray

All Known Implementing Classes:

JsUint8Array, JsUint8ClampedArray

public interface Uint8Array
extends ArrayBufferView, IndexableInt

The UInt8Array type represents an array of 8-bit unsigned integers.

Once established, you can reference elements in the array using the object's methods, or using standard array index syntax (that is, using bracket notation).

Field Summary

Fields

Modifier and Type	Field and Description
static int	BYTES_PER_ELEMENT The size, in bytes, of each array element.

Method Summary

Methods

Modifier and Type	Method and Description
int	getLength() The number of entries in the array; for these 8-bit values, this is the same as the size of the array in bytes.
void	setElements(Object array)
void	setElements(Object array, int offset)
Uint8Array	subarray(int start) Returns a new Uint8Array view on the ArrayBuffer store for this Uint8Array object.
Uint8Array	subarray(int start, int end) Returns a new Uint8Array view on the ArrayBuffer store for this Uint8Array object.

Methods inherited from interface elemental.html.ArrayBufferView

getBuffer, getByteLength, getByteOffset

Methods inherited from interface elemental.util.IndexableInt

intAt, length

Methods inherited from interface elemental.util.IndexableNumber

numberAt

Field Detail

BYTES_PER_ELEMENT

static final int BYTES_PER_ELEMENT

The size, in bytes, of each array element.

See Also:

Constant Field Values

Method Detail

getLength

int getLength()

The number of entries in the array; for these 8-bit values, this is the same as the size of the array in bytes. Read only.

setElements

void setElements(Object array)

setElements

void setElements(Object array,
               int offset)

subarray

Uint8Array subarray(int start)

Returns a new Uint8Array view on the ArrayBuffer store for this Uint8Array object.

Parameters

begin

The offset to the first element in the array to be referenced by the new Uint8Array object.

end Optional

The offset to the element after last element in the array to be referenced by the new Uint8Array object; if not specified, all elements from the one specified by begin to the end of the array are included in the new view.

Notes

The range specified by begin and end is clamped to the valid index range for the current array; if the computed length of the new array would be negative, it's clamped to zero. If either begin or end is negative, it refers to an index from the end of the array instead of from the beginning.

Note: Keep in mind that this is creating a new view on the existing buffer; changes to the new object's contents will impact the original object and vice versa.

subarray

Uint8Array subarray(int start,
                  int end)

Returns a new Uint8Array view on the ArrayBuffer store for this Uint8Array object.

Parameters

begin

The offset to the first element in the array to be referenced by the new Uint8Array object.

end Optional

The offset to the element after last element in the array to be referenced by the new Uint8Array object; if not specified, all elements from the one specified by begin to the end of the array are included in the new view.

Notes

The range specified by begin and end is clamped to the valid index range for the current array; if the computed length of the new array would be negative, it's clamped to zero. If either begin or end is negative, it refers to an index from the end of the array instead of from the beginning.

Note: Keep in mind that this is creating a new view on the existing buffer; changes to the new object's contents will impact the original object and vice versa.