We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

Search Results for

    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
    Namespace: Microsoft.MixedReality.Toolkit
    Assembly: cs.temp.dll.dll
    Syntax
    [MixedRealityServiceProfile(typeof(IMixedRealityCameraSystem))]
    public class MixedRealityCameraProfile : BaseMixedRealityProfile

    Properties

    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

    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

    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

    HoloLensQualityLevel

    Quality level for a HoloLens device.

    Declaration
    [Obsolete("HoloLensQualityLevel is obsolete and will be removed in a future Mixed Reality Toolkit release. Please use TransparentQualityLevel.")]
    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

    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

    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
    In This Article
    Back to top Generated by DocFX