Class MeshMaterial

Slightly opinionated default shader for PixiJS 2D objects.

Memberof

PIXI

Hierarchy (view full)

MeshMaterial
Shader
- MeshMaterial

Index

Constructors

constructor

new MeshMaterial(uSampler, options?): MeshMaterial
Parameters
- uSampler: Texture<Resource>
  Texture that material uses to render.
- Optional options: IMeshMaterialOptions
  Additional options
Returns MeshMaterial
Inherited from Shader.constructor
- Defined in node_modules/@pixi/mesh/lib/MeshMaterial.d.ts:50

Properties

_tintRGB

_tintRGB: number

batchable

batchable: boolean

true if shader can be batch with the renderer's batch system.

Default

true

disposeRunner

disposeRunner: Runner<any, any[]>

pluginName

pluginName: string

Renderer plugin for batching.

Default

'batch'

program

program: Program

Program that the shader uses.

uniformGroup

uniformGroup: UniformGroup<Dict<any>>

`Readonly` uvMatrix

uvMatrix: TextureMatrix

TextureMatrix instance for this Mesh, used to track Texture changes.

Accessors

alpha

get alpha(): number
Returns number
- Defined in node_modules/@pixi/mesh/lib/MeshMaterial.d.ts:59
set alpha(value): void
This gets automatically set by the object using this.
Parameters
- value: number
Returns void
Default
```
1
```
- Defined in node_modules/@pixi/mesh/lib/MeshMaterial.d.ts:58

texture

get texture(): Texture<Resource>
Reference to the texture being rendered.

Returns Texture<Resource>
- Defined in node_modules/@pixi/mesh/lib/MeshMaterial.d.ts:52
set texture(value): void
Parameters
- value: Texture<Resource>
Returns void
- Defined in node_modules/@pixi/mesh/lib/MeshMaterial.d.ts:53

tint

get tint(): ColorSource
Returns ColorSource
- Defined in node_modules/@pixi/mesh/lib/MeshMaterial.d.ts:65
set tint(value): void
Multiply tint for the material.
Parameters
- value: ColorSource
Returns void
Default
```
0xFFFFFF
```
- Defined in node_modules/@pixi/mesh/lib/MeshMaterial.d.ts:64

uniforms

get uniforms(): Dict<any>
Shader uniform values, shortcut for uniformGroup.uniforms.

Returns Dict<any>
- Defined in node_modules/@pixi/core/lib/shader/Shader.d.ts:30

Methods

checkUniformExists

checkUniformExists(name, group): boolean
Parameters
- name: string
- group: UniformGroup<Dict<any>>
Returns boolean
Inherited from Shader.checkUniformExists
- Defined in node_modules/@pixi/core/lib/shader/Shader.d.ts:24

destroy

destroy(): void
Returns void
Inherited from Shader.destroy
- Defined in node_modules/@pixi/core/lib/shader/Shader.d.ts:25

update

update(): void
Gets called automatically by the Mesh. Intended to be overridden for custom PIXI.MeshMaterial objects.

Returns void
- Defined in node_modules/@pixi/mesh/lib/MeshMaterial.d.ts:72

`Static` from

from(vertexSrc?, fragmentSrc?, uniforms?): Shader
A short hand function to create a shader based of a vertex and fragment shader.
Parameters
- Optional vertexSrc: string
  The source of the vertex shader.
- Optional fragmentSrc: string
  The source of the fragment shader.
- Optional uniforms: Dict<any>
  Custom uniforms to use to augment the built-in ones.
Returns Shader
A shiny new PixiJS shader!
Inherited from Shader.from
- Defined in node_modules/@pixi/core/lib/shader/Shader.d.ts:38

Class MeshMaterial

Memberof

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MeshMaterial

Properties

_tintRGB

batchable

Default

disposeRunner

pluginName

Default

program

uniformGroup

Readonly uvMatrix

Accessors

alpha

Returns number

Parameters

Returns void

Default

texture

Returns Texture<Resource>

Parameters

Returns void

tint

Returns ColorSource

Parameters

Returns void

Default

uniforms

Returns Dict<any>

Methods

checkUniformExists

Parameters

Returns boolean

destroy

Returns void

update

Returns void

Static from

Parameters

Returns Shader

Settings

Member Visibility

Theme

On This Page

`Readonly` uvMatrix

`Static` from