Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

IsPreviewSupported(Camera, out string)

Allow to specify if a camera can be previewed or not.
Read time 1 minuteLast updated 6 days ago

Definition

IsPreviewSupported(Camera, string)

protected virtual bool IsPreviewSupported(Camera camera, out string reason)

Parameters

camera

Camera
The camera to check if it is compatible with preview.

reason

string
The reason why it is not compatible. This message will be displayed instead of the preview in the Preview widget in the scene.

Returns

Type

Description

boolIf false, the preview is forbidden for this camera.

Remarks

Preview are done with the SceneView's preview widget. When selecting a camera to preview, this method will be called to determine if the camera is previewable or not. The default implementation of this method consider every camera is previewable, but it may not be the case for the custom RenderPipeline you write on your own. If it is the case, override this method.