Class: CreateFullScreenSettings

CreateFullScreenSettings~CreateFullScreenSettings(THREE, renderer, camera, options)

creates functions for resize of the canvas to fullscreen and restore to default size.

Constructor

new CreateFullScreenSettings(THREE, renderer, camera, options)

Parameters:
Name Type Description
THREE THREE THREE
renderer THREE.WebGLRenderer WebGLRenderer
camera THREE.PerspectiveCamera PerspectiveCamera
options object the following options are available:
Properties
Name Type Attributes Description
canvasMenu CanvasMenu <optional>
 CanvasMenu
stereoEffect StereoEffect <optional>
 StereoEffect instance.
fullScreen object <optional>
 followed fullScreen methods available:
Properties
Name Type Attributes Description
onFullScreenToggle onFullScreenToggle <optional>
 user toggled fullscreen mode of the canvas.
Source:

Namespaces

RendererSetSize

Methods

isFullScreen()

Source:
Returns:
true if canvas is full screen.

setFullScreen(fullScreenopt, boTimeoutopt)

Sets the full screen of the canvas.
Parameters:
Name Type Attributes Default Description
fullScreen boolean <optional>
 false false - full screen of the canvas.
boTimeout boolean <optional>
 false true - set fullScreen after 0 msec timeout.
Source:

setStereoEffect(_stereoEffect)

Parameters:
Name Type Description
_stereoEffect StereoEffect StereoEffect.
Source:

Events

onclick

User has clicked the "Full Screen" button on the CanvasMenu.
Source: