Class Shader

Hierarchy

GraphicAsset
- Shader
  - PhongShader

Index

Constructors

constructor

Events

codeChanged

Properties

Accessors

Constructors

constructor

new Shader(props?: ObjectProps<Shader>): Shader

Overrides UniqueObject.constructor
- Defined in src/graphics/shading/Shader.ts:154
Parameters
- Optional props: ObjectProps<Shader>
Returns Shader

Events

codeChanged

codeChanged: AsyncEvent<string> = new AsyncEvent<string>()

Properties

Protected _fragmentCode

_fragmentCode: string

Protected _shaderError

_shaderError: boolean = false

Protected _vertexCode

_vertexCode: string

deleted

deleted: AsyncEvent<string> = new AsyncEvent<string>()

id

id: string

isPersistent

isPersistent: boolean = false

name

name: string

Optional templatePath

templatePath: undefined | string

Accessors

fragmentCode

get fragmentCode(): string
set fragmentCode(fragmentCode: string): void

- Defined in src/graphics/shading/Shader.ts:99
Returns string
- Defined in src/graphics/shading/Shader.ts:121
Parameters
- fragmentCode: string
Returns void

version

get version(): number

- Defined in src/graphics/shading/Shader.ts:90
Returns number

vertexCode

get vertexCode(): string
set vertexCode(vertexCode: string): void

- Defined in src/graphics/shading/Shader.ts:98
Returns string
- Defined in src/graphics/shading/Shader.ts:100
Parameters
- vertexCode: string
Returns void

Methods

applyNumberArrayParam

applyNumberArrayParam(name: string, numbers: number[], bucketId?: undefined | string): void

- Defined in src/graphics/shading/Shader.ts:257
Parameters
- name: string
- numbers: number[]
- Optional bucketId: undefined | string
Returns void

applyParam

applyParam(name: string, value: any, bucketId?: undefined | string): void

- Defined in src/graphics/shading/Shader.ts:220
Parameters
- name: string
- value: any
- Optional bucketId: undefined | string
Returns void

applyReferenceArrayParam

applyReferenceArrayParam(name: string, referreds: GraphicAsset[], bucketId?: undefined | string): void

- Defined in src/graphics/shading/Shader.ts:237
Parameters
- name: string
- referreds: GraphicAsset[]
- Optional bucketId: undefined | string
Returns void

applyReferenceParam

applyReferenceParam(name: string, referred: GraphicAsset, bucketId?: undefined | string): void

- Defined in src/graphics/shading/Shader.ts:228
Parameters
- name: string
- referred: GraphicAsset
- Optional bucketId: undefined | string
Returns void

applyVec3ArrayParam

applyVec3ArrayParam(name: string, vecs: Vector3[], bucketId?: undefined | string): void

- Defined in src/graphics/shading/Shader.ts:266
Parameters
- name: string
- vecs: Vector3[]
- Optional bucketId: undefined | string
Returns void

begin

begin(context?: IShadingContext): boolean

- Defined in src/graphics/shading/Shader.ts:163
Parameters
- Optional context: IShadingContext
Returns boolean

beginWithVisual

beginWithVisual(visual: Visual, bucketId: string, fog?: Fog): ShaderInstance | null

- Defined in src/graphics/shading/Shader.ts:182
Parameters
- visual: Visual
- bucketId: string
- Optional fog: Fog
Returns ShaderInstance | null

copy

copy(): UniqueObject

Inherited from UniqueObject.copy

Overrides SerializableObject.copy
- Defined in src/core/UniqueObject.ts:24
Returns UniqueObject

deserialize

deserialize(json: SerializedObjectType): Promise<SerializableObject> | SerializableObject

Inherited from SerializableObject.deserialize
- Defined in src/core/SerializableObject.ts:45
Parameters
- json: SerializedObjectType
Returns Promise<SerializableObject> | SerializableObject

destroy

destroy(): void

Inherited from GraphicAsset.destroy

Overrides Asset.destroy
- Defined in src/graphics/GraphicAsset.ts:7
Returns void

getAttributes

getAttributes(bucketId?: undefined | string): ShaderAttributes

- Defined in src/graphics/shading/Shader.ts:293
Parameters
- Optional bucketId: undefined | string
Returns ShaderAttributes

getUniforms

getUniforms(bucketId?: undefined | string): ShaderParams

- Defined in src/graphics/shading/Shader.ts:297
Parameters
- Optional bucketId: undefined | string
Returns ShaderParams

graphicLoad

graphicLoad(): boolean

Inherited from GraphicAsset.graphicLoad
- Defined in src/graphics/GraphicAsset.ts:12
Returns boolean

graphicUnload

graphicUnload(): void

Overrides GraphicAsset.graphicUnload
- Defined in src/graphics/shading/Shader.ts:275
Returns void

invalidate

invalidate(): void

- Defined in src/graphics/shading/Shader.ts:287
Returns void

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

isLoaded

isLoaded(): boolean

Inherited from Asset.isLoaded
- Defined in src/assets/Asset.ts:24
Returns boolean

Protected loadInstance

loadInstance(instance: ShaderInstance): boolean

- Defined in src/graphics/shading/Shader.ts:347
Parameters
- instance: ShaderInstance
Returns boolean

save

save(folderPath?: undefined | string): void

Inherited from Asset.save
- Defined in src/assets/Asset.ts:33
Parameters
- Optional folderPath: undefined | string
Returns void

serialize

serialize(): SerializedObjectType

Inherited from SerializableObject.serialize
- Defined in src/core/SerializableObject.ts:41
Returns SerializedObjectType

setProperty

setProperty(name: string, value: any): void

Inherited from SerializableObject.setProperty
- Defined in src/core/SerializableObject.ts:37
Parameters
- name: string
- value: any
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Overrides SerializableObject.upgrade
- Defined in src/graphics/shading/Shader.ts:301
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject

Protected useDirectionalLights

useDirectionalLights(): boolean

- Defined in src/graphics/shading/Shader.ts:410
Returns boolean