FullScreenRenderWindow

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

Introduction

vtkFullScreenRenderWindow provides a skeleton for implementing a fullscreen render window.

Methods

addController

Argument	Type	Required	Description
html	HTMLElement	Yes

addRepresentation

Representation API

Argument	Type	Required	Description
representation		Yes

delete

Release GL context

extend

Method used to decorate a given object (publicAPI+model) with vtkFullScreenRenderWindow 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	IFullScreenRenderWindowInitialValues	No	(default: {})

getApiSpecificRenderWindow

Returns vtkWebGPURenderWindow if ?viewAPI='WebGPU' is in URL, or if vtkFullScreenRenderWindow has been created with "defaultViewAPI: 'WebGPU", otherwise vtkOpenGLRenderWindow is returned.

getContainer

Get container element

getControlContainer

Get control container element

getInteractor

Get interactor object

getRenderWindow

Get Render windows object

getRenderer

Get Renderer object

getRootContainer

Get root container element

newInstance

Method used to create a new instance of vtkFullScreenRenderWindow

Argument	Type	Required	Description
initialValues	IFullScreenRenderWindowInitialValues	No	for pre-setting some of its content

removeController

Remove controller

removeRepresentation

Remove representation

Argument	Type	Required	Description
representation		Yes

resize

Handle window resize

setBackground

Set background color

Argument	Type	Required	Description
background	RGBColor or RGBAColor	Yes	The background color.

setControllerVisibility

Hide or show controller

Argument	Type	Required	Description
visible	Boolean	Yes

setResizeCallback

Argument	Type	Required	Description
cb		Yes

toggleControllerVisibility

Toggle controller visibility