Documentation / scene / RenderQueue
Class: RenderQueue
Defined in: libs/scene/src/render/render_queue.ts:180
A queue that contains the items to be rendered
Extends
Disposable
Constructors
Constructor
new RenderQueue(
renderPass,bindGroupAllocator?):RenderQueue
Defined in: libs/scene/src/render/render_queue.ts:223
Creates an instance of a render queue
Parameters
renderPass
The render pass to which the render queue belongs
bindGroupAllocator?
Returns
RenderQueue
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
sunLight
Get Signature
get sunLight():
DirectionalLight
Defined in: libs/scene/src/render/render_queue.ts:244
The sun light
Returns
Set Signature
set sunLight(
light):void
Defined in: libs/scene/src/render/render_queue.ts:247
Parameters
light
Returns
void
primaryDirectionalLight
Get Signature
get primaryDirectionalLight():
DirectionalLight
Defined in: libs/scene/src/render/render_queue.ts:251
Primary directional light used by effects that need a main light direction.
Returns
Set Signature
set primaryDirectionalLight(
light):void
Defined in: libs/scene/src/render/render_queue.ts:254
Parameters
light
Returns
void
primaryTransmissionLight
Get Signature
get primaryTransmissionLight():
PunctualLight
Defined in: libs/scene/src/render/render_queue.ts:258
Primary punctual light used by thin-transmission effects when there is no main directional light.
Returns
Set Signature
set primaryTransmissionLight(
light):void
Defined in: libs/scene/src/render/render_queue.ts:261
Parameters
light
Returns
void
drawTransparent
Get Signature
get drawTransparent():
boolean
Defined in: libs/scene/src/render/render_queue.ts:306
Whether this render queue has transparent objects to be drawn
Returns
boolean
renderPass
Get Signature
get renderPass():
RenderPass
Defined in: libs/scene/src/render/render_queue.ts:310
The render pass to which the render queue belongs
Returns
itemList
Get Signature
get itemList():
RenderItemList
Defined in: libs/scene/src/render/render_queue.ts:316
Gets the items of the render queue
Returns
shadowedLights
Get Signature
get shadowedLights():
PunctualLight[]
Defined in: libs/scene/src/render/render_queue.ts:322
Gets the shadowed lights
Returns
waters
Get Signature
get waters(): readonly
Water[]
Defined in: libs/scene/src/render/render_queue.ts:326
Visible water surfaces collected while culling.
Returns
readonly Water[]
unshadowedLights
Get Signature
get unshadowedLights():
PunctualLight[]
Defined in: libs/scene/src/render/render_queue.ts:339
Gets the unshadowed lights
Returns
ref
Get Signature
get ref():
RenderQueueRef
Defined in: libs/scene/src/render/render_queue.ts:345
Gets the indirect reference of this
Returns
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
pushWater()
pushWater(
water):void
Defined in: libs/scene/src/render/render_queue.ts:333
Record a visible water surface.
Parameters
water
The water node that passed culling.
Returns
void
getInstanceInfo()
getInstanceInfo(
drawable):DrawableInstanceInfo
Defined in: libs/scene/src/render/render_queue.ts:353
Gets the instance information for given drawable object
Parameters
drawable
The drawable object
Returns
The instane information for given drawable object, null if no exists
pushLight()
pushLight(
light):void
Defined in: libs/scene/src/render/render_queue.ts:369
Push a punctual light
Parameters
light
The light to be pushed
Returns
void
pushRenderQueue()
pushRenderQueue(
queue):void
Defined in: libs/scene/src/render/render_queue.ts:393
Push items from another render queue
Parameters
queue
RenderQueue
The render queue to be pushed
Returns
void
push()
push(
camera,drawable):void
Defined in: libs/scene/src/render/render_queue.ts:438
Push an item to the render queue
Parameters
camera
The camera for drawing the item
drawable
The object to be drawn
Returns
void
reset()
reset():
void
Defined in: libs/scene/src/render/render_queue.ts:548
Removes all items in the render queue
Returns
void
binaryInsert()
binaryInsert(
itemList,item):void
Defined in: libs/scene/src/render/render_queue.ts:677
Parameters
itemList
item
Returns
void
sortTransparentItems()
sortTransparentItems(
cameraPos):void
Defined in: libs/scene/src/render/render_queue.ts:698
Sorts the items in the render queue for rendering
Parameters
cameraPos
Vector3
Returns
void
onDispose()
protectedonDispose():void
Defined in: libs/scene/src/render/render_queue.ts:743
Disposes the render queue
Returns
void
Overrides
Disposable.onDispose