UnityEngine.SubsystemsModule.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.SubsystemsModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.IntegratedSubsystem">
  8. <summary>
  9. <para>An IntegratedSubsystem is initialized from an IntegratedSubsystemDescriptor for a given Subsystem (Example, Input, Environment, Display, etc.) and provides an interface to interact with that given IntegratedSubsystem until it is Destroyed. After an IntegratedSubsystem is created it can be Started or Stopped to turn on and off functionality (and preserve performance). The base type for IntegratedSubsystem only exposes this functionality; this class is designed to be a base class for derived classes that expose more functionality specific to a given IntegratedSubsystem.
  10. Note: initializing a second IntegratedSubsystem from the same IntegratedSubsystemDescriptor will return a reference to the existing IntegratedSubsystem as only one IntegratedSubsystem is currently allowed for a single IntegratedSubsystem provider.
  11. </para>
  12. </summary>
  13. </member>
  14. <member name="P:UnityEngine.IntegratedSubsystem.running">
  15. <summary>
  16. <para>Whether or not the subsystem is running.</para>
  17. </summary>
  18. </member>
  19. <member name="M:UnityEngine.IntegratedSubsystem.Destroy">
  20. <summary>
  21. <para>Destroys this instance of a subsystem.</para>
  22. </summary>
  23. </member>
  24. <member name="M:UnityEngine.IntegratedSubsystem.Start">
  25. <summary>
  26. <para>Starts an instance of a subsystem.</para>
  27. </summary>
  28. </member>
  29. <member name="M:UnityEngine.IntegratedSubsystem.Stop">
  30. <summary>
  31. <para>Stops an instance of a subsystem.</para>
  32. </summary>
  33. </member>
  34. <member name="T:UnityEngine.IntegratedSubsystemDescriptor">
  35. <summary>
  36. <para>Information about a subsystem that can be queried before creating a subsystem instance.</para>
  37. </summary>
  38. </member>
  39. <member name="P:UnityEngine.IntegratedSubsystemDescriptor.id">
  40. <summary>
  41. <para>A unique string that identifies the subsystem that this Descriptor can create.</para>
  42. </summary>
  43. </member>
  44. <member name="?:UnityEngine.ISubsystem">
  45. <summary>
  46. <para>Interface implemented by both Subsystem and IntegratedSubsystem which provides control over the state of either.
  47. </para>
  48. </summary>
  49. </member>
  50. <member name="P:UnityEngine.ISubsystem.running">
  51. <summary>
  52. <para>Will be true if asking the subsytem to start was successful. False in the case that the subsystem has stopped, was asked to stop or has not been started yet.</para>
  53. </summary>
  54. </member>
  55. <member name="M:UnityEngine.ISubsystem.Destroy">
  56. <summary>
  57. <para>Destroys this instance of a subsystem.</para>
  58. </summary>
  59. </member>
  60. <member name="M:UnityEngine.ISubsystem.Start">
  61. <summary>
  62. <para>Starts an instance of a subsystem.</para>
  63. </summary>
  64. </member>
  65. <member name="M:UnityEngine.ISubsystem.Stop">
  66. <summary>
  67. <para>Stops an instance of a subsystem.</para>
  68. </summary>
  69. </member>
  70. <member name="?:UnityEngine.ISubsystemDescriptor">
  71. <summary>
  72. <para>A subsystem descriptor is metadata about a subsystem which can be inspected before loading / initializing a subsystem.
  73. </para>
  74. </summary>
  75. </member>
  76. <member name="P:UnityEngine.ISubsystemDescriptor.id">
  77. <summary>
  78. <para>A unique string that identifies the subsystem that this Descriptor can create.</para>
  79. </summary>
  80. </member>
  81. <member name="M:UnityEngine.ISubsystemDescriptor.Create">
  82. <summary>
  83. <para>Creates an ISubsystem from this descriptor.</para>
  84. </summary>
  85. <returns>
  86. <para>An instance of ISubsystem.</para>
  87. </returns>
  88. </member>
  89. <member name="T:UnityEngine.Subsystem">
  90. <summary>
  91. <para>A Subsystem is initialized from a SubsystemDescriptorWithProvider for a given Subsystem (Example, Input, Display, etc.) and provides an interface to interact with that given Subsystem until it is Destroyed. After a Subsystem is created it can be Started or Stopped to turn on and off functionality (and improve performance). The base type for subsystems only exposes this functionality; this class is designed to be a base class for derived classes that expose more functionality specific to a given Subsystem.
  92. Note: initializing a second Subsystem from the same SubsystemDescriptor will return a reference to the existing Subsystem as only one Subsystem is currently allowed for a single Subsystem provider.
  93. This subsystem base-class is deprecated. If you are creating a new subsystem type, derive from SubsystemWithProvider instead.</para>
  94. </summary>
  95. </member>
  96. <member name="P:UnityEngine.Subsystem.running">
  97. <summary>
  98. <para>Whether or not the subsystem is running.</para>
  99. </summary>
  100. </member>
  101. <member name="M:UnityEngine.Subsystem.Destroy">
  102. <summary>
  103. <para>Destroys this instance of a subsystem.</para>
  104. </summary>
  105. </member>
  106. <member name="M:UnityEngine.Subsystem.Start">
  107. <summary>
  108. <para>Starts an instance of a subsystem.</para>
  109. </summary>
  110. </member>
  111. <member name="M:UnityEngine.Subsystem.Stop">
  112. <summary>
  113. <para>Stops an instance of a subsystem.</para>
  114. </summary>
  115. </member>
  116. <member name="T:UnityEngine.SubsystemDescriptor">
  117. <summary>
  118. <para>Information about a subsystem that can be queried before creating a subsystem instance.
  119. This subsystem descriptor base-class is deprecated. If you are creating a new subsystem type, derive from SubsystemDecriptorWithProvider instead.</para>
  120. </summary>
  121. </member>
  122. <member name="P:UnityEngine.SubsystemDescriptor.id">
  123. <summary>
  124. <para>A unique string that identifies the subsystem that this Descriptor can create.</para>
  125. </summary>
  126. </member>
  127. <member name="P:UnityEngine.SubsystemDescriptor.subsystemImplementationType">
  128. <summary>
  129. <para>The System.Type of the subsystem implementation associated with this descriptor.</para>
  130. </summary>
  131. </member>
  132. <member name="T:UnityEngine.SubsystemManager">
  133. <summary>
  134. <para>Gives access to subsystems which provide additional functionality through plugins.</para>
  135. </summary>
  136. </member>
  137. <member name="?:UnityEngine.SubsystemManager.afterReloadSubsystems(System.Action)">
  138. <summary>
  139. <para>Called from SubsystemManager when it has completed reloading all XR SDK Provider packaged subsystems.</para>
  140. </summary>
  141. <param name="value"></param>
  142. </member>
  143. <member name="?:UnityEngine.SubsystemManager.beforeReloadSubsystems(System.Action)">
  144. <summary>
  145. <para>Called from SubsystemManager before reloading all XR SDK Provider packaged subsystems.</para>
  146. </summary>
  147. <param name="value"></param>
  148. </member>
  149. <member name="?:UnityEngine.SubsystemManager.reloadSubsytemsCompleted(System.Action)">
  150. <summary>
  151. <para>Called from SubsystemManager when it has completed reloading all XR SDK Provider packaged subsystems.</para>
  152. </summary>
  153. <param name="value"></param>
  154. </member>
  155. <member name="?:UnityEngine.SubsystemManager.reloadSubsytemsStarted(System.Action)">
  156. <summary>
  157. <para>Called from SubsystemManager before reloading all XR SDK Provider packaged subsystems.</para>
  158. </summary>
  159. <param name="value"></param>
  160. </member>
  161. <member name="M:UnityEngine.SubsystemManager.GetAllSubsystemDescriptors(System.Collections.Generic.List`1&lt;UnityEngine.ISubsystemDescriptor&gt;)">
  162. <summary>
  163. <para>Gets all of the currently known subsystem descriptors regardless of specific subsystem type.</para>
  164. </summary>
  165. <param name="descriptors">Subsystem descriptors.</param>
  166. </member>
  167. <member name="M:UnityEngine.SubsystemManager.GetInstances(System.Collections.Generic.List`1&lt;T&gt;)">
  168. <summary>
  169. <para>Returns active Subsystems of a specific instance type.
  170. *Note:* This method is deprecated, use GetSubsystems instead.</para>
  171. </summary>
  172. <param name="instances">Active instances.</param>
  173. <param name="subsystems"></param>
  174. </member>
  175. <member name="M:UnityEngine.SubsystemManager.GetSubsystemDescriptors(System.Collections.Generic.List`1&lt;T&gt;)">
  176. <summary>
  177. <para>Returns a list of SubsystemDescriptors which describe additional functionality that can be enabled.</para>
  178. </summary>
  179. <param name="descriptors">Subsystem specific descriptors.</param>
  180. </member>
  181. <member name="M:UnityEngine.SubsystemManager.GetSubsystems(System.Collections.Generic.List`1&lt;T&gt;)">
  182. <summary>
  183. <para>Returns active Subsystems of a specific instance type.</para>
  184. </summary>
  185. <param name="subsystems">Active subsystems.</param>
  186. </member>
  187. <member name="T:UnityEngine.SubsystemsImplementation.SubsystemDescriptorStore">
  188. <summary>
  189. <para>Registration entry point for subsystems to register their descriptor.</para>
  190. </summary>
  191. </member>
  192. <member name="T:UnityEngine.SubsystemsImplementation.SubsystemDescriptorWithProvider">
  193. <summary>
  194. <para>Information about a SubsystemWithProvider that can be queried before creating a subsystem instance.</para>
  195. </summary>
  196. </member>
  197. <member name="P:UnityEngine.SubsystemsImplementation.SubsystemDescriptorWithProvider.id">
  198. <summary>
  199. <para>A unique string that identifies the SubsystemWithProvider that this descriptor can create.</para>
  200. </summary>
  201. </member>
  202. <member name="T:UnityEngine.SubsystemsImplementation.SubsystemProvider">
  203. <summary>
  204. <para>A provider that supplies data to a subsystem, generally for platform-specific implementations.</para>
  205. </summary>
  206. </member>
  207. <member name="T:UnityEngine.SubsystemsImplementation.SubsystemWithProvider">
  208. <summary>
  209. <para>A subsystem is initialized from a SubsystemDescriptorWithProvider for a given subsystem (Session, Plane, Face, etc.) and provides an interface to interact with that given subsystem until it is Destroyed. After a subsystem is created, it can be Started or Stopped to turn on and off functionality and preserve performance. The base type for the subsystem only exposes this functionality; this class is designed to be a base class for derived classes that expose more functionality specific to a given subsystem.
  210. *Note:* Initializing a second subsystem from the same subsystem descriptor will return a reference to the existing subsystem, because only one subsystem is currently allowed for a single subsystem provider.</para>
  211. </summary>
  212. </member>
  213. <member name="P:UnityEngine.SubsystemsImplementation.SubsystemWithProvider.running">
  214. <summary>
  215. <para>Whether or not the subsystem is running.
  216. This returns true after Start has been called on the subsystem, and false after Stop is called.</para>
  217. </summary>
  218. </member>
  219. <member name="M:UnityEngine.SubsystemsImplementation.SubsystemWithProvider.Destroy">
  220. <summary>
  221. <para>Destroys this instance of a subsystem.
  222. Also unloads all resources acquired during the initialization step. Call this when you no longer need this instance of a subsystem.
  223. Note: Once a subsystem is Destroyed, script can still hold a reference but calling a method on it will result in a NullArgumentException.</para>
  224. </summary>
  225. </member>
  226. <member name="M:UnityEngine.SubsystemsImplementation.SubsystemWithProvider.Start">
  227. <summary>
  228. <para>Starts an instance of a subsystem.
  229. Once the instance is started, the subsystem representing this instance is active and can be interacted with.</para>
  230. </summary>
  231. </member>
  232. <member name="M:UnityEngine.SubsystemsImplementation.SubsystemWithProvider.Stop">
  233. <summary>
  234. <para>Stops an instance of a subsystem.
  235. Once the instance is stopped, the subsystem representing this instance is no longer active and should not consume CPU resources.</para>
  236. </summary>
  237. </member>
  238. <member name="A:UnityEngine.SubsystemsModule">
  239. <summary>
  240. <para>The Subsystem module contains the definitions and runtime support for general subsystems in Unity.</para>
  241. </summary>
  242. </member>
  243. </members>
  244. </doc>