Class Glsl<T>

constructor

• new Glsl<T extends Type = Type>(
      getValue: (builder: GlslBuilder) => Value<T>,
  ): Glsl<T>

  Type Parameters

  • T extends Type = Type

  Parameters

  • getValue: (builder: GlslBuilder) => Value<T>

  Returns Glsl<T>

ReadonlygetValue

StaticPI

a

• a(this: Vector4): Scalar

  Get the fourth component of vector

  Parameters

  • this: Vector4

  Returns Scalar

abs

• abs(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

acos

• acos(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

add

• add<T extends Glsl.AnyNumeric | Glsl.AnyMatrix>(
      this: T,
      other: number | Scalar | T,
  ): T

  Type Parameters

  • T extends Glsl.AnyNumeric | Glsl.AnyMatrix

  Parameters

  • this: T
  • other: number | Scalar | T

  Returns T

• add<T extends Glsl.AnyNumeric | Glsl.AnyMatrix>(this: Scalar, other: T): T

  Type Parameters

  • T extends Glsl.AnyNumeric | Glsl.AnyMatrix

  Parameters

  • this: Scalar
  • other: T

  Returns T

and

• and(this: Boolean, other: Boolean): Boolean

  Parameters

  • this: Boolean
  • other: Boolean

  Returns Boolean

asin

• asin(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

atan

• atan<T extends Type.AnyNumeric>(this: Glsl<T>): Glsl<T>

  Type Parameters

  • T extends Type.AnyNumeric

  Parameters

  • this: Glsl<T>

  Returns Glsl<T>

• atan<T extends Type.AnyNumeric>(this: Glsl<T>, x: Glsl<T>): Glsl<T>

  Type Parameters

  • T extends Type.AnyNumeric

  Parameters

  • this: Glsl<T>
  • x: Glsl<T>

  Returns Glsl<T>

• atan(this: Scalar, x: number): Scalar

  Parameters

  • this: Scalar
  • x: number

  Returns Scalar

b

• b(this: Vector3 | Vector4): Scalar

  Get the third component of vector

  Parameters

  • this: Vector3 | Vector4

  Returns Scalar

cat

• cat(this: Scalar, v: number | Scalar): Vector2

  Parameters

  • this: Scalar
  • v: number | Scalar

  Returns Vector2

• cat(this: Scalar, v: Vector2): Vector3

  Parameters

  • this: Scalar
  • v: Vector2

  Returns Vector3

• cat(this: Scalar, v: Vector3): Vector4

  Parameters

  • this: Scalar
  • v: Vector3

  Returns Vector4

• cat(this: Vector2, v: number | Scalar): Vector3

  Parameters

  • this: Vector2
  • v: number | Scalar

  Returns Vector3

• cat(this: Vector2, v: Vector2): Vector4

  Parameters

  • this: Vector2
  • v: Vector2

  Returns Vector4

• cat(this: Vector3, v: number | Scalar): Vector4

  Parameters

  • this: Vector3
  • v: number | Scalar

  Returns Vector4

ceil

• ceil(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

clamp

• clamp<T extends Glsl.AnyNumeric>(this: T, min: T, max: T): T

  Type Parameters

  • T extends Glsl.AnyNumeric

  Parameters

  • this: T
  • min: T
  • max: T

  Returns T

• clamp<T extends Glsl.AnyNumeric>(
      this: T,
      min: number | Scalar,
      max: number | Scalar,
  ): T

  Type Parameters

  • T extends Glsl.AnyNumeric

  Parameters

  • this: T
  • min: number | Scalar
  • max: number | Scalar

  Returns T

cond

• cond<T extends Glsl<Type>>(
      this: Boolean,
      precision: Precision,
      whenTrue: T,
      whenFalse: T,
  ): T

  Conditional expression

  Type Parameters

  • T extends Glsl<Type>

  Parameters

  • this: Boolean
  • precision: Precision

    Precision of the expression result

  • whenTrue: T

    True brunch of the condition

  • whenFalse: T

    False brunch of the condition

  Returns T

condHQ

• condHQ<T extends Glsl<Type>>(this: Boolean, whenTrue: T, whenFalse: T): T

  Type Parameters

  • T extends Glsl<Type>

  Parameters

  • this: Boolean
  • whenTrue: T
  • whenFalse: T

  Returns T

condLQ

• condLQ<T extends Glsl<Type>>(this: Boolean, whenTrue: T, whenFalse: T): T

  Type Parameters

  • T extends Glsl<Type>

  Parameters

  • this: Boolean
  • whenTrue: T
  • whenFalse: T

  Returns T

condMQ

• condMQ<T extends Glsl<Type>>(this: Boolean, whenTrue: T, whenFalse: T): T

  Type Parameters

  • T extends Glsl<Type>

  Parameters

  • this: Boolean
  • whenTrue: T
  • whenFalse: T

  Returns T

cos

• cos(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

degrees

• degrees(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

distance

• distance<T extends Glsl.AnyNumeric>(this: T, other: T): Scalar

  Type Parameters

  • T extends Glsl.AnyNumeric

  Parameters

  • this: T
  • other: T

  Returns Scalar

• distance(this: Scalar, other: number): Scalar

  Parameters

  • this: Scalar
  • other: number

  Returns Scalar

div

• div<T extends Glsl.AnyNumeric | Glsl.AnyMatrix>(
      this: T,
      other: number | Scalar | T,
  ): T

  Type Parameters

  • T extends Glsl.AnyNumeric | Glsl.AnyMatrix

  Parameters

  • this: T
  • other: number | Scalar | T

  Returns T

• div<T extends Glsl.AnyNumeric | Glsl.AnyMatrix>(this: Scalar, other: T): T

  Type Parameters

  • T extends Glsl.AnyNumeric | Glsl.AnyMatrix

  Parameters

  • this: Scalar
  • other: T

  Returns T

dot

• dot<T extends Glsl.AnyNumeric>(this: T, other: T): Scalar

  Type Parameters

  • T extends Glsl.AnyNumeric

  Parameters

  • this: T
  • other: T

  Returns Scalar

• dot(this: Scalar, other: number): Scalar

  Parameters

  • this: Scalar
  • other: number

  Returns Scalar

eq

• eq(this: Scalar, other: number | Scalar): Boolean

  Equal

  Parameters

  • this: Scalar
  • other: number | Scalar

  Returns Boolean

exp

• exp(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

exp2

• exp2(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

floor

• floor(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

fract

• fract(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

g

• g(this: Vector2 | Vector3 | Vector4): Scalar

  Get the second component of vector

  Parameters

  • this: Vector2 | Vector3 | Vector4

  Returns Scalar

gt

• gt(this: Scalar, other: number | Scalar): Boolean

  Greater

  Parameters

  • this: Scalar
  • other: number | Scalar

  Returns Boolean

gte

• gte(this: Scalar, other: number | Scalar): Boolean

  Greater or equal

  Parameters

  • this: Scalar
  • other: number | Scalar

  Returns Boolean

inversesqrt

• inversesqrt(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

length

• length(this: Glsl.AnyNumeric): Scalar

  Parameters

  • this: Glsl.AnyNumeric

  Returns Scalar

log

• log(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

log2

• log2(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

lt

• lt(this: Scalar, other: number | Scalar): Boolean

  Less

  Parameters

  • this: Scalar
  • other: number | Scalar

  Returns Boolean

lte

• lte(this: Scalar, other: number | Scalar): Boolean

  Less or equal

  Parameters

  • this: Scalar
  • other: number | Scalar

  Returns Boolean

max

• max<P extends Type.AnyNumeric>(this: Glsl<P>, p: Glsl<P>): Glsl<P>

  Type Parameters

  • P extends Type.AnyNumeric

  Parameters

  • this: Glsl<P>
  • p: Glsl<P>

  Returns Glsl<P>

• max(this: Scalar, p: number): Scalar

  Parameters

  • this: Scalar
  • p: number

  Returns Scalar

mem

• mem<T extends Glsl<Type>>(this: T, precision: Precision): T

  Save some expression into a variable.

  The operand is both emitted and traversed only once: the walk runs inside the builder's once() cache, which stores the resulting value, so every later reference returns the cached variable without re-walking the subtree. Memoizing inside mem is therefore safe for deep, heavily shared expression trees — without this, a node referenced N times is walked N times and a deep tree assembles in time exponential in its depth.

  Type Parameters

  • T extends Glsl<Type>

  Parameters

  • this: T
  • precision: Precision

  Returns T

memHQ

• memHQ(): Glsl<T>

  Save some expression with high quality into a variable

  Returns Glsl<T>

memLQ

• memLQ(): Glsl<T>

  Save some expression with low quality into a variable

  Returns Glsl<T>

memMQ

• memMQ(): Glsl<T>

  Save some expression with medium quality into a variable

  Returns Glsl<T>

min

• min<P extends Type.AnyNumeric>(this: Glsl<P>, p: Glsl<P>): Glsl<P>

  Type Parameters

  • P extends Type.AnyNumeric

  Parameters

  • this: Glsl<P>
  • p: Glsl<P>

  Returns Glsl<P>

• min(this: Scalar, p: number): Scalar

  Parameters

  • this: Scalar
  • p: number

  Returns Scalar

mix

• mix<P extends Glsl.AnyNumeric>(this: P, other: P, p: P): P

  Type Parameters

  • P extends Glsl.AnyNumeric

  Parameters

  • this: P
  • other: P
  • p: P

  Returns P

• mix<P extends Glsl.AnyNumeric>(this: P, other: P, p: number): P

  Type Parameters

  • P extends Glsl.AnyNumeric

  Parameters

  • this: P
  • other: P
  • p: number

  Returns P

• mix(this: Scalar, other: number, p: number | Scalar): Scalar

  Parameters

  • this: Scalar
  • other: number
  • p: number | Scalar

  Returns Scalar

mod

• mod<P extends Type.AnyNumeric>(this: Glsl<P>, p: Glsl<P>): Glsl<P>

  Type Parameters

  • P extends Type.AnyNumeric

  Parameters

  • this: Glsl<P>
  • p: Glsl<P>

  Returns Glsl<P>

• mod(this: Scalar, p: number): Scalar

  Parameters

  • this: Scalar
  • p: number

  Returns Scalar

mul

• mul<T extends Glsl.AnyNumeric | Glsl.AnyMatrix>(
      this: T,
      other: number | Scalar | T,
  ): T

  Type Parameters

  • T extends Glsl.AnyNumeric | Glsl.AnyMatrix

  Parameters

  • this: T
  • other: number | Scalar | T

  Returns T

• mul<T extends Glsl.AnyNumeric | Glsl.AnyMatrix>(
      this: Scalar,
      other: number | Scalar | T,
  ): T

  Type Parameters

  • T extends Glsl.AnyNumeric | Glsl.AnyMatrix

  Parameters

  • this: Scalar
  • other: number | Scalar | T

  Returns T

• mul(this: Matrix2, other: Vector2): Vector2

  Parameters

  • this: Matrix2
  • other: Vector2

  Returns Vector2

• mul(this: Vector2, other: Matrix2): Vector2

  Parameters

  • this: Vector2
  • other: Matrix2

  Returns Vector2

• mul(this: Matrix3, other: Vector3): Vector3

  Parameters

  • this: Matrix3
  • other: Vector3

  Returns Vector3

• mul(this: Vector3, other: Matrix3): Vector3

  Parameters

  • this: Vector3
  • other: Matrix3

  Returns Vector3

• mul(this: Matrix4, other: Vector4): Vector4

  Parameters

  • this: Matrix4
  • other: Vector4

  Returns Vector4

• mul(this: Vector4, other: Matrix4): Vector4

  Parameters

  • this: Vector4
  • other: Matrix4

  Returns Vector4

neq

• neq(this: Scalar, other: number | Scalar): Boolean

  Not equal

  Parameters

  • this: Scalar
  • other: number | Scalar

  Returns Boolean

normalize

• normalize(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

not

• not(this: Glsl<Boolean>): Glsl<Boolean>

  Parameters

  • this: Glsl<Boolean>

  Returns Glsl<Boolean>

or

• or(this: Boolean, other: Boolean): Boolean

  Parameters

  • this: Boolean
  • other: Boolean

  Returns Boolean

pow

• pow(this: Scalar, p: Scalar): Scalar

  Parameters

  • this: Scalar
  • p: Scalar

  Returns Scalar

• pow(this: Vector2, p: Vector2): Vector2

  Parameters

  • this: Vector2
  • p: Vector2

  Returns Vector2

• pow(this: Vector3, p: Vector3): Vector3

  Parameters

  • this: Vector3
  • p: Vector3

  Returns Vector3

• pow(this: Vector4, p: Vector4): Vector4

  Parameters

  • this: Vector4
  • p: Vector4

  Returns Vector4

• pow(this: Scalar, p: number): Scalar

  Parameters

  • this: Scalar
  • p: number

  Returns Scalar

r

• r(this: Glsl.AnyVector): Scalar

  Get the first component of vector

  Parameters

  • this: Glsl.AnyVector

  Returns Scalar

radians

• radians(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

reflect

• reflect<T extends Glsl.AnyNumeric>(this: T, n: T): T

  Type Parameters

  • T extends Glsl.AnyNumeric

  Parameters

  • this: T
  • n: T

  Returns T

refract

• refract<T extends Glsl.AnyNumeric>(this: T, n: T, eta: number | Scalar): T

  Type Parameters

  • T extends Glsl.AnyNumeric

  Parameters

  • this: T
  • n: T
  • eta: number | Scalar

  Returns T

round

• round<T extends Glsl.AnyNumeric>(this: T): T

  Type Parameters

  • T extends Glsl.AnyNumeric

  Parameters

  • this: T

  Returns T

sign

• sign(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

sin

• sin(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

smoothstep

• smoothstep(this: Scalar, edge1: number | Scalar, edge2: number | Scalar): Scalar

  Parameters

  • this: Scalar
  • edge1: number | Scalar
  • edge2: number | Scalar

  Returns Scalar

• smoothstep<T extends Glsl.AnyNumeric>(this: T, edge1: T, edge2: T): T

  Type Parameters

  • T extends Glsl.AnyNumeric

  Parameters

  • this: T
  • edge1: T
  • edge2: T

  Returns T

• smoothstep<T extends Glsl.AnyNumeric>(
      this: Scalar,
      edge1: number | Scalar,
      edge2: number | Scalar,
  ): T

  Type Parameters

  • T extends Glsl.AnyNumeric

  Parameters

  • this: Scalar
  • edge1: number | Scalar
  • edge2: number | Scalar

  Returns T

sqrt

• sqrt(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

sub

• sub<T extends Glsl.AnyNumeric | Glsl.AnyMatrix>(
      this: T,
      other: number | Scalar | T,
  ): T

  Type Parameters

  • T extends Glsl.AnyNumeric | Glsl.AnyMatrix

  Parameters

  • this: T
  • other: number | Scalar | T

  Returns T

• sub<T extends Glsl.AnyNumeric | Glsl.AnyMatrix>(this: Scalar, other: T): T

  Type Parameters

  • T extends Glsl.AnyNumeric | Glsl.AnyMatrix

  Parameters

  • this: Scalar
  • other: T

  Returns T

take

• take<T extends Type.AnyVector>(this: Glsl<T>, i: Indexes<T>): Scalar

  Type Parameters

  • T extends Type.AnyVector

  Parameters

  • this: Glsl<T>
  • i: Indexes<T>

  Returns Scalar

• take<T extends Type.AnyVector>(
      this: Glsl<T>,
      i1: Indexes<T>,
      i2: Indexes<T>,
  ): Vector2

  Type Parameters

  • T extends Type.AnyVector

  Parameters

  • this: Glsl<T>
  • i1: Indexes<T>
  • i2: Indexes<T>

  Returns Vector2

• take<T extends Vector3 | Vector4>(
      this: Glsl<T>,
      i1: Indexes<T>,
      i2: Indexes<T>,
      i3: Indexes<T>,
  ): Vector3

  Type Parameters

  • T extends Vector3 | Vector4

  Parameters

  • this: Glsl<T>
  • i1: Indexes<T>
  • i2: Indexes<T>
  • i3: Indexes<T>

  Returns Vector3

• take(
      this: Vector4,
      i1: 0 | 1 | 2 | 3,
      i2: 0 | 1 | 2 | 3,
      i3: 0 | 1 | 2 | 3,
      i4: 0 | 1 | 2 | 3,
  ): Vector4

  Parameters

  • this: Vector4
  • i1: 0 | 1 | 2 | 3
  • i2: 0 | 1 | 2 | 3
  • i3: 0 | 1 | 2 | 3
  • i4: 0 | 1 | 2 | 3

  Returns Vector4

tan

• tan(this: Glsl<Type.AnyNumeric>): Glsl<T>

  Parameters

  • this: Glsl<Type.AnyNumeric>

  Returns Glsl<T>

texture2D

• texture2D(this: Sampler, point: Vector2): Vector4

  Get texture value at the specified point

  Parameters

  • this: Sampler
  • point: Vector2

  Returns Vector4

vec2

• vec2(this: Scalar): Vector2

  Parameters

  • this: Scalar

  Returns Vector2

vec3

• vec3(this: Scalar): Vector3

  Parameters

  • this: Scalar

  Returns Vector3

vec4

• vec4(this: Scalar): Vector4

  Parameters

  • this: Scalar

  Returns Vector4

w

• w(this: Vector4): Scalar

  Get the fourth component of vector

  Parameters

  • this: Vector4

  Returns Scalar

x

• x(this: Glsl.AnyVector): Scalar

  Get the first component of vector

  Parameters

  • this: Glsl.AnyVector

  Returns Scalar

y

• y(this: Vector2 | Vector3 | Vector4): Scalar

  Get the second component of vector

  Parameters

  • this: Vector2 | Vector3 | Vector4

  Returns Scalar

z

• z(this: Vector3 | Vector4): Scalar

  Get the third component of vector

  Parameters

  • this: Vector3 | Vector4

  Returns Scalar

Staticval

• val(v: boolean): Glsl<Boolean>

  Parameters

  • v: boolean

  Returns Glsl<Boolean>

• val(v: number): Scalar

  Parameters

  • v: number

  Returns Scalar

• val<T extends Glsl<Type>>(v: T): T

  Type Parameters

  • T extends Glsl<Type>

  Parameters

  • v: T

  Returns T

• val(v1: number | Scalar, v2: number | Scalar): Vector2

  Parameters

  • v1: number | Scalar
  • v2: number | Scalar

  Returns Vector2

• val(v1: number | Scalar, v2: Vector2): Vector3

  Parameters

  • v1: number | Scalar
  • v2: Vector2

  Returns Vector3

• val(v1: number | Scalar, v2: Vector3): Vector4

  Parameters

  • v1: number | Scalar
  • v2: Vector3

  Returns Vector4

• val(v1: Vector2, v2: number | Scalar): Vector3

  Parameters

  • v1: Vector2
  • v2: number | Scalar

  Returns Vector3

• val(v1: Vector3, v2: number | Scalar): Vector4

  Parameters

  • v1: Vector3
  • v2: number | Scalar

  Returns Vector4

• val(v1: number | Scalar, v2: number | Scalar, v3: number | Scalar): Vector3

  Parameters

  • v1: number | Scalar
  • v2: number | Scalar
  • v3: number | Scalar

  Returns Vector3

• val(v1: Vector2, v2: number | Scalar, v3: number | Scalar): Vector4

  Parameters

  • v1: Vector2
  • v2: number | Scalar
  • v3: number | Scalar

  Returns Vector4

• val(v1: number | Scalar, v2: Vector2, v3: number | Scalar): Vector4

  Parameters

  • v1: number | Scalar
  • v2: Vector2
  • v3: number | Scalar

  Returns Vector4

• val(v1: number | Scalar, v2: number | Scalar, v3: Vector2): Vector4

  Parameters

  • v1: number | Scalar
  • v2: number | Scalar
  • v3: Vector2

  Returns Vector4

• val(
      v1: number | Scalar,
      v2: number | Scalar,
      v3: number | Scalar,
      v4: number | Scalar,
  ): Vector4

  Parameters

  • v1: number | Scalar
  • v2: number | Scalar
  • v3: number | Scalar
  • v4: number | Scalar

  Returns Vector4