Skip to content

@web-engine-dev/math


@web-engine-dev/math / MathPool

Variable: MathPool ​

const MathPool: object

Pre-configured pools for common math types.

Type Declaration ​

_mat4Pool ​

_mat4Pool: ObjectPool<Mat4>

_quatPool ​

_quatPool: ObjectPool<Quat>

_vec2Pool ​

_vec2Pool: ObjectPool<Vec2>

_vec3Pool ​

_vec3Pool: ObjectPool<Vec3>

_vec4Pool ​

_vec4Pool: ObjectPool<Vec4>

clearAll() ​

clearAll(): void

Clears all pools.

Returns ​

void

getMat4() ​

getMat4(): Mat4

Returns ​

Mat4

getQuat() ​

getQuat(): Quat

Returns ​

Quat

getStats() ​

getStats(): object

Returns statistics about pool usage.

Returns ​

object

mat4 ​

mat4: number

quat ​

quat: number

vec2 ​

vec2: number

vec3 ​

vec3: number

vec4 ​

vec4: number

getVec2() ​

getVec2(): Vec2

Returns ​

Vec2

getVec3() ​

getVec3(): Vec3

Returns ​

Vec3

getVec4() ​

getVec4(): Vec4

Returns ​

Vec4

preallocateAll() ​

preallocateAll(count?): void

Pre-allocates objects in all pools.

Parameters ​

count? ​

number = 16

Returns ​

void

releaseMat4() ​

releaseMat4(m): void

Parameters ​

m ​

Mat4

Returns ​

void

releaseQuat() ​

releaseQuat(q): void

Parameters ​

q ​

Quat

Returns ​

void

releaseVec2() ​

releaseVec2(v): void

Parameters ​

v ​

Vec2

Returns ​

void

releaseVec3() ​

releaseVec3(v): void

Parameters ​

v ​

Vec3

Returns ​

void

releaseVec4() ​

releaseVec4(v): void

Parameters ​

v ​

Vec4

Returns ​

void

withMat4() ​

withMat4<R>(fn): R

Executes a function with temporary Mat4 objects that are automatically released.

Type Parameters ​

R ​

R

Parameters ​

fn ​

(m1, m2, m3, m4) => R

Returns ​

R

withQuat() ​

withQuat<R>(fn): R

Executes a function with temporary Quat objects that are automatically released.

Type Parameters ​

R ​

R

Parameters ​

fn ​

(q1, q2, q3, q4) => R

Returns ​

R

withVec2() ​

withVec2<R>(fn): R

Executes a function with temporary Vec2 objects that are automatically released.

Type Parameters ​

R ​

R

Parameters ​

fn ​

(v1, v2, v3, v4) => R

Function that receives 1-4 temporary Vec2 objects

Returns ​

R

The return value of the function

withVec3() ​

withVec3<R>(fn): R

Executes a function with temporary Vec3 objects that are automatically released.

Type Parameters ​

R ​

R

Parameters ​

fn ​

(v1, v2, v3, v4) => R

Function that receives 1-4 temporary Vec3 objects

Returns ​

R

The return value of the function

withVec4() ​

withVec4<R>(fn): R

Executes a function with temporary Vec4 objects that are automatically released.

Type Parameters ​

R ​

R

Parameters ​

fn ​

(v1, v2, v3, v4) => R

Returns ​

R

Proprietary software. All rights reserved.