Material

Index

Constructors

• constructor

Properties

• id
• BuiltInUniforms

Accessors

• color
• fragmentSource
• images
• isOverridingGraphic
• isUsingScreenTexture
• name
• padding
• pipeline
• uniforms
• vertexSource

Methods

• addImageSource
• getShader
• removeImageSource
• update
• use

Constructors

constructor

• Material(options: MaterialOptions): Material

• Parameters

  • options: MaterialOptions

  Returns Material

Properties

publicreadonlyid

id: number = ...

Unique identifier for this material, useful for debugging and tooling

staticBuiltInUniforms

BuiltInUniforms: string[] = ...

Accessors

color

• get color(): Color
• set color(c: Color): void

• Returns Color

• Parameters

  • c: Color

  Returns void

fragmentSource

• get fragmentSource(): string

• Fragment source this material was created with (before shader compilation)

  ---

  Returns string

publicimages

• get images(): Record<string, ImageSource>

• Returns Record<string, ImageSource>

isOverridingGraphic

• get isOverridingGraphic(): boolean

• Returns boolean

isUsingScreenTexture

• get isUsingScreenTexture(): boolean

• Returns boolean

name

• get name(): string

• Returns string

padding

• get padding(): number

• Extra transparent pixels added around the graphic when running the pipeline

  ---

  Returns number

pipeline

• get pipeline(): ShaderPipelineLike | undefined

• The multipass pipeline run on the graphic before the composite fragment, if any

  ---

  Returns ShaderPipelineLike | undefined

publicuniforms

• get uniforms(): UniformDictionary

• Returns UniformDictionary

vertexSource

• get vertexSource(): string

• Vertex source this material was created with (before shader compilation)

  ---

  Returns string

Methods

addImageSource

• addImageSource(samplerName: string, image: ImageSource): void

• Parameters

  • samplerName: string

  • image: ImageSource

  Returns void

getShader

• getShader(): Shader | null

• Returns Shader | null

removeImageSource

• removeImageSource(samplerName: string): void

• Parameters

  • samplerName: string

  Returns void

update

• update(callback: (shader: Shader) => any): void

• Parameters

  • callback: (shader: Shader) => any

  Returns void

use

• use(): void

• Returns void