Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LineMaterialParameters

Line material parameters

Hierarchy

Index

Properties

Optional alphaTest

alphaTest?: number

Sets the alpha value to be used when running an alpha test. The material will not be rendered if the opacity is lower than this value. Default is 0.

Optional alphaToCoverage

alphaToCoverage?: boolean

Enables alpha to coverage. Can only be used with MSAA-enabled contexts (meaning when the renderer was created with antialias parameter set to true). Default is false.

Optional blendDst

Blending destination. Default is OneMinusSrcAlphaFactor. See the destination factors constants for all possible values. The material's blending must be set to CustomBlending for this to have any effect.

Optional blendDstAlpha

blendDstAlpha?: number

The transparency of the .blendDst. Uses .blendDst value if null. Default is null.

Optional blendEquation

blendEquation?: BlendingEquation

Blending equation to use when applying blending. Default is AddEquation. See the blending equation constants for all possible values. The material's blending must be set to CustomBlending for this to have any effect.

Optional blendEquationAlpha

blendEquationAlpha?: number

The transparency of the .blendEquation. Uses .blendEquation value if null. Default is null.

Optional blendSrc

Blending source. Default is SrcAlphaFactor. See the source factors constants for all possible values. The material's blending must be set to CustomBlending for this to have any effect.

Optional blendSrcAlpha

blendSrcAlpha?: number

The transparency of the .blendSrc. Uses .blendSrc value if null. Default is null.

Optional blending

blending?: Blending

Which blending to use when displaying objects with this material. This must be set to CustomBlending to use custom blendSrc, blendDst or blendEquation. See the blending mode constants for all possible values. Default is NormalBlending.

Optional clipIntersection

clipIntersection?: boolean

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

Optional clipShadows

clipShadows?: boolean

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

Optional clippingPlanes

clippingPlanes?: I3JS.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). This requires WebGLRenderer.localClippingEnabled to be true. See the WebGL / clipping /intersection example. Default is null.

Optional color

color?: number

Optional 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.

Optional dashOffset

dashOffset?: number

Optional dashScale

dashScale?: number

Optional dashSize

dashSize?: number

Optional dashed

dashed?: boolean

Optional defines

defines?: 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.

Optional depthFunc

depthFunc?: DepthModes

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

Optional depthTest

depthTest?: boolean

Whether to have depth test enabled when rendering this material. Default is true.

Optional 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.

Optional dithering

dithering?: boolean

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

Optional fog

fog?: boolean

Whether the material is affected by fog. Default is true.

Optional format

format?: PixelFormat

When this property is set to THREE.RGBFormat, the material is considered to be opaque and alpha values are ignored. Default is THREE.RGBAFormat.

Optional gapSize

gapSize?: number

Optional linewidth

linewidth?: number

Optional name

name?: string

Optional name of the object (doesn't need to be unique). Default is an empty string.

Optional opacity

opacity?: number

Float in the range of 0.0 - 1.0 indicating how transparent the material is. A value of 0.0 indicates fully transparent, 1.0 is fully opaque. If the material's transparent property is not set to true, the material will remain fully opaque and this value will only affect its color. Default is 1.0.

Optional polygonOffset

polygonOffset?: boolean

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

Optional polygonOffsetFactor

polygonOffsetFactor?: number

Sets the polygon offset factor. Default is 0.

Optional polygonOffsetUnits

polygonOffsetUnits?: number

Sets the polygon offset units. Default is 0.

Optional precision

precision?: "highp" | "mediump" | "lowp"

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

Optional premultipliedAlpha

premultipliedAlpha?: boolean

Whether to premultiply the alpha (transparency) value. See [Example:webgl_materials_physical_transmission WebGL / Materials / Physical / Transmission] for an example of the difference. Default is false.

Optional resolution

resolution?: I3JS.Vector2

Optional shadowSide

shadowSide?: Side

Defines which side of faces cast shadows. When set, can be THREE.FrontSide, THREE.BackSide, or THREE.DoubleSide. Default is null. If null, the side casting shadows is determined as follows:

Optional side

side?: Side

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

Optional stencilFail

stencilFail?: StencilOp

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

Optional stencilFunc

stencilFunc?: StencilFunc

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

Optional stencilFuncMask

stencilFuncMask?: number

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

Optional stencilRef

stencilRef?: number

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

Optional stencilWrite

stencilWrite?: boolean

Whether stencil operations are performed against the stencil buffer. In order to perform writes or comparisons against the stencil buffer this value must be true. Default is false.

Optional stencilWriteMask

stencilWriteMask?: number

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

Optional 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 operations constants for all possible values.

Optional 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 operations constants for all possible values.

Optional toneMapped

toneMapped?: boolean

Defines whether this material is tone mapped according to the renderer's toneMapping setting. Default is true.

Optional 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. g When set to true, the extent to which the material is transparent is controlled by setting its opacity property. Default is false.

Optional 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.

Optional vertexColors

vertexColors?: boolean

Defines whether vertex coloring is used. Default is false.

Optional visible

visible?: boolean

Defines whether this material is visible. Default is true.

Optional wireframe

wireframe?: boolean

Optional worldUnits

worldUnits?: boolean

Generated using TypeDoc