C# Class Microsoft.MixedReality.Toolkit.Utilities.Editor.ScreenshotUtility

Utility class to aide in taking screenshots via menu items and public APIs. Screenshots can be capture at various resolutions and with the current camera's clear color or a transparent clear color for use in easy post compositing of images.

Mostrar archivo Open project: danielfranze/HighscoreAR

Public Methods

Method	Description
CaptureScreenshot ( string path, int superSize = 1, bool transparentClearColor = false, Camera camera = null ) : bool	Captures a screenshot with the current main camera's clear color.
GetScreenshotDirectory ( ) : string	Gets a directory which is safe for saving screenshots.
GetScreenshotPath ( ) : string	Gets a unique screenshot path with a file name based on date and time.

Private Methods

Method	Description
CaptureScreenshot1x ( ) : void
CaptureScreenshot1xAlphaComposite ( ) : void
CaptureScreenshot2x ( ) : void
CaptureScreenshot2xAlphaComposite ( ) : void
CaptureScreenshot4x ( ) : void
CaptureScreenshot4xAlphaComposite ( ) : void

Method Details

CaptureScreenshot() public static method

Captures a screenshot with the current main camera's clear color.

public static CaptureScreenshot ( string path, int superSize = 1, bool transparentClearColor = false, Camera camera = null ) : bool
path	string	The path to save the screenshot to.
superSize	int	The multiplication factor to apply to the native resolution.
transparentClearColor	bool	True if the captured screenshot should have a transparent clear color. Which can be used for screenshot overlays.
camera	Camera	The optional camera to take the screenshot from.
return	bool

GetScreenshotDirectory() public static method

Gets a directory which is safe for saving screenshots.

public static GetScreenshotDirectory ( ) : string
return	string

GetScreenshotPath() public static method

Gets a unique screenshot path with a file name based on date and time.

public static GetScreenshotPath ( ) : string
return	string