Class MeshMaterial

constructor

• new MeshMaterial(
      uSampler: Texture<Resource>,
      options?: IMeshMaterialOptions,
  ): MeshMaterial

• Parameters

  • uSampler: Texture<Resource>

    Texture that material uses to render.
  • Optionaloptions: IMeshMaterialOptions

    Additional options

    • Optionalalpha?: number

    • OptionalpluginName?: string

    • Optionalprogram?: Program

    • Optionaltint?: ColorSource

    • Optionaluniforms?: Dict<unknown>

  Returns MeshMaterial

_tintRGB

batchable

true
Copy

disposeRunner

pluginName

'batch'
Copy

program

uniformGroup

ReadonlyuvMatrix

alpha

• get alpha(): number

• Returns number

• set alpha(value: number): void

• This gets automatically set by the object using this.

  Parameters

  • value: number

  Returns void

  Default

  1
  Copy

texture

• get texture(): Texture<Resource>

• Reference to the texture being rendered.

  Returns Texture<Resource>
• set texture(value: Texture<Resource>): void

• Parameters

  • value: Texture<Resource>

  Returns void

tint

• get tint(): ColorSource

• Returns ColorSource

• set tint(value: ColorSource): void

• Multiply tint for the material.

  Parameters

  • value: ColorSource

  Returns void

  Default

  0xFFFFFF
  Copy

uniforms

• get uniforms(): Dict<any>

• Shader uniform values, shortcut for uniformGroup.uniforms.

  Returns Dict<any>

checkUniformExists

• checkUniformExists(name: string, group: UniformGroup<Dict<any>>): boolean

• Parameters

  • name: string
  • group: UniformGroup<Dict<any>>

  Returns boolean

destroy

• destroy(): void

• Returns void

update

• update(): void

• Gets called automatically by the Mesh. Intended to be overridden for custom PIXI.MeshMaterial objects.

  Returns void

Staticfrom

• from(vertexSrc?: string, fragmentSrc?: string, uniforms?: Dict<any>): Shader

• A short hand function to create a shader based of a vertex and fragment shader.

  Parameters

  • OptionalvertexSrc: string

    The source of the vertex shader.
  • OptionalfragmentSrc: string

    The source of the fragment shader.
  • Optionaluniforms: Dict<any>

    Custom uniforms to use to augment the built-in ones.

  Returns Shader

  A shiny new PixiJS shader!