Documentation / scene / RenderQueue

Class: RenderQueue

Defined in: libs/scene/src/render/render_queue.ts:160

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:193

Creates an instance of a render queue

Parameters

renderPass

RenderPass

The render pass to which the render queue belongs

bindGroupAllocator?

InstanceBindGroupAllocator

Returns

RenderQueue

Overrides

Disposable.constructor

Accessors

disposed

Get Signature

get disposed(): boolean

Defined in: libs/base/dist/index.d.ts:6065

Returns

boolean

Inherited from

Disposable.disposed

---

sunLight

Get Signature

get sunLight(): DirectionalLight

Defined in: libs/scene/src/render/render_queue.ts:212

The sun light

Returns

DirectionalLight

Set Signature

set sunLight(light): void

Defined in: libs/scene/src/render/render_queue.ts:215

Parameters

light

DirectionalLight

Returns

void

---

primaryDirectionalLight

Get Signature

get primaryDirectionalLight(): DirectionalLight

Defined in: libs/scene/src/render/render_queue.ts:219

Primary directional light used by effects that need a main light direction.

Returns

DirectionalLight

Set Signature

set primaryDirectionalLight(light): void

Defined in: libs/scene/src/render/render_queue.ts:222

Parameters

light

DirectionalLight

Returns

void

---

primaryTransmissionLight

Get Signature

get primaryTransmissionLight(): PunctualLight

Defined in: libs/scene/src/render/render_queue.ts:226

Primary punctual light used by thin-transmission effects when there is no main directional light.

Returns

PunctualLight

Set Signature

set primaryTransmissionLight(light): void

Defined in: libs/scene/src/render/render_queue.ts:229

Parameters

light

PunctualLight

Returns

void

---

drawTransparent

Get Signature

get drawTransparent(): boolean

Defined in: libs/scene/src/render/render_queue.ts:262

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:266

The render pass to which the render queue belongs

Returns

RenderPass

---

itemList

Get Signature

get itemList(): RenderItemList

Defined in: libs/scene/src/render/render_queue.ts:272

Gets the items of the render queue

Returns

RenderItemList

---

shadowedLights

Get Signature

get shadowedLights(): PunctualLight[]

Defined in: libs/scene/src/render/render_queue.ts:278

Gets the shadowed lights

Returns

PunctualLight[]

---

unshadowedLights

Get Signature

get unshadowedLights(): PunctualLight[]

Defined in: libs/scene/src/render/render_queue.ts:284

Gets the unshadowed lights

Returns

PunctualLight[]

---

ref

Get Signature

get ref(): RenderQueueRef

Defined in: libs/scene/src/render/render_queue.ts:290

Gets the indirect reference of this

Returns

RenderQueueRef

Methods

on()

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:594

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:598

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:602

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:606

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:6066

Returns

void

Inherited from

Disposable.dispose

---

getInstanceInfo()

getInstanceInfo(drawable): DrawableInstanceInfo

Defined in: libs/scene/src/render/render_queue.ts:298

Gets the instance information for given drawable object

Parameters

drawable

Drawable

The drawable object

Returns

DrawableInstanceInfo

The instane information for given drawable object, null if no exists

---

pushLight()

pushLight(light): void

Defined in: libs/scene/src/render/render_queue.ts:314

Push a punctual light

Parameters

light

PunctualLight

The light to be pushed

Returns

void

---

pushRenderQueue()

pushRenderQueue(queue): void

Defined in: libs/scene/src/render/render_queue.ts:338

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:381

Push an item to the render queue

Parameters

camera

Camera

The camera for drawing the item

drawable

Drawable

The object to be drawn

Returns

void

---

reset()

reset(): void

Defined in: libs/scene/src/render/render_queue.ts:481

Removes all items in the render queue

Returns

void

---

binaryInsert()

binaryInsert(itemList, item): void

Defined in: libs/scene/src/render/render_queue.ts:603

Parameters

itemList

RenderQueueItem[]

item

RenderQueueItem

Returns

void

---

sortTransparentItems()

sortTransparentItems(cameraPos): void

Defined in: libs/scene/src/render/render_queue.ts:624

Sorts the items in the render queue for rendering

Parameters

cameraPos

Vector3

Returns

void

---

onDispose()

protected onDispose(): void

Defined in: libs/scene/src/render/render_queue.ts:669

Disposes the render queue

Returns

void

Overrides

Disposable.onDispose