IMixedRealityCameraSystem Interface

Definition

Namespace:

Microsoft.MixedReality.Toolkit.CameraSystem

Assembly:

Microsoft.MixedReality.Toolkit.dll

Manager interface for a camera system in the Mixed Reality Toolkit. The camera system is expected to manage settings on the main camera. It should update the camera's clear settings, render mask, etc based on platform.

public interface class IMixedRealityCameraSystem : IDisposable, Microsoft::MixedReality::Toolkit::IMixedRealityEventSource, Microsoft::MixedReality::Toolkit::IMixedRealityEventSystem, System::Collections::IEqualityComparer

public interface IMixedRealityCameraSystem : IDisposable, Microsoft.MixedReality.Toolkit.IMixedRealityEventSource, Microsoft.MixedReality.Toolkit.IMixedRealityEventSystem, System.Collections.IEqualityComparer

type IMixedRealityCameraSystem = interface
    interface IMixedRealityEventSystem
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityEventSource
    interface IEqualityComparer

Public Interface IMixedRealityCameraSystem
Implements IDisposable, IEqualityComparer, IMixedRealityEventSource, IMixedRealityEventSystem

Derived

Microsoft.MixedReality.Toolkit.CameraSystem.MixedRealityCameraSystem

Implements

IMixedRealityEventSource IMixedRealityEventSystem IMixedRealityService IEqualityComparer IDisposable

Properties

CameraProfile	Typed representation of the ConfigurationProfile property.
ConfigurationProfile	The configuration profile for the service. (Inherited from IMixedRealityService)
EventListeners	List of event listeners that are registered to this Event System. (Inherited from IMixedRealityEventSystem)
IsOpaque	Is the current camera displaying on an opaque (VR / immersive) or a transparent (AR) device
Name	Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action. (Inherited from IMixedRealityService)
Priority	Optional Priority to reorder registered managers based on their respective priority, reduces the risk of race conditions by prioritizing the order in which managers are evaluated. (Inherited from IMixedRealityService)
SourceId	The unique source id of this event source. (Inherited from IMixedRealityEventSource)
SourceName	The name of this event source. (Inherited from IMixedRealityEventSource)

Methods

Destroy()	Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed. (Inherited from IMixedRealityService)
Disable()	Optional Disable function to pause the service. (Inherited from IMixedRealityService)
Enable()	Optional Enable function to enable / re-enable the service. (Inherited from IMixedRealityService)
HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)	The main function for handling and forwarding all events to their intended recipients. (Inherited from IMixedRealityEventSystem)
Initialize()	The initialize function is used to setup the service once created. This method is called once all services have been registered in the Mixed Reality Toolkit. (Inherited from IMixedRealityService)
LateUpdate()	Optional LateUpdate function to that is called after Update has been called on all services. (Inherited from IMixedRealityService)
Register(GameObject)	Obsolete. Registers a GameObject to listen for events from this Event System. (Inherited from IMixedRealityEventSystem)
RegisterHandler<T>(IEventSystemHandler)	Registers the given handler as a global listener for all events handled via the T interface. T must be an interface type, not a class type, derived from IEventSystemHandler. (Inherited from IMixedRealityEventSystem)
Reset()	Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change. (Inherited from IMixedRealityService)
Unregister(GameObject)	Obsolete. Unregisters a GameObject from listening for events from this Event System. (Inherited from IMixedRealityEventSystem)
UnregisterHandler<T>(IEventSystemHandler)	Unregisters the given handler as a global listener for all events handled via the T interface. T must be an interface type, not a class type, derived from IEventSystemHandler. (Inherited from IMixedRealityEventSystem)
Update()	Optional Update function to perform per-frame updates of the service. (Inherited from IMixedRealityService)