Godray | @ko-yelie/kgl

Hierarchy

Program
- Godray

Index

Constructors

constructor

Accessors

Constructors

constructor

new Godray(kgl: KglEffect): Godray

Overrides Program.constructor
- Defined in src/effects/godray.ts:15
Parameters
- kgl: KglEffect
Returns Godray

Properties

_rotate

_rotate: Vec3 = ...

_scale

_scale: Vec3 = ...

_scalePatch

_scalePatch: number = 1

_translate

_translate: Vec3 = ...

attributes

attributes: {} = {}

Type declaration

[K: string]: AttributeProgram

children

children: ObjectGl[] = []

Optional count

count?: number

data

data: AnyData = {}

drawType

drawType: DrawType

fragmentShader

fragmentShader: null | <internal>.WebGLShader = null

gl

gl: <internal>.WebGLRenderingContext

glMode

glMode: number

godrayBlur

godrayBlur: Blur

godraySpecular

godraySpecular: Specular

godrayZoomblur

godrayZoomblur: Zoomblur

hasCamera

hasCamera: boolean

hasLight

hasLight: boolean

hasMatrix

hasMatrix: boolean = true

Optional height

height?: number

Optional heightSegments

heightSegments?: number

id

id: number = -1

Optional indicesCount

indicesCount?: number

Optional instanceCount

instanceCount?: number

Optional instancedArraysExt

instancedArraysExt?: ANGLE_instanced_arrays

Optional invMatrix

invMatrix?: Float32Array

isAdditive

isAdditive: boolean

isAutoResolution

isAutoResolution: boolean

isCulling

isCulling: boolean

isDepth

isDepth: boolean

isHidden

isHidden: boolean

isInstanced

isInstanced: boolean

isPoint

isPoint: boolean = false

isProgram

isProgram: boolean = true

isTransparent

isTransparent: boolean

isUpdateMatrix

isUpdateMatrix: boolean = false

kgl

kgl: default

kglTextures

kglTextures: KglTexture[] = []

mMatrix

mMatrix: Float32Array = ...

Optional mode

mode?: Mode

mvpMatrix

mvpMatrix: Float32Array = ...

Optional openEnded

openEnded?: boolean

program

program: null | <internal>.WebGLProgram = null

Optional radialSegments

radialSegments?: number

radius

radius: number = 0.02

Optional radiusBottom

radiusBottom?: number

Optional radiusTop

radiusTop?: number

Optional size

size?: number

textures

textures: {} = {}

Type declaration

[K: string]: Texture

Optional thetaLength

thetaLength?: number

Optional thetaStart

thetaStart?: number

uniforms

uniforms: Uniforms = {}

vertexShader

vertexShader: null | <internal>.WebGLShader = null

Optional width

width?: number

Accessors

rotate

get rotate(): any
set rotate(radian: any): void

Inherited from Program.rotate
- Defined in src/object.ts:233
Returns any
Inherited from Program.rotate
- Defined in src/object.ts:237
Parameters
- radian: any
Returns void

rotate3d

get rotate3d(): Vec3
set rotate3d(radian: Vec3): void

Inherited from Program.rotate3d
- Defined in src/object.ts:241
Returns Vec3
Inherited from Program.rotate3d
- Defined in src/object.ts:245
Parameters
- radian: Vec3
Returns void

rotateX

get rotateX(): any
set rotateX(radian: any): void

Inherited from Program.rotateX
- Defined in src/object.ts:206
Returns any
Inherited from Program.rotateX
- Defined in src/object.ts:210
Parameters
- radian: any
Returns void

rotateY

get rotateY(): any
set rotateY(radian: any): void

Inherited from Program.rotateY
- Defined in src/object.ts:215
Returns any
Inherited from Program.rotateY
- Defined in src/object.ts:219
Parameters
- radian: any
Returns void

rotateZ

get rotateZ(): any
set rotateZ(radian: any): void

Inherited from Program.rotateZ
- Defined in src/object.ts:224
Returns any
Inherited from Program.rotateZ
- Defined in src/object.ts:228
Parameters
- radian: any
Returns void

scale

get scale(): any
set scale(value: any): void

Inherited from Program.scale
- Defined in src/object.ts:138
Returns any
Inherited from Program.scale
- Defined in src/object.ts:145
Parameters
- value: any
Returns void

scale2d

get scale2d(): number | Array2 | Vec2
set scale2d(value: number | Array2 | Vec2): void

Inherited from Program.scale2d
- Defined in src/object.ts:177
Returns number | Array2 | Vec2
Inherited from Program.scale2d
- Defined in src/object.ts:181
Parameters
- value: number | Array2 | Vec2
Returns void

scale3d

get scale3d(): number | Array3 | Vec3
set scale3d(value: number | Array3 | Vec3): void

Inherited from Program.scale3d
- Defined in src/object.ts:191
Returns number | Array3 | Vec3
Inherited from Program.scale3d
- Defined in src/object.ts:195
Parameters
- value: number | Array3 | Vec3
Returns void

scalePatch

get scalePatch(): number
set scalePatch(value: number): void

Inherited from Program.scalePatch
- Defined in src/object.ts:252
Returns number
Inherited from Program.scalePatch
- Defined in src/object.ts:256
Parameters
- value: number
Returns void

scaleX

get scaleX(): any
set scaleX(value: any): void

Inherited from Program.scaleX
- Defined in src/object.ts:150
Returns any
Inherited from Program.scaleX
- Defined in src/object.ts:154
Parameters
- value: any
Returns void

scaleY

get scaleY(): any
set scaleY(value: any): void

Inherited from Program.scaleY
- Defined in src/object.ts:159
Returns any
Inherited from Program.scaleY
- Defined in src/object.ts:163
Parameters
- value: any
Returns void

scaleZ

get scaleZ(): any
set scaleZ(value: any): void

Inherited from Program.scaleZ
- Defined in src/object.ts:168
Returns any
Inherited from Program.scaleZ
- Defined in src/object.ts:172
Parameters
- value: any
Returns void

translate3d

get translate3d(): Vec3
set translate3d(value: Vec3): void

Inherited from Program.translate3d
- Defined in src/object.ts:127
Returns Vec3
Inherited from Program.translate3d
- Defined in src/object.ts:131
Parameters
- value: Vec3
Returns void

x

get x(): any
set x(value: any): void

Inherited from Program.x
- Defined in src/object.ts:100
Returns any
Inherited from Program.x
- Defined in src/object.ts:104
Parameters
- value: any
Returns void

y

get y(): any
set y(value: any): void

Inherited from Program.y
- Defined in src/object.ts:109
Returns any
Inherited from Program.y
- Defined in src/object.ts:113
Parameters
- value: any
Returns void

z

get z(): any
set z(value: any): void

Inherited from Program.z
- Defined in src/object.ts:118
Returns any
Inherited from Program.z
- Defined in src/object.ts:122
Parameters
- value: any
Returns void

Methods

add

add(objectGl: ObjectGl): void

Inherited from Program.add
- Defined in src/object.ts:324
Parameters
- objectGl: ObjectGl
Returns void

addAttribute

addAttribute(key: string, value: AttributeValue, size?: number, isIndices?: boolean, isInstanced?: boolean): void

Inherited from Program.addAttribute
- Defined in src/program.ts:315
Parameters
- key: string
- value: AttributeValue
- Optional size: number
- isIndices: boolean = false
- isInstanced: boolean = false
Returns void

addUniform

addUniform(key: string, value: any): void

Inherited from Program.addUniform
- Defined in src/program.ts:421
Parameters
- key: string
- value: any
Returns void

changeMatrix

changeMatrix(): void

Inherited from Program.changeMatrix
- Defined in src/object.ts:261
Returns void

createAttribute

createAttribute(data: Attributes, isInstanced?: boolean): void

Inherited from Program.createAttribute
- Defined in src/program.ts:307
Parameters
- data: Attributes
- isInstanced: boolean = false
Returns void

createProgram

createProgram(codeVertexShader: string, codeFragmentShader: string): void

Inherited from Program.createProgram
- Defined in src/program.ts:261
Parameters
- codeVertexShader: string
- codeFragmentShader: string
Returns void

createShader

createShader(type: "VERTEX_SHADER" | "FRAGMENT_SHADER", content: string): undefined | <internal>.WebGLShader

Inherited from Program.createShader
- Defined in src/program.ts:292
Parameters
- type: "VERTEX_SHADER" | "FRAGMENT_SHADER"
- content: string
Returns undefined | <internal>.WebGLShader

createTexture

createTexture(key: string, el: TexImageSource): undefined | number

Inherited from Program.createTexture
- Defined in src/program.ts:553
Parameters
- key: string
- el: TexImageSource
Returns undefined | number

createUniform

createUniform(data: Uniforms): void

Inherited from Program.createUniform
- Defined in src/program.ts:397
Parameters
- data: Uniforms
Returns void

destroy

destroy(): void

Inherited from Program.destroy
- Defined in src/program.ts:693
Returns void

draw

draw(): void

Inherited from Program.draw
- Defined in src/program.ts:624
Returns void

drawEffect

drawEffect(readFramebufferKey: string, cacheFramebufferKey: string, outFramebufferKey: string, strength?: number, center?: Array2, radius?: number, isOnscreen?: boolean): void

- Defined in src/effects/godray.ts:35
Parameters
- readFramebufferKey: string
- cacheFramebufferKey: string
- outFramebufferKey: string
- Optional strength: number
- Optional center: Array2
- Optional radius: number
- Optional isOnscreen: boolean
Returns void

forEachProgram

forEachProgram(func: Function): void

Inherited from Program.forEachProgram
- Defined in src/object.ts:346
Parameters
- func: Function
Returns void

hidden

hidden(): void

Inherited from Program.hidden
- Defined in src/program.ts:620
Returns void

remove

remove(objectGl: ObjectGl): void

Inherited from Program.remove
- Defined in src/object.ts:328
Parameters
- objectGl: ObjectGl
Returns void

setAttribute

setAttribute(key: string): void

Inherited from Program.setAttribute
- Defined in src/program.ts:357
Parameters
- key: string
Returns void

setIsUpdateMatrix

setIsUpdateMatrix(): void

Inherited from Program.setIsUpdateMatrix
- Defined in src/object.ts:267
Returns void

updateAttribute

updateAttribute(key: string, values: AttributeValue, offset?: number): void

Inherited from Program.updateAttribute
- Defined in src/program.ts:372
Parameters
- key: string
- values: AttributeValue
- offset: number = 0
Returns void

updateMatrix

updateMatrix(vpMatrix: Float32Array): undefined | true

Inherited from Program.updateMatrix
- Defined in src/program.ts:379
Parameters
- vpMatrix: Float32Array
Returns undefined | true

updateTexture

updateTexture(key: string, el: TexImageSource): number

Inherited from Program.updateTexture
- Defined in src/program.ts:599
Parameters
- key: string
- el: TexImageSource
Returns number

updateUniforms

updateUniforms(uniforms: {}): void

Inherited from Program.updateUniforms
- Defined in src/program.ts:545
Parameters
- uniforms: {}
  - [K: string]: UniformValue
Returns void

use

use(): void

Inherited from Program.use
- Defined in src/program.ts:609
Returns void

visible

visible(): void

Inherited from Program.visible
- Defined in src/program.ts:616
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

kgl: KglEffect

Returns Godray

Properties

_rotate

_scale

_scalePatch

_translate

attributes

Type declaration

[K: string]: AttributeProgram

children

Optional count

data

drawType

fragmentShader

gl

glMode

godrayBlur

godraySpecular

godrayZoomblur

hasCamera

hasLight

hasMatrix

Optional height

Optional heightSegments

id

Optional indicesCount

Optional instanceCount

Optional instancedArraysExt

Optional invMatrix

isAdditive

isAutoResolution

isCulling

isDepth

isHidden

isInstanced

isPoint

isProgram

isTransparent

isUpdateMatrix

kgl

kglTextures

mMatrix

Optional mode

mvpMatrix

Optional openEnded

program

Optional radialSegments

radius

Optional radiusBottom

Optional radiusTop

Optional size

textures

Type declaration

[K: string]: Texture

Optional thetaLength

Optional thetaStart

uniforms

vertexShader

Optional width

Accessors

rotate

Returns any

Parameters

radian: any

Returns void

rotate3d

Returns Vec3

Parameters

radian: Vec3

Returns void