Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Material

Materials are used to render a mesh with a specific visual appearance.

Hierarchy

Index

Properties

Protected _renderSortType

_renderSortType: MaterialRenderSortType = MaterialRenderSortType.opaque

Protected Optional _shader

_shader: MeshShader

drawMode

drawMode: DRAW_MODES = PIXI.DRAW_MODES.TRIANGLES

Draw mode used to render a mesh.

state

state: State & { clockwiseFrontFace: false; culling: true; depthTest: true } = Object.assign(new PIXI.State(), {culling: true, clockwiseFrontFace: false, depthTest: true})

State used to render a mesh.

Accessors

blendMode

  • get blendMode(): BLEND_MODES
  • set blendMode(value: BLEND_MODES): void

doubleSided

  • get doubleSided(): boolean
  • set doubleSided(value: boolean): void

isInstancingSupported

  • get isInstancingSupported(): boolean

renderSortType

  • Sort type used to render a mesh. This will determine in which order the material is being rendered compared to other materials. Setting this to "transparent" will also disable writing to depth buffer (only available in PixiJS 6.0+).

    Returns MaterialRenderSortType

  • Sort type used to render a mesh. This will determine in which order the material is being rendered compared to other materials. Setting this to "transparent" will also disable writing to depth buffer (only available in PixiJS 6.0+).

    Parameters

    Returns void

Methods

createInstance

  • createInstance(): unknown

Abstract createShader

  • Creates a shader used to render the specified mesh.

    Parameters

    • mesh: Mesh3D

      The mesh to create the shader for.

    • renderer: Renderer

      The renderer to use.

    Returns MeshShader | undefined

destroy

  • destroy(): void

render

  • render(mesh: Mesh3D, renderer: Renderer): void
  • Renders the specified mesh.

    Parameters

    • mesh: Mesh3D

      The mesh to render.

    • renderer: Renderer

      The renderer to use.

    Returns void

Optional Abstract updateUniforms

Generated using TypeDoc