Home Reference Source Repository

Function

Static Public Summary
public

arrayToBuffer(srcArray: Array, existedBuffer: ArrayBuffer, byteOffset: Number, length: Number, littleEndian: Boolean): ArrayBuffer

Copies a source typed array to a destination buffer

public

bufferToArray(srcBuffer: ArrayBuffer, dstArray: Array, byteOffset: Number, length: Number, littleEndian: Boolean): Array

Copies a source buffer to a destination typed array

public

bufferToStruct(srcBuffer: ArrayBuffer, dstStruct: Object | Object[], byteOffset: Number, littleEndian: Boolean): Object

Copies a source buffer to a destination structure

public

Returns new 'float array[size]' C equivalent

public

Returns new 'double array[size]' C equivalent

public

Returns new 'short array[size]' C equivalent

public

Returns new 'int array[size]' C equivalent

public

Returns new 'char array[size]' C equivalent

public

struct(srcStruct: Object, size: Number): Object

Returns new 'struct s[size]' C equivalent with 'byteLength' field is a total size of structure

public

structToBuffer(srcStruct: Object | Object[], existedBuffer: ArrayBuffer, byteOffset: Number, littleEndian: Number): ArrayBuffer

Copies a source structure to a destination buffer

public

Returns new 'unsigned short array[size]' C equivalent

public

Returns new 'unsigned int array[size]' C equivalent

public

Returns new 'unsigned char array[size]' C equivalent

Static Public

public arrayToBuffer(srcArray: Array, existedBuffer: ArrayBuffer, byteOffset: Number, length: Number, littleEndian: Boolean): ArrayBuffer source

import {arrayToBuffer} from 'ctype-js/src/ctype.js'

Copies a source typed array to a destination buffer

Params:

NameTypeAttributeDescription
srcArray Array

Source typed array

existedBuffer ArrayBuffer
  • default: null

DesExisted buffer

byteOffset Number
  • default: 0

Byte offset from a start of a source typed array

length Number
  • default: NaN

Byte length for copying from a source typed array

littleEndian Boolean
  • default: true

Little-endian bytes order flag

Return:

ArrayBuffer

Destination buffer reference

public bufferToArray(srcBuffer: ArrayBuffer, dstArray: Array, byteOffset: Number, length: Number, littleEndian: Boolean): Array source

import {bufferToArray} from 'ctype-js/src/ctype.js'

Copies a source buffer to a destination typed array

Params:

NameTypeAttributeDescription
srcBuffer ArrayBuffer

Source buffer

dstArray Array

Destination typed array

byteOffset Number
  • default: 0

Byte offset from a start of a source buffer

length Number
  • default: NaN

Byte length for copying from a source buffer

littleEndian Boolean
  • default: true

Little-endian bytes order flag

Return:

Array

Destination array reference

public bufferToStruct(srcBuffer: ArrayBuffer, dstStruct: Object | Object[], byteOffset: Number, littleEndian: Boolean): Object source

import {bufferToStruct} from 'ctype-js/src/ctype.js'

Copies a source buffer to a destination structure

Params:

NameTypeAttributeDescription
srcBuffer ArrayBuffer

Source buffer

dstStruct Object | Object[]

Destination structure or array of structures

byteOffset Number
  • default: 0

Byte offset from a start of a source buffer

littleEndian Boolean
  • default: true

Little-endian bytes order flag

Return:

Object

Destination structure reference

public float32(size: Number): Float32Array source

import {float32} from 'ctype-js/src/ctype.js'

Returns new 'float array[size]' C equivalent

Params:

NameTypeAttributeDescription
size Number
  • default: 1

Array length

Return:

Float32Array

Signed 32-byte floating point array

public float64(size: Number): Float64Array source

import {float64} from 'ctype-js/src/ctype.js'

Returns new 'double array[size]' C equivalent

Params:

NameTypeAttributeDescription
size Number
  • default: 1

Array length

Return:

Float64Array

Signed 64-byte floating point array

public int16(size: Number): Int16Array source

import {int16} from 'ctype-js/src/ctype.js'

Returns new 'short array[size]' C equivalent

Params:

NameTypeAttributeDescription
size Number
  • default: 1

Array length

Return:

Int16Array

Signed 16-byte integer array

public int32(size: Number): Int32Array source

import {int32} from 'ctype-js/src/ctype.js'

Returns new 'int array[size]' C equivalent

Params:

NameTypeAttributeDescription
size Number
  • default: 1

Array length

Return:

Int32Array

Signed 32-byte integer array

public int8(size: Number): Int8Array source

import {int8} from 'ctype-js/src/ctype.js'

Returns new 'char array[size]' C equivalent

Params:

NameTypeAttributeDescription
size Number
  • default: 1

Array length

Return:

Int8Array

Signed 8-byte integer array

public struct(srcStruct: Object, size: Number): Object source

import {struct} from 'ctype-js/src/ctype.js'

Returns new 'struct s[size]' C equivalent with 'byteLength' field is a total size of structure

Params:

NameTypeAttributeDescription
srcStruct Object

Empty source object

size Number
  • default: 1

Array length

Return:

Object

Object structure with typed fields

public structToBuffer(srcStruct: Object | Object[], existedBuffer: ArrayBuffer, byteOffset: Number, littleEndian: Number): ArrayBuffer source

import {structToBuffer} from 'ctype-js/src/ctype.js'

Copies a source structure to a destination buffer

Params:

NameTypeAttributeDescription
srcStruct Object | Object[]

Source structure or array of structures

existedBuffer ArrayBuffer
  • default: null

Existed buffer

byteOffset Number
  • default: 0

Byte offset from a start of a source buffer

littleEndian Number
  • default: true

Little-endian bytes order flag

Return:

ArrayBuffer

Destination buffer reference

public uint16(size: Number): Uint16Array source

import {uint16} from 'ctype-js/src/ctype.js'

Returns new 'unsigned short array[size]' C equivalent

Params:

NameTypeAttributeDescription
size Number
  • default: 1

Array length

Return:

Uint16Array

Unsigned 16-byte integer array

public uint32(size: Number): Uint32Array source

import {uint32} from 'ctype-js/src/ctype.js'

Returns new 'unsigned int array[size]' C equivalent

Params:

NameTypeAttributeDescription
size Number
  • default: 1

Array length

Return:

Uint32Array

Unsigned 32-byte integer array

public uint8(size: Number): Uint8Array source

import {uint8} from 'ctype-js/src/ctype.js'

Returns new 'unsigned char array[size]' C equivalent

Params:

NameTypeAttributeDescription
size Number
  • default: 1

Array length

Return:

Uint8Array

Unsigned 8-byte integer array