Glsl | webgl-dsl

Type parameters

T: Type = Type

Hierarchy

Glsl

Index

Type aliases

Constructors

constructor

Properties

Methods

Type aliases

Constructors

constructor

new Glsl(getValue: (builder: GlslBuilder) => Value<T>): Glsl

- Defined in src/dsl.ts:187
Parameters
- getValue: (builder: GlslBuilder) => Value<T>
 - - (builder: GlslBuilder): Value<T>
 - Parameters
 - builder: GlslBuilder
 Returns Value<T>
Returns Glsl

Properties

abs

abs: (Anonymous function) = Glsl.unary("abs")

acos

acos: (Anonymous function) = Glsl.unary("acos")

asin

asin: (Anonymous function) = Glsl.unary("asin")

ceil

ceil: (Anonymous function) = Glsl.unary("floor")

cos

cos: (Anonymous function) = Glsl.unary("cos")

degrees

degrees: (Anonymous function) = Glsl.unary("degrees")

eq

eq: (Anonymous function) = Glsl.bool("==")

Equal

exp

exp: (Anonymous function) = Glsl.unary("exp")

exp2

exp2: (Anonymous function) = Glsl.unary("exp2")

floor

floor: (Anonymous function) = Glsl.unary("floor")

fract

fract: (Anonymous function) = Glsl.unary("fract")

Readonly getValue

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

Type declaration

- (builder: GlslBuilder): Value<T>
- Parameters
 - builder: GlslBuilder
 Returns Value<T>

gt

gt: (Anonymous function) = Glsl.bool(">")

Greater

gte

gte: (Anonymous function) = Glsl.bool(">=")

Greater or equal

inversesqrt

inversesqrt: (Anonymous function) = Glsl.unary("inversesqrt")

log

log: (Anonymous function) = Glsl.unary("log")

log2

log2: (Anonymous function) = Glsl.unary("log2")

lt

lt: (Anonymous function) = Glsl.bool("<")

Less

lte

lte: (Anonymous function) = Glsl.bool("<=")

Less or equal

neq

neq: (Anonymous function) = Glsl.bool("!=")

Not equal

normalize

normalize: (Anonymous function) = Glsl.unary("normalize")

not

not: (Anonymous function) = Glsl.unary<Type.Boolean>("!")

radians

radians: (Anonymous function) = Glsl.unary("radians")

sign

sign: (Anonymous function) = Glsl.unary("sign")

sin

sin: (Anonymous function) = Glsl.unary("sin")

sqrt

sqrt: (Anonymous function) = Glsl.unary("sqrt")

tan

tan: (Anonymous function) = Glsl.unary("tan")

Static PI

PI: Scalar = Glsl.val(Math.PI)

Methods

a

a(this: AnyVector): Scalar

- Defined in src/dsl.ts:603
Get the fourth component of vector

Parameters
- this: AnyVector
Returns Scalar

add

add<T>(this: T, other: T | Scalar | number): T
add<T>(this: Scalar, other: T): T

- Defined in src/dsl.ts:355
Addition

Type parameters
- T: AnyNumeric | AnyMatrix
Parameters
- this: T
- other: T | Scalar | number
Returns T
- Defined in src/dsl.ts:356
Addition

Type parameters
- T: AnyNumeric | AnyMatrix
Parameters
- this: Scalar
- other: T
Returns T

and

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

- Defined in src/dsl.ts:428
Parameters
- this: Boolean
- other: Boolean
Returns Boolean

atan

atan<T>(this: Glsl<T>): Glsl<T>
atan<T>(this: Glsl<T>, x: Glsl<T>): Glsl<T>
atan(this: Scalar, x: number): Scalar

- Defined in src/dsl.ts:253
Type parameters
- T: AnyNumeric
Parameters
- this: Glsl<T>
Returns Glsl<T>
- Defined in src/dsl.ts:254
Type parameters
- T: AnyNumeric
Parameters
- this: Glsl<T>
- x: Glsl<T>
Returns Glsl<T>
- Defined in src/dsl.ts:255
Parameters
- this: Scalar
- x: number
Returns Scalar

b

b(this: AnyVector): Scalar

- Defined in src/dsl.ts:599
Get the third component of vector

Parameters
- this: AnyVector
Returns Scalar

cat

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

- Defined in src/dsl.ts:605
Create vector as a concatenation of current value and argument

Parameters
- this: Scalar
- v: Scalar | number
Returns Vector2
- Defined in src/dsl.ts:606
Create vector as a concatenation of current value and argument

Parameters
- this: Scalar
- v: Vector2
Returns Vector3
- Defined in src/dsl.ts:607
Create vector as a concatenation of current value and argument

Parameters
- this: Scalar
- v: Vector3
Returns Vector4
- Defined in src/dsl.ts:608
Create vector as a concatenation of current value and argument

Parameters
- this: Vector2
- v: Scalar | number
Returns Vector3
- Defined in src/dsl.ts:609
Create vector as a concatenation of current value and argument

Parameters
- this: Vector2
- v: Vector2
Returns Vector4
- Defined in src/dsl.ts:610
Create vector as a concatenation of current value and argument

Parameters
- this: Vector3
- v: Scalar | number
Returns Vector4

clamp

clamp<T>(this: T, min: T, max: T): T
clamp<T>(this: T, min: Scalar | number, max: Scalar | number): T

- Defined in src/dsl.ts:301
Type parameters
- T: AnyNumeric
Parameters
- this: T
- min: T
- max: T
Returns T
- Defined in src/dsl.ts:302
Type parameters
- T: AnyNumeric
Parameters
- this: T
- min: Scalar | number
- max: Scalar | number
Returns T

cond

cond<T>(this: Boolean, precision: Precision, whenTrue: T, whenFalse: T): T

- Defined in src/dsl.ts:474
Conditional expression

Type parameters
- T: Glsl
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>(this: Boolean, whenTrue: T, whenFalse: T): T

- Defined in src/dsl.ts:514
Type parameters
- T: Glsl
Parameters
- this: Boolean
- whenTrue: T
- whenFalse: T
Returns T

condLQ

condLQ<T>(this: Boolean, whenTrue: T, whenFalse: T): T

- Defined in src/dsl.ts:520
Type parameters
- T: Glsl
Parameters
- this: Boolean
- whenTrue: T
- whenFalse: T
Returns T

condMQ

condMQ<T>(this: Boolean, whenTrue: T, whenFalse: T): T

- Defined in src/dsl.ts:517
Type parameters
- T: Glsl
Parameters
- this: Boolean
- whenTrue: T
- whenFalse: T
Returns T

distance

distance<T>(this: T, other: T): Scalar
distance(this: Scalar, other: number): Scalar

- Defined in src/dsl.ts:320
Distance to other point

Type parameters
- T: AnyNumeric
Parameters
- this: T
- other: T
Returns Scalar
- Defined in src/dsl.ts:321
Distance to other point

Parameters
- this: Scalar
- other: number
Returns Scalar

div

div<T>(this: T, other: T | Scalar | number): T
div<T>(this: Scalar, other: T): T

- Defined in src/dsl.ts:373
Division

Type parameters
- T: AnyNumeric | AnyMatrix
Parameters
- this: T
- other: T | Scalar | number
Returns T
- Defined in src/dsl.ts:374
Division

Type parameters
- T: AnyNumeric | AnyMatrix
Parameters
- this: Scalar
- other: T
Returns T

dot

dot<T>(this: T, other: T): Scalar
dot(this: Scalar, other: number): Scalar

- Defined in src/dsl.ts:329
Dot product

Type parameters
- T: AnyNumeric
Parameters
- this: T
- other: T
Returns Scalar
- Defined in src/dsl.ts:330
Dot product

Parameters
- this: Scalar
- other: number
Returns Scalar

g

g(this: AnyVector): Scalar

- Defined in src/dsl.ts:595
Get the second component of vector

Parameters
- this: AnyVector
Returns Scalar

length

length(this: AnyNumeric): Scalar

- Defined in src/dsl.ts:315
Parameters
- this: AnyNumeric
Returns Scalar

max

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

- Defined in src/dsl.ts:288
Type parameters
- P: AnyNumeric
Parameters
- this: Glsl
- p: Glsl
Returns Glsl
- Defined in src/dsl.ts:289
Parameters
- this: Scalar
- p: number
Returns Scalar

mem

mem<T>(this: T, precision: Precision): T

- Defined in src/dsl.ts:438
Save some expression into a variable

Type parameters
- T: Glsl
Parameters
- this: T
- precision: Precision
Returns T

memHQ

memHQ(): this

- Defined in src/dsl.ts:458
Save some expression with high quality into a variable

Returns this

memLQ

memLQ(): this

- Defined in src/dsl.ts:466
Save some expression with low quality into a variable

Returns this

memMQ

memMQ(): this

