Class Material

Hierarchy

Asset
- Material

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Material(props?: MaterialProps): Material

Overrides UniqueObject.constructor
- Defined in src/graphics/Material.ts:138
Parameters
- Optional props: MaterialProps
Returns Material

Properties

deleted

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

id

id: string

isPersistent

isPersistent: boolean = false

name

name: string

Optional templatePath

templatePath: undefined | string

Accessors

blending

get blending(): BlendingModes
set blending(blending: BlendingModes): void

- Defined in src/graphics/Material.ts:45
Returns BlendingModes
- Defined in src/graphics/Material.ts:56
Parameters
- blending: BlendingModes
Returns void

buckedId

get buckedId(): string

- Defined in src/graphics/Material.ts:105
Returns string

cullMode

get cullMode(): CullModes
set cullMode(cullMode: CullModes): void

- Defined in src/graphics/Material.ts:47
Returns CullModes
- Defined in src/graphics/Material.ts:60
Parameters
- cullMode: CullModes
Returns void

depthTest

get depthTest(): boolean
set depthTest(depthTest: boolean): void

- Defined in src/graphics/Material.ts:50
Returns boolean
- Defined in src/graphics/Material.ts:64
Parameters
- depthTest: boolean
Returns void

priority

get priority(): number
set priority(priority: number): void

- Defined in src/graphics/Material.ts:48
Returns number
- Defined in src/graphics/Material.ts:54
Parameters
- priority: number
Returns void

renderPass

get renderPass(): RenderPass
set renderPass(renderPass: RenderPass): void

- Defined in src/graphics/Material.ts:46
Returns RenderPass
- Defined in src/graphics/Material.ts:53
Parameters
- renderPass: RenderPass
Returns void

shader

get shader(): null | Shader
set shader(shader: Shader | null): void

- Defined in src/graphics/Material.ts:44
Returns null | Shader
- Defined in src/graphics/Material.ts:52
Parameters
- shader: Shader | null
Returns void

shaderParams

get shaderParams(): SerializableObject
set shaderParams(paramDefinitions: SerializableObject): void

- Defined in src/graphics/Material.ts:49
Returns SerializableObject
- Defined in src/graphics/Material.ts:69
Parameters
- paramDefinitions: SerializableObject
Returns void

version

get version(): number

- Defined in src/graphics/Material.ts:42
Returns number

Methods

applyParameter

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

- Defined in src/graphics/Material.ts:241
Parameters
- name: string
- value: any
Returns void

applyReferenceParameter

applyReferenceParameter(name: string, referred: GraphicAsset): void

- Defined in src/graphics/Material.ts:250
Parameters
- name: string
- referred: GraphicAsset
Returns void

begin

begin(context?: IShadingContext): boolean

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

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

Overrides Asset.destroy
- Defined in src/graphics/Material.ts:202
Returns void

getParameter

getParameter(name: string): any

- Defined in src/graphics/Material.ts:236
Parameters
- name: string
Returns any

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

Overrides Asset.isLoaded
- Defined in src/graphics/Material.ts:215
Returns boolean

queueParameter

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

- Defined in src/graphics/Material.ts:223
Parameters
- name: string
- value: any
Returns void

queueReferenceParameter

queueReferenceParameter(name: string, referred: GraphicAsset): void

- Defined in src/graphics/Material.ts:227
Parameters
- name: string
- referred: GraphicAsset
Returns void

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/Material.ts:260
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject

uploadState

uploadState(): void

- Defined in src/graphics/Material.ts:175
Returns void