vtf-js
Version:
A javascript IO library for the Valve Texture Format.
55 lines (54 loc) • 2.6 kB
TypeScript
/**
* Wraps DataView with utility functions and pointer offsets.
* This class is also available separately in the `stupid-buffer` npm package.
*/
export declare class DataBuffer extends Uint8Array {
pointer: number;
view: DataView;
protected little: boolean;
constructor(length: number);
constructor(array: ArrayLike<number> | ArrayBufferLike);
constructor(buffer: ArrayBufferLike, byteOffset?: number, length?: number);
/** Sets the default endianness of the DataBuffer. */
set_endian(little: boolean): void;
/** Creates a new DataBuffer within the specified bounds. */
ref(start?: number, length?: number): DataBuffer;
/** Moves the pointer to the specified position. */
seek(position: number): void;
/** Increments the pointer by the specified number of bytes. */
pad(length: number): void;
/** Aligns the pointer to the nearest multiple specified, and pads a number of bytes if specified. */
align(multiple: number, offset?: number): void;
read_u8(): number;
read_u8(length: number): Uint8Array;
write_u8(value: number | Uint8Array): void;
read_u16(): number;
read_u16(length: undefined, little?: boolean): number;
read_u16(length: number, little?: boolean): Uint16Array;
write_u16(value: number | Uint16Array, little?: boolean): void;
read_u32(): number;
read_u32(length: undefined, little?: boolean): number;
read_u32(length: number, little?: boolean): Uint32Array;
write_u32(value: number | Uint32Array, little?: boolean): void;
read_i8(): number;
read_i8(length: number): Int8Array;
write_i8(value: number | Int8Array): void;
read_i16(): number;
read_i16(length: undefined, little?: boolean): number;
read_i16(length: number, little?: boolean): Int16Array;
write_i16(value: number | Int16Array, little?: boolean): void;
read_i32(): number;
read_i32(length: undefined, little?: boolean): number;
read_i32(length: number, little?: boolean): Int32Array;
write_i32(value: number | Int32Array, little?: boolean): void;
read_f32(): number;
read_f32(length: undefined, little?: boolean): number;
read_f32(length: number, little?: boolean): Float32Array;
write_f32(value: number | Float32Array, little?: boolean): void;
read_f64(): number;
read_f64(length: undefined, little?: boolean): number;
read_f64(length: number, little?: boolean): Float64Array;
write_f64(value: number | Float64Array, little?: boolean): void;
read_str(length?: number): string;
write_str(str: string, length?: number): void;
}