IndexDatatype

IndexDatatype

Constants for WebGL index datatypes. These corresponds to the type parameter of drawElements.

Source:

Members

<static, constant> :Number

0x1401. 8-bit unsigned byte corresponding to UNSIGNED_BYTE and the type of an element in Uint8Array.

<static, constant> :Number

0x1405. 32-bit unsigned int corresponding to UNSIGNED_INT and the type of an element in Uint32Array.

<static, constant> :Number

0x1403. 16-bit unsigned short corresponding to UNSIGNED_SHORT and the type of an element in Uint16Array.

Methods

<static>

Creates a typed array that will store indices, using either or Uint32Array depending on the number of vertices.

Parameters:
Name Type Description
numberOfVertices Number Number of vertices that the indices will reference.
indicesLengthOrArray Any Passed through to the typed array constructor.
Throws:
DeveloperError : center is required.
Returns:
Array A Uint16Array or Uint32Array constructed with indicesLengthOrArray.
Example
this.indices = IndexDatatype.createTypedArray(positions.length / 3, numberOfIndices);

<static>

Returns the size, in bytes, of the corresponding datatype.

Parameters:
Name Type Description
indexDatatype IndexDatatype The index datatype to get the size of.
Throws:
DeveloperError : indexDatatype is required and must be a valid IndexDatatype constant.
Returns:
Number The size in bytes.
Example
// Returns 2
var size = IndexDatatype.getSizeInBytes(IndexDatatype.UNSIGNED_SHORT);

<static>

Validates that the provided index datatype is a valid IndexDatatype.

Parameters:
Name Type Description
indexDatatype IndexDatatype The index datatype to validate.
Returns:
Boolean true if the provided index datatype is a valid value; otherwise, false.
Example
if (!IndexDatatype.validate(indexDatatype)) {
  throw new DeveloperError('indexDatatype must be a valid value.');
}
Documentation generated by JSDoc 3 on Mon Jan 06 2014 14:06:08 GMT-0500 (EST)