Class XREnvironmentProbeSubsystem

Defines an interface for interacting with environment probe functionality for creating realistic lighting and environment texturing in AR scenes.

Inheritance

object

SubsystemWithProvider

SubsystemWithProvider<XREnvironmentProbeSubsystem, XREnvironmentProbeSubsystemDescriptor, XREnvironmentProbeSubsystem.Provider>

TrackingSubsystem<XREnvironmentProbe, XREnvironmentProbeSubsystem, XREnvironmentProbeSubsystemDescriptor, XREnvironmentProbeSubsystem.Provider>

XREnvironmentProbeSubsystem

Implements

ISubsystem

Inherited Members

TrackingSubsystem<XREnvironmentProbe, XREnvironmentProbeSubsystem, XREnvironmentProbeSubsystemDescriptor, XREnvironmentProbeSubsystem.Provider>.GetChanges(Allocator)

SubsystemWithProvider<XREnvironmentProbeSubsystem, XREnvironmentProbeSubsystemDescriptor, XREnvironmentProbeSubsystem.Provider>.OnCreate()

SubsystemWithProvider<XREnvironmentProbeSubsystem, XREnvironmentProbeSubsystemDescriptor, XREnvironmentProbeSubsystem.Provider>.OnStart()

SubsystemWithProvider<XREnvironmentProbeSubsystem, XREnvironmentProbeSubsystemDescriptor, XREnvironmentProbeSubsystem.Provider>.OnStop()

SubsystemWithProvider<XREnvironmentProbeSubsystem, XREnvironmentProbeSubsystemDescriptor, XREnvironmentProbeSubsystem.Provider>.OnDestroy()

SubsystemWithProvider<XREnvironmentProbeSubsystem, XREnvironmentProbeSubsystemDescriptor, XREnvironmentProbeSubsystem.Provider>.subsystemDescriptor

SubsystemWithProvider<XREnvironmentProbeSubsystem, XREnvironmentProbeSubsystemDescriptor, XREnvironmentProbeSubsystem.Provider>.provider

SubsystemWithProvider.Start()

SubsystemWithProvider.OnStart()

SubsystemWithProvider.Stop()

SubsystemWithProvider.OnStop()

SubsystemWithProvider.Destroy()

SubsystemWithProvider.OnDestroy()

SubsystemWithProvider.running

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: UnityEngine.XR.ARSubsystems

Assembly: solution.dll

Syntax

public class XREnvironmentProbeSubsystem : TrackingSubsystem<XREnvironmentProbe, XREnvironmentProbeSubsystem, XREnvironmentProbeSubsystemDescriptor, XREnvironmentProbeSubsystem.Provider>, ISubsystem

Constructors

Name	Description
XREnvironmentProbeSubsystem()	Constructs an XREnvironmentProbeSubsystem. Do not create this directly. Call Create on an XREnvironmentProbeSubsystemDescriptor obtained from the SubsystemManager.

Properties

Name	Description
automaticPlacementEnabled	True if the AR session will automatically place environment probes in the scene, false otherwise.
automaticPlacementRequested	Specifies whether the AR session should automatically place environment probes in the scene.
environmentTextureHDREnabled	True if HDR environment textures are enabled.
environmentTextureHDRRequested	Specifies whether the environment textures should be returned as HDR textures.

Methods

Name	Description
GetChanges(Allocator)	Get the changes (added, updated, and removed) environment probes since the last call to GetChanges(Allocator).
Register(XREnvironmentProbeSubsystemCinfo)	Registers a subsystem implementation based on the given subystem parameters.
RemoveEnvironmentProbe(TrackableId)	Asynchronously removes the environment probe matching the trackable ID from the AR session.
TryAddEnvironmentProbe(Pose, Vector3, Vector3, out XREnvironmentProbe)	Tries to create an environment probe.