Interface StructConstructor<T>

A definition for a type

interface StructConstructor<T extends {}> {
    new StructConstructor<
        TArrayBuffer extends ArrayBufferLike = ArrayBuffer,
    >(
        buffer?: TArrayBuffer,
        byteOffset?: number,
        byteLength?: number,
    ): Expand<StructInstance<TArrayBuffer> & T>;
    alignment: number;
    array?: TypeArrayConstructor<T & ArrayBufferView<ArrayBufferLike>>;
    isUnion: boolean;
    name: string;
    prototype: ArrayBufferView<ArrayBufferLike> & T;
    size: number;
    get(
        this: void,
        buffer: ArrayBufferLike,
        offset: number,
    ): T & ArrayBufferView<ArrayBufferLike>;
    set(
        this: void,
        buffer: ArrayBufferLike,
        offset: number,
        value: T & ArrayBufferView<ArrayBufferLike>,
    ): void;
}

Type Parameters

  • T extends {}

Hierarchy (View Summary)

Constructors

constructor

Properties

alignment array? isUnion name prototype size

Methods

get set

Constructors

constructor

Properties

Readonlyalignment

alignment: number

Optional Readonlyarray

array?: TypeArrayConstructor<T & ArrayBufferView<ArrayBufferLike>>

ReadonlyisUnion

isUnion: boolean

Readonlyname

name: string

prototype

prototype: ArrayBufferView<ArrayBufferLike> & T

Readonlysize

size: number

Methods

get

  • get(
        this: void,
        buffer: ArrayBufferLike,
        offset: number,
    ): T & ArrayBufferView<ArrayBufferLike>

    Get a value from a buffer

    Parameters

    • this: void
    • buffer: ArrayBufferLike
    • offset: number

    Returns T & ArrayBufferView<ArrayBufferLike>

set

  • set(
        this: void,
        buffer: ArrayBufferLike,
        offset: number,
        value: T & ArrayBufferView<ArrayBufferLike>,
    ): void

    Set a value in a buffer

    Parameters

    • this: void
    • buffer: ArrayBufferLike
    • offset: number
    • value: T & ArrayBufferView<ArrayBufferLike>

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods