mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class MixedRealityCameraProfile

    This Scriptable Object tells you if your head mounted display (HMD) is a transparent device or an occluded device. Based on those values, you can customize your camera and quality settings.

    Inheritance
    Object
    BaseMixedRealityProfile
    MixedRealityCameraProfile
    Implements
    ScriptableObject
    Namespace: Microsoft.MixedReality.Toolkit
    Assembly: cs.temp.dll.dll
    Syntax
    public class MixedRealityCameraProfile : BaseMixedRealityProfile, ScriptableObject

    Properties

    BackgroundColorOpaqueDisplay

    Background color for an opaque display.

    Declaration
    public Color BackgroundColorOpaqueDisplay { get; }
    Property Value
    Type Description
    Color

    BackgroundColorOpaqueDisplay

    Background color for an opaque display.

    Declaration
    public Color BackgroundColorOpaqueDisplay { get; }
    Property Value
    Type Description
    Color

    BackgroundColorTransparentDisplay

    Background color for a transparent display.

    Declaration
    public Color BackgroundColorTransparentDisplay { get; }
    Property Value
    Type Description
    Color

    BackgroundColorTransparentDisplay

    Background color for a transparent display.

    Declaration
    public Color BackgroundColorTransparentDisplay { get; }
    Property Value
    Type Description
    Color

    CameraClearFlagsOpaqueDisplay

    Flags describing how to clear the camera for an opaque display.

    Declaration
    public CameraClearFlags CameraClearFlagsOpaqueDisplay { get; }
    Property Value
    Type Description
    CameraClearFlags

    CameraClearFlagsOpaqueDisplay

    Flags describing how to clear the camera for an opaque display.

    Declaration
    public CameraClearFlags CameraClearFlagsOpaqueDisplay { get; }
    Property Value
    Type Description
    CameraClearFlags

    CameraClearFlagsTransparentDisplay

    Flags describing how to clear the camera for a transparent display.

    Declaration
    public CameraClearFlags CameraClearFlagsTransparentDisplay { get; }
    Property Value
    Type Description
    CameraClearFlags

    CameraClearFlagsTransparentDisplay

    Flags describing how to clear the camera for a transparent display.

    Declaration
    public CameraClearFlags CameraClearFlagsTransparentDisplay { get; }
    Property Value
    Type Description
    CameraClearFlags

    FarClipPlaneOpaqueDisplay

    Far clipping plane distance for an opaque display.

    Declaration
    public float FarClipPlaneOpaqueDisplay { get; }
    Property Value
    Type Description
    Single

    FarClipPlaneOpaqueDisplay

    Far clipping plane distance for an opaque display.

    Declaration
    public float FarClipPlaneOpaqueDisplay { get; }
    Property Value
    Type Description
    Single

    FarClipPlaneTransparentDisplay

    Far clipping plane distance for a transparent display.

    Declaration
    public float FarClipPlaneTransparentDisplay { get; }
    Property Value
    Type Description
    Single

    FarClipPlaneTransparentDisplay

    Far clipping plane distance for a transparent display.

    Declaration
    public float FarClipPlaneTransparentDisplay { get; }
    Property Value
    Type Description
    Single

    HoloLensQualityLevel

    Quality level for a HoloLens device.

    Declaration
    public int HoloLensQualityLevel { get; }
    Property Value
    Type Description
    Int32
    Remarks

    HoloLensQualityLevel is obsolete and will be removed in a future Mixed Reality Toolkit release. Please use TransparentQualityLevel.

    HoloLensQualityLevel

    Quality level for a HoloLens device.

    Declaration
    public int HoloLensQualityLevel { get; }
    Property Value
    Type Description
    Int32
    Remarks

    HoloLensQualityLevel is obsolete and will be removed in a future Mixed Reality Toolkit release. Please use TransparentQualityLevel.

    NearClipPlaneOpaqueDisplay

    Near clipping plane distance for an opaque display.

    Declaration
    public float NearClipPlaneOpaqueDisplay { get; }
    Property Value
    Type Description
    Single

    NearClipPlaneOpaqueDisplay

    Near clipping plane distance for an opaque display.

    Declaration
    public float NearClipPlaneOpaqueDisplay { get; }
    Property Value
    Type Description
    Single

    NearClipPlaneTransparentDisplay

    Near clipping plane distance for a transparent display.

    Declaration
    public float NearClipPlaneTransparentDisplay { get; }
    Property Value
    Type Description
    Single

    NearClipPlaneTransparentDisplay

    Near clipping plane distance for a transparent display.

    Declaration
    public float NearClipPlaneTransparentDisplay { get; }
    Property Value
    Type Description
    Single

    OpaqueQualityLevel

    Quality level for an opaque display.

    Declaration
    public int OpaqueQualityLevel { get; }
    Property Value
    Type Description
    Int32

    OpaqueQualityLevel

    Quality level for an opaque display.

    Declaration
    public int OpaqueQualityLevel { get; }
    Property Value
    Type Description
    Int32

    SettingsConfigurations

    Configuration objects describing the registered settings providers.

    Declaration
    public MixedRealityCameraSettingsConfiguration[] SettingsConfigurations { get; }
    Property Value
    Type Description
    MixedRealityCameraSettingsConfiguration[]

    SettingsConfigurations

    Configuration objects describing the registered settings providers.

    Declaration
    public MixedRealityCameraSettingsConfiguration[] SettingsConfigurations { get; }
    Property Value
    Type Description
    MixedRealityCameraSettingsConfiguration[]

    TransparentQualityLevel

    Quality level for a transparent display.

    Declaration
    public int TransparentQualityLevel { get; }
    Property Value
    Type Description
    Int32

    TransparentQualityLevel

    Quality level for a transparent display.

    Declaration
    public int TransparentQualityLevel { get; }
    Property Value
    Type Description
    Int32

    Implements

    ScriptableObject
    In This Article
    • Properties
      • BackgroundColorOpaqueDisplay
      • BackgroundColorOpaqueDisplay
      • BackgroundColorTransparentDisplay
      • BackgroundColorTransparentDisplay
      • CameraClearFlagsOpaqueDisplay
      • CameraClearFlagsOpaqueDisplay
      • CameraClearFlagsTransparentDisplay
      • CameraClearFlagsTransparentDisplay
      • FarClipPlaneOpaqueDisplay
      • FarClipPlaneOpaqueDisplay
      • FarClipPlaneTransparentDisplay
      • FarClipPlaneTransparentDisplay
      • HoloLensQualityLevel
      • HoloLensQualityLevel
      • NearClipPlaneOpaqueDisplay
      • NearClipPlaneOpaqueDisplay
      • NearClipPlaneTransparentDisplay
      • NearClipPlaneTransparentDisplay
      • OpaqueQualityLevel
      • OpaqueQualityLevel
      • SettingsConfigurations
      • SettingsConfigurations
      • TransparentQualityLevel
      • TransparentQualityLevel
    • Implements
    Back to top Generated by DocFX