Properties

Readable public state on the Grassworks instance. Explicit getter methods such as getGrassParams() and getStats() are documented under Methods instead of being treated as properties.

camera

THREE.Camera

Camera used for culling, LOD and interaction follow.

scene

THREE.Scene

Scene containing generated grass tiles.

renderer

WebGPURenderer

WebGPU renderer used by Grassworks.

terrain

THREE.Object3D

Plane-based terrain supplied to Grassworks.

Only plane-based terrain is supported by the documented terrain model.

tileSize

number

World-space size of each grass tile.

maxDistance

number

Maximum distance at which grass remains visible.

grassType

"blade" | "billboard"

Current grass representation.

grassAtlas

string | null

Texture source used by Billboard grass.

Billboard atlas composition is covered in the Grass Atlas Guide.

grassMap

string | THREE.Texture | null

Current grass map source/state.

preset

string

Current named Blade preset key.

influenceWorldSize

number

World-space size of the interaction map.

influenceResolution

integer

Interaction-map resolution.

influenceRecoverySpeed

number

Interaction recovery speed, 0–1.

influenceDebugPlaneVisible

boolean

Whether the influence debug plane is visible.

interactionEnabled

boolean

Whether influence interaction is enabled.

painterEnabled

boolean

Whether the Terrain Painter mode is enabled.

enabled

boolean

Whether per-frame Grassworks updating is enabled.

visible

boolean

Whether generated grass meshes are visible.

castShadow

boolean

Whether generated grass meshes cast shadows.

receiveShadow

boolean

Whether generated grass meshes receive shadows.

debugBoxes

boolean

Whether tile debug boxes are enabled.