Class GodRaysExpr

godrays expression

Hierarchy

ExprVec4
- GodRaysExpr

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GodRaysExpr(col?: Vec4, exposure?: Float, decay?: Float, density?: Float, weight?: Float, lightPos?: Vec2, samplerNum?: number, numSamples?: number, convertDepth?: { newColor: Vec4; threshold: Float }): GodRaysExpr

Inherited from ExprVec4.constructor
- Defined in exprs/godraysexpr.ts:31
Parameters
- col: Vec4 = ...
- exposure: Float = ...
- decay: Float = ...
- density: Float = ...
- weight: Float = ...
- lightPos: Vec2 = ...
- samplerNum: number = 0
- numSamples: number = ...
- Optional convertDepth: { newColor: Vec4; threshold: Float }
  - newColor: Vec4
  - threshold: Float
Returns GodRaysExpr

Properties

col

col: Vec4

decay

decay: Float

Readonly defaultNameMap

defaultNameMap: DefaultNameMap = ...

defaultNames

defaultNames: string[]

density

density: Float

exposure

exposure: Float

externalFuncs

externalFuncs: string[] = ...

funcIndex

funcIndex: number = 0

Readonly id

id: string

lightPos

lightPos: Vec2

Readonly needs

needs: Needs = ...

Optional newColor

newColor: undefined | PrimitiveVec4 | ExprVec4 | Operator<Vec4> | Mutable<PrimitiveVec4> | WrappedExpr<Vec4> | BasicVec4

regionBranded

regionBranded: boolean = false

sourceCode

sourceCode: string = ""

sourceLists

sourceLists: SourceLists

Optional threshold

threshold: undefined | PrimitiveFloat | ExprFloat | Operator<Float> | Mutable<PrimitiveFloat> | WrappedExpr<Float> | BasicFloat

Readonly uniformValChangeMap

uniformValChangeMap: UniformValChangeMap = ...

values

values: Float[]

weight

weight: Float

Static count

count: number = 0

increments for each expression created; used to uniquely id each expression

Methods

addFuncs

addFuncs(funcs: string[]): GodRaysExpr

Inherited from ExprVec4.addFuncs
- Defined in exprs/expr.ts:205
Parameters
- funcs: string[]
Returns GodRaysExpr

applyUniforms

applyUniforms(gl: WebGL2RenderingContext, uniformLocs: UniformLocs): void

Inherited from ExprVec4.applyUniforms
- Defined in exprs/expr.ts:116
Parameters
- gl: WebGL2RenderingContext
- uniformLocs: UniformLocs
Returns void

brandExprWithChannel

brandExprWithChannel(funcIndex: number, samplerNum?: number): GodRaysExpr

Inherited from ExprVec4.brandExprWithChannel
- Defined in exprs/expr.ts:210
Parameters
- funcIndex: number
- Optional samplerNum: number
Returns GodRaysExpr

brandExprWithRegion

brandExprWithRegion(space: PrimitiveFloat | ExprFloat | Operator<Float> | Mutable<PrimitiveFloat> | WrappedExpr<Float> | BasicFloat | Float[]): GodRaysExpr

Inherited from ExprVec4.brandExprWithRegion
- Defined in exprs/expr.ts:221
Parameters
- space: PrimitiveFloat | ExprFloat | Operator<Float> | Mutable<PrimitiveFloat> | WrappedExpr<Float> | BasicFloat | Float[]
Returns GodRaysExpr

genPrograms

genPrograms(gl: WebGL2RenderingContext, vShader: WebGLShader, uniformLocs: UniformLocs, shaders: WebGLShader[]): WebGLProgramLoop

Inherited from ExprVec4.genPrograms
- Defined in exprs/expr.ts:528
Parameters
- gl: WebGL2RenderingContext
- vShader: WebGLShader
- uniformLocs: UniformLocs
- shaders: WebGLShader[]
Returns WebGLProgramLoop

getSampleNum

getSampleNum(mult?: number): number

Inherited from ExprVec4.getSampleNum
- Defined in exprs/expr.ts:136
Parameters
- mult: number = 1
Returns number

parse

parse(buildInfo: BuildInfo): string

Inherited from ExprVec4.parse
- Defined in exprs/expr.ts:184
parses this expression into a string, adding info as it recurses into nested expressions

Parameters
- buildInfo: BuildInfo
Returns string

repeat

repeat(num: number): EffectLoop

Inherited from ExprVec4.repeat
- Defined in exprs/expr.ts:524
Parameters
- num: number
Returns EffectLoop

setColor

setColor(color: PrimitiveVec4): void

- Defined in exprs/godraysexpr.ts:101
sets the light color

Parameters
- color: PrimitiveVec4
Returns void

setDecay

setDecay(decay: number | PrimitiveFloat): void

- Defined in exprs/godraysexpr.ts:113
sets the decay

Parameters
- decay: number | PrimitiveFloat
Returns void

setDensity

setDensity(density: number | PrimitiveFloat): void

- Defined in exprs/godraysexpr.ts:119
sets the density

Parameters
- density: number | PrimitiveFloat
Returns void

setExposure

setExposure(exposure: number | PrimitiveFloat): void

- Defined in exprs/godraysexpr.ts:107
sets the exposure

Parameters
- exposure: number | PrimitiveFloat
Returns void

setLightPos

setLightPos(lightPos: PrimitiveVec2): void

- Defined in exprs/godraysexpr.ts:131
sets the light position

Parameters
- lightPos: PrimitiveVec2
Returns void

setNewColor

setNewColor(newColor: PrimitiveVec4): void

- Defined in exprs/godraysexpr.ts:144
Parameters
- newColor: PrimitiveVec4
Returns void

setThreshold

setThreshold(threshold: number | PrimitiveFloat): void

- Defined in exprs/godraysexpr.ts:139
Parameters
- threshold: number | PrimitiveFloat
Returns void

setUniform

setUniform(name: string, newVal: number | PrimitiveFloat | ExprFloat | Operator<Float> | Mutable<PrimitiveFloat> | WrappedExpr<Float> | BasicFloat | PrimitiveVec | ExprVec | Operator<Vec> | Mutable<PrimitiveVec> | WrappedExpr<Vec> | BasicVec): void

Inherited from ExprVec4.setUniform
- Defined in exprs/expr.ts:151
set a uniform by name directly

Parameters
- name: string
  
  uniform name in the source code
- newVal: number | PrimitiveFloat | ExprFloat | Operator<Float> | Mutable<PrimitiveFloat> | WrappedExpr<Float> | BasicFloat | PrimitiveVec | ExprVec | Operator<Vec> | Mutable<PrimitiveVec> | WrappedExpr<Vec> | BasicVec
  
  value to set the uniform to
Returns void

setWeight

setWeight(weight: number | PrimitiveFloat): void

- Defined in exprs/godraysexpr.ts:125
sets the weight

Parameters
- weight: number | PrimitiveFloat
Returns void

typeString

typeString(): TypeString

Inherited from ExprVec4.typeString
- Defined in exprs/expr.ts:542
Returns TypeString

Generated using TypeDoc