Skip to main content

interface.RenderStateBackground

API > RenderStateBackground

Interface: RenderStateBackground

Background/environment related render state.

Properties

blur

blur?: number

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.

Source

@novorender/core3d/state/index.ts:207


color

color?: RGB

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

Remarks

If undefined, the default background will be used instead.

Source

@novorender/core3d/state/index.ts:194


rotation

rotation?: number

The horizontal rotation angle, in degrees.

Source

@novorender/core3d/state/index.ts:210


url

url?: string

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/'.

Source

@novorender/core3d/state/index.ts:200