Documentation / scene / RGProfilingOptions

Interface: RGProfilingOptions

Defined in: libs/scene/src/render/rendergraph/types.ts:369

Render graph GPU timestamp profiling options.

Properties

enabled?

optional enabled?: boolean

Defined in: libs/scene/src/render/rendergraph/types.ts:371

Enable render graph timestamp profiling. Default true when an options object is provided.

---

graph?

optional graph?: boolean

Defined in: libs/scene/src/render/rendergraph/types.ts:373

Measure the whole graph execution. Default true.

---

pass?

optional pass?: boolean

Defined in: libs/scene/src/render/rendergraph/types.ts:375

Measure every render graph pass. Default true.

---

subpass?

optional subpass?: boolean

Defined in: libs/scene/src/render/rendergraph/types.ts:377

Measure every subpass and expose it as a child scope. Default true.

---

includePendingUploads?

optional includePendingUploads?: boolean

Defined in: libs/scene/src/render/rendergraph/types.ts:379

Include pending upload/copy commands at timestamp boundaries. Default true.

---

allowCrossFrame?

optional allowCrossFrame?: boolean

Defined in: libs/scene/src/render/rendergraph/types.ts:381

Allow graph profile scopes to remain open across frame boundaries. Default false.

---

maxPendingFrames?

optional maxPendingFrames?: number

Defined in: libs/scene/src/render/rendergraph/types.ts:383

Maximum unresolved profile frames kept by the executor. Default 3.

---

label?

optional label?: string

Defined in: libs/scene/src/render/rendergraph/types.ts:385

Root graph profile label. Default 'RenderGraph'.

---

device?

optional device?: AbstractDevice

Defined in: libs/scene/src/render/rendergraph/types.ts:387

Device used for timestamp queries. If omitted, the scene global getDevice() is used.