Class PointsMaterial

Hierarchy

  • ShaderMaterial
    • PointsMaterial

Constructors

  • Creates a PointsMaterial using the specified options.

    Parameters

    • options: PointsMaterialOptions = {}

      The options.

    Returns PointsMaterial

Properties

_brightness: number
_contrast: number
_mustUpdateUniforms?: boolean
_saturation: number
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: number

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

Default

0
alphaToCoverage: boolean

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

Default

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

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

Default

THREE.OneMinusSrcAlphaFactor
blendDstAlpha: number

The tranparency of the .blendDst. Default is null.

Default

null
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: number

The tranparency of the .blendEquation. Default is null.

Default

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

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

Default

THREE.SrcAlphaFactor
blendSrcAlpha: number

The tranparency of the .blendSrc. Default is null.

Default

null
blending: Blending

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

Default

THREE.NormalBlending
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: boolean

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

Default

false
clipping: boolean

Default

false
clippingPlanes: 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
colorLayer: ColorLayer
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: any

Default

{ 'color': [ 1, 1, 1 ], 'uv': [ 0, 0 ], 'uv1': [ 0, 0 ] }
defines: {
    [key: string]: any;
}

Type declaration

  • [key: string]: any

Default

{}
depthFunc: DepthModes

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

Default

THREE.LessEqualDepth
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: 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: any

Deprecated

Use ShaderMaterial#extensions.derivatives extensions.derivatives instead.

disposed?: boolean
dithering: boolean

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

Default

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

Type declaration

  • clipCullDistance: boolean
  • derivatives: boolean
  • drawBuffers: boolean
  • fragDepth: boolean
  • shaderTextureLOD: boolean

Default

{ derivatives: false, fragDepth: false, drawBuffers: false, shaderTextureLOD: false, clipCullDistance: false }
fog: boolean

Default

false
forceSinglePass: boolean

Default

false
fragmentShader: string
glslVersion: GLSLVersion

Default

null
id: number

Unique number of this material instance.

index0AttributeName: string

Default

undefined
influence: Vector2[]
isMaterial: true

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

Remarks

This is a constant value

Default Value

true

isShaderMaterial: true

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

Remarks

This is a constant value

Default Value

true

lights: boolean

Default

false
linewidth: number

Default

1
mode: number
name: string

Material name. Default is an empty string.

Default

''
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: number

Opacity. Default is 1.

Default

1
origin: Vector2[]
overlayColor: Vector4
pickingId: number
polygonOffset: boolean

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

Default

false
polygonOffsetFactor: number

Sets the polygon offset factor. Default is 0.

Default

0
polygonOffsetUnits: number

Sets the polygon offset units. Default is 0.

Default

0
precision: "highp" | "mediump" | "lowp"

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

Default

null
premultipliedAlpha: boolean

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

Default

false
scale: number
shadowSide: 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

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}
size: number
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

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

Default

THREE.AlwaysStencilFunc
stencilFuncMask: number

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

Default

0xff
stencilRef: number

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

Default

0
stencilWrite: boolean

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

Default

false
stencilWriteMask: number

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

Default

0xff
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: 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
tColors: Color[]
toneMapped: boolean

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

Default

true
transformations: Matrix4[]
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: string

Default

'ShaderMaterial'
uniforms: {
    [uniform: string]: IUniform;
}

Type declaration

  • [uniform: string]: IUniform

Default

{}
uniformsGroups: UniformsGroup[]
uniformsNeedUpdate: boolean

Default

false
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: string

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

vec: Vector3[]
version: number

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

Default

0
vertexColors: boolean

Defines whether vertex coloring is used. Default is false.

Default

false
vertexShader: string
visible: boolean

Defines whether this material is visible. Default is true.

Default

true
wireframe: boolean

Default

false
wireframeLinewidth: number

Default

1

Accessors

  • get brightness(): number
  • Gets or sets the brightness of this layer.

    Returns number

  • set brightness(v): void
  • Parameters

    • v: number

    Returns void

  • get contrast(): number
  • Gets or sets the contrast of this layer.

    Returns number

  • set contrast(v): void
  • Parameters

    • v: number

    Returns void

  • get saturation(): number
  • Gets or sets the saturation of this layer.

    Returns number

  • set saturation(v): void
  • Parameters

    • v: number

    Returns void

Methods

  • 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, PointsMaterial>

      The function that gets called when the event is fired.

    Returns void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

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

    Parameters

    • material: Material

    Returns PointsMaterial

  • 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

  • Fire an event type.

    Type Parameters

    • T extends "dispose"

    Parameters

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

      The event that gets fired.

    Returns void

  • Returns void

  • Parameters

    • picking: number

    Returns void

  • Parameters

    • v: boolean

    Returns void

  • Parameters

    Returns any

  • Parameters

    Returns 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, PointsMaterial>

      The function that gets called when the event is fired.

    Returns boolean

  • Type Parameters

    • T extends string

    Parameters

    Returns boolean

  • Parameters

    Returns 0 | -1

  • 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

    • parameters: WebGLProgramParametersWithUniforms

      WebGL program parameters

    • renderer: WebGLRenderer

      WebGLRenderer context that is initializing the material

    Returns void

  • Parameters

    Returns void

  • Returns 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, PointsMaterial>

      The listener function that gets removed.

    Returns void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

  • Parameters

    • layer: ColorLayer
    • textureAndPitch: TextureAndPitch

    Returns void

  • Parameters

    • layer: ColorLayer
    • brightness: number
    • contrast: number
    • saturation: number

    Returns void

  • Returns void

  • Returns void

  • Returns void

  • Parameters

    • parameters: ShaderMaterialParameters

    Returns void

  • Parameters

    • meta: any

    Returns any

  • Returns void

Generated using TypeDoc