Skip to main content

@novorender/api / DerivedRenderState

Interface: DerivedRenderState

Defined in: @novorender/src/core3d/state/index.ts:92

An extended variant of RenderState with additional derived properties.

Extends​

Properties​

background​

readonly background: RenderStateBackground;

Defined in: @novorender/src/core3d/state/index.ts:41

background/environment related state.

Inherited from​

RenderState.background

camera​

readonly camera: RenderStateCamera;

Defined in: @novorender/src/core3d/state/index.ts:44

camera related state.

Inherited from​

RenderState.camera

clipping​

readonly clipping: RenderStateClipping;

Defined in: @novorender/src/core3d/state/index.ts:68

Clipping planes related state.

Inherited from​

RenderState.clipping

cube​

readonly cube: RenderStateCube;

Defined in: @novorender/src/core3d/state/index.ts:56

@internal.

Inherited from​

RenderState.cube

dynamic​

readonly dynamic: RenderStateDynamicObjects;

Defined in: @novorender/src/core3d/state/index.ts:65

Dynamic objects related state.

Inherited from​

RenderState.dynamic

effectiveSamplesMSAA​

readonly effectiveSamplesMSAA: number;

Defined in: @novorender/src/core3d/state/index.ts:102

The effective number of MSAA samples uses for this frame.

Remarks​

This originates from RenderStateOutput.samplesMSAA but is potentially capped to the device's MSAA sample limit.

grid​

readonly grid: RenderStateGrid;

Defined in: @novorender/src/core3d/state/index.ts:50

Grid helper related state.

Inherited from​

RenderState.grid

highlights​

readonly highlights: RenderStateHighlightGroups;

Defined in: @novorender/src/core3d/state/index.ts:71

Highlights related state.

Inherited from​

RenderState.highlights

localSpaceTranslation​

readonly localSpaceTranslation: ReadonlyVec3;

Defined in: @novorender/src/core3d/state/index.ts:94

Local space is a variant of world space that is close to camera to avoid excessively large coordinates and thus float32 rounding errors in shader.

matrices​

readonly matrices: Matrices;

Defined in: @novorender/src/core3d/state/index.ts:96

The set of matrices that used to transform coordinate between spaces.

outlines​

readonly outlines: RenderStateOutlines;

Defined in: @novorender/src/core3d/state/index.ts:74

Outlines related state.

Inherited from​

RenderState.outlines

output​

readonly output: RenderStateOutput;

Defined in: @novorender/src/core3d/state/index.ts:38

Output image related state.

Inherited from​

RenderState.output

pick​

readonly pick: RenderStatePick;

Defined in: @novorender/src/core3d/state/index.ts:86

Pick info rendering related state.

Inherited from​

RenderState.pick

points​

readonly points: RenderStatePointCloud;

Defined in: @novorender/src/core3d/state/index.ts:80

Point cloud rendering related state.

Inherited from​

RenderState.points

quality​

readonly quality: RenderStateQuality;

Defined in: @novorender/src/core3d/state/index.ts:47

Render quality related state.

Inherited from​

RenderState.quality

scene​

readonly scene: undefined | RenderStateScene;

Defined in: @novorender/src/core3d/state/index.ts:59

Static, streamable scene related state.

Inherited from​

RenderState.scene

terrain​

readonly terrain: RenderStateTerrain;

Defined in: @novorender/src/core3d/state/index.ts:62

Terrain rendering related state.

Inherited from​

RenderState.terrain

tonemapping​

readonly tonemapping: RenderStateTonemapping;

Defined in: @novorender/src/core3d/state/index.ts:77

Tonemapping related state.

Inherited from​

RenderState.tonemapping

toonOutline​

readonly toonOutline: RenderStateToonOutline;

Defined in: @novorender/src/core3d/state/index.ts:83

Toon outline rendering related state.

Inherited from​

RenderState.toonOutline

viewFrustum​

readonly viewFrustum: ViewFrustum;

Defined in: @novorender/src/core3d/state/index.ts:98

The 6 planes of the view frustum, defined in world space.