Documentation / scene / SceneRenderContext

Interface: SceneRenderContext

Defined in: libs/scene/src/render/rendergraph/scene_render_context.ts:118

Scene rendering facade for custom render graph passes.

Properties

ctx

readonly ctx: DrawContext

Defined in: libs/scene/src/render/rendergraph/scene_render_context.ts:120

The frame draw context (camera, scene, env, device).

Methods

cull()

cull(camera?, filter?): RenderQueue

Defined in: libs/scene/src/render/rendergraph/scene_render_context.ts:123

Cull into a pass-scoped queue, optionally filtering drawables.

Parameters

camera?

Camera

filter?

(drawable) => boolean

Returns

RenderQueue

---

createQueue()

createQueue(): SceneRenderQueueBuilder

Defined in: libs/scene/src/render/rendergraph/scene_render_context.ts:126

Start building a user-authored queue.

Returns

SceneRenderQueueBuilder

---

renderScene()

renderScene(target, queue, opts?): void

Defined in: libs/scene/src/render/rendergraph/scene_render_context.ts:129

Render opaque and transparent geometry into target.

Parameters

target

FrameBuffer

queue

RenderQueue

opts?

SceneRenderOptions

Returns

void

---

renderOpaque()

renderOpaque(target, queue, opts?): void

Defined in: libs/scene/src/render/rendergraph/scene_render_context.ts:132

Render only the opaque geometry of a queue. See SceneRenderContext.renderScene.

Parameters

target

FrameBuffer

queue

RenderQueue

opts?

SceneRenderOptions

Returns

void

---

renderTransparent()

renderTransparent(target, queue, opts?): void

Defined in: libs/scene/src/render/rendergraph/scene_render_context.ts:135

Render only the transparent geometry of a queue. See SceneRenderContext.renderScene.

Parameters

target

FrameBuffer

queue

RenderQueue

opts?

SceneRenderOptions

Returns

void

---

renderDepth()

renderDepth(target, queue, opts?): void

Defined in: libs/scene/src/render/rendergraph/scene_render_context.ts:138

Render a linear-depth pass for a queue's opaque geometry. See SceneRenderContext.renderScene.

Parameters

target

FrameBuffer

queue

RenderQueue

opts?

SceneRenderOptions

Returns

void

---

createPersistentQueue()

createPersistentQueue(): PersistentSceneQueue

Defined in: libs/scene/src/render/rendergraph/scene_render_context.ts:143

Create a caller-managed queue. It is not disposed with the current pass.

Returns

PersistentSceneQueue