Interface LayerNodeMaterial

A node material.

interface LayerNodeMaterial {
    alphaHash: boolean;
    alphaTest: number;
    alphaToCoverage: boolean;
    blendAlpha: number;
    blendColor: Color;
    blendDst: BlendingDstFactor;
    blendDstAlpha: null | number;
    blendEquation: BlendingEquation;
    blendEquationAlpha: null | number;
    blendSrc: 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214;
    blendSrcAlpha: null | number;
    blending: Blending;
    clipIntersection: boolean;
    clipShadows: boolean;
    clippingPlanes: null | Plane[];
    colorWrite: boolean;
    defines: undefined | {
        [key: string]: any;
    };
    depthFunc: DepthModes;
    depthTest: boolean;
    depthWrite: boolean;
    dithering: boolean;
    forceSinglePass: boolean;
    id: number;
    isMaterial: true;
    name: string;
    needsUpdate: boolean;
    opacity: number;
    polygonOffset: boolean;
    polygonOffsetFactor: number;
    polygonOffsetUnits: number;
    precision: null | "highp" | "mediump" | "lowp";
    premultipliedAlpha: boolean;
    shadowSide: null | Side;
    side: Side;
    stencilFail: StencilOp;
    stencilFunc: StencilFunc;
    stencilFuncMask: number;
    stencilRef: number;
    stencilWrite: boolean;
    stencilWriteMask: number;
    stencilZFail: StencilOp;
    stencilZPass: StencilOp;
    toneMapped: boolean;
    transparent: boolean;
    type: string;
    userData: Record<string, any>;
    uuid: string;
    version: number;
    vertexColors: boolean;
    visible: boolean;
    addEventListener<T>(type, listener): void;
    addEventListener<T>(type, listener): void;
    clone(): this;
    copy(material): this;
    customProgramCacheKey(): string;
    dispatchEvent<T>(event): void;
    dispose(): void;
    hasColorLayer(layer): boolean;
    hasEventListener<T>(type, listener): boolean;
    hasEventListener<T>(type, listener): boolean;
    indexOfColorLayer(layer): number;
    onBeforeCompile(parameters, renderer): void;
    pushColorLayer(layer, extent): void;
    removeColorLayer(layer): void;
    removeEventListener<T>(type, listener): void;
    removeEventListener<T>(type, listener): void;
    setColorTextures(layer, textureAndPitch): void;
    setColorimetry(layer, brightness, contrast, saturation): void;
    setLayerElevationRange(layer, range): void;
    setLayerOpacity(layer, opacity): void;
    setLayerVisibility(layer, visible): void;
    setValues(values): void;
    toJSON(meta?): any;
}

Hierarchy (view full)

Properties

alphaHash alphaTest alphaToCoverage blendAlpha blendColor blendDst blendDstAlpha blendEquation blendEquationAlpha blendSrc blendSrcAlpha blending clipIntersection clipShadows clippingPlanes colorWrite defines depthFunc depthTest depthWrite dithering forceSinglePass id isMaterial name needsUpdate opacity polygonOffset polygonOffsetFactor polygonOffsetUnits precision premultipliedAlpha shadowSide side stencilFail stencilFunc stencilFuncMask stencilRef stencilWrite stencilWriteMask stencilZFail stencilZPass toneMapped transparent type userData uuid version vertexColors visible

Methods

addEventListener clone copy customProgramCacheKey dispatchEvent dispose hasColorLayer hasEventListener indexOfColorLayer onBeforeCompile pushColorLayer removeColorLayer removeEventListener setColorTextures setColorimetry setLayerElevationRange setLayerOpacity setLayerVisibility setValues toJSON

Properties

alphaHash

alphaHash: boolean

Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.

alphaTest

alphaTest: number

Sets the alpha value to be used when running an alpha test. Default is 0.

Default

0

alphaToCoverage

alphaToCoverage: boolean

Enables alpha to coverage. Can only be used with MSAA-enabled rendering contexts.

Default

false

blendAlpha

blendAlpha: number

Represents the alpha value of the constant blend color. This property has only an effect when using custom blending with ConstantAlphaFactor or OneMinusConstantAlphaFactor.

Default

0

blendColor

blendColor: Color

Represent the RGB values of the constant blend color. This property has only an effect when using custom blending with ConstantColorFactor or OneMinusConstantColorFactor.

Default

0x000000

blendDst

blendDst: BlendingDstFactor

Blending destination. It's one of the blending mode constants defined in Three.js. Default is OneMinusSrcAlphaFactor.

Default

THREE.OneMinusSrcAlphaFactor

blendDstAlpha

blendDstAlpha: null | number

The tranparency of the .blendDst. Default is null.

Default

null

blendEquation

blendEquation: BlendingEquation

Blending equation to use when applying blending. It's one of the constants defined in Three.js. Default is AddEquation.

Default

THREE.AddEquation

blendEquationAlpha

blendEquationAlpha: null | number

The tranparency of the .blendEquation. Default is null.

Default

null

blendSrc

blendSrc: 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214

Blending source. It's one of the blending mode constants defined in Three.js. Default is SrcAlphaFactor.

Default

THREE.SrcAlphaFactor

blendSrcAlpha

blendSrcAlpha: null | number

The tranparency of the .blendSrc. Default is null.

Default

null

blending

blending: Blending

Which blending to use when displaying objects with this material. Default is NormalBlending.

Default

THREE.NormalBlending

clipIntersection

clipIntersection: boolean

Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union. Default is false.

Default

false

clipShadows

clipShadows: boolean

Defines whether to clip shadows according to the clipping planes specified on this material. Default is false.

Default

false

clippingPlanes

clippingPlanes: null | Plane[]

User-defined clipping planes specified as THREE.Plane objects in world space. These planes apply to the objects this material is attached to. Points in space whose signed distance to the plane is negative are clipped (not rendered). See the WebGL / clipping /intersection example. Default is null.

Default

null

colorWrite

colorWrite: boolean

Whether to render the material's color. This can be used in conjunction with a mesh's .renderOrder property to create invisible objects that occlude other objects. Default is true.

Default

true

defines

defines: undefined | {
    [key: string]: any;
}

Custom defines to be injected into the shader. These are passed in form of an object literal, with key/value pairs. { MY_CUSTOM_DEFINE: '' , PI2: Math.PI * 2 }. The pairs are defined in both vertex and fragment shaders. Default is undefined.

Type declaration

  • [key: string]: any

Default

undefined

depthFunc

depthFunc: DepthModes

Which depth function to use. Default is LessEqualDepth. See the depth mode constants for all possible values.

Default

THREE.LessEqualDepth

depthTest

depthTest: boolean

Whether to have depth test enabled when rendering this material. When the depth test is disabled, the depth write will also be implicitly disabled.

Default

true

depthWrite

depthWrite: boolean

Whether rendering this material has any effect on the depth buffer. Default is true. When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.

Default

true

dithering

dithering: boolean

Whether to apply dithering to the color to remove the appearance of banding. Default is false.

Default

false

forceSinglePass

forceSinglePass: boolean

Default

false

id

id: number

Unique number of this material instance.

Readonly isMaterial

isMaterial: true

Read-only flag to check if a given object is of type Material.

Remarks

This is a constant value

Default Value

true

name

name: string

Material name. Default is an empty string.

Default

''

needsUpdate

needsUpdate: boolean

Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.

Default

false

opacity

opacity: number

Opacity. Default is 1.

Default

1

polygonOffset

polygonOffset: boolean

Whether to use polygon offset. Default is false. This corresponds to the POLYGON_OFFSET_FILL WebGL feature.

Default

false

polygonOffsetFactor

polygonOffsetFactor: number

Sets the polygon offset factor. Default is 0.

Default

0

polygonOffsetUnits

polygonOffsetUnits: number

Sets the polygon offset units. Default is 0.

Default

0

precision

precision: null | "highp" | "mediump" | "lowp"

Override the renderer's default precision for this material. Can be "highp", "mediump" or "lowp". Defaults is null.

Default

null

premultipliedAlpha

premultipliedAlpha: boolean

Whether to premultiply the alpha (transparency) value. See WebGL / Materials / Transparency for an example of the difference. Default is false.

Default

false

shadowSide

shadowSide: null | Side

Defines which of the face sides will cast shadows. Default is null. If null, the value is opposite that of side, above.

Default

null

side

side: Side

Defines which of the face sides will be rendered - front, back or both. Default is THREE.FrontSide. Other options are THREE.BackSide and THREE.DoubleSide.

Default

{@link THREE.FrontSide}

stencilFail

stencilFail: StencilOp

Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.

Default

THREE.KeepStencilOp

stencilFunc

stencilFunc: StencilFunc

The stencil comparison function to use. Default is AlwaysStencilFunc. See stencil operation constants for all possible values.

Default

THREE.AlwaysStencilFunc

stencilFuncMask

stencilFuncMask: number

The bit mask to use when comparing against the stencil buffer. Default is 0xFF.

Default

0xff

stencilRef

stencilRef: number

The value to use when performing stencil comparisons or stencil operations. Default is 0.

Default

0

stencilWrite

stencilWrite: boolean

Whether rendering this material has any effect on the stencil buffer. Default is false.

Default

false

stencilWriteMask

stencilWriteMask: number

The bit mask to use when writing to the stencil buffer. Default is 0xFF.

Default

0xff

stencilZFail

stencilZFail: StencilOp

Which stencil operation to perform when the comparison function returns true but the depth test fails. Default is KeepStencilOp. See the stencil operation constants for all possible values.

Default

THREE.KeepStencilOp

stencilZPass

stencilZPass: StencilOp

Which stencil operation to perform when the comparison function returns true and the depth test passes. Default is KeepStencilOp. See the stencil operation constants for all possible values.

Default

THREE.KeepStencilOp

toneMapped

toneMapped: boolean

Defines whether this material is tone mapped according to the renderer's toneMapping setting. It is ignored when rendering to a render target.

Default

true

transparent

transparent: boolean

Defines whether this material is transparent. This has an effect on rendering as transparent objects need special treatment and are rendered after non-transparent objects. When set to true, the extent to which the material is transparent is controlled by setting it's .opacity property.

Default

false

type

type: string

Value is the string 'Material'. This shouldn't be changed, and can be used to find all objects of this type in a scene.

Default

'Material'

userData

userData: Record<string, any>

An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.

Default

{}

uuid

uuid: string

UUID of this material instance. This gets automatically assigned, so this shouldn't be edited.

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

Default

0

vertexColors

vertexColors: boolean

Defines whether vertex coloring is used. Default is false.

Default

false

visible

visible: boolean

Defines whether this material is visible. Default is true.

Default

true

Methods

addEventListener

  • addEventListener<T>(type, listener): void

  • Adds a listener to an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<{
          dispose: {};
      }[T], T, LayerNodeMaterial>

      The function that gets called when the event is fired.

    Returns void

  • addEventListener<T>(type, listener): void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

clone

  • clone(): this

  • Return a new material with the same parameters as this material.

    Returns this

copy

  • copy(material): this

  • Copy the parameters from the passed material into this material.

    Parameters

    Returns this

customProgramCacheKey

  • customProgramCacheKey(): string

  • In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.

    Returns string

dispatchEvent

  • dispatchEvent<T>(event): void

  • Fire an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    • event: BaseEvent<T> & {
          dispose: {};
      }[T]

      The event that gets fired.

    Returns void

dispose

  • dispose(): void

  • This disposes the material. Textures of a material don't get disposed. These needs to be disposed by Texture.

    Returns void

hasColorLayer

hasEventListener

  • hasEventListener<T>(type, listener): boolean

  • Checks if listener is added to an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<{
          dispose: {};
      }[T], T, LayerNodeMaterial>

      The function that gets called when the event is fired.

    Returns boolean

  • hasEventListener<T>(type, listener): boolean

  • Type Parameters

    • T extends string

    Parameters

    Returns boolean

indexOfColorLayer

onBeforeCompile

  • onBeforeCompile(parameters, renderer): void

  • An optional callback that is executed immediately before the shader program is compiled. This function is called with the associated WebGL program parameters and renderer. Useful for the modification of built-in materials.

    Parameters

    Returns void

pushColorLayer

removeColorLayer

removeEventListener

  • removeEventListener<T>(type, listener): void

  • Removes a listener from an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

    • type: T

      The type of the listener that gets removed.

    • listener: EventListener<{
          dispose: {};
      }[T], T, LayerNodeMaterial>

      The listener function that gets removed.

    Returns void

  • removeEventListener<T>(type, listener): void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

setColorTextures

setColorimetry

setLayerElevationRange

setLayerOpacity

setLayerVisibility

setValues

  • setValues(values): void

  • Sets the properties based on the values.

    Parameters

    Returns void

toJSON

  • toJSON(meta?): any

  • Convert the material to three.js JSON format.

    Parameters

    • Optional meta: any

      Object containing metadata such as textures or images for the material.

    Returns any

Settings

Member Visibility

On This Page

alphaHashalphaTestalphaToCoverageblendAlphablendColorblendDstblendDstAlphablendEquationblendEquationAlphablendSrcblendSrcAlphablendingclipIntersectionclipShadowsclippingPlanescolorWritedefinesdepthFuncdepthTestdepthWriteditheringforceSinglePassidisMaterialnameneedsUpdateopacitypolygonOffsetpolygonOffsetFactorpolygonOffsetUnitsprecisionpremultipliedAlphashadowSidesidestencilFailstencilFuncstencilFuncMaskstencilRefstencilWritestencilWriteMaskstencilZFailstencilZPasstoneMappedtransparenttypeuserDatauuidversionvertexColorsvisibleaddEventListenerclonecopycustomProgramCacheKeydispatchEventdisposehasColorLayerhasEventListenerindexOfColorLayeronBeforeCompilepushColorLayerremoveColorLayerremoveEventListenersetColorTexturessetColorimetrysetLayerElevationRangesetLayerOpacitysetLayerVisibilitysetValuestoJSON