CameraSettings Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Class that contains settings which are applied to CameraSettingsManager.
[UnityEngine.AddComponentMenu("MRTK/Core/Camera Settings")]
[System.Serializable]
public class CameraSettings
[<UnityEngine.AddComponentMenu("MRTK/Core/Camera Settings")>]
[<System.Serializable>]
type CameraSettings = class
Public Class CameraSettings
- Inheritance
-
CameraSettings
- Attributes
-
UnityEngine.AddComponentMenuAttribute SerializableAttribute
Constructors
| Name | Description |
|---|---|
| CameraSettings() |
Initializes a new instance of the CameraSettings class. |
| CameraSettings(DisplayType) |
Initializes a new instance of the CameraSettings class. |
Fields
| Name | Description |
|---|---|
| DefaultClearColorOpaque |
The default UnityEngine.Color to apply to ClearColor if on an opaque XR headset. |
| DefaultClearColorTransparent |
The default UnityEngine.Color to apply to ClearColor if on a transparent XR headset. |
| DefaultClearModeOpaque |
The default clear mode used for opaque displays. |
| DefaultClearModeTransparent |
The default clear mode used for transparent displays. |
| DefaultFarPlaneDistanceOpaque |
The default value to apply to FarPlaneDistance if on an opaque XR headset. |
| DefaultFarPlaneDistanceTransparent |
The default value to apply to FarPlaneDistance if on a transparent XR headset. |
| DefaultNearPlaneDistanceOpaque |
The default value to apply to NearPlaneDistance if on an opaque XR headset. |
| DefaultNearPlaneDistanceTransparent |
The default value to apply to NearPlaneDistance if on a transparent XR headset. |
| DefaultQualityLevelOpaque |
The default value to apply to QualityLevel if on an opaque XR headset. |
| DefaultQualityLevelTransparent |
The default value to apply to QualityLevel if on a transparent XR headset. |
Properties
| Name | Description |
|---|---|
| AdjustQualityLevel |
Should the quality level be adjusted based on camera type? |
| AdjustTrackingOrigin |
Should the tracking origin be adjusted based on camera type? |
| ClearColor |
Color to use when clearing (does not apply to sky box or depth). |
| ClearMode |
How the display should be cleared. |
| FarPlaneDistance |
Furthest distance, in meters, at which holograms will display. |
| NearPlaneDistance |
Closest distance (in meters) at which holograms will display. |
| QualityLevel |
The desired level of graphical quality. |