- Defined in src/dsl.ts:462
Save some expression with medium quality into a variable

Returns this

min

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

- Defined in src/dsl.ts:281
Type parameters
- P: AnyNumeric
Parameters
- this: Glsl
- p: Glsl
Returns Glsl
- Defined in src/dsl.ts:282
Parameters
- this: Scalar
- p: number
Returns Scalar

mix

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

- Defined in src/dsl.ts:294
Type parameters
- P: AnyNumeric
Parameters
- this: P
- other: P
- p: P
Returns P
- Defined in src/dsl.ts:295
Type parameters
- P: AnyNumeric
Parameters
- this: P
- other: P
- p: number
Returns P
- Defined in src/dsl.ts:296
Parameters
- this: Scalar
- other: number
- p: Scalar | number
Returns Scalar

mod

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

- Defined in src/dsl.ts:274
Type parameters
- P: AnyNumeric
Parameters
- this: Glsl
- p: Glsl
Returns Glsl
- Defined in src/dsl.ts:275
Parameters
- this: Scalar
- p: number
Returns Scalar

mul

mul<T>(this: T, other: T | Scalar | number): T
mul<T>(this: Scalar, other: T | Scalar | number): T
mul(this: Matrix2, other: Vector2): Vector2
mul(this: Vector2, other: Matrix2): Vector2
mul(this: Matrix3, other: Vector3): Vector3
mul(this: Vector3, other: Matrix3): Vector3
mul(this: Matrix4, other: Vector4): Vector4
mul(this: Vector4, other: Matrix4): Vector4

- Defined in src/dsl.ts:382
Multiplication operation

Type parameters
- T: AnyNumeric | AnyMatrix
Parameters
- this: T
- other: T | Scalar | number
Returns T
- Defined in src/dsl.ts:383
Multiplication operation

Type parameters
- T: AnyNumeric | AnyMatrix
Parameters
- this: Scalar
- other: T | Scalar | number
Returns T
- Defined in src/dsl.ts:384
Multiplication operation

Parameters
- this: Matrix2
- other: Vector2
Returns Vector2
- Defined in src/dsl.ts:385
Multiplication operation

Parameters
- this: Vector2
- other: Matrix2
Returns Vector2
- Defined in src/dsl.ts:386
Multiplication operation

Parameters
- this: Matrix3
- other: Vector3
Returns Vector3
- Defined in src/dsl.ts:387
Multiplication operation

Parameters
- this: Vector3
- other: Matrix3
Returns Vector3
- Defined in src/dsl.ts:388
Multiplication operation

Parameters
- this: Matrix4
- other: Vector4
Returns Vector4
- Defined in src/dsl.ts:389
Multiplication operation

Parameters
- this: Vector4
- other: Matrix4
Returns Vector4

or

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

- Defined in src/dsl.ts:431
Parameters
- this: Boolean
- other: Boolean
Returns Boolean

pow

pow(this: Scalar, p: Scalar): Scalar
pow(this: Vector2, p: Vector2): Vector2
pow(this: Vector3, p: Vector3): Vector3
pow(this: Vector4, p: Vector4): Vector4
pow(this: Scalar, p: number): Scalar

- Defined in src/dsl.ts:264
Parameters
- this: Scalar
- p: Scalar
Returns Scalar
- Defined in src/dsl.ts:265
Parameters
- this: Vector2
- p: Vector2
Returns Vector2
- Defined in src/dsl.ts:266
Parameters
- this: Vector3
- p: Vector3
Returns Vector3
- Defined in src/dsl.ts:267
Parameters
- this: Vector4
- p: Vector4
Returns Vector4
- Defined in src/dsl.ts:268
Parameters
- this: Scalar
- p: number
Returns Scalar

r

r(this: AnyVector): Scalar

- Defined in src/dsl.ts:591
Get the first component of vector

Parameters
- this: AnyVector
Returns Scalar

reflect

reflect<T>(this: T, n: T): T

- Defined in src/dsl.ts:338
Type parameters
- T: AnyNumeric
Parameters
- this: T
- n: T
Returns T

refract

refract<T>(this: T, n: T, eta: Scalar | number): T

- Defined in src/dsl.ts:343
Type parameters
- T: AnyNumeric
Parameters
- this: T
- n: T
- eta: Scalar | number
Returns T

round

round<T>(this: T): T

- Defined in src/dsl.ts:247
Type parameters
- T: AnyNumeric
Parameters
- this: T
Returns T

smoothstep

smoothstep(this: Scalar, edge1: Scalar | number, edge2: Scalar | number): Scalar
smoothstep<T>(this: T, edge1: T, edge2: T): T
smoothstep<T>(this: Scalar, edge1: Scalar | number, edge2: Scalar | number): T

- Defined in src/dsl.ts:308
Parameters
- this: Scalar
- edge1: Scalar | number
- edge2: Scalar | number
Returns Scalar
- Defined in src/dsl.ts:309
Type parameters
- T: AnyNumeric
Parameters
- this: T
- edge1: T
- edge2: T
Returns T
- Defined in src/dsl.ts:310
Type parameters
- T: AnyNumeric
Parameters
- this: Scalar
- edge1: Scalar | number
- edge2: Scalar | number
Returns T

sub

sub<T>(this: T, other: T | Scalar | number): T
sub<T>(this: Scalar, other: T): T

- Defined in src/dsl.ts:364
Substraction

Type parameters
- T: AnyNumeric | AnyMatrix
Parameters
- this: T
- other: T | Scalar | number
Returns T
- Defined in src/dsl.ts:365
Substraction

Type parameters
- T: AnyNumeric | AnyMatrix
Parameters
- this: Scalar
- other: T
Returns T

take

take<T>(this: Glsl<T>, i: Indexes<T>): Scalar
take<T>(this: Glsl<T>, i1: Indexes<T>, i2: Indexes<T>): Vector2
take<T>(this: Glsl<T>, i1: Indexes<T>, i2: Indexes<T>, i3: Indexes<T>): Vector3
take(this: Vector4, i1: Indexes<Vector4>, i2: Indexes<Vector4>, i3: Indexes<Vector4>, i4: Indexes<Vector4>): Vector4

- Defined in src/dsl.ts:524
Take one or more components from vector

Type parameters
- T: AnyVector
Parameters
- this: Glsl<T>
- i: Indexes<T>
Returns Scalar
- Defined in src/dsl.ts:525
Take one or more components from vector

Type parameters
- T: AnyVector
Parameters
- this: Glsl<T>
- i1: Indexes<T>
- i2: Indexes<T>
Returns Vector2
- Defined in src/dsl.ts:526
Take one or more components from vector

Type parameters
- T: Vector3 | Vector4
Parameters
- this: Glsl<T>
- i1: Indexes<T>
- i2: Indexes<T>
- i3: Indexes<T>
Returns Vector3
- Defined in src/dsl.ts:527
Take one or more components from vector

Parameters
- this: Vector4
- i1: Indexes<Vector4>
- i2: Indexes<Vector4>
- i3: Indexes<Vector4>
- i4: Indexes<Vector4>
Returns Vector4

texture2D

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

- Defined in src/dsl.ts:351
Get texture value at the specified point

Parameters
- this: Sampler
- point: Vector2
Returns Vector4

vec2

vec2(this: Scalar): Vector2

- Defined in src/dsl.ts:544
Parameters
- this: Scalar
Returns Vector2

vec3

vec3(this: Scalar): Vector3

- Defined in src/dsl.ts:553
Parameters
- this: Scalar
Returns Vector3

vec4

vec4(this: Scalar): Vector4

- Defined in src/dsl.ts:562
Parameters
- this: Scalar
Returns Vector4

w

w(this: AnyVector): Scalar

- Defined in src/dsl.ts:586
Get the fourth component of vector

Parameters
- this: AnyVector
Returns Scalar

x

x(this: AnyVector): Scalar

- Defined in src/dsl.ts:574
Get the first component of vector

Parameters
- this: AnyVector
Returns Scalar

y

y(this: AnyVector): Scalar

- Defined in src/dsl.ts:578
Get the second component of vector

Parameters
- this: AnyVector
Returns Scalar

z

z(this: AnyVector): Scalar

- Defined in src/dsl.ts:582
Get the third component of vector

Parameters
- this: AnyVector
Returns Scalar

Static Private bool

bool(name: string): (Anonymous function)

- Defined in src/dsl.ts:409
Parameters
- name: string
Returns (Anonymous function)

Static Private call

call(name: string, values: (Glsl | number)[], rtype: (types: Type[]) => Type): Glsl<Type>

- Defined in src/dsl.ts:193
Parameters
- name: string
- values: (Glsl | number)[]
- rtype: (types: Type[]) => Type
 - - (types: Type[]): Type
 - Parameters
 - types: Type[]
 Returns Type
Returns Glsl<Type>

Static Private unary

unary<X>(name: string): (Anonymous function)

- Defined in src/dsl.ts:219
Type parameters
- X: Type = Type.AnyNumeric
Parameters
- name: string
Returns (Anonymous function)

Static val

val(v: boolean): Glsl<Boolean>
val(v: number): Scalar
val<T>(v: T): T
val(v1: Scalar | number, v2: Scalar | number): Vector2
val(v1: Scalar | number, v2: Vector2): Vector3
val(v1: Scalar | number, v2: Vector3): Vector4
val(v1: Vector2, v2: Scalar | number): Vector3
val(v1: Vector3, v2: Scalar | number): Vector4
val(v1: Scalar | number, v2: Scalar | number, v3: Scalar | number): Vector3
val(v1: Vector2, v2: Scalar | number, v3: Scalar | number): Vector4
val(v1: Scalar | number, v2: Vector2, v3: Scalar | number): Vector4
val(v1: Scalar | number, v2: Scalar | number, v3: Vector2): Vector4
val(v1: Scalar | number, v2: Scalar | number, v3: Scalar | number, v4: Scalar | number): Vector4

- Defined in src/dsl.ts:633
Wrap set of values into single GLSL value

Parameters
- v: boolean
Returns Glsl<Boolean>
- Defined in src/dsl.ts:634
Wrap set of values into single GLSL value

Parameters
- v: number
Returns Scalar
- Defined in src/dsl.ts:635
Wrap set of values into single GLSL value

Type parameters
- T: Glsl
Parameters
- v: T
Returns T
- Defined in src/dsl.ts:636
Wrap set of values into single GLSL value

Parameters
- v1: Scalar | number
- v2: Scalar | number
Returns Vector2
- Defined in src/dsl.ts:640
Wrap set of values into single GLSL value

Parameters
- v1: Scalar | number
- v2: Vector2
Returns Vector3
- Defined in src/dsl.ts:644
Wrap set of values into single GLSL value

Parameters
- v1: Scalar | number
- v2: Vector3
Returns Vector4
- Defined in src/dsl.ts:648
Wrap set of values into single GLSL value

Parameters
- v1: Vector2
- v2: Scalar | number
Returns Vector3
- Defined in src/dsl.ts:652
Wrap set of values into single GLSL value

Parameters
- v1: Vector3
- v2: Scalar | number
Returns Vector4
- Defined in src/dsl.ts:657
Wrap set of values into single GLSL value

Parameters
- v1: Scalar | number
- v2: Scalar | number
- v3: Scalar | number
Returns Vector3
- Defined in src/dsl.ts:662
Wrap set of values into single GLSL value

Parameters
- v1: Vector2
- v2: Scalar | number
- v3: Scalar | number
Returns Vector4
- Defined in src/dsl.ts:667
Wrap set of values into single GLSL value

Parameters
- v1: Scalar | number
- v2: Vector2
- v3: Scalar | number
Returns Vector4
- Defined in src/dsl.ts:672
Wrap set of values into single GLSL value

Parameters
- v1: Scalar | number
- v2: Scalar | number
- v3: Vector2
Returns Vector4
- Defined in src/dsl.ts:678
Wrap set of values into single GLSL value

Parameters
- v1: Scalar | number
- v2: Scalar | number
- v3: Scalar | number
- v4: Scalar | number
Returns Vector4

Type parameters

T: Type = Type

Hierarchy

Index

Type aliases

Constructors

Properties

Methods

Type aliases

Static AnyMatrix

Static AnyNumeric

Static AnyVector

Static Boolean

Static Matrix2

Static Matrix3

Static Matrix4

Static Sampler

Static Scalar

Static Vector2

Static Vector3

Static Vector4

Constructors

constructor

Parameters

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

Parameters

builder: GlslBuilder

Returns Value<T>

Returns Glsl

Properties

abs

acos

asin

ceil

cos

degrees

eq

exp

exp2

floor

fract

Readonly getValue

Type declaration

Parameters

builder: GlslBuilder

Returns Value<T>

gt

gte

inversesqrt

log

log2

lt

lte

neq

normalize

not

radians

sign

sin

sqrt

tan

Static PI

Methods

a

Parameters

this: AnyVector

Returns Scalar

add

Type parameters

T: AnyNumeric | AnyMatrix

Parameters

this: T

other: T | Scalar | number

Returns T

Type parameters

T: AnyNumeric | AnyMatrix

Parameters

this: Scalar

other: T

Returns T