Class GridMaterial

Hierarchy

  • ShaderMaterial
    • GridMaterial

Constructors

constructor

Methods

addEventListener clone copy customProgramCacheKey dispatchEvent dispose hasEventListener onBeforeCompile removeEventListener setValues toJSON

Properties

alphaTest alphaToCoverage blendDst blendDstAlpha blendEquation blendEquationAlpha blendSrc blendSrcAlpha blending clipIntersection clipShadows clipping clippingPlanes colorWrite defaultAttributeValues defines depthFunc depthTest depthWrite derivatives dithering extensions fog forceSinglePass fragmentShader glslVersion id index0AttributeName isMaterial isShaderMaterial lights linewidth name needsUpdate opacity polygonOffset polygonOffsetFactor polygonOffsetUnits precision premultipliedAlpha shadowSide side stencilFail stencilFunc stencilFuncMask stencilRef stencilWrite stencilWriteMask stencilZFail stencilZPass toneMapped transparent type uniforms uniformsNeedUpdate userData uuid version vertexColors vertexShader visible wireframe wireframeLinewidth

Constructors

constructor

Methods

addEventListener

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

  • Adds a listener to an event type.

    Type Parameters

    • T extends string

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<Event, T, GridMaterial>

      The function that gets called when the event is fired.

    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

    • material: Material

    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(event): void

  • Fire an event type.

    Parameters

    • event: Event

      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

hasEventListener

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

  • Checks if listener is added to an event type.

    Type Parameters

    • T extends string

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<Event, T, GridMaterial>

      The function that gets called when the event is fired.

    Returns boolean

onBeforeCompile

  • onBeforeCompile(shader, renderer): void

  • An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials.

    Parameters

    • shader: Shader

      Source code of the shader

    • renderer: WebGLRenderer

      WebGLRenderer Context that is initializing the material

    Returns void

removeEventListener

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

  • Removes a listener from an event type.

    Type Parameters

    • T extends string

    Parameters

    • type: T

      The type of the listener that gets removed.

    • listener: EventListener<Event, T, GridMaterial>

      The listener function that gets removed.

    Returns void

setValues

  • setValues(parameters): void

  • Parameters

    • parameters: ShaderMaterialParameters

    Returns void

toJSON

  • toJSON(meta): any

  • Parameters

    • meta: any

    Returns any

Properties

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

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: BlendingDstFactor | 210

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

clipping

clipping: boolean

Default

false

clippingPlanes

clippingPlanes: any

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

defaultAttributeValues

defaultAttributeValues: any

Default

{ 'color': [ 1, 1, 1 ], 'uv': [ 0, 0 ], 'uv2': [ 0, 0 ] }

defines

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

Default

{}

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. Default is true.

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

derivatives

derivatives: any

Deprecated

Use .derivatives extensions.derivatives instead.

dithering

dithering: boolean

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

Default

false

extensions

extensions: {
    derivatives: boolean;
    drawBuffers: boolean;
    fragDepth: boolean;
    shaderTextureLOD: boolean;
}

Default

{ derivatives: false, fragDepth: false, drawBuffers: false, shaderTextureLOD: false }

fog

fog: boolean

Default

false

forceSinglePass

forceSinglePass: boolean

Default

false

fragmentShader

fragmentShader: string

glslVersion

glslVersion: null | GLSLVersion

Default

null

id

id: number

Unique number of this material instance.

index0AttributeName

index0AttributeName: undefined | string

Default

undefined

ReadonlyisMaterial

isMaterial: true

Used to check whether this or derived classes are materials. Default is true. You should not change this, as it used internally for optimisation.

isShaderMaterial

isShaderMaterial: boolean

lights

lights: boolean

Default

false

linewidth

linewidth: number

Default

1

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

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. Default is true.

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 is false.

Default

false

type

type: string

Default

'ShaderMaterial'

uniforms

uniforms: {
    cellColor: Uniform<Color>;
    cellSize: Uniform<number>;
    cellThickness: Uniform<number>;
    fadeDistance: Uniform<number>;
    fadeFrom: Uniform<number>;
    fadeStrength: Uniform<number>;
    followCamera: Uniform<boolean>;
    infiniteGrid: Uniform<boolean>;
    sectionColor: Uniform<Color>;
    sectionSize: Uniform<number>;
    sectionThickness: Uniform<number>;
    worldCamProjPosition: Uniform<Vector3>;
    worldPlanePosition: Uniform<Vector3>;
}

uniformsNeedUpdate

uniformsNeedUpdate: boolean

Default

false

userData

userData: 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

vertexShader

vertexShader: string

visible

visible: boolean

Defines whether this material is visible. Default is true.

Default

true

wireframe

wireframe: boolean

Default

false

wireframeLinewidth

wireframeLinewidth: number

Default

1

Settings

Member Visibility

On This Page

constructoraddEventListenerclonecopycustomProgramCacheKeydispatchEventdisposehasEventListeneronBeforeCompileremoveEventListenersetValuestoJSONalphaTestalphaToCoverageblendDstblendDstAlphablendEquationblendEquationAlphablendSrcblendSrcAlphablendingclipIntersectionclipShadowsclippingclippingPlanescolorWritedefaultAttributeValuesdefinesdepthFuncdepthTestdepthWritederivativesditheringextensionsfogforceSinglePassfragmentShaderglslVersionidindex0AttributeNameisMaterialisShaderMateriallightslinewidthnameneedsUpdateopacitypolygonOffsetpolygonOffsetFactorpolygonOffsetUnitsprecisionpremultipliedAlphashadowSidesidestencilFailstencilFuncstencilFuncMaskstencilRefstencilWritestencilWriteMaskstencilZFailstencilZPasstoneMappedtransparenttypeuniformsuniformsNeedUpdateuserDatauuidversionvertexColorsvertexShadervisiblewireframewireframeLinewidth