Documentation / scene / GrassRenderer
Class: GrassRenderer
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:529
Grass renderer for clipmap terrain
Extends
Disposable
Constructors
Constructor
new GrassRenderer(
terrain):GrassRenderer
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:536
Creates an instance of GrassRenderer
Parameters
terrain
Clipmap terrain object
Returns
GrassRenderer
Overrides
Disposable.constructor
Accessors
disposed
Get Signature
get disposed():
boolean
Defined in: libs/base/dist/index.d.ts:6107
Returns
boolean
Inherited from
Disposable.disposed
numGrassBlades
Get Signature
get numGrassBlades():
number
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:548
How many grass blades
Returns
number
numLayers
Get Signature
get numLayers():
number
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:552
How many grass layers
Returns
number
Methods
on()
on<
K>(type,listener,context?):void
Defined in: libs/base/dist/index.d.ts:630
IEventTarget.on
Type Parameters
K
K extends "dispose"
Parameters
type
K
listener
EventListener<{ dispose: []; }, K>
context?
unknown
Returns
void
Inherited from
Disposable.on
once()
once<
K>(type,listener,context?):void
Defined in: libs/base/dist/index.d.ts:634
IEventTarget.once
Type Parameters
K
K extends "dispose"
Parameters
type
K
listener
EventListener<{ dispose: []; }, K>
context?
unknown
Returns
void
Inherited from
Disposable.once
off()
off<
K>(type,listener?,context?):void
Defined in: libs/base/dist/index.d.ts:638
IEventTarget.off
Type Parameters
K
K extends "dispose"
Parameters
type
K
listener?
EventListener<{ dispose: []; }>
context?
unknown
Returns
void
Inherited from
Disposable.off
dispatchEvent()
dispatchEvent<
K>(type, ...args):void
Defined in: libs/base/dist/index.d.ts:642
IEventTarget.dispatchEvent
Type Parameters
K
K extends "dispose"
Parameters
type
K
args
...object[K]
Returns
void
Inherited from
Disposable.dispatchEvent
dispose()
dispose():
void
Defined in: libs/base/dist/index.d.ts:6108
Returns
void
Inherited from
Disposable.dispose
getLayer()
getLayer(
index):GrassLayer
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:560
Gets the grass layer at given index
Parameters
index
number
Index of the grass layer
Returns
The grass layer at the index
addLayer()
addLayer(
bladeWidth,bladeHeight,albedoMap?):number
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:570
Adds a grass layer
Parameters
bladeWidth
number
Width of grass blades in this layer
bladeHeight
number
Height of grass blades in this layer
albedoMap?
Texture2D
Albedo texture of grass blades in this layer
Returns
number
Index of the added grass layer
getGrassTexture()
getGrassTexture(
layer):Texture2D<unknown>
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:586
Gets the albedo texture of grass blades in the grass layer at given index
Parameters
layer
number
Index of the grass layer to get
Returns
Texture2D<unknown>
Albedo texture of grass blades in the grass layer
setGrassTexture()
setGrassTexture(
layer,texture):void
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:594
Sets the albedo texture of grass blades in the grass layer at given index
Parameters
layer
number
Index of the grass layer to set
texture
Texture2D
Albedo texture to set
Returns
void
getBladeWidth()
getBladeWidth(
layer):number
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:607
Gets width of the grass blades in the grass layer at given index
Parameters
layer
number
Index of the grass layer
Returns
number
Width of the grass blades in the layer
getBladeHeight()
getBladeHeight(
layer):number
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:615
Gets height of the grass blades in the grass layer at given index
Parameters
layer
number
Index of the grass layer
Returns
number
Height of the grass blades in the layer
setBladeSize()
setBladeSize(
layer,width,height):void
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:624
Sets size of the grass blades in the grass layer at given index
Parameters
layer
number
Index of the grass layer
width
number
Width to set
height
number
Height to set
Returns
void
onDispose()
protectedonDispose():void
Defined in: libs/scene/src/scene/terrain-cm/grass.ts:641
Returns
void
Overrides
Disposable.onDispose