RenderWindow

Source (.js)Source (.d.ts)

Introduction

vtkRenderWindow is an abstract object to specify the behavior of a rendering window.

A rendering window is a window in a graphical user interface where renderers draw their images. Methods are provided to synchronize the rendering process, set window size, and control double buffering. The window also allows rendering in stereo. The interlaced render stereo type is for output to a VRex stereo projector. All of the odd horizontal lines are from the left eye, and the even lines are from the right eye. The user has to make the render window aligned with the VRex projector, or the eye will be swapped.

Methods

addRenderWindow

Add a child render window

Argument	Type	Required	Description
renderWindow	vtkRenderWindow	Yes	The vtkRenderWindow instance.

addRenderer

Add renderer

Argument	Type	Required	Description
renderer	vtkRenderer	Yes	The vtkRenderer instance.

addView

Add renderer

Argument	Type	Required	Description
view		Yes

captureImages

Argument	Type	Required	Description
format	String	Yes
opts	*	Yes

extend

Method use to decorate a given object (publicAPI+model) with vtkRenderWindow characteristics.

Argument	Type	Required	Description
publicAPI		Yes	object on which methods will be bounds (public)
model		Yes	object on which data structure will be bounds (protected)
initialValues	IRenderWindowInitialValues	No	(default: {})

getChildRenderWindows

getChildRenderWindowsByReference

getDefaultViewAPI

Switch the rendering backend between WebGL and WebGPU. By default, the WebGL backend is used. To switch, to WebGPU call renderWindow.setDefaultViewAPI('WebGPU') before calling render.

getInteractor

getNeverRendered

getNumberOfLayers

getRenderers

getRenderersByReference

getStatistics

getViews

hasRenderer

Argument	Type	Required	Description
ren	vtkRenderer	Yes

hasView

Argument	Type	Required	Description
view		Yes

invisiblePropCount

listViewAPIs

newAPISpecificView

newAPISpecificView

Argument	Type	Required	Description
name	String	Yes
{}		Yes	[initialValues]

newInstance

Method use to create a new instance of vtkRenderWindow

onCompletion

Argument	Type	Required	Description
callback		Yes

propCount

registerViewConstructor

removeRenderWindow

Remove a child render window added using addRenderWindow(renderWindow)

Argument	Type	Required	Description
renderWindow	vtkRenderWindow	Yes	The vtkRenderWindow instance.

removeRenderer

Remove renderer

Argument	Type	Required	Description
renderer	vtkRenderer	Yes	The vtkRenderer instance.

removeView

Remove renderer

Argument	Type	Required	Description
view		Yes

render

setDefaultViewAPI

Switch the rendering backend between WebGL and WebGPU. By default, the WebGL backend is used. To switch, to WebGPU call renderWindow.setDefaultViewAPI('WebGPU') before calling render. Must be called before newAPISpecificView() is called.

Argument	Type	Required	Description
defaultViewAPI		Yes	(default: 'WebGL')

setInteractor

Argument	Type	Required	Description
interactor		Yes

setNumberOfLayers

Argument	Type	Required	Description
numberOfLayers		Yes

setViews

Argument	Type	Required	Description
views		Yes

str