Class Renderer

Renderer class that handles 3D scene rendering and settings management

Implements

Core.Ultra.IRenderer

Index

Constructors

Accessors

backgroundBlur backgroundColor ghostColor hdrBackgroundSaturation hdrBackgroundScale hdrScale lockIblRotation onSceneUpdated toneMappingWhitePoint

Methods

dispose getBoundingBox notifySceneUpdated onConnect validateConnection

Constructors

constructor

new Renderer(
    rpc: RpcSafeClient,
    logger: ILogger,
    settings?: Partial<RenderSettings>,
): Core.Ultra.Renderer
Creates a new Renderer instance
Parameters
- rpc: RpcSafeClient
  RPC client for communication with the rendering backend
- logger: ILogger
- settings: Partial<RenderSettings> = {}
  Optional partial render settings to override defaults
Returns Core.Ultra.Renderer
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:68

Accessors

backgroundBlur

get backgroundBlur(): number
Gets the background blur value

Returns number
Current background blur
Implementation of IRenderer.backgroundBlur
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:162
set backgroundBlur(value: number): void
Sets the background blur value
Parameters
- value: number
  New background blur value
Returns void
Implementation of IRenderer.backgroundBlur
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:251

backgroundColor

get backgroundColor(): RGBA
Gets the background color

Returns RGBA
Current background color as RGBA
Implementation of IRenderer.backgroundColor
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:170
set backgroundColor(value: RGBA): void
Sets the background color
Parameters
- value: RGBA
  New background color as RGBA
Returns void
Implementation of IRenderer.backgroundColor
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:263

ghostColor

get ghostColor(): RGBA
Gets the ghost color used for transparent rendering

Returns RGBA
Current ghost color as RGBA
Implementation of IRenderer.ghostColor
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:114
set ghostColor(value: RGBA): void
Updates the ghost color used for transparent rendering
Parameters
- value: RGBA
  New ghost color as RGBA
Returns void
Implementation of IRenderer.ghostColor
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:180

hdrBackgroundSaturation

get hdrBackgroundSaturation(): number
Gets the HDR background saturation value

Returns number
Current HDR background saturation
Implementation of IRenderer.hdrBackgroundSaturation
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:154
set hdrBackgroundSaturation(value: number): void
Sets the HDR background saturation value
Parameters
- value: number
  New HDR background saturation value
Returns void
Implementation of IRenderer.hdrBackgroundSaturation
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:239

hdrBackgroundScale

get hdrBackgroundScale(): number
Gets the HDR background scale value

Returns number
Current HDR background scale
Implementation of IRenderer.hdrBackgroundScale
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:146
set hdrBackgroundScale(value: number): void
Sets the HDR background scale value
Parameters
- value: number
  New HDR background scale value
Returns void
Implementation of IRenderer.hdrBackgroundScale
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:227

hdrScale

get hdrScale(): number
Gets the HDR scale value

Returns number
Current HDR scale
Implementation of IRenderer.hdrScale
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:138
set hdrScale(value: number): void
Sets the HDR scale value
Parameters
- value: number
  New HDR scale value
Returns void
Implementation of IRenderer.hdrScale
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:215

lockIblRotation

get lockIblRotation(): boolean
Gets the IBL rotation lock setting

Returns boolean
Whether IBL rotation is locked
Implementation of IRenderer.lockIblRotation
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:122
set lockIblRotation(value: boolean): void
Updates the IBL rotation lock setting
Parameters
- value: boolean
  Whether to lock IBL rotation
Returns void
Implementation of IRenderer.lockIblRotation
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:192

onSceneUpdated

get onSceneUpdated(): ISignal
Returns ISignal
Implementation of IRenderer.onSceneUpdated
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:59

toneMappingWhitePoint

get toneMappingWhitePoint(): number
Gets the tone mapping white point value

Returns number
Current tone mapping white point
Implementation of IRenderer.toneMappingWhitePoint
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:130
set toneMappingWhitePoint(value: number): void
Sets the tone mapping white point value
Parameters
- value: number
  New tone mapping white point value
Returns void
Implementation of IRenderer.toneMappingWhitePoint
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:203

Methods

dispose

dispose(): void
Cleans up renderer resources Cancels any pending animation frames

Returns void
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:303

getBoundingBox

getBoundingBox(): Promise<Box3>
Returns Promise<Box3>
Implementation of IRenderer.getBoundingBox
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:271

notifySceneUpdated

notifySceneUpdated(): void
Returns void
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:104

onConnect

onConnect(): void
Initializes the renderer when connection is established Sets up initial scene settings, ghost color, and IBL rotation

Returns void
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:99

validateConnection

validateConnection(): Promise<ClientStreamError>
Validates the connection to the server by attempting to start a scene.

Returns Promise<ClientStreamError>
A promise that resolves to a ClientStreamError if the connection fails, or undefined if successful.
- Defined in src/vim-web/core-viewers/ultra/renderer.ts:78

Class Renderer

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Core.Ultra.Renderer

Accessors

backgroundBlur

Returns number

Parameters

Returns void

backgroundColor

Returns RGBA

Parameters

Returns void

ghostColor

Returns RGBA

Parameters

Returns void

hdrBackgroundSaturation

Returns number

Parameters

Returns void

hdrBackgroundScale

Returns number

Parameters

Returns void

hdrScale

Returns number

Parameters

Returns void

lockIblRotation

Returns boolean

Parameters

Returns void

onSceneUpdated

Returns ISignal

toneMappingWhitePoint

Returns number

Parameters

Returns void

Methods

dispose

Returns void

getBoundingBox

Returns Promise<Box3>

notifySceneUpdated

Returns void

onConnect

Returns void

validateConnection

Returns Promise<ClientStreamError>

Settings

On This Page