CellexalVR  1.1.0
A virtual reality platform for the exploration and analysis of single-cell gene expression data
CellexalVR.Tools.CaptureScreenshot Class Reference

This class takes screenshots of what the user sees in the virtual environment. More...

Inheritance diagram for CellexalVR.Tools.CaptureScreenshot:

Public Member Functions

void Capture ()
 Takes a screenshot of what is currently on the rendertexture. More...
 
void ToggleLayerToCapture (string layerName, bool toggle)
 Toggles a layer to render on the rendertexture. More...
 
void ToggleBackground (bool toggle)
 Toggles rendering the skybox on the rendertexture. More...
 
void ToggleAllLayers (bool toggle)
 Toggles all layers to render on the rendertexture. More...
 
void Toggle (bool toggle)
 Toggles this gameobject on or off. Repositions it in front of the user when toggled on. More...
 

Public Attributes

Camera snapShotCamera
 
int picWidth
 
int picHeight
 
GameObject quadPrefab
 
Light flash
 
Color backgroundColor
 

Detailed Description

This class takes screenshots of what the user sees in the virtual environment.

Member Function Documentation

◆ Capture()

void CellexalVR.Tools.CaptureScreenshot.Capture ( )

Takes a screenshot of what is currently on the rendertexture.

◆ Toggle()

void CellexalVR.Tools.CaptureScreenshot.Toggle ( bool  toggle)

Toggles this gameobject on or off. Repositions it in front of the user when toggled on.

Parameters
toggleTrue for toggling in, false for toggling off.

◆ ToggleAllLayers()

void CellexalVR.Tools.CaptureScreenshot.ToggleAllLayers ( bool  toggle)

Toggles all layers to render on the rendertexture.

Parameters
toggleTrue to toggle the layers on, false to toggle off.

◆ ToggleBackground()

void CellexalVR.Tools.CaptureScreenshot.ToggleBackground ( bool  toggle)

Toggles rendering the skybox on the rendertexture.

Parameters
toggleTrue to toggle the skybox on, false to toggle off.

◆ ToggleLayerToCapture()

void CellexalVR.Tools.CaptureScreenshot.ToggleLayerToCapture ( string  layerName,
bool  toggle 
)

Toggles a layer to render on the rendertexture.

Parameters
layerNameThe name of the layer to toggle.
toggleTrue to toggle the layer on, false to toggle off.

The documentation for this class was generated from the following file: