XRSessionSubsystemDescriptor.cs
7.16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
using System;
#if UNITY_2020_2_OR_NEWER
using UnityEngine.SubsystemsImplementation;
#endif
namespace UnityEngine.XR.ARSubsystems
{
/// <summary>
/// Descriptor for the <see cref="XRSessionSubsystem"/> describing capabilities which may vary by implementation.
/// </summary>
public sealed class XRSessionSubsystemDescriptor :
#if UNITY_2020_2_OR_NEWER
SubsystemDescriptorWithProvider<XRSessionSubsystem, XRSessionSubsystem.Provider>
#else
SubsystemDescriptor<XRSessionSubsystem>
#endif
{
/// <summary>
/// Whether the session supports the update or installation of session software.
/// </summary>
public bool supportsInstall { get; private set; }
/// <summary>
/// Whether the session supports matching the AR frame rate to the Unity frame rate.
/// </summary>
public bool supportsMatchFrameRate { get; private set; }
/// <summary>
/// Used in conjunction with <see cref="RegisterDescriptor(Cinfo)"/> to register a provider.
/// This should only be used by subsystem implementors.
/// </summary>
public struct Cinfo : IEquatable<Cinfo>
{
/// <summary>
/// Whether the session supports the update or installation of session software.
/// </summary>
public bool supportsInstall { get; set; }
/// <summary>
/// Whether the session supports matching the AR frame rate to the Unity frame rate.
/// </summary>
public bool supportsMatchFrameRate { get; set; }
/// <summary>
/// The string used to identify this subsystem implementation.
/// This will be available when enumerating the available descriptors at runtime.
/// </summary>
public string id { get; set; }
#if UNITY_2020_2_OR_NEWER
/// <summary>
/// Specifies the provider implementation type to use for instantiation.
/// </summary>
/// <value>
/// The provider implementation type to use for instantiation.
/// </value>
public Type providerType { get; set; }
/// <summary>
/// Specifies the <c>XRAnchorSubsystem</c>-derived type that forwards casted calls to its provider.
/// </summary>
/// <value>
/// The type of the subsystem to use for instantiation. If null, <c>XRAnchorSubsystem</c> will be instantiated.
/// </value>
public Type subsystemTypeOverride { get; set; }
#endif
/// <summary>
/// The <c>Type</c> of the implementation.
/// </summary>
#if UNITY_2020_2_OR_NEWER
[Obsolete("XRSubsystem no longer supports the deprecated set of base classes for subsystems as of Unity 2020.2. Use providerType and, optionally, subsystemTypeOverride instead.", true)]
#endif
public Type subsystemImplementationType { get; set; }
/// <summary>
/// Generates a hash code suitable for use in a <c>HashSet</c> or <c>Dictionary</c>.
/// </summary>
/// <returns>A hash code suitable for use in a <c>HashSet</c> or <c>Dictionary</c>.</returns>
public override int GetHashCode()
{
unchecked
{
int hash = HashCode.ReferenceHash(id);
#if UNITY_2020_2_OR_NEWER
hash = hash * 486187739 + HashCode.ReferenceHash(providerType);
hash = hash * 486187739 + HashCode.ReferenceHash(subsystemTypeOverride);
#else
hash = hash * 486187739 + HashCode.ReferenceHash(subsystemImplementationType);
#endif
hash = hash * 486187739 + supportsInstall.GetHashCode();
hash = hash * 486187739 + supportsMatchFrameRate.GetHashCode();
return hash;
}
}
/// <summary>
/// Tests for equality.
/// </summary>
/// <param name="other">The other <see cref="Cinfo"/> to compare against.</param>
/// <returns><c>true</c> if all fields in <paramref name="other"/> are equal to this <see cref="Cinfo"/>, otherwise <c>false</c>.</returns>
public bool Equals(Cinfo other)
{
return
string.Equals(id, other.id) &&
#if UNITY_2020_2_OR_NEWER
ReferenceEquals(providerType, other.providerType) &&
ReferenceEquals(subsystemTypeOverride, other.subsystemTypeOverride) &&
#else
ReferenceEquals(subsystemImplementationType, other.subsystemImplementationType) &&
#endif
supportsInstall == other.supportsInstall &&
supportsMatchFrameRate == other.supportsMatchFrameRate;
}
/// <summary>
/// Tests for equality.
/// </summary>
/// <param name="obj">The <c>object</c> to test for equality.</param>
/// <returns><c>true</c> if <paramref name="obj"/> is a <see cref="Cinfo"/> and <see cref="Equals(Cinfo)"/> returns <c>true</c>, otherwise <c>false</c>.</returns>
public override bool Equals(object obj) => obj is Cinfo && Equals((Cinfo)obj);
/// <summary>
/// Tests for equality.
/// </summary>
/// <param name="lhs">The left-hand side of the comparison.</param>
/// <param name="rhs">The right-hand side of the comparison.</param>
/// <returns><c>true</c> if <paramref name="lhs"/> is equal to <paramref name="rhs"/>. Same as <see cref="Equals(Cinfo"/>.</returns>
public static bool operator ==(Cinfo lhs, Cinfo rhs) => lhs.Equals(rhs);
/// <summary>
/// Tests for inequality.
/// </summary>
/// <param name="lhs">The left-hand side of the comparison.</param>
/// <param name="rhs">The right-hand side of the comparison.</param>
/// <returns><c>true</c> if <paramref name="lhs"/> is not equal to <paramref name="rhs"/>. Same as !<see cref="Equals(Cinfo"/>.</returns>
public static bool operator !=(Cinfo lhs, Cinfo rhs) => !lhs.Equals(rhs);
}
/// <summary>
/// Register a subsystem implementation.
/// This should only be used by subsystem implementors.
/// </summary>
/// <param name="cinfo">Information used to construct the descriptor.</param>
public static void RegisterDescriptor(Cinfo cinfo)
{
#if UNITY_2020_2_OR_NEWER
SubsystemDescriptorStore.RegisterDescriptor(new XRSessionSubsystemDescriptor(cinfo));
#else
SubsystemRegistration.CreateDescriptor(new XRSessionSubsystemDescriptor(cinfo));
#endif
}
XRSessionSubsystemDescriptor(Cinfo cinfo)
{
id = cinfo.id;
#if UNITY_2020_2_OR_NEWER
providerType = cinfo.providerType;
subsystemTypeOverride = cinfo.subsystemTypeOverride;
#else
subsystemImplementationType = cinfo.subsystemImplementationType;
#endif
supportsInstall = cinfo.supportsInstall;
supportsMatchFrameRate = cinfo.supportsMatchFrameRate;
}
}
}