API
API|
@babylonjs/core|
GreasedLineMaterialOptions

Interface GreasedLineMaterialOptions

Options for GreasedLineMaterial

interface GreasedLineMaterialOptions {
    cameraFacing?: boolean;
    color?: Color3;
    colorDistributionType?: GreasedLineMeshColorDistributionType;
    colorMode?: GreasedLineMeshColorMode;
    colors?: Color3[];
    colorsSampling?: number;
    colorsTexture?: RawTexture;
    dashCount?: number;
    dashOffset?: number;
    dashRatio?: number;
    forceGLSL?: boolean;
    materialType?: GreasedLineMeshMaterialType;
    resolution?: Vector2;
    sizeAttenuation?: boolean;
    useColors?: boolean;
    useDash?: boolean;
    visibility?: number;
    width?: number;
}

Hierarchy (View Summary)

Index
cameraFacing? color? colorDistributionType? colorMode? colors? colorsSampling? colorsTexture? dashCount? dashOffset? dashRatio? forceGLSL? materialType? resolution? sizeAttenuation? useColors? useDash? visibility? width?
cameraFacing?: boolean

Whether to use camera facing for the line. Defaults to true.

color?: Color3

Color of the line. Applies to all line segments. Defaults to White.

colorDistributionType?: GreasedLineMeshColorDistributionType

The method used to distribute the colors along the line. You can use segment distribution when each segment will use on color from the color table. Or you can use line distribution when the colors are distributed evenly along the line ignoring the segments.

colorMode?: GreasedLineMeshColorMode

Color mode of the line. Applies to all line segments. The pixel color from the material shader will be modified with the value of

  • color using the colorMode. Defaults to
  • GreasedLineMeshColorMode.SET
colors?: Color3[]

Colors of the line segments. Defaults to empty.

colorsSampling?: number

Sampling type of the colors texture Defaults to NEAREST_NEAREST.

colorsTexture?: RawTexture

You can provide a colorsTexture to use instead of one generated from the 'colors' option

dashCount?: number

GreasedLinePluginMaterial.setDashCount Number of dashes in the line. Defaults to 1.

dashOffset?: number

Offset of the dashes along the line. 0 to 1. Defaults to 0.

GreasedLinePluginMaterial.setDashOffset

dashRatio?: number

Length of the dash. 0 to 1. 0.5 means half empty, half drawn. Defaults to 0.5.

GreasedLinePluginMaterial.setDashRatio

forceGLSL?: boolean

Force the greased lines to compile to glsl even on WebGPU engines. False by default. This is mostly meant for backward compatibility.

materialType?: GreasedLineMeshMaterialType

Type of the material to use to render the line. Defaults to StandardMaterial.

resolution?: Vector2

Defaults to engine.getRenderWidth() and engine.getRenderHeight() Rendering resolution

sizeAttenuation?: boolean

If false then width units = scene units. If true then line will width be reduced. Defaults to false.

useColors?: boolean

If true,

colors are used, otherwise they're ignored. Defaults to false.

useDash?: boolean

If true, dashing is used. Defaults to false.

visibility?: number

Sets the line length visibility. 0 - 0% of the line will be visible. 1 - 100% of the line will be visible.

GreasedLinePluginMaterial.setVisibility

width?: number

Line width. If sizeAttenuation os false scene units will be used for width. Defaults to 0.1 if

sizeAttenuation is false, or to 1 if it's true.