Skip to main content

@novorender/api / RenderStateBackground

Interface: RenderStateBackground

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

Background/environment related render state.

Properties​

blur?​

readonly optional blur: number;

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

A blur factor to use when rendering the background image.

Remarks​

0 will yield no blur, while 1 will yield max blur. Blurring is useful for not overly cluttering up the image with backgrounds while still retaining the ambience and lighting characteristics.

color?​

readonly optional color: RGB;

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

The background color to be used if no url is specified.

Remarks​

If undefined, the default background will be used instead.

rotation?​

readonly optional rotation: number;

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

The horizontal rotation angle, in degrees.

url?​

readonly optional url: string;

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

The absolute url of the background/environment.

Remarks​

This should point to the folder that contains the textures files of the desired environment, e.g. `https://api.novorender/env/lake/'.