UnityEngine.XRModule.xml 111 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.XRModule</name>
  6. </assembly>
  7. <member name="A:UnityEngine.XRModule">
  8. <summary>
  9. <para>The XR module contains the VR and AR related platform support functionality.</para>
  10. </summary>
  11. </member>
  12. <member name="T:UnityEngine.XR.Bone">
  13. <summary>
  14. <para>A tracked bone on the device at an XR.XRNode in the XR input subsystem.</para>
  15. </summary>
  16. </member>
  17. <member name="M:UnityEngine.XR.Bone.TryGetChildBones(System.Collections.Generic.List`1&lt;UnityEngine.XR.Bone&gt;)">
  18. <summary>
  19. <para>Get the child bones of this bone.</para>
  20. </summary>
  21. <param name="childBones">A list of bones that will be filled out with the children bones of this bone.</param>
  22. <returns>
  23. <para>true if bone can be queried for child bones; otherwise false.</para>
  24. </returns>
  25. </member>
  26. <member name="M:UnityEngine.XR.Bone.TryGetParentBone(UnityEngine.XR.Bone&amp;)">
  27. <summary>
  28. <para>Gets the parent of this bone.</para>
  29. </summary>
  30. <param name="parentBone">Bone struct that receives the parent bone of this bone.</param>
  31. <returns>
  32. <para>true if the rotation was retrieved, false otherwise.</para>
  33. </returns>
  34. </member>
  35. <member name="M:UnityEngine.XR.Bone.TryGetPosition(UnityEngine.Vector3&amp;)">
  36. <summary>
  37. <para>Gets the world position of the bone</para>
  38. </summary>
  39. <param name="position">Vector3 to receive the position of the bone in Unity world space.</param>
  40. <returns>
  41. <para>true if the rotation was retrieved, false otherwise.</para>
  42. </returns>
  43. </member>
  44. <member name="M:UnityEngine.XR.Bone.TryGetRotation(UnityEngine.Quaternion&amp;)">
  45. <summary>
  46. <para>Gets the world rotation of the bone.</para>
  47. </summary>
  48. <param name="rotation">Quaternion to receive the rotation of the bone in Unity world space.</param>
  49. <returns>
  50. <para>true if the rotation was retrieved, false otherwise.</para>
  51. </returns>
  52. </member>
  53. <member name="T:UnityEngine.XR.CommonUsages">
  54. <summary>
  55. <para>Defines static variables that are used to retrieve input features from XR.InputDevice.TryGetFeatureValue.</para>
  56. </summary>
  57. </member>
  58. <member name="F:UnityEngine.XR.CommonUsages.batteryLevel">
  59. <summary>
  60. <para>Value representing the current battery life of this device.</para>
  61. </summary>
  62. </member>
  63. <member name="F:UnityEngine.XR.CommonUsages.centerEyeAcceleration">
  64. <summary>
  65. <para>The acceleration of the center eye on this device.</para>
  66. </summary>
  67. </member>
  68. <member name="F:UnityEngine.XR.CommonUsages.centerEyeAngularAcceleration">
  69. <summary>
  70. <para>The angular acceleration of the center eye on this device, formatted as euler angles.</para>
  71. </summary>
  72. </member>
  73. <member name="F:UnityEngine.XR.CommonUsages.centerEyeAngularVelocity">
  74. <summary>
  75. <para>The angular velocity of the center eye on this device, formatted as euler angles.</para>
  76. </summary>
  77. </member>
  78. <member name="F:UnityEngine.XR.CommonUsages.centerEyePosition">
  79. <summary>
  80. <para>The position of the center eye on this device.</para>
  81. </summary>
  82. </member>
  83. <member name="F:UnityEngine.XR.CommonUsages.centerEyeRotation">
  84. <summary>
  85. <para>The rotation of the center eye on this device.</para>
  86. </summary>
  87. </member>
  88. <member name="F:UnityEngine.XR.CommonUsages.centerEyeVelocity">
  89. <summary>
  90. <para>The velocity of the center eye on this device.</para>
  91. </summary>
  92. </member>
  93. <member name="F:UnityEngine.XR.CommonUsages.colorCameraAcceleration">
  94. <summary>
  95. <para>The acceleration of the color camera on this device.</para>
  96. </summary>
  97. </member>
  98. <member name="F:UnityEngine.XR.CommonUsages.colorCameraAngularAcceleration">
  99. <summary>
  100. <para>The angular acceleration of the color camera on this device, formatted as euler angles.</para>
  101. </summary>
  102. </member>
  103. <member name="F:UnityEngine.XR.CommonUsages.colorCameraAngularVelocity">
  104. <summary>
  105. <para>The angular velocity of the color camera on this device, formatted as euler angles.</para>
  106. </summary>
  107. </member>
  108. <member name="F:UnityEngine.XR.CommonUsages.colorCameraPosition">
  109. <summary>
  110. <para>The position of the color camera on this device.</para>
  111. </summary>
  112. </member>
  113. <member name="F:UnityEngine.XR.CommonUsages.colorCameraRotation">
  114. <summary>
  115. <para>The rotation of the color camera on this device.</para>
  116. </summary>
  117. </member>
  118. <member name="F:UnityEngine.XR.CommonUsages.colorCameraVelocity">
  119. <summary>
  120. <para>The velocity of the color camera on this device.</para>
  121. </summary>
  122. </member>
  123. <member name="F:UnityEngine.XR.CommonUsages.deviceAcceleration">
  124. <summary>
  125. <para>The acceleration of the device.</para>
  126. </summary>
  127. </member>
  128. <member name="F:UnityEngine.XR.CommonUsages.deviceAngularAcceleration">
  129. <summary>
  130. <para>The angular acceleration of this device, formatted as euler angles.</para>
  131. </summary>
  132. </member>
  133. <member name="F:UnityEngine.XR.CommonUsages.deviceAngularVelocity">
  134. <summary>
  135. <para>The angular velocity of this device, formatted as euler angles.</para>
  136. </summary>
  137. </member>
  138. <member name="F:UnityEngine.XR.CommonUsages.devicePosition">
  139. <summary>
  140. <para>The position of the device.</para>
  141. </summary>
  142. </member>
  143. <member name="F:UnityEngine.XR.CommonUsages.deviceRotation">
  144. <summary>
  145. <para>The rotation of this device.</para>
  146. </summary>
  147. </member>
  148. <member name="F:UnityEngine.XR.CommonUsages.deviceVelocity">
  149. <summary>
  150. <para>The velocity of the device.</para>
  151. </summary>
  152. </member>
  153. <member name="F:UnityEngine.XR.CommonUsages.dPad">
  154. <summary>
  155. <para>A non-handed 2D axis.</para>
  156. </summary>
  157. </member>
  158. <member name="F:UnityEngine.XR.CommonUsages.eyesData">
  159. <summary>
  160. <para>An Eyes struct containing eye tracking data collected from the device.</para>
  161. </summary>
  162. </member>
  163. <member name="F:UnityEngine.XR.CommonUsages.grip">
  164. <summary>
  165. <para>Represents the users grip on the controller.</para>
  166. </summary>
  167. </member>
  168. <member name="F:UnityEngine.XR.CommonUsages.gripButton">
  169. <summary>
  170. <para>A binary measure of whether the device is being gripped.</para>
  171. </summary>
  172. </member>
  173. <member name="F:UnityEngine.XR.CommonUsages.handData">
  174. <summary>
  175. <para>Value representing the hand data for this device.</para>
  176. </summary>
  177. </member>
  178. <member name="F:UnityEngine.XR.CommonUsages.indexFinger">
  179. <summary>
  180. <para>Represents the grip pressure or angle of the index finger.</para>
  181. </summary>
  182. </member>
  183. <member name="F:UnityEngine.XR.CommonUsages.indexTouch">
  184. <summary>
  185. <para>Represents a touch of the trigger or index finger.</para>
  186. </summary>
  187. </member>
  188. <member name="F:UnityEngine.XR.CommonUsages.isTracked">
  189. <summary>
  190. <para>Informs to the developer whether the device is currently being tracked.</para>
  191. </summary>
  192. </member>
  193. <member name="F:UnityEngine.XR.CommonUsages.leftEyeAcceleration">
  194. <summary>
  195. <para>The acceleration of the left eye on this device.</para>
  196. </summary>
  197. </member>
  198. <member name="F:UnityEngine.XR.CommonUsages.leftEyeAngularAcceleration">
  199. <summary>
  200. <para>The angular acceleration of the left eye on this device, formatted as euler angles.</para>
  201. </summary>
  202. </member>
  203. <member name="F:UnityEngine.XR.CommonUsages.leftEyeAngularVelocity">
  204. <summary>
  205. <para>The angular velocity of the left eye on this device, formatted as euler angles.</para>
  206. </summary>
  207. </member>
  208. <member name="F:UnityEngine.XR.CommonUsages.leftEyePosition">
  209. <summary>
  210. <para>The position of the left eye on this device.</para>
  211. </summary>
  212. </member>
  213. <member name="F:UnityEngine.XR.CommonUsages.leftEyeRotation">
  214. <summary>
  215. <para>The rotation of the left eye on this device.</para>
  216. </summary>
  217. </member>
  218. <member name="F:UnityEngine.XR.CommonUsages.leftEyeVelocity">
  219. <summary>
  220. <para>The velocity of the left eye on this device.</para>
  221. </summary>
  222. </member>
  223. <member name="F:UnityEngine.XR.CommonUsages.menuButton">
  224. <summary>
  225. <para>Represents a menu button, used to pause, go back, or otherwise exit gameplay.</para>
  226. </summary>
  227. </member>
  228. <member name="F:UnityEngine.XR.CommonUsages.middleFinger">
  229. <summary>
  230. <para>Represents the grip pressure or angle of the middle finger.</para>
  231. </summary>
  232. </member>
  233. <member name="F:UnityEngine.XR.CommonUsages.pinkyFinger">
  234. <summary>
  235. <para>Represents the grip pressure or angle of the pinky finger.</para>
  236. </summary>
  237. </member>
  238. <member name="F:UnityEngine.XR.CommonUsages.primary2DAxis">
  239. <summary>
  240. <para>The primary touchpad or joystick on a device.</para>
  241. </summary>
  242. </member>
  243. <member name="F:UnityEngine.XR.CommonUsages.primary2DAxisClick">
  244. <summary>
  245. <para>Represents the primary 2D axis being clicked or otherwise depressed.</para>
  246. </summary>
  247. </member>
  248. <member name="F:UnityEngine.XR.CommonUsages.primary2DAxisTouch">
  249. <summary>
  250. <para>Represents the primary 2D axis being touched.</para>
  251. </summary>
  252. </member>
  253. <member name="F:UnityEngine.XR.CommonUsages.primaryButton">
  254. <summary>
  255. <para>The primary face button being pressed on a device, or sole button if only one is available.</para>
  256. </summary>
  257. </member>
  258. <member name="F:UnityEngine.XR.CommonUsages.primaryTouch">
  259. <summary>
  260. <para>The primary face button being touched on a device.</para>
  261. </summary>
  262. </member>
  263. <member name="F:UnityEngine.XR.CommonUsages.rightEyeAcceleration">
  264. <summary>
  265. <para>The acceleration of the right eye on this device.</para>
  266. </summary>
  267. </member>
  268. <member name="F:UnityEngine.XR.CommonUsages.rightEyeAngularAcceleration">
  269. <summary>
  270. <para>The angular acceleration of the right eye on this device, formatted as euler angles.</para>
  271. </summary>
  272. </member>
  273. <member name="F:UnityEngine.XR.CommonUsages.rightEyeAngularVelocity">
  274. <summary>
  275. <para>The angular velocity of the right eye on this device, formatted as euler angles.</para>
  276. </summary>
  277. </member>
  278. <member name="F:UnityEngine.XR.CommonUsages.rightEyePosition">
  279. <summary>
  280. <para>The position of the right eye on this device.</para>
  281. </summary>
  282. </member>
  283. <member name="F:UnityEngine.XR.CommonUsages.rightEyeRotation">
  284. <summary>
  285. <para>The rotation of the right eye on this device.</para>
  286. </summary>
  287. </member>
  288. <member name="F:UnityEngine.XR.CommonUsages.rightEyeVelocity">
  289. <summary>
  290. <para>The velocity of the right eye on this device.</para>
  291. </summary>
  292. </member>
  293. <member name="F:UnityEngine.XR.CommonUsages.ringFinger">
  294. <summary>
  295. <para>Represents the grip pressure or angle of the ring finger.</para>
  296. </summary>
  297. </member>
  298. <member name="F:UnityEngine.XR.CommonUsages.secondary2DAxis">
  299. <summary>
  300. <para>A secondary touchpad or joystick on a device.</para>
  301. </summary>
  302. </member>
  303. <member name="F:UnityEngine.XR.CommonUsages.secondary2DAxisClick">
  304. <summary>
  305. <para>Represents the secondary 2D axis being clicked or otherwise depressed.</para>
  306. </summary>
  307. </member>
  308. <member name="F:UnityEngine.XR.CommonUsages.secondary2DAxisTouch">
  309. <summary>
  310. <para>Represents the secondary 2D axis being touched.</para>
  311. </summary>
  312. </member>
  313. <member name="F:UnityEngine.XR.CommonUsages.secondaryButton">
  314. <summary>
  315. <para>The secondary face button being pressed on a device.</para>
  316. </summary>
  317. </member>
  318. <member name="F:UnityEngine.XR.CommonUsages.secondaryTouch">
  319. <summary>
  320. <para>The secondary face button being touched on a device.</para>
  321. </summary>
  322. </member>
  323. <member name="F:UnityEngine.XR.CommonUsages.thumbrest">
  324. <summary>
  325. <para>Represents a thumbrest or light thumb touch.</para>
  326. </summary>
  327. </member>
  328. <member name="F:UnityEngine.XR.CommonUsages.thumbTouch">
  329. <summary>
  330. <para>Represents the thumb pressing any input or feature.</para>
  331. </summary>
  332. </member>
  333. <member name="F:UnityEngine.XR.CommonUsages.trackingState">
  334. <summary>
  335. <para>Represents the values being tracked for this device.</para>
  336. </summary>
  337. </member>
  338. <member name="F:UnityEngine.XR.CommonUsages.trigger">
  339. <summary>
  340. <para>A trigger-like control, pressed with the index finger.</para>
  341. </summary>
  342. </member>
  343. <member name="F:UnityEngine.XR.CommonUsages.triggerButton">
  344. <summary>
  345. <para>A binary measure of whether the index finger is activating the trigger.</para>
  346. </summary>
  347. </member>
  348. <member name="F:UnityEngine.XR.CommonUsages.userPresence">
  349. <summary>
  350. <para>Use this property to test whether the user is currently wearing and/or interacting with the XR device. The exact behavior of this property varies with each type of device: some devices have a sensor specifically to detect user proximity, however you can reasonably infer that a user is present with the device when the property is UserPresenceState.Present.</para>
  351. </summary>
  352. </member>
  353. <member name="T:UnityEngine.XR.Eyes">
  354. <summary>
  355. <para>Contains eye tracking data from the device at an XR.XRNode in the XR input subsystem.</para>
  356. </summary>
  357. </member>
  358. <member name="M:UnityEngine.XR.Eyes.TryGetFixationPoint(UnityEngine.Vector3&amp;)">
  359. <summary>
  360. <para>Gets the point represents the convergence of the line of sight for both eyes.</para>
  361. </summary>
  362. <param name="fixationPoint">A Vector3 struct that is filled in with the fixation position.</param>
  363. <returns>
  364. <para>true if eyes can be queried for the fixation point; otherwise false.</para>
  365. </returns>
  366. </member>
  367. <member name="M:UnityEngine.XR.Eyes.TryGetLeftEyeOpenAmount(System.Single&amp;)">
  368. <summary>
  369. <para>Gets a value that represents the how far the left eye is open.</para>
  370. </summary>
  371. <param name="OpenAmount">A float value, with a range of 0.0 to 1.0, that indicates how open the left eye is. A value of 0.0 indicates that the eye is fully closed, while a value of 1.0 indicates that the eye is fully open.</param>
  372. <param name="openAmount"></param>
  373. <returns>
  374. <para>true if eyes can be queried for the amount that the left eye is open; otherwise false.</para>
  375. </returns>
  376. </member>
  377. <member name="M:UnityEngine.XR.Eyes.TryGetLeftEyePosition(UnityEngine.Vector3&amp;)">
  378. <summary>
  379. <para>Gets the Vector3 that describes the position of the left eye.</para>
  380. </summary>
  381. <param name="positionOut">A Vector3 struct to receive the left eye position.</param>
  382. <param name="position"></param>
  383. <returns>
  384. <para>true if eyes can be queried for the left eye position; otherwise false.</para>
  385. </returns>
  386. </member>
  387. <member name="M:UnityEngine.XR.Eyes.TryGetLeftEyeRotation(UnityEngine.Quaternion&amp;)">
  388. <summary>
  389. <para>Gets the Quaternion that describes the rotation of the left eye.</para>
  390. </summary>
  391. <param name="rotationOut">A Quaternion struct to receive the left eye rotation.</param>
  392. <param name="rotation"></param>
  393. <returns>
  394. <para>true if eyes can be queried for the left eye rotation; otherwise false.</para>
  395. </returns>
  396. </member>
  397. <member name="M:UnityEngine.XR.Eyes.TryGetRightEyeOpenAmount(System.Single&amp;)">
  398. <summary>
  399. <para>Gets a value that represents the how far the right eye is open.</para>
  400. </summary>
  401. <param name="OpenAmount">A float value, with a range of 0.0 to 1.0, that indicates how open the right eye is. A value of 0.0 indicates that the eye is fully closed, while a value of 1.0 indicates that the eye is fully open.</param>
  402. <param name="openAmount"></param>
  403. <returns>
  404. <para>true if eyes can be queried for the amount that the right eye is open; otherwise false.</para>
  405. </returns>
  406. </member>
  407. <member name="M:UnityEngine.XR.Eyes.TryGetRightEyePosition(UnityEngine.Vector3&amp;)">
  408. <summary>
  409. <para>Gets the Vector3 that describes the position of the right eye.</para>
  410. </summary>
  411. <param name="positionOut">A Vector3 struct to receive the right eye position.</param>
  412. <param name="position"></param>
  413. <returns>
  414. <para>true if eyes can be queried for the right eye position; otherwise false.</para>
  415. </returns>
  416. </member>
  417. <member name="M:UnityEngine.XR.Eyes.TryGetRightEyeRotation(UnityEngine.Quaternion&amp;)">
  418. <summary>
  419. <para>Gets the Quaternion that describes the rotation of the right eye.</para>
  420. </summary>
  421. <param name="rotationOut">A Quaternion struct to receive the right eye rotation.</param>
  422. <param name="rotation"></param>
  423. <returns>
  424. <para>true if eyes can be queried for the right eye rotation; otherwise false.</para>
  425. </returns>
  426. </member>
  427. <member name="T:UnityEngine.XR.Hand">
  428. <summary>
  429. <para>A tracked hand on the device at an XR.XRNode in the XR input subsystem.</para>
  430. </summary>
  431. </member>
  432. <member name="M:UnityEngine.XR.Hand.TryGetFingerBones(UnityEngine.XR.HandFinger,System.Collections.Generic.List`1&lt;UnityEngine.XR.Bone&gt;)">
  433. <summary>
  434. <para>Gets a list of the finger bones for a finger on this hand.</para>
  435. </summary>
  436. <param name="finger">HandFinger enum value for this finger.</param>
  437. <param name="bonesOut">A list of bones that will be filled out for this finger.</param>
  438. <returns>
  439. <para>true if hand can be queried for this finger; otherwise false.</para>
  440. </returns>
  441. </member>
  442. <member name="M:UnityEngine.XR.Hand.TryGetRootBone(UnityEngine.XR.Bone&amp;)">
  443. <summary>
  444. <para>Gets the root bone for this hand.</para>
  445. </summary>
  446. <param name="boneOut">A Bone struct to receive the root bone.</param>
  447. <returns>
  448. <para>true if hand can be queried for the root bone; otherwise false.</para>
  449. </returns>
  450. </member>
  451. <member name="T:UnityEngine.XR.HandFinger">
  452. <summary>
  453. <para>Enumeration describing the AR rendering mode used with XR.Hand.</para>
  454. </summary>
  455. </member>
  456. <member name="F:UnityEngine.XR.HandFinger.Index">
  457. <summary>
  458. <para>Index finger on a hand.</para>
  459. </summary>
  460. </member>
  461. <member name="F:UnityEngine.XR.HandFinger.Middle">
  462. <summary>
  463. <para>Middle finger on a hand.</para>
  464. </summary>
  465. </member>
  466. <member name="F:UnityEngine.XR.HandFinger.Pinky">
  467. <summary>
  468. <para>Pinky finger on a hand.</para>
  469. </summary>
  470. </member>
  471. <member name="F:UnityEngine.XR.HandFinger.Ring">
  472. <summary>
  473. <para>Ring finger on a hand.</para>
  474. </summary>
  475. </member>
  476. <member name="F:UnityEngine.XR.HandFinger.Thumb">
  477. <summary>
  478. <para>Thumb finger on a hand.</para>
  479. </summary>
  480. </member>
  481. <member name="T:UnityEngine.XR.HapticCapabilities">
  482. <summary>
  483. <para>Describes the haptic capabilities of the device at an XR.XRNode in the XR input subsystem.</para>
  484. </summary>
  485. </member>
  486. <member name="P:UnityEngine.XR.HapticCapabilities.bufferFrequencyHz">
  487. <summary>
  488. <para>The frequency (in Hz) that this device plays back buffered haptic data.</para>
  489. </summary>
  490. </member>
  491. <member name="P:UnityEngine.XR.HapticCapabilities.bufferMaxSize">
  492. <summary>
  493. <para>The maximum amount of data that can be sent to an InputDevice via InputDevice.SendHapticBuffer.</para>
  494. </summary>
  495. </member>
  496. <member name="P:UnityEngine.XR.HapticCapabilities.bufferOptimalSize">
  497. <summary>
  498. <para>The optimal buffer size an InputDevice expects to be sent via InputDevice.SendHapticBuffer in order to provide a continuous rumble between individual frames.</para>
  499. </summary>
  500. </member>
  501. <member name="P:UnityEngine.XR.HapticCapabilities.numChannels">
  502. <summary>
  503. <para>The number of channels that this device plays back haptic data.</para>
  504. </summary>
  505. </member>
  506. <member name="P:UnityEngine.XR.HapticCapabilities.supportsBuffer">
  507. <summary>
  508. <para>True if this device supports sending a haptic buffer.</para>
  509. </summary>
  510. </member>
  511. <member name="P:UnityEngine.XR.HapticCapabilities.supportsImpulse">
  512. <summary>
  513. <para>True if this device supports sending a haptic impulse.</para>
  514. </summary>
  515. </member>
  516. <member name="T:UnityEngine.XR.InputDevice">
  517. <summary>
  518. <para>Defines an input device in the XR input subsystem.</para>
  519. </summary>
  520. </member>
  521. <member name="P:UnityEngine.XR.InputDevice.characteristics">
  522. <summary>
  523. <para>Read Only. A bitmask of enumerated flags describing the characteristics of this InputDevice.</para>
  524. </summary>
  525. </member>
  526. <member name="P:UnityEngine.XR.InputDevice.isValid">
  527. <summary>
  528. <para>Read Only. True if the device is currently a valid input device; otherwise false.</para>
  529. </summary>
  530. </member>
  531. <member name="P:UnityEngine.XR.InputDevice.manufacturer">
  532. <summary>
  533. <para>The manufacturer of the connected Input Device.</para>
  534. </summary>
  535. </member>
  536. <member name="P:UnityEngine.XR.InputDevice.name">
  537. <summary>
  538. <para>Read Only. The name of the device in the XR system. This is a platform provided unique identifier for the device.</para>
  539. </summary>
  540. </member>
  541. <member name="P:UnityEngine.XR.InputDevice.role">
  542. <summary>
  543. <para>Read Only. The InputDeviceRole of the device in the XR system. This is a platform provided description of how the device is used.</para>
  544. </summary>
  545. </member>
  546. <member name="P:UnityEngine.XR.InputDevice.serialNumber">
  547. <summary>
  548. <para>The serial number of the connected Input Device. Blank if no serial number is available.</para>
  549. </summary>
  550. </member>
  551. <member name="P:UnityEngine.XR.InputDevice.subsystem">
  552. <summary>
  553. <para>Gets the XRInputSubsystem that reported this InputDevice.</para>
  554. </summary>
  555. </member>
  556. <member name="M:UnityEngine.XR.InputDevice.SendHapticBuffer(System.UInt32,System.Byte[])">
  557. <summary>
  558. <para>Sends a raw buffer of haptic data to the device.</para>
  559. </summary>
  560. <param name="channel">The channel to receive the data.</param>
  561. <param name="buffer">A raw byte buffer that contains the haptic data to send to the device.</param>
  562. <returns>
  563. <para>Returns true if successful. Returns false otherwise.</para>
  564. </returns>
  565. </member>
  566. <member name="M:UnityEngine.XR.InputDevice.SendHapticImpulse(System.UInt32,System.Single,System.Single)">
  567. <summary>
  568. <para>Sends a haptic impulse to a device.</para>
  569. </summary>
  570. <param name="channel">The channel to receive the impulse.</param>
  571. <param name="amplitude">The normalized (0.0 to 1.0) amplitude value of the haptic impulse to play on the device.</param>
  572. <param name="duration">The duration in seconds that the haptic impulse will play. Only supported on Oculus.</param>
  573. <returns>
  574. <para>Returns true if successful. Returns false otherwise.</para>
  575. </returns>
  576. </member>
  577. <member name="M:UnityEngine.XR.InputDevice.StopHaptics">
  578. <summary>
  579. <para>Stop all haptic playback for a device.</para>
  580. </summary>
  581. </member>
  582. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureUsages(System.Collections.Generic.List`1&lt;UnityEngine.XR.InputFeatureUsage&gt;)">
  583. <summary>
  584. <para>Gets a list of all the input feature usages available on this device. For example, "Trigger" or "Device Position".</para>
  585. </summary>
  586. <param name="featureUsages">A List of InputFeatureUsage structures to receive the available features on this device.</param>
  587. <returns>
  588. <para>true if device can be queried; otherwise false.</para>
  589. </returns>
  590. </member>
  591. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;System.Boolean&gt;,System.Boolean&amp;)">
  592. <summary>
  593. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  594. </summary>
  595. <param name="usage">Usage that describes the feature to retrieve.</param>
  596. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  597. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  598. <returns>
  599. <para>True if the feature information is retrieved; otherwise false.</para>
  600. </returns>
  601. </member>
  602. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;System.UInt32&gt;,System.UInt32&amp;)">
  603. <summary>
  604. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  605. </summary>
  606. <param name="usage">Usage that describes the feature to retrieve.</param>
  607. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  608. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  609. <returns>
  610. <para>True if the feature information is retrieved; otherwise false.</para>
  611. </returns>
  612. </member>
  613. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;System.Single&gt;,System.Single&amp;)">
  614. <summary>
  615. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  616. </summary>
  617. <param name="usage">Usage that describes the feature to retrieve.</param>
  618. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  619. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  620. <returns>
  621. <para>True if the feature information is retrieved; otherwise false.</para>
  622. </returns>
  623. </member>
  624. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;UnityEngine.Vector2&gt;,UnityEngine.Vector2&amp;)">
  625. <summary>
  626. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  627. </summary>
  628. <param name="usage">Usage that describes the feature to retrieve.</param>
  629. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  630. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  631. <returns>
  632. <para>True if the feature information is retrieved; otherwise false.</para>
  633. </returns>
  634. </member>
  635. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;UnityEngine.Vector3&gt;,UnityEngine.Vector3&amp;)">
  636. <summary>
  637. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  638. </summary>
  639. <param name="usage">Usage that describes the feature to retrieve.</param>
  640. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  641. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  642. <returns>
  643. <para>True if the feature information is retrieved; otherwise false.</para>
  644. </returns>
  645. </member>
  646. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;UnityEngine.Quaternion&gt;,UnityEngine.Quaternion&amp;)">
  647. <summary>
  648. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  649. </summary>
  650. <param name="usage">Usage that describes the feature to retrieve.</param>
  651. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  652. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  653. <returns>
  654. <para>True if the feature information is retrieved; otherwise false.</para>
  655. </returns>
  656. </member>
  657. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;UnityEngine.XR.Bone&gt;,UnityEngine.XR.Bone&amp;)">
  658. <summary>
  659. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  660. </summary>
  661. <param name="usage">Usage that describes the feature to retrieve.</param>
  662. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  663. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  664. <returns>
  665. <para>True if the feature information is retrieved; otherwise false.</para>
  666. </returns>
  667. </member>
  668. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;UnityEngine.XR.Hand&gt;,UnityEngine.XR.Hand&amp;)">
  669. <summary>
  670. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  671. </summary>
  672. <param name="usage">Usage that describes the feature to retrieve.</param>
  673. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  674. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  675. <returns>
  676. <para>True if the feature information is retrieved; otherwise false.</para>
  677. </returns>
  678. </member>
  679. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;UnityEngine.XR.Eyes&gt;,UnityEngine.XR.Eyes&amp;)">
  680. <summary>
  681. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  682. </summary>
  683. <param name="usage">Usage that describes the feature to retrieve.</param>
  684. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  685. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  686. <returns>
  687. <para>True if the feature information is retrieved; otherwise false.</para>
  688. </returns>
  689. </member>
  690. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;UnityEngine.XR.InputTrackingState&gt;,UnityEngine.XR.InputTrackingState&amp;)">
  691. <summary>
  692. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  693. </summary>
  694. <param name="usage">Usage that describes the feature to retrieve.</param>
  695. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  696. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  697. <returns>
  698. <para>True if the feature information is retrieved; otherwise false.</para>
  699. </returns>
  700. </member>
  701. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;System.Boolean&gt;,System.DateTime,System.Boolean&amp;)">
  702. <summary>
  703. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  704. </summary>
  705. <param name="usage">Usage that describes the feature to retrieve.</param>
  706. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  707. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  708. <returns>
  709. <para>True if the feature information is retrieved; otherwise false.</para>
  710. </returns>
  711. </member>
  712. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;System.UInt32&gt;,System.DateTime,System.UInt32&amp;)">
  713. <summary>
  714. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  715. </summary>
  716. <param name="usage">Usage that describes the feature to retrieve.</param>
  717. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  718. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  719. <returns>
  720. <para>True if the feature information is retrieved; otherwise false.</para>
  721. </returns>
  722. </member>
  723. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;System.Single&gt;,System.DateTime,System.Single&amp;)">
  724. <summary>
  725. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  726. </summary>
  727. <param name="usage">Usage that describes the feature to retrieve.</param>
  728. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  729. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  730. <returns>
  731. <para>True if the feature information is retrieved; otherwise false.</para>
  732. </returns>
  733. </member>
  734. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;UnityEngine.Vector2&gt;,System.DateTime,UnityEngine.Vector2&amp;)">
  735. <summary>
  736. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  737. </summary>
  738. <param name="usage">Usage that describes the feature to retrieve.</param>
  739. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  740. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  741. <returns>
  742. <para>True if the feature information is retrieved; otherwise false.</para>
  743. </returns>
  744. </member>
  745. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;UnityEngine.Vector3&gt;,System.DateTime,UnityEngine.Vector3&amp;)">
  746. <summary>
  747. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  748. </summary>
  749. <param name="usage">Usage that describes the feature to retrieve.</param>
  750. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  751. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  752. <returns>
  753. <para>True if the feature information is retrieved; otherwise false.</para>
  754. </returns>
  755. </member>
  756. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;UnityEngine.Quaternion&gt;,System.DateTime,UnityEngine.Quaternion&amp;)">
  757. <summary>
  758. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  759. </summary>
  760. <param name="usage">Usage that describes the feature to retrieve.</param>
  761. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  762. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  763. <returns>
  764. <para>True if the feature information is retrieved; otherwise false.</para>
  765. </returns>
  766. </member>
  767. <member name="M:UnityEngine.XR.InputDevice.TryGetFeatureValue(UnityEngine.XR.InputFeatureUsage`1&lt;UnityEngine.XR.InputTrackingState&gt;,System.DateTime,UnityEngine.XR.InputTrackingState&amp;)">
  768. <summary>
  769. <para>Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time</para>
  770. </summary>
  771. <param name="usage">Usage that describes the feature to retrieve.</param>
  772. <param name="time">A DateTime struct with the local time at which to query for data.</param>
  773. <param name="value">A variable of the appropriate type to receive the information about the feature.</param>
  774. <returns>
  775. <para>True if the feature information is retrieved; otherwise false.</para>
  776. </returns>
  777. </member>
  778. <member name="M:UnityEngine.XR.InputDevice.TryGetHapticCapabilities(UnityEngine.XR.HapticCapabilities&amp;)">
  779. <summary>
  780. <para>Gets the haptic capabilities of the device.</para>
  781. </summary>
  782. <param name="capabilities">A HapticCapabilities struct to receive the capabilities of this device.</param>
  783. <returns>
  784. <para>Returns true if the device supports any form of haptics. Returns false otherwise.</para>
  785. </returns>
  786. </member>
  787. <member name="T:UnityEngine.XR.InputDeviceCharacteristics">
  788. <summary>
  789. <para>A set of bit flags describing XR.InputDevice characteristics.</para>
  790. </summary>
  791. </member>
  792. <member name="F:UnityEngine.XR.InputDeviceCharacteristics.Camera">
  793. <summary>
  794. <para>The InputDevice has a camera and associated camera tracking information.</para>
  795. </summary>
  796. </member>
  797. <member name="F:UnityEngine.XR.InputDeviceCharacteristics.Controller">
  798. <summary>
  799. <para>The InputDevice is a game controller.</para>
  800. </summary>
  801. </member>
  802. <member name="F:UnityEngine.XR.InputDeviceCharacteristics.EyeTracking">
  803. <summary>
  804. <para>The InputDevice provides eye tracking information via an Eyes input feature.</para>
  805. </summary>
  806. </member>
  807. <member name="F:UnityEngine.XR.InputDeviceCharacteristics.HandTracking">
  808. <summary>
  809. <para>The InputDevice provides hand tracking information via a Hand input feature.</para>
  810. </summary>
  811. </member>
  812. <member name="F:UnityEngine.XR.InputDeviceCharacteristics.HeadMounted">
  813. <summary>
  814. <para>The InputDevice is attached to the head.</para>
  815. </summary>
  816. </member>
  817. <member name="F:UnityEngine.XR.InputDeviceCharacteristics.HeldInHand">
  818. <summary>
  819. <para>The InputDevice is held in the user's hand. Typically, a tracked controller.</para>
  820. </summary>
  821. </member>
  822. <member name="F:UnityEngine.XR.InputDeviceCharacteristics.Left">
  823. <summary>
  824. <para>The InputDevice is associated with the left side of the user.</para>
  825. </summary>
  826. </member>
  827. <member name="F:UnityEngine.XR.InputDeviceCharacteristics.None">
  828. <summary>
  829. <para>A default value specifying no flags.</para>
  830. </summary>
  831. </member>
  832. <member name="F:UnityEngine.XR.InputDeviceCharacteristics.Right">
  833. <summary>
  834. <para>The InputDevice is associated with the right side of the user.</para>
  835. </summary>
  836. </member>
  837. <member name="F:UnityEngine.XR.InputDeviceCharacteristics.Simulated6DOF">
  838. <summary>
  839. <para>The InputDevice reports software approximated, positional data.</para>
  840. </summary>
  841. </member>
  842. <member name="F:UnityEngine.XR.InputDeviceCharacteristics.TrackedDevice">
  843. <summary>
  844. <para>The InputDevice provides 3DOF or 6DOF tracking data.</para>
  845. </summary>
  846. </member>
  847. <member name="F:UnityEngine.XR.InputDeviceCharacteristics.TrackingReference">
  848. <summary>
  849. <para>The InputDevice is an unmoving reference object used to locate and track other objects in the world.</para>
  850. </summary>
  851. </member>
  852. <member name="T:UnityEngine.XR.InputDeviceRole">
  853. <summary>
  854. <para>Enumeration describing the role of a XR.InputDevice in providing input.</para>
  855. </summary>
  856. </member>
  857. <member name="F:UnityEngine.XR.InputDeviceRole.GameController">
  858. <summary>
  859. <para>This device is a game controller.</para>
  860. </summary>
  861. </member>
  862. <member name="F:UnityEngine.XR.InputDeviceRole.Generic">
  863. <summary>
  864. <para>This device is typically a HMD or Camera.</para>
  865. </summary>
  866. </member>
  867. <member name="F:UnityEngine.XR.InputDeviceRole.HardwareTracker">
  868. <summary>
  869. <para>This device is a hardware tracker.</para>
  870. </summary>
  871. </member>
  872. <member name="F:UnityEngine.XR.InputDeviceRole.LeftHanded">
  873. <summary>
  874. <para>This device is a controller that represents the left hand.</para>
  875. </summary>
  876. </member>
  877. <member name="F:UnityEngine.XR.InputDeviceRole.LegacyController">
  878. <summary>
  879. <para>This device is a legacy controller.</para>
  880. </summary>
  881. </member>
  882. <member name="F:UnityEngine.XR.InputDeviceRole.RightHanded">
  883. <summary>
  884. <para>This device is a controller that represents the right hand.</para>
  885. </summary>
  886. </member>
  887. <member name="F:UnityEngine.XR.InputDeviceRole.TrackingReference">
  888. <summary>
  889. <para>This device is a tracking reference used to track other devices in 3D.</para>
  890. </summary>
  891. </member>
  892. <member name="F:UnityEngine.XR.InputDeviceRole.Unknown">
  893. <summary>
  894. <para>This device does not have a known role.</para>
  895. </summary>
  896. </member>
  897. <member name="T:UnityEngine.XR.InputDevices">
  898. <summary>
  899. <para>An interface for accessing devices in the XR input subsytem.</para>
  900. </summary>
  901. </member>
  902. <member name="?:UnityEngine.XR.InputDevices.deviceConfigChanged(System.Action`1&lt;UnityEngine.XR.InputDevice&gt;)">
  903. <summary>
  904. <para>Defines the delegate to use to register events when an InputDevice's configuration changes.</para>
  905. </summary>
  906. <param name="value">The InputDevice whose configuration has changed.</param>
  907. </member>
  908. <member name="?:UnityEngine.XR.InputDevices.deviceConnected(System.Action`1&lt;UnityEngine.XR.InputDevice&gt;)">
  909. <summary>
  910. <para>Defines the delegate to use to register events when an InputDevice is connected.</para>
  911. </summary>
  912. <param name="value">The InputDevice that just connected.</param>
  913. </member>
  914. <member name="?:UnityEngine.XR.InputDevices.deviceDisconnected(System.Action`1&lt;UnityEngine.XR.InputDevice&gt;)">
  915. <summary>
  916. <para>Defines the delegate to use to register events when an InputDevice is disconnected.</para>
  917. </summary>
  918. <param name="value">The InputDevice that just disconnected.</param>
  919. </member>
  920. <member name="M:UnityEngine.XR.InputDevices.GetDeviceAtXRNode(UnityEngine.XR.XRNode)">
  921. <summary>
  922. <para>Gets the input device at a given XR.XRNode endpoint.</para>
  923. </summary>
  924. <param name="node">The XRNode that owns the requested device.</param>
  925. <returns>
  926. <para>An XR.InputDevice at this [[XR.XRNode].</para>
  927. </returns>
  928. </member>
  929. <member name="M:UnityEngine.XR.InputDevices.GetDevices(System.Collections.Generic.List`1&lt;UnityEngine.XR.InputDevice&gt;)">
  930. <summary>
  931. <para>Gets a list of active input devices available to the XR Input Subsystem.</para>
  932. </summary>
  933. <param name="inputDevices">A List of type InputDevices to receive the available input devices.</param>
  934. </member>
  935. <member name="M:UnityEngine.XR.InputDevices.GetDevicesAtXRNode(UnityEngine.XR.XRNode,System.Collections.Generic.List`1&lt;UnityEngine.XR.InputDevice&gt;)">
  936. <summary>
  937. <para>Gets a list of active input devices available to the XR Input Subsystem at a given XR.XRNode endpoint.</para>
  938. </summary>
  939. <param name="node">The XRNode that owns the requested device.</param>
  940. <param name="inputDevices">A List of type InputDevices to receive the available input devices.</param>
  941. </member>
  942. <member name="M:UnityEngine.XR.InputDevices.GetDevicesWithCharacteristics(UnityEngine.XR.InputDeviceCharacteristics,System.Collections.Generic.List`1&lt;UnityEngine.XR.InputDevice&gt;)">
  943. <summary>
  944. <para>Gets the list of active XR input devices that match the specified InputDeviceCharacteristics.</para>
  945. </summary>
  946. <param name="desiredCharacteristics">A bitwise combination of the characteristics you are looking for.</param>
  947. <param name="inputDevices">A List&lt;InputDevice&gt; object to receive the available input devices.</param>
  948. </member>
  949. <member name="M:UnityEngine.XR.InputDevices.GetDevicesWithRole(UnityEngine.XR.InputDeviceRole,System.Collections.Generic.List`1&lt;UnityEngine.XR.InputDevice&gt;)">
  950. <summary>
  951. <para>Gets a list of active input devices available to the XR Input Subsystem that match the specified role.</para>
  952. </summary>
  953. <param name="role">XR.InputDeviceRole that is defined for the devices returned.</param>
  954. <param name="inputDevices">A List of type InputDevices to receive the available input devices.</param>
  955. </member>
  956. <member name="T:UnityEngine.XR.InputFeatureUsage">
  957. <summary>
  958. <para>Defines a generic usage that maps to an input feature on a device. Use the As method to turn into a generic usage.</para>
  959. </summary>
  960. </member>
  961. <member name="P:UnityEngine.XR.InputFeatureUsage.name">
  962. <summary>
  963. <para>The string name of this usage feature; used internally to map to an input feature on a device.</para>
  964. </summary>
  965. </member>
  966. <member name="P:UnityEngine.XR.InputFeatureUsage.type">
  967. <summary>
  968. <para>The type of this usage feature; used internally to map to an input feature on a device.</para>
  969. </summary>
  970. </member>
  971. <member name="M:UnityEngine.XR.InputFeatureUsage.As">
  972. <summary>
  973. <para>Returns the generic version of this type for retrieving a feature value from a device.</para>
  974. </summary>
  975. </member>
  976. <member name="T:UnityEngine.XR.InputFeatureUsage`1">
  977. <summary>
  978. <para>Defines a generic usage that maps to an input feature on a device.</para>
  979. </summary>
  980. </member>
  981. <member name="P:UnityEngine.XR.InputFeatureUsage_1.name">
  982. <summary>
  983. <para>The string name of this usage feature; used internally to map to an input feature on a device.</para>
  984. </summary>
  985. </member>
  986. <member name="M:UnityEngine.XR.InputFeatureUsage_1.#ctor(System.String)">
  987. <summary>
  988. <para>Construct a usage from a usage name.</para>
  989. </summary>
  990. <param name="usageName">The name of the feature usage to query for.</param>
  991. </member>
  992. <member name="?:UnityEngine.XR.InputFeatureUsage_1.op_Explicit(UnityEngine.XR.InputFeatureUsage`1&lt;T&gt;)">
  993. <summary>
  994. <para>Converts a generic InputFeatureUsage&lt;T&gt; into an InputFeatureUsage.</para>
  995. </summary>
  996. <param name="self"></param>
  997. </member>
  998. <member name="T:UnityEngine.XR.InputTracking">
  999. <summary>
  1000. <para>A collection of methods and properties for accessing XR input devices by their XR Node representation.</para>
  1001. </summary>
  1002. </member>
  1003. <member name="P:UnityEngine.XR.InputTracking.disablePositionalTracking">
  1004. <summary>
  1005. <para>Disables positional tracking in XR. This takes effect the next time the head pose is sampled. If set to true the camera only tracks headset rotation state.</para>
  1006. </summary>
  1007. </member>
  1008. <member name="?:UnityEngine.XR.InputTracking.nodeAdded(System.Action`1&lt;UnityEngine.XR.XRNodeState&gt;)">
  1009. <summary>
  1010. <para>Called when a tracked node is added to the underlying XR system.</para>
  1011. </summary>
  1012. <param name="nodeState">Describes the node that has been added.</param>
  1013. <param name="value"></param>
  1014. </member>
  1015. <member name="?:UnityEngine.XR.InputTracking.nodeRemoved(System.Action`1&lt;UnityEngine.XR.XRNodeState&gt;)">
  1016. <summary>
  1017. <para>Called when a tracked node is removed from the underlying XR system.</para>
  1018. </summary>
  1019. <param name="nodeState">Describes the node that has been removed.</param>
  1020. <param name="value"></param>
  1021. </member>
  1022. <member name="?:UnityEngine.XR.InputTracking.trackingAcquired(System.Action`1&lt;UnityEngine.XR.XRNodeState&gt;)">
  1023. <summary>
  1024. <para>Called when a tracked node begins reporting tracking information.</para>
  1025. </summary>
  1026. <param name="nodeState">Describes the node that has begun being tracked.</param>
  1027. <param name="value"></param>
  1028. </member>
  1029. <member name="?:UnityEngine.XR.InputTracking.trackingLost(System.Action`1&lt;UnityEngine.XR.XRNodeState&gt;)">
  1030. <summary>
  1031. <para>Called when a tracked node stops reporting tracking information.</para>
  1032. </summary>
  1033. <param name="nodeState">Describes the node that has lost tracking.</param>
  1034. <param name="value"></param>
  1035. </member>
  1036. <member name="M:UnityEngine.XR.InputTracking.GetLocalPosition(UnityEngine.XR.XRNode)">
  1037. <summary>
  1038. <para>Note: This API has been marked as obsolete in code, and is no longer in use. Please use InputTracking.GetNodeStates and look for the XRNodeState with the corresponding XRNode type instead.
  1039. Gets the position of a specific node.</para>
  1040. </summary>
  1041. <param name="node">Specifies which node's position should be returned.</param>
  1042. <returns>
  1043. <para>The position of the node in its local tracking space.</para>
  1044. </returns>
  1045. </member>
  1046. <member name="M:UnityEngine.XR.InputTracking.GetLocalRotation(UnityEngine.XR.XRNode)">
  1047. <summary>
  1048. <para>Note: This API has been marked as obsolete in code, and is no longer in use. Please use InputTracking.GetNodeStates and look for the XRNodeState with the corresponding XRNode type instead.
  1049. Gets the rotation of a specific node.</para>
  1050. </summary>
  1051. <param name="node">Specifies which node's rotation should be returned.</param>
  1052. <returns>
  1053. <para>The rotation of the node in its local tracking space.</para>
  1054. </returns>
  1055. </member>
  1056. <member name="M:UnityEngine.XR.InputTracking.GetNodeName(System.UInt64)">
  1057. <summary>
  1058. <para>Accepts the unique identifier for a tracked node and returns a friendly name for it.</para>
  1059. </summary>
  1060. <param name="uniqueID">The unique identifier for the Node index.</param>
  1061. <param name="uniqueId"></param>
  1062. <returns>
  1063. <para>The name of the tracked node if the given 64-bit identifier maps to a currently tracked node. Empty string otherwise.</para>
  1064. </returns>
  1065. </member>
  1066. <member name="M:UnityEngine.XR.InputTracking.GetNodeStates(System.Collections.Generic.List`1&lt;UnityEngine.XR.XRNodeState&gt;)">
  1067. <summary>
  1068. <para>Describes all currently connected XRNodes and provides available tracking states for each.</para>
  1069. </summary>
  1070. <param name="nodeStates">A list that is populated with XR.XRNodeState objects.</param>
  1071. </member>
  1072. <member name="M:UnityEngine.XR.InputTracking.Recenter">
  1073. <summary>
  1074. <para>Center tracking to the current position and orientation of the HMD.</para>
  1075. </summary>
  1076. </member>
  1077. <member name="T:UnityEngine.XR.InputTrackingState">
  1078. <summary>
  1079. <para>Represents the values being tracked for this device.</para>
  1080. </summary>
  1081. </member>
  1082. <member name="F:UnityEngine.XR.InputTrackingState.Acceleration">
  1083. <summary>
  1084. <para>Represents acceleration being tracked for this device.</para>
  1085. </summary>
  1086. </member>
  1087. <member name="F:UnityEngine.XR.InputTrackingState.All">
  1088. <summary>
  1089. <para>Represents all InputTrackingState values being tracked for this device.</para>
  1090. </summary>
  1091. </member>
  1092. <member name="F:UnityEngine.XR.InputTrackingState.AngularAcceleration">
  1093. <summary>
  1094. <para>Represents angular acceleration being tracked for this device.</para>
  1095. </summary>
  1096. </member>
  1097. <member name="F:UnityEngine.XR.InputTrackingState.AngularVelocity">
  1098. <summary>
  1099. <para>Represents no angular velocity being tracked for this device.</para>
  1100. </summary>
  1101. </member>
  1102. <member name="F:UnityEngine.XR.InputTrackingState.None">
  1103. <summary>
  1104. <para>Represents no values being tracked for this device.</para>
  1105. </summary>
  1106. </member>
  1107. <member name="F:UnityEngine.XR.InputTrackingState.Position">
  1108. <summary>
  1109. <para>Represents position being tracked for this device.</para>
  1110. </summary>
  1111. </member>
  1112. <member name="F:UnityEngine.XR.InputTrackingState.Rotation">
  1113. <summary>
  1114. <para>Represents rotation being tracked for this device.</para>
  1115. </summary>
  1116. </member>
  1117. <member name="F:UnityEngine.XR.InputTrackingState.Velocity">
  1118. <summary>
  1119. <para>Represents velocity being tracked for this device.</para>
  1120. </summary>
  1121. </member>
  1122. <member name="T:UnityEngine.XR.MeshChangeState">
  1123. <summary>
  1124. <para>The state of a tracked mesh since the last query.</para>
  1125. </summary>
  1126. </member>
  1127. <member name="F:UnityEngine.XR.MeshChangeState.Added">
  1128. <summary>
  1129. <para>The mesh has been added since the last call to XRMeshSubsystem.TryGetMeshInfos.</para>
  1130. </summary>
  1131. </member>
  1132. <member name="F:UnityEngine.XR.MeshChangeState.Removed">
  1133. <summary>
  1134. <para>The mesh has been removed since the last call to XRMeshSubsystem.TryGetMeshInfos.</para>
  1135. </summary>
  1136. </member>
  1137. <member name="F:UnityEngine.XR.MeshChangeState.Unchanged">
  1138. <summary>
  1139. <para>The mesh has not changed since the last call to XRMeshSubsystem.TryGetMeshInfos.</para>
  1140. </summary>
  1141. </member>
  1142. <member name="F:UnityEngine.XR.MeshChangeState.Updated">
  1143. <summary>
  1144. <para>The mesh has been updated since the last call to XRMeshSubsystem.TryGetMeshInfos.</para>
  1145. </summary>
  1146. </member>
  1147. <member name="T:UnityEngine.XR.MeshGenerationOptions">
  1148. <summary>
  1149. <para>Options for generating meshes.</para>
  1150. </summary>
  1151. </member>
  1152. <member name="F:UnityEngine.XR.MeshGenerationOptions.ConsumeTransform">
  1153. <summary>
  1154. <para>Indicates you plan to consume the resulting mesh's transform.</para>
  1155. </summary>
  1156. </member>
  1157. <member name="F:UnityEngine.XR.MeshGenerationOptions.None">
  1158. <summary>
  1159. <para>No options are specified.</para>
  1160. </summary>
  1161. </member>
  1162. <member name="T:UnityEngine.XR.MeshGenerationResult">
  1163. <summary>
  1164. <para>Contains event information related to a generated mesh.</para>
  1165. </summary>
  1166. </member>
  1167. <member name="P:UnityEngine.XR.MeshGenerationResult.Attributes">
  1168. <summary>
  1169. <para>The MeshVertexAttributes that were written to the MeshGenerationResult.Mesh.</para>
  1170. </summary>
  1171. </member>
  1172. <member name="P:UnityEngine.XR.MeshGenerationResult.Mesh">
  1173. <summary>
  1174. <para>If the generation was successful, data has been written to this Mesh.</para>
  1175. </summary>
  1176. </member>
  1177. <member name="P:UnityEngine.XR.MeshGenerationResult.MeshCollider">
  1178. <summary>
  1179. <para>If the generation was successful, physics data has been written to this MeshCollider.</para>
  1180. </summary>
  1181. </member>
  1182. <member name="P:UnityEngine.XR.MeshGenerationResult.MeshId">
  1183. <summary>
  1184. <para>The MeshId of the tracked mesh that was generated.</para>
  1185. </summary>
  1186. </member>
  1187. <member name="P:UnityEngine.XR.MeshGenerationResult.Position">
  1188. <summary>
  1189. <para>The position associated with the generated mesh relative to the session origin.</para>
  1190. </summary>
  1191. </member>
  1192. <member name="P:UnityEngine.XR.MeshGenerationResult.Rotation">
  1193. <summary>
  1194. <para>The rotation associated with the generated mesh relative to the session origin.</para>
  1195. </summary>
  1196. </member>
  1197. <member name="P:UnityEngine.XR.MeshGenerationResult.Scale">
  1198. <summary>
  1199. <para>The scale associated with the generated mesh relative to the session origin.</para>
  1200. </summary>
  1201. </member>
  1202. <member name="P:UnityEngine.XR.MeshGenerationResult.Status">
  1203. <summary>
  1204. <para>The MeshGenerationStatus of the mesh generation task.</para>
  1205. </summary>
  1206. </member>
  1207. <member name="P:UnityEngine.XR.MeshGenerationResult.Timestamp">
  1208. <summary>
  1209. <para>The timestamp associated with the generated mesh.</para>
  1210. </summary>
  1211. </member>
  1212. <member name="T:UnityEngine.XR.MeshGenerationStatus">
  1213. <summary>
  1214. <para>The status of a XRMeshSubsystem.GenerateMeshAsync.</para>
  1215. </summary>
  1216. </member>
  1217. <member name="F:UnityEngine.XR.MeshGenerationStatus.Canceled">
  1218. <summary>
  1219. <para>The mesh generation was canceled.</para>
  1220. </summary>
  1221. </member>
  1222. <member name="F:UnityEngine.XR.MeshGenerationStatus.GenerationAlreadyInProgress">
  1223. <summary>
  1224. <para>The XRMeshSubsystem was already generating the requested mesh.</para>
  1225. </summary>
  1226. </member>
  1227. <member name="F:UnityEngine.XR.MeshGenerationStatus.InvalidMeshId">
  1228. <summary>
  1229. <para>The mesh generation failed because the mesh does not exist.</para>
  1230. </summary>
  1231. </member>
  1232. <member name="F:UnityEngine.XR.MeshGenerationStatus.Success">
  1233. <summary>
  1234. <para>The mesh generation was successful.</para>
  1235. </summary>
  1236. </member>
  1237. <member name="F:UnityEngine.XR.MeshGenerationStatus.UnknownError">
  1238. <summary>
  1239. <para>The mesh generation failed for unknown reasons.</para>
  1240. </summary>
  1241. </member>
  1242. <member name="T:UnityEngine.XR.MeshId">
  1243. <summary>
  1244. <para>A session-unique identifier for trackables in the environment, e.g., planes and feature points.</para>
  1245. </summary>
  1246. </member>
  1247. <member name="P:UnityEngine.XR.MeshId.InvalidId">
  1248. <summary>
  1249. <para>Represents an invalid id.</para>
  1250. </summary>
  1251. </member>
  1252. <member name="M:UnityEngine.XR.MeshId.ToString">
  1253. <summary>
  1254. <para>Generates a nicely formatted version of the id.</para>
  1255. </summary>
  1256. <returns>
  1257. <para>A string unique to this id</para>
  1258. </returns>
  1259. </member>
  1260. <member name="T:UnityEngine.XR.MeshInfo">
  1261. <summary>
  1262. <para>Contains state information related to a tracked mesh.</para>
  1263. </summary>
  1264. </member>
  1265. <member name="P:UnityEngine.XR.MeshInfo.ChangeState">
  1266. <summary>
  1267. <para>The change state (e.g., Added, Removed) of the tracked mesh.</para>
  1268. </summary>
  1269. </member>
  1270. <member name="P:UnityEngine.XR.MeshInfo.MeshId">
  1271. <summary>
  1272. <para>The MeshId of the tracked mesh.</para>
  1273. </summary>
  1274. </member>
  1275. <member name="P:UnityEngine.XR.MeshInfo.PriorityHint">
  1276. <summary>
  1277. <para>A hint that can be used to determine when this mesh should be processed.</para>
  1278. </summary>
  1279. </member>
  1280. <member name="T:UnityEngine.XR.MeshTransform">
  1281. <summary>
  1282. <para>Contains transform information related to a tracked mesh.</para>
  1283. </summary>
  1284. </member>
  1285. <member name="M:UnityEngine.XR.MeshTransform.#ctor(UnityEngine.XR.MeshId&amp;,System.UInt64,UnityEngine.Vector3&amp;,UnityEngine.Quaternion&amp;,UnityEngine.Vector3&amp;)">
  1286. <summary>
  1287. <para>Creates a new MeshTransform.</para>
  1288. </summary>
  1289. <param name="meshId">The identifier of the mesh.</param>
  1290. <param name="timestamp">The timestamp for the mesh's transform. Larger values indicate newer transforms.</param>
  1291. <param name="position">The position of the mesh relative to the session origin.</param>
  1292. <param name="rotation">The rotation of the mesh relative to the session origin.</param>
  1293. <param name="scale">The scale of the mesh relative to the session origin.</param>
  1294. </member>
  1295. <member name="P:UnityEngine.XR.MeshTransform.MeshId">
  1296. <summary>
  1297. <para>The session-unique identifier of the tracked mesh.</para>
  1298. </summary>
  1299. </member>
  1300. <member name="P:UnityEngine.XR.MeshTransform.Position">
  1301. <summary>
  1302. <para>The position of the mesh, relative to the session origin.</para>
  1303. </summary>
  1304. </member>
  1305. <member name="P:UnityEngine.XR.MeshTransform.Rotation">
  1306. <summary>
  1307. <para>The rotation of the mesh, relative to the session origin.</para>
  1308. </summary>
  1309. </member>
  1310. <member name="P:UnityEngine.XR.MeshTransform.Scale">
  1311. <summary>
  1312. <para>The scale of the mesh, relative to the session origin.</para>
  1313. </summary>
  1314. </member>
  1315. <member name="P:UnityEngine.XR.MeshTransform.Timestamp">
  1316. <summary>
  1317. <para>The timestamp associated with this transform.</para>
  1318. </summary>
  1319. </member>
  1320. <member name="T:UnityEngine.XR.MeshVertexAttributes">
  1321. <summary>
  1322. <para>A set of vertex attributes.</para>
  1323. </summary>
  1324. </member>
  1325. <member name="F:UnityEngine.XR.MeshVertexAttributes.Colors">
  1326. <summary>
  1327. <para>Vertex normals</para>
  1328. </summary>
  1329. </member>
  1330. <member name="F:UnityEngine.XR.MeshVertexAttributes.None">
  1331. <summary>
  1332. <para>No vertex attributes</para>
  1333. </summary>
  1334. </member>
  1335. <member name="F:UnityEngine.XR.MeshVertexAttributes.Normals">
  1336. <summary>
  1337. <para>Vertex normals</para>
  1338. </summary>
  1339. </member>
  1340. <member name="F:UnityEngine.XR.MeshVertexAttributes.Tangents">
  1341. <summary>
  1342. <para>Vertex tangents</para>
  1343. </summary>
  1344. </member>
  1345. <member name="F:UnityEngine.XR.MeshVertexAttributes.UVs">
  1346. <summary>
  1347. <para>Vertex UVs</para>
  1348. </summary>
  1349. </member>
  1350. <member name="T:UnityEngine.XR.Provider.XRStats">
  1351. <summary>
  1352. <para>Provides timing and other statistics from XR subsystems.</para>
  1353. </summary>
  1354. </member>
  1355. <member name="M:UnityEngine.XR.Provider.XRStats.TryGetStat(UnityEngine.IntegratedSubsystem,System.String,System.Single&amp;)">
  1356. <summary>
  1357. <para>Retrieve a statistic for an XR subsystem.</para>
  1358. </summary>
  1359. <param name="xrSubsystem">The subsystem with which the stat is registered.</param>
  1360. <param name="tag">The tag used to query for a statistic.</param>
  1361. <param name="value">Receives the current value of the requested statistic. Contains a valid value when this method returns true.</param>
  1362. <returns>
  1363. <para>True, if the requested statistic is available, false otherwise.</para>
  1364. </returns>
  1365. </member>
  1366. <member name="T:UnityEngine.XR.TrackingOriginModeFlags">
  1367. <summary>
  1368. <para>This enum provides context to where the 0,0,0 point of tracking for InputDevices is.</para>
  1369. </summary>
  1370. </member>
  1371. <member name="F:UnityEngine.XR.TrackingOriginModeFlags.Device">
  1372. <summary>
  1373. <para>XRInputSubsystem tracks all InputDevices in reference to the first known location of a specific InputDevice when set to TrackingOriginModeFlags.Device.</para>
  1374. </summary>
  1375. </member>
  1376. <member name="F:UnityEngine.XR.TrackingOriginModeFlags.Floor">
  1377. <summary>
  1378. <para>XRInputSubsystem tracks all InputDevices in reference to a point on the floor when set to TrackingOriginModeFlags.Floor.</para>
  1379. </summary>
  1380. </member>
  1381. <member name="F:UnityEngine.XR.TrackingOriginModeFlags.TrackingReference">
  1382. <summary>
  1383. <para>XRInputSubsystem tracks all InputDevices in reference to an InputDevice with the InputDeviceCharacteristics.TrackingReference flag set when set to TrackingOriginModeFlags.TrackingReference.</para>
  1384. </summary>
  1385. </member>
  1386. <member name="F:UnityEngine.XR.TrackingOriginModeFlags.Unbounded">
  1387. <summary>
  1388. <para>XRInputSubsystem tracks all InputDevices in relation to a world anchor. This world anchor can change at any time, and is chosen by the runtime.</para>
  1389. </summary>
  1390. </member>
  1391. <member name="F:UnityEngine.XR.TrackingOriginModeFlags.Unknown">
  1392. <summary>
  1393. <para>TrackingOriginModeFlags.Unknown enumerates when the XRInputSubsystem was not able to set its tracking origin or has no tracking.</para>
  1394. </summary>
  1395. </member>
  1396. <member name="T:UnityEngine.XR.XRDisplaySubsystem">
  1397. <summary>
  1398. <para>An XRDisplaySubsystem controls rendering to a head tracked display.</para>
  1399. </summary>
  1400. </member>
  1401. <member name="P:UnityEngine.XR.XRDisplaySubsystem.contentProtectionEnabled">
  1402. <summary>
  1403. <para>Sets or gets the state of content protection for the current active provider.
  1404. For most providers, content protection allows you to use write only textures for rendering. This stops the ability for apps to read textures from the graphics card and view/record images that may be protected in some way.
  1405. </para>
  1406. </summary>
  1407. </member>
  1408. <member name="P:UnityEngine.XR.XRDisplaySubsystem.disableLegacyRenderer">
  1409. <summary>
  1410. <para>Disables the legacy renderer while this XRDisplaySubsystem is active.</para>
  1411. </summary>
  1412. </member>
  1413. <member name="?:UnityEngine.XR.XRDisplaySubsystem.displayFocusChanged(System.Action`1&lt;System.Boolean&gt;)">
  1414. <summary>
  1415. <para>Event sent when XR display focus changes.</para>
  1416. </summary>
  1417. <param name="value">Delegate method to call when the event is sent.</param>
  1418. </member>
  1419. <member name="P:UnityEngine.XR.XRDisplaySubsystem.displayOpaque">
  1420. <summary>
  1421. <para>Determines if the current attached device has an opaque display.
  1422. Most VR devices are opaque in order to increase the immersive experience, AR devices are transparent to allow for interaction with an augmentation of the current environment.
  1423. </para>
  1424. </summary>
  1425. </member>
  1426. <member name="P:UnityEngine.XR.XRDisplaySubsystem.occlusionMaskScale">
  1427. <summary>
  1428. <para>A scale applied to the standard occulsion mask.</para>
  1429. </summary>
  1430. </member>
  1431. <member name="P:UnityEngine.XR.XRDisplaySubsystem.reprojectionMode">
  1432. <summary>
  1433. <para>The kind of reprojection the app requests to stabilize its holographic rendering relative to the user's head motion.</para>
  1434. </summary>
  1435. </member>
  1436. <member name="P:UnityEngine.XR.XRDisplaySubsystem.scaleOfAllRenderTargets">
  1437. <summary>
  1438. <para>Controls the size of the textures submitted to the display as a multiplier of the display's default resolution.</para>
  1439. </summary>
  1440. </member>
  1441. <member name="P:UnityEngine.XR.XRDisplaySubsystem.scaleOfAllViewports">
  1442. <summary>
  1443. <para>Controls how much of the allocated display texture should be used for rendering.</para>
  1444. </summary>
  1445. </member>
  1446. <member name="P:UnityEngine.XR.XRDisplaySubsystem.singlePassRenderingDisabled">
  1447. <summary>
  1448. <para>Returns true when single pass stereo rendering is disabled and returns false if otherwise.</para>
  1449. </summary>
  1450. </member>
  1451. <member name="P:UnityEngine.XR.XRDisplaySubsystem.supportedTextureLayouts">
  1452. <summary>
  1453. <para>Specifies all texture layouts supported by this display subsystem. This var is a bit field that could be combination of XRDisplaySubsystem.TextureLayout.</para>
  1454. </summary>
  1455. </member>
  1456. <member name="P:UnityEngine.XR.XRDisplaySubsystem.textureLayout">
  1457. <summary>
  1458. <para>Set DisplaySubsystem to use certain texture layout. Should query supported texture layout through XRDisplaySubsystem.supportedTextureLayouts
  1459. first for the capabilities.</para>
  1460. </summary>
  1461. </member>
  1462. <member name="P:UnityEngine.XR.XRDisplaySubsystem.zFar">
  1463. <summary>
  1464. <para>Set DisplaySubsystem to use zFar for rendering.</para>
  1465. </summary>
  1466. </member>
  1467. <member name="P:UnityEngine.XR.XRDisplaySubsystem.zNear">
  1468. <summary>
  1469. <para>Set DisplaySubsystem to use zNear for rendering.</para>
  1470. </summary>
  1471. </member>
  1472. <member name="M:UnityEngine.XR.XRDisplaySubsystem.AddGraphicsThreadMirrorViewBlit(UnityEngine.Rendering.CommandBuffer,System.Boolean)">
  1473. <summary>
  1474. <para>This function records the display subsystem's native blit event to the target command buffer. This function is typically called by a scriptable rendering pipeline.</para>
  1475. </summary>
  1476. <param name="cmd">The target CommandBuffer that records the native blit event.</param>
  1477. <param name="allowGraphicsStateInvalidate">True causes the graphics device to invalidate internal states before and after calling into the provider's native blit. This ensures the GFX internal states' consistency with the cost of some runtime performance.</param>
  1478. <param name="mode">The XRMirrorViewBlitMode XR display should perform.</param>
  1479. <returns>
  1480. <para>Returns true if native blit event is successfully recorded. Returns false otherwise.</para>
  1481. </returns>
  1482. </member>
  1483. <member name="M:UnityEngine.XR.XRDisplaySubsystem.AddGraphicsThreadMirrorViewBlit(UnityEngine.Rendering.CommandBuffer,System.Boolean,System.Int32)">
  1484. <summary>
  1485. <para>This function records the display subsystem's native blit event to the target command buffer. This function is typically called by a scriptable rendering pipeline.</para>
  1486. </summary>
  1487. <param name="cmd">The target CommandBuffer that records the native blit event.</param>
  1488. <param name="allowGraphicsStateInvalidate">True causes the graphics device to invalidate internal states before and after calling into the provider's native blit. This ensures the GFX internal states' consistency with the cost of some runtime performance.</param>
  1489. <param name="mode">The XRMirrorViewBlitMode XR display should perform.</param>
  1490. <returns>
  1491. <para>Returns true if native blit event is successfully recorded. Returns false otherwise.</para>
  1492. </returns>
  1493. </member>
  1494. <member name="M:UnityEngine.XR.XRDisplaySubsystem.BeginRecordingIfLateLatched(UnityEngine.Camera)">
  1495. <summary>
  1496. <para>This function enables late latching recording of constant buffer memory locations which are later patched with the latest pose data.</para>
  1497. </summary>
  1498. <param name="camera">The camera where late latch recording is to be enabled.</param>
  1499. </member>
  1500. <member name="M:UnityEngine.XR.XRDisplaySubsystem.EndRecordingIfLateLatched(UnityEngine.Camera)">
  1501. <summary>
  1502. <para>This function disables late latching recording of constant buffer locations.</para>
  1503. </summary>
  1504. <param name="camera">The camera where late latch end recording is to be done.</param>
  1505. </member>
  1506. <member name="M:UnityEngine.XR.XRDisplaySubsystem.GetCullingParameters(UnityEngine.Camera,System.Int32,UnityEngine.Rendering.ScriptableCullingParameters&amp;)">
  1507. <summary>
  1508. <para>Gets culling parameters for a specific culling pass index.</para>
  1509. </summary>
  1510. <param name="camera">Camera for the basis of the culling view and frustum.</param>
  1511. <param name="cullingPassIndex">Index of the culling pass obtained from XR.XRDisplaySubsystem.XRRenderPass.cullingPassIndex|XRRenderPass.cullingPassIndex.</param>
  1512. <param name="scriptableCullingParameters">Scriptable culling parameters to populate.</param>
  1513. </member>
  1514. <member name="M:UnityEngine.XR.XRDisplaySubsystem.GetMirrorViewBlitDesc(UnityEngine.RenderTexture,UnityEngine.XR.XRDisplaySubsystem/XRMirrorViewBlitDesc&amp;)">
  1515. <summary>
  1516. <para>Get a mirror view blit operation descriptor from the current display subsystem.</para>
  1517. </summary>
  1518. <param name="mirrorRt">A render texture representing mirror view's render target.</param>
  1519. <param name="outDesc">Information that describes desired mirror view blit operation.</param>
  1520. <param name="mode">The XRMirrorViewBlitMode XR display should perform.</param>
  1521. <returns>
  1522. <para>Return true if information is retrieved successfully, false otherwise.</para>
  1523. </returns>
  1524. </member>
  1525. <member name="M:UnityEngine.XR.XRDisplaySubsystem.GetMirrorViewBlitDesc(UnityEngine.RenderTexture,UnityEngine.XR.XRDisplaySubsystem/XRMirrorViewBlitDesc&amp;,System.Int32)">
  1526. <summary>
  1527. <para>Get a mirror view blit operation descriptor from the current display subsystem.</para>
  1528. </summary>
  1529. <param name="mirrorRt">A render texture representing mirror view's render target.</param>
  1530. <param name="outDesc">Information that describes desired mirror view blit operation.</param>
  1531. <param name="mode">The XRMirrorViewBlitMode XR display should perform.</param>
  1532. <returns>
  1533. <para>Return true if information is retrieved successfully, false otherwise.</para>
  1534. </returns>
  1535. </member>
  1536. <member name="M:UnityEngine.XR.XRDisplaySubsystem.GetPreferredMirrorBlitMode">
  1537. <summary>
  1538. <para>Returns the XR display's preferred mirror blit mode.</para>
  1539. </summary>
  1540. <returns>
  1541. <para>Display subsystem's preferred blit mode.</para>
  1542. </returns>
  1543. </member>
  1544. <member name="M:UnityEngine.XR.XRDisplaySubsystem.GetRenderPass(System.Int32,UnityEngine.XR.XRDisplaySubsystem/XRRenderPass&amp;)">
  1545. <summary>
  1546. <para>Gets an XRRenderPass of a specific index.</para>
  1547. </summary>
  1548. <param name="renderPassIndex">The index of the render pass to get. Must be less than GetRenderPassCount.</param>
  1549. <param name="renderPass">Render pass to populate.</param>
  1550. </member>
  1551. <member name="M:UnityEngine.XR.XRDisplaySubsystem.GetRenderPassCount">
  1552. <summary>
  1553. <para>The number of XRRenderPass entries for this XR Display.</para>
  1554. </summary>
  1555. <returns>
  1556. <para>Count of render passes.</para>
  1557. </returns>
  1558. </member>
  1559. <member name="M:UnityEngine.XR.XRDisplaySubsystem.GetRenderTextureForRenderPass(System.Int32)">
  1560. <summary>
  1561. <para>Given a render pass, return the RenderTexture instance backing that render pass. If the render pass is invalid, or if the render texture does not exist, return null.</para>
  1562. </summary>
  1563. <param name="renderPass">The render pass index to get the render texture for.</param>
  1564. <returns>
  1565. <para>The render texture associated with that render pass, or null if not found.</para>
  1566. </returns>
  1567. </member>
  1568. <member name="M:UnityEngine.XR.XRDisplaySubsystem.GetSharedDepthTextureForRenderPass(System.Int32)">
  1569. <summary>
  1570. <para>Given a render pass, return the shared depth buffer RenderTexture instance backing that render pass. If the render pass is invalid, or if the render texture does not exist, return null.</para>
  1571. </summary>
  1572. <param name="renderPass">The render pass index to get the shared depth buffer render texture for.</param>
  1573. <returns>
  1574. <para>The shared depth buffer render texture associated with that render pass, or null if not found.</para>
  1575. </returns>
  1576. </member>
  1577. <member name="T:UnityEngine.XR.XRDisplaySubsystem.LateLatchNode">
  1578. <summary>
  1579. <para>Type of node to be late latched.</para>
  1580. </summary>
  1581. </member>
  1582. <member name="F:UnityEngine.XR.XRDisplaySubsystem.LateLatchNode.Head">
  1583. <summary>
  1584. <para>Head node type for late latching. This represents the camera node in the pose hierarchy.</para>
  1585. </summary>
  1586. </member>
  1587. <member name="F:UnityEngine.XR.XRDisplaySubsystem.LateLatchNode.LeftHand">
  1588. <summary>
  1589. <para>Left hand node type for late latching. This represents the left hand anchor node in the pose hierarchy.</para>
  1590. </summary>
  1591. </member>
  1592. <member name="F:UnityEngine.XR.XRDisplaySubsystem.LateLatchNode.RightHand">
  1593. <summary>
  1594. <para>Right hand node type for late latching. This represents the right hand anchor node in the pose hierarchy.</para>
  1595. </summary>
  1596. </member>
  1597. <member name="M:UnityEngine.XR.XRDisplaySubsystem.MarkTransformLateLatched(UnityEngine.Transform,UnityEngine.XR.XRDisplaySubsystem/LateLatchNode)">
  1598. <summary>
  1599. <para>This marks a given GameObject's transform to be late latched in the next frame. Once marked for late latching, the GameObject transform and its descendants will be updated with the latest VR pose updates before rendering is submitted to the GPU.</para>
  1600. </summary>
  1601. <param name="transform">The transform of the GameObject to be late latched.</param>
  1602. <param name="nodeType">The late latch node type to be associated with the transform.</param>
  1603. </member>
  1604. <member name="T:UnityEngine.XR.XRDisplaySubsystem.ReprojectionMode">
  1605. <summary>
  1606. <para>The kind of reprojection the app requests to stabilize its holographic rendering relative to the user's head motion.</para>
  1607. </summary>
  1608. </member>
  1609. <member name="F:UnityEngine.XR.XRDisplaySubsystem.ReprojectionMode.None">
  1610. <summary>
  1611. <para>Does not stabalize the image for the user's head motion and instead fixes it in the display. Note that this is only comfortable for users when you use it sparingly, for example when the only visible content is a small cursor.</para>
  1612. </summary>
  1613. </member>
  1614. <member name="F:UnityEngine.XR.XRDisplaySubsystem.ReprojectionMode.OrientationOnly">
  1615. <summary>
  1616. <para>Stabalizes the image only for changes to the user's head orientation, ignores changes in position. This is best for body-locked content that you want to move with the user as they walk around, such as a 360-degree video.</para>
  1617. </summary>
  1618. </member>
  1619. <member name="F:UnityEngine.XR.XRDisplaySubsystem.ReprojectionMode.PositionAndOrientation">
  1620. <summary>
  1621. <para>Stabalizes the image for changes to both the user's head position and orientation. This is best for world-locked content that you want to remain stationary as the user walks around.</para>
  1622. </summary>
  1623. </member>
  1624. <member name="F:UnityEngine.XR.XRDisplaySubsystem.ReprojectionMode.Unspecified">
  1625. <summary>
  1626. <para>Does not specify the type of reprojection mode to use.</para>
  1627. </summary>
  1628. </member>
  1629. <member name="M:UnityEngine.XR.XRDisplaySubsystem.SetFocusPlane(UnityEngine.Vector3,UnityEngine.Vector3,UnityEngine.Vector3)">
  1630. <summary>
  1631. <para>Sets a point in 3D space that acts as the focal point of the Scene for this frame. This helps to improve the visual fidelity of content around this point. You must set this value every frame.
  1632. Note that specifying body-locked content in focus improves the fidelity of body-locked content at the expense of content not locked to the body. This is especially apparent when the user moves.
  1633. </para>
  1634. </summary>
  1635. <param name="point">The position of the focal point in the Scene, relative to the Camera.</param>
  1636. <param name="normal">Surface normal of the plane being viewed at the focal point.</param>
  1637. <param name="velocity">A vector that describes how the focus point moves in the Scene at this point in time. This allows the device to compensate for both your head movement and the movement of the object in the Scene.</param>
  1638. </member>
  1639. <member name="M:UnityEngine.XR.XRDisplaySubsystem.SetMSAALevel(System.Int32)">
  1640. <summary>
  1641. <para>Set MSAA level for the DisplaySubsystem's render texture.</para>
  1642. </summary>
  1643. <param name="level">The MSAA level.</param>
  1644. </member>
  1645. <member name="M:UnityEngine.XR.XRDisplaySubsystem.SetPreferredMirrorBlitMode(System.Int32)">
  1646. <summary>
  1647. <para>Override the XR display's preferred mirror blit mode from the script.</para>
  1648. </summary>
  1649. <param name="blitMode">XRMirrorViewBlitMode to set.</param>
  1650. </member>
  1651. <member name="T:UnityEngine.XR.XRDisplaySubsystem.TextureLayout">
  1652. <summary>
  1653. <para>Flags that represents supported texture layout.</para>
  1654. </summary>
  1655. </member>
  1656. <member name="F:UnityEngine.XR.XRDisplaySubsystem.TextureLayout.SeparateTexture2Ds">
  1657. <summary>
  1658. <para>Textures could be configured to multiple texture2D type.</para>
  1659. </summary>
  1660. </member>
  1661. <member name="F:UnityEngine.XR.XRDisplaySubsystem.TextureLayout.SingleTexture2D">
  1662. <summary>
  1663. <para>Textures could be configured to a texture2D that represents multiple views.</para>
  1664. </summary>
  1665. </member>
  1666. <member name="F:UnityEngine.XR.XRDisplaySubsystem.TextureLayout.Texture2DArray">
  1667. <summary>
  1668. <para>Textures could be configured to a texture2DArray type.</para>
  1669. </summary>
  1670. </member>
  1671. <member name="M:UnityEngine.XR.XRDisplaySubsystem.TryGetAppGPUTimeLastFrame(System.Single&amp;)">
  1672. <summary>
  1673. <para>Retrieves the time the GPU has spent on executing commands from the application's last frame, as reported by the XR Plugin. Measured in seconds.</para>
  1674. </summary>
  1675. <param name="gpuTimeLastFrame">Outputs the time spent by the GPU during the last frame.</param>
  1676. <returns>
  1677. <para>Returns true if the GPU time spent on the last frame is available. Returns false if that time is unavailable.</para>
  1678. </returns>
  1679. </member>
  1680. <member name="M:UnityEngine.XR.XRDisplaySubsystem.TryGetCompositorGPUTimeLastFrame">
  1681. <summary>
  1682. <para>Retrieves the amount of time that the GPU spent executing the compositor renderer during the last frame, as reported by the XR Plugin. Measured in seconds.</para>
  1683. </summary>
  1684. <param name="gpuTimeLastFrameCompositor">Outputs the time spent by the GPU for the compositor during the last frame.</param>
  1685. <returns>
  1686. <para>Returns true if the GPU time spent on the last frame is available. Returns false if that time is unavailable.</para>
  1687. </returns>
  1688. </member>
  1689. <member name="M:UnityEngine.XR.XRDisplaySubsystem.TryGetCompositorGPUTimeLastFrame(System.Single&amp;)">
  1690. <summary>
  1691. <para>Retrieves the amount of time that the GPU spent executing the compositor renderer during the last frame, as reported by the XR Plugin. Measured in seconds.</para>
  1692. </summary>
  1693. <param name="gpuTimeLastFrameCompositor">Outputs the time spent by the GPU for the compositor during the last frame.</param>
  1694. <returns>
  1695. <para>Returns true if the GPU time spent on the last frame is available. Returns false if that time is unavailable.</para>
  1696. </returns>
  1697. </member>
  1698. <member name="M:UnityEngine.XR.XRDisplaySubsystem.TryGetDisplayRefreshRate(System.Single&amp;)">
  1699. <summary>
  1700. <para>Retrieves the refresh rate of the display as reported by the XR Plugin.</para>
  1701. </summary>
  1702. <param name="hmdRefreshRate">Outputs the display refresh rate in Hz.</param>
  1703. <param name="displayRefreshRate"></param>
  1704. <returns>
  1705. <para>Returns true if the display refresh rate is available. Returns false if that rate is unavailable.</para>
  1706. </returns>
  1707. </member>
  1708. <member name="M:UnityEngine.XR.XRDisplaySubsystem.TryGetDroppedFrameCount(System.Int32&amp;)">
  1709. <summary>
  1710. <para>Retrieves the number of dropped frames reported by the XR Plugin.</para>
  1711. </summary>
  1712. <param name="droppedFrameCount">Outputs the number of frames dropped since the last update.</param>
  1713. <returns>
  1714. <para>Returns true if the dropped frame count is available. Returns false otherwise.</para>
  1715. </returns>
  1716. </member>
  1717. <member name="M:UnityEngine.XR.XRDisplaySubsystem.TryGetFramePresentCount(System.Int32&amp;)">
  1718. <summary>
  1719. <para>Retrieves the number of times the current frame has been drawn to the device as reported by the XR Plugin.</para>
  1720. </summary>
  1721. <param name="framePresentCount">Outputs the number of times the current frame has been presented.</param>
  1722. <returns>
  1723. <para>Returns true if the current frame count is available. Returns false otherwise.</para>
  1724. </returns>
  1725. </member>
  1726. <member name="M:UnityEngine.XR.XRDisplaySubsystem.TryGetMotionToPhoton(System.Single&amp;)">
  1727. <summary>
  1728. <para>Retrieves the motion-to-photon value as reported by the XR Plugin.</para>
  1729. </summary>
  1730. <param name="motionToPhoton">Outputs the motion-to-photon value.</param>
  1731. <returns>
  1732. <para>Returns true if the motion-to-photon value is available. Returns false otherwise.</para>
  1733. </returns>
  1734. </member>
  1735. <member name="T:UnityEngine.XR.XRDisplaySubsystem.XRBlitParams">
  1736. <summary>
  1737. <para>This struct holds data for a single blit operation.</para>
  1738. </summary>
  1739. </member>
  1740. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRBlitParams.destRect">
  1741. <summary>
  1742. <para>Destination Rect area that the blit operation wants to blit to.</para>
  1743. </summary>
  1744. </member>
  1745. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRBlitParams.srcRect">
  1746. <summary>
  1747. <para>Source Rect area that the blit operation wants to blit from.</para>
  1748. </summary>
  1749. </member>
  1750. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRBlitParams.srcTex">
  1751. <summary>
  1752. <para>Source render texture that the blit operation wants to blit from.</para>
  1753. </summary>
  1754. </member>
  1755. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRBlitParams.srcTexArraySlice">
  1756. <summary>
  1757. <para>Describes source texture's desired array slice. Texture2D will have array slice 1.</para>
  1758. </summary>
  1759. </member>
  1760. <member name="T:UnityEngine.XR.XRDisplaySubsystem.XRMirrorViewBlitDesc">
  1761. <summary>
  1762. <para>All information in this struct describes the desired mirror view blit operation.</para>
  1763. </summary>
  1764. </member>
  1765. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRMirrorViewBlitDesc.blitParamsCount">
  1766. <summary>
  1767. <para>The number of XRBlitParams entries for this XRMirrorViewBlitDesc.</para>
  1768. </summary>
  1769. </member>
  1770. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRMirrorViewBlitDesc.nativeBlitAvailable">
  1771. <summary>
  1772. <para>When this is true, the current display subsystem supports native blit and AddGraphicsThreadMirrorViewBlit must be called to perform native blit.</para>
  1773. </summary>
  1774. </member>
  1775. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRMirrorViewBlitDesc.nativeBlitInvalidStates">
  1776. <summary>
  1777. <para>When this is true, display subsystem will modifiy the graphics state.</para>
  1778. </summary>
  1779. </member>
  1780. <member name="M:UnityEngine.XR.XRDisplaySubsystem.XRMirrorViewBlitDesc.GetBlitParameter(System.Int32,UnityEngine.XR.XRDisplaySubsystem/XRBlitParams&amp;)">
  1781. <summary>
  1782. <para>Gets an XRBlitParams for a specific XRMirrorViewBlitDesc.</para>
  1783. </summary>
  1784. <param name="blitParameterIndex">Index of the blit parameter to get.</param>
  1785. <param name="blitParameter">XRBlitParams to populate.</param>
  1786. </member>
  1787. <member name="T:UnityEngine.XR.XRDisplaySubsystem.XRRenderParameter">
  1788. <summary>
  1789. <para>A single viewpoint that must be rendered by the render pipeline. Contains a target viewport and texture array slice within a corresponding XR.XRDisplaySubsystem.XRRenderPass.renderTarget|renderTarget.</para>
  1790. </summary>
  1791. </member>
  1792. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderParameter.isPreviousViewValid">
  1793. <summary>
  1794. <para>Determines whether XR.XRDisplaySubsystem.XRRenderParameter.previousView is valid for use in a frame.</para>
  1795. </summary>
  1796. </member>
  1797. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderParameter.occlusionMesh">
  1798. <summary>
  1799. <para>Represents the area in screen-space that is not visible on the XR Display.</para>
  1800. </summary>
  1801. </member>
  1802. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderParameter.previousView">
  1803. <summary>
  1804. <para>Previous frame view matrix for use in motion vector calculation. Use XR.XRDisplaySubsystem.XRRenderParameter.isPreviousViewValid to determine if previous view is valid for use. When late latching is enabled, previous view is also adjusted for late latching. </para>
  1805. </summary>
  1806. </member>
  1807. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderParameter.projection">
  1808. <summary>
  1809. <para>The projection matrix that the render pipeline should use to render to the XR.XRDisplaySubsystem.XRRenderPass.renderTarget|renderTarget.</para>
  1810. </summary>
  1811. </member>
  1812. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderParameter.textureArraySlice">
  1813. <summary>
  1814. <para>The slice of the output texture array that the render pipeline should render to.</para>
  1815. </summary>
  1816. </member>
  1817. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderParameter.view">
  1818. <summary>
  1819. <para>World transform that the render pipeline should use to render to the XR.XRDisplaySubsystem.XRRenderPass.renderTarget|renderTarget.</para>
  1820. </summary>
  1821. </member>
  1822. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderParameter.viewport">
  1823. <summary>
  1824. <para>Selects the viewport of the output texture XR.XRDisplaySubsystem.XRRenderPass.renderTarget|renderTarget.</para>
  1825. </summary>
  1826. </member>
  1827. <member name="T:UnityEngine.XR.XRDisplaySubsystem.XRRenderPass">
  1828. <summary>
  1829. <para>Contains configuration parameters about which view into the Scene the renderer should rasterize, and a render target (which can be a texture array) for the result of the rasterization.</para>
  1830. </summary>
  1831. </member>
  1832. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderPass.cullingPassIndex">
  1833. <summary>
  1834. <para>An index that a render pipeline can pass to XR.XRDisplaySubsystem.GetCullingParameters to obtain culling information.</para>
  1835. </summary>
  1836. </member>
  1837. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderPass.hasMotionVectorPass">
  1838. <summary>
  1839. <para>A boolean indicating if this render pass contains a motion-vector generation pass.</para>
  1840. </summary>
  1841. </member>
  1842. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderPass.motionVectorRenderTarget">
  1843. <summary>
  1844. <para>The output render-texture target for the motion-vector generation render pass.</para>
  1845. </summary>
  1846. </member>
  1847. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderPass.motionVectorRenderTargetDesc">
  1848. <summary>
  1849. <para>The render texture description for the target texture for the motion-vector render pass.</para>
  1850. </summary>
  1851. </member>
  1852. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderPass.renderPassIndex">
  1853. <summary>
  1854. <para>The index of the render pass (originally passed in to XRDisplaySubsystem.GetRenderPass).</para>
  1855. </summary>
  1856. </member>
  1857. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderPass.renderTarget">
  1858. <summary>
  1859. <para>The output target for the render pass.</para>
  1860. </summary>
  1861. </member>
  1862. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderPass.renderTargetDesc">
  1863. <summary>
  1864. <para>Descriptor that can be passed to RenderTexture.GetTemporary to create temporary textures that match the XR Display render target.</para>
  1865. </summary>
  1866. </member>
  1867. <member name="F:UnityEngine.XR.XRDisplaySubsystem.XRRenderPass.shouldFillOutDepth">
  1868. <summary>
  1869. <para>When this is false an optimal renderer can avoid resolving the depth buffer.</para>
  1870. </summary>
  1871. </member>
  1872. <member name="M:UnityEngine.XR.XRDisplaySubsystem.XRRenderPass.GetRenderParameter(UnityEngine.Camera,System.Int32,UnityEngine.XR.XRDisplaySubsystem/XRRenderParameter&amp;)">
  1873. <summary>
  1874. <para>Gets an XRRenderParameter for a specific XRRenderPass.</para>
  1875. </summary>
  1876. <param name="camera">Camera for the basis of the view and projection.</param>
  1877. <param name="renderParameterIndex">Index of the render parameter to get. Must be less than GetRenderParameterCount.</param>
  1878. <param name="renderParameter">XRRenderParameter to populate.</param>
  1879. </member>
  1880. <member name="M:UnityEngine.XR.XRDisplaySubsystem.XRRenderPass.GetRenderParameterCount">
  1881. <summary>
  1882. <para>The number of XRRenderParameter entries for this XRRenderPass.</para>
  1883. </summary>
  1884. <returns>
  1885. <para>Count of render parameters.</para>
  1886. </returns>
  1887. </member>
  1888. <member name="T:UnityEngine.XR.XRDisplaySubsystemDescriptor">
  1889. <summary>
  1890. <para>Class providing information about XRDisplaySubsystem registration.</para>
  1891. </summary>
  1892. </member>
  1893. <member name="P:UnityEngine.XR.XRDisplaySubsystemDescriptor.disablesLegacyVr">
  1894. <summary>
  1895. <para>Indicates whether legacy VR settings must be disabled for the subsystem. Set to true if the Editor must disable the legacy VR settings disabled; otherwise false.</para>
  1896. </summary>
  1897. </member>
  1898. <member name="P:UnityEngine.XR.XRDisplaySubsystemDescriptor.enableBackBufferMSAA">
  1899. <summary>
  1900. <para>Indicates whether MSAA must be resolved in the back buffer. Set to true if MSAA needs to be resolved in the back buffer; otherwise false.</para>
  1901. </summary>
  1902. </member>
  1903. <member name="M:UnityEngine.XR.XRDisplaySubsystemDescriptor.GetAvailableMirrorBlitModeCount">
  1904. <summary>
  1905. <para>Get current display subsystem's total number of supported mirror blit modes.</para>
  1906. </summary>
  1907. <returns>
  1908. <para>Number of supported mirror blit modes.</para>
  1909. </returns>
  1910. </member>
  1911. <member name="M:UnityEngine.XR.XRDisplaySubsystemDescriptor.GetMirrorBlitModeByIndex(System.Int32,UnityEngine.XR.XRMirrorViewBlitModeDesc&amp;)">
  1912. <summary>
  1913. <para>Get a supported mirror view blit mode from the current display subsystem descriptor.</para>
  1914. </summary>
  1915. <param name="mode">XRMirrorViewBlitMode to populate.</param>
  1916. <param name="index">Index of the mirror blit mode to get.</param>
  1917. </member>
  1918. <member name="T:UnityEngine.XR.XRInputSubsystem">
  1919. <summary>
  1920. <para>XRInputSubsystem
  1921. Instance is used to enable and disable the inputs coming from a specific plugin.</para>
  1922. </summary>
  1923. </member>
  1924. <member name="?:UnityEngine.XR.XRInputSubsystem.boundaryChanged(System.Action`1&lt;UnityEngine.XR.XRInputSubsystem&gt;)">
  1925. <summary>
  1926. <para>An event that takes the delegate instance that the XRInputSubsystem calls when it changes its tracking boundary.</para>
  1927. </summary>
  1928. <param name="value">Unity calls this delegate when the tracking boundary changes.</param>
  1929. </member>
  1930. <member name="?:UnityEngine.XR.XRInputSubsystem.trackingOriginUpdated(System.Action`1&lt;UnityEngine.XR.XRInputSubsystem&gt;)">
  1931. <summary>
  1932. <para>An event that takes the delegate instance that the XRInputSubsystem calls when it changes the origin it reports devices at.</para>
  1933. </summary>
  1934. <param name="value">Unity calls this delegate when the TrackingOriginFlags changes.</param>
  1935. </member>
  1936. <member name="M:UnityEngine.XR.XRInputSubsystem.GetSupportedTrackingOriginModes">
  1937. <summary>
  1938. <para>Gets all TrackingOriginModeFlags that this subsystem supports.</para>
  1939. </summary>
  1940. <returns>
  1941. <para>A single series of flags that contains all supported TrackingOriginModeFlags.</para>
  1942. </returns>
  1943. </member>
  1944. <member name="M:UnityEngine.XR.XRInputSubsystem.GetTrackingOriginMode">
  1945. <summary>
  1946. <para>Gets the Tracking Origin Mode.</para>
  1947. </summary>
  1948. <returns>
  1949. <para>The Tracking Origin Mode that this subsystem is in.</para>
  1950. </returns>
  1951. </member>
  1952. <member name="M:UnityEngine.XR.XRInputSubsystem.TryGetBoundaryPoints">
  1953. <summary>
  1954. <para>Gets the list of 3D position values that represents the SDK-set boundary.</para>
  1955. </summary>
  1956. <param name="boundary">The list of boundary points.</param>
  1957. <returns>
  1958. <para>True if this XRInputSubsystem supports boundary points and they are available. Returns false otherwise.</para>
  1959. </returns>
  1960. </member>
  1961. <member name="M:UnityEngine.XR.XRInputSubsystem.TryGetInputDevices(System.Collections.Generic.List`1&lt;UnityEngine.XR.InputDevice&gt;)">
  1962. <summary>
  1963. <para>Gets a list of all connected InputDevices reported by this XRInputSubsystem.</para>
  1964. </summary>
  1965. <param name="devices">The list of devices reported by this subsystem.</param>
  1966. <returns>
  1967. <para>True, if the XRInputSubsystem retrieves any devices. Returns false otherwise.</para>
  1968. </returns>
  1969. </member>
  1970. <member name="M:UnityEngine.XR.XRInputSubsystem.TryRecenter">
  1971. <summary>
  1972. <para>Centers the tracking features on all InputDevices to the current position and orientation of the head-mounted device.</para>
  1973. </summary>
  1974. <returns>
  1975. <para>True if the method recenters the XRInputSubsystem. Returns false otherwise.</para>
  1976. </returns>
  1977. </member>
  1978. <member name="M:UnityEngine.XR.XRInputSubsystem.TrySetTrackingOriginMode">
  1979. <summary>
  1980. <para>Attempts to set the TrackingOriginModeFlags of the subsystem.</para>
  1981. </summary>
  1982. <param name="origin">The new TrackingOriginModeFlags that you'd like to change to.</param>
  1983. <returns>
  1984. <para>True if the method changes the origin. Returns false otherwise.</para>
  1985. </returns>
  1986. </member>
  1987. <member name="T:UnityEngine.XR.XRInputSubsystemDescriptor">
  1988. <summary>
  1989. <para>Information about an Input subsystem.</para>
  1990. </summary>
  1991. </member>
  1992. <member name="P:UnityEngine.XR.XRInputSubsystemDescriptor.disablesLegacyInput">
  1993. <summary>
  1994. <para>When true, will suppress legacy support for Daydream, Oculus, OpenVR, and Windows MR built directly into the Unity runtime from generating input. This is useful when adding an XRInputSubsystem that supports these devices.</para>
  1995. </summary>
  1996. </member>
  1997. <member name="T:UnityEngine.XR.XRMeshSubsystem">
  1998. <summary>
  1999. <para>Allows external systems to provide dynamic meshes to Unity.</para>
  2000. </summary>
  2001. </member>
  2002. <member name="P:UnityEngine.XR.XRMeshSubsystem.meshDensity">
  2003. <summary>
  2004. <para>Call this function to request a change in the density of the generated Meshes. Unity gives the density level as a value within the range 0.0 to 1.0 and the provider determines how to map that value to their implementation.
  2005. Setting this value does not guarantee an immediate change in the density of any currently created Mesh and may only change the density for new or updated Meshes.</para>
  2006. </summary>
  2007. </member>
  2008. <member name="M:UnityEngine.XR.XRMeshSubsystem.GenerateMeshAsync(UnityEngine.XR.MeshId,UnityEngine.Mesh,UnityEngine.MeshCollider,UnityEngine.XR.MeshVertexAttributes,System.Action`1&lt;UnityEngine.XR.MeshGenerationResult&gt;)">
  2009. <summary>
  2010. <para>Requests the generation of the Mesh with MeshId meshId. Unity calls onMeshGenerationComplete when generation finishes.</para>
  2011. </summary>
  2012. <param name="meshId">The MeshId of the mesh you wish to generate.</param>
  2013. <param name="mesh">The Mesh to write the results into.</param>
  2014. <param name="meshCollider">(Optional) The MeshCollider to populate with physics data. This may be null.</param>
  2015. <param name="attributes">The vertex attributes you'd like to use.</param>
  2016. <param name="onMeshGenerationComplete">The delegate to invoke when the generation completes.</param>
  2017. </member>
  2018. <member name="M:UnityEngine.XR.XRMeshSubsystem.GenerateMeshAsync(UnityEngine.XR.MeshId,UnityEngine.Mesh,UnityEngine.MeshCollider,UnityEngine.XR.MeshVertexAttributes,System.Action`1&lt;UnityEngine.XR.MeshGenerationResult&gt;,UnityEngine.XR.MeshGenerationOptions)">
  2019. <summary>
  2020. <para>Requests the generation of the Mesh with MeshId meshId. Unity calls onMeshGenerationComplete when generation finishes.</para>
  2021. </summary>
  2022. <param name="meshId">The MeshId of the mesh you wish to generate.</param>
  2023. <param name="mesh">The Mesh to write the results into.</param>
  2024. <param name="meshCollider">(Optional) The MeshCollider to populate with physics data. This may be null.</param>
  2025. <param name="attributes">The vertex attributes you'd like to use.</param>
  2026. <param name="onMeshGenerationComplete">The delegate to invoke when the generation completes.</param>
  2027. <param name="options">The mesh generation options.</param>
  2028. </member>
  2029. <member name="M:UnityEngine.XR.XRMeshSubsystem.GetUpdatedMeshTransforms(Unity.Collections.Allocator)">
  2030. <summary>
  2031. <para>Gets the updated mesh transforms.</para>
  2032. </summary>
  2033. <param name="allocator">The allocator to use for the returned NativeArray.</param>
  2034. <returns>
  2035. <para>A new NativeArray of MeshTransforms.</para>
  2036. </returns>
  2037. </member>
  2038. <member name="M:UnityEngine.XR.XRMeshSubsystem.SetBoundingVolume(UnityEngine.Vector3,UnityEngine.Vector3)">
  2039. <summary>
  2040. <para>Set the bounding volume to restrict the space in which Unity generates and tracks Meshes.
  2041. The bounding volume is an Axis Aligned Bounding Box (AABB) centered at the origin and extends in each dimension as defined in extents.
  2042. The units of measurement depend on the provider.</para>
  2043. </summary>
  2044. <param name="origin"></param>
  2045. <param name="extents"></param>
  2046. </member>
  2047. <member name="M:UnityEngine.XR.XRMeshSubsystem.TryGetMeshInfos(System.Collections.Generic.List`1&lt;UnityEngine.XR.MeshInfo&gt;)">
  2048. <summary>
  2049. <para>Gets information about every Mesh the system currently tracks.</para>
  2050. </summary>
  2051. <param name="meshInfosOut">A List of MeshInfos to be filled. Passing null will throw an ArgumentNullException.</param>
  2052. <returns>
  2053. <para>True if the List was populated.</para>
  2054. </returns>
  2055. </member>
  2056. <member name="T:UnityEngine.XR.XRMeshSubsystemDescriptor">
  2057. <summary>
  2058. <para>Information about an XRMeshSubsystem.</para>
  2059. </summary>
  2060. </member>
  2061. <member name="T:UnityEngine.XR.XRMirrorViewBlitMode">
  2062. <summary>
  2063. <para>Engine reserved blit modes. Blit mode capabilities should be queried from XRDisplaySubsystemDescriptor.GetAvailableMirrorBlitModeCount and XRDisplaySubsystemDescriptor.GetMirrorBlitModeByIndex.</para>
  2064. </summary>
  2065. </member>
  2066. <member name="F:UnityEngine.XR.XRMirrorViewBlitMode.Default">
  2067. <summary>
  2068. <para>Mirror view pass should blit platform default image to the mirror target.</para>
  2069. </summary>
  2070. </member>
  2071. <member name="F:UnityEngine.XR.XRMirrorViewBlitMode.Distort">
  2072. <summary>
  2073. <para>Mirror view pass should blit after distortion pass image to the mirror target.</para>
  2074. </summary>
  2075. </member>
  2076. <member name="F:UnityEngine.XR.XRMirrorViewBlitMode.LeftEye">
  2077. <summary>
  2078. <para>Mirror view pass should blit left eye image to the mirror target.</para>
  2079. </summary>
  2080. </member>
  2081. <member name="F:UnityEngine.XR.XRMirrorViewBlitMode.None">
  2082. <summary>
  2083. <para>Mirror view pass should not be performed.</para>
  2084. </summary>
  2085. </member>
  2086. <member name="F:UnityEngine.XR.XRMirrorViewBlitMode.RightEye">
  2087. <summary>
  2088. <para>Mirror view pass should blit right eye image to the mirror target.</para>
  2089. </summary>
  2090. </member>
  2091. <member name="F:UnityEngine.XR.XRMirrorViewBlitMode.SideBySide">
  2092. <summary>
  2093. <para>Mirror view pass should blit left eye image and right eye image in a side-by-side fashion to the mirror target.</para>
  2094. </summary>
  2095. </member>
  2096. <member name="F:UnityEngine.XR.XRMirrorViewBlitMode.SideBySideOcclusionMesh">
  2097. <summary>
  2098. <para>Mirror view pass should blit similar to side-by-side mode, but also showing not rendered pixels saved by the occlusion mesh.</para>
  2099. </summary>
  2100. </member>
  2101. <member name="T:UnityEngine.XR.XRMirrorViewBlitModeDesc">
  2102. <summary>
  2103. <para>Struct that describes the mirror view blit mode.</para>
  2104. </summary>
  2105. </member>
  2106. <member name="F:UnityEngine.XR.XRMirrorViewBlitModeDesc.blitMode">
  2107. <summary>
  2108. <para>Mirror view blit mode Id. For details, see XRMirrorViewBlitMode. In case of provider's custom blit mode, the value wouldn't be the reserved XRMirrorViewBlitMode.</para>
  2109. </summary>
  2110. </member>
  2111. <member name="F:UnityEngine.XR.XRMirrorViewBlitModeDesc.blitModeDesc">
  2112. <summary>
  2113. <para>String that describes the mirror view blit mode.</para>
  2114. </summary>
  2115. </member>
  2116. <member name="T:UnityEngine.XR.XRNode">
  2117. <summary>
  2118. <para>Enumeration of XR nodes which can be updated by XR input or sent haptic data.</para>
  2119. </summary>
  2120. </member>
  2121. <member name="F:UnityEngine.XR.XRNode.CenterEye">
  2122. <summary>
  2123. <para>Node representing a point between the left and right eyes.</para>
  2124. </summary>
  2125. </member>
  2126. <member name="F:UnityEngine.XR.XRNode.GameController">
  2127. <summary>
  2128. <para>Represents a tracked game Controller not associated with a specific hand.</para>
  2129. </summary>
  2130. </member>
  2131. <member name="F:UnityEngine.XR.XRNode.HardwareTracker">
  2132. <summary>
  2133. <para>Represents a physical device that provides tracking data for objects to which it is attached.</para>
  2134. </summary>
  2135. </member>
  2136. <member name="F:UnityEngine.XR.XRNode.Head">
  2137. <summary>
  2138. <para>Node representing the user's head.</para>
  2139. </summary>
  2140. </member>
  2141. <member name="F:UnityEngine.XR.XRNode.LeftEye">
  2142. <summary>
  2143. <para>Node representing the left eye.</para>
  2144. </summary>
  2145. </member>
  2146. <member name="F:UnityEngine.XR.XRNode.LeftHand">
  2147. <summary>
  2148. <para>Node representing the left hand.</para>
  2149. </summary>
  2150. </member>
  2151. <member name="F:UnityEngine.XR.XRNode.RightEye">
  2152. <summary>
  2153. <para>Node representing the right eye.</para>
  2154. </summary>
  2155. </member>
  2156. <member name="F:UnityEngine.XR.XRNode.RightHand">
  2157. <summary>
  2158. <para>Node representing the right hand.</para>
  2159. </summary>
  2160. </member>
  2161. <member name="F:UnityEngine.XR.XRNode.TrackingReference">
  2162. <summary>
  2163. <para>Represents a stationary physical device that can be used as a point of reference in the tracked area.</para>
  2164. </summary>
  2165. </member>
  2166. <member name="P:UnityEngine.XR.XRNodeState.acceleration">
  2167. <summary>
  2168. <para>Sets the vector representing the current acceleration of the tracked node.</para>
  2169. </summary>
  2170. </member>
  2171. <member name="P:UnityEngine.XR.XRNodeState.angularAcceleration">
  2172. <summary>
  2173. <para>Sets the vector representing the current angular acceleration of the tracked node.</para>
  2174. </summary>
  2175. </member>
  2176. <member name="P:UnityEngine.XR.XRNodeState.angularVelocity">
  2177. <summary>
  2178. <para>Sets the vector representing the current angular velocity of the tracked node.</para>
  2179. </summary>
  2180. </member>
  2181. <member name="P:UnityEngine.XR.XRNodeState.nodeType">
  2182. <summary>
  2183. <para>The type of the tracked node as specified in XR.XRNode.</para>
  2184. </summary>
  2185. </member>
  2186. <member name="P:UnityEngine.XR.XRNodeState.position">
  2187. <summary>
  2188. <para>Sets the vector representing the current position of the tracked node.</para>
  2189. </summary>
  2190. </member>
  2191. <member name="P:UnityEngine.XR.XRNodeState.rotation">
  2192. <summary>
  2193. <para>Sets the quaternion representing the current rotation of the tracked node.</para>
  2194. </summary>
  2195. </member>
  2196. <member name="P:UnityEngine.XR.XRNodeState.tracked">
  2197. <summary>
  2198. <para>
  2199. Set to true if the node is presently being tracked by the underlying XR system,
  2200. and false if the node is not presently being tracked by the underlying XR system.</para>
  2201. </summary>
  2202. </member>
  2203. <member name="P:UnityEngine.XR.XRNodeState.uniqueID">
  2204. <summary>
  2205. <para>The unique identifier of the tracked node.</para>
  2206. </summary>
  2207. </member>
  2208. <member name="P:UnityEngine.XR.XRNodeState.velocity">
  2209. <summary>
  2210. <para>Sets the vector representing the current velocity of the tracked node.</para>
  2211. </summary>
  2212. </member>
  2213. <member name="M:UnityEngine.XR.XRNodeState.TryGetAcceleration(UnityEngine.Vector3&amp;)">
  2214. <summary>
  2215. <para>Attempt to retrieve a vector representing the current acceleration of the tracked node.</para>
  2216. </summary>
  2217. <param name="acceleration"></param>
  2218. <returns>
  2219. <para>True if the acceleration was set in the output parameter. False if the acceleration is not available due to limitations of the underlying platform or if the node is not presently tracked.</para>
  2220. </returns>
  2221. </member>
  2222. <member name="M:UnityEngine.XR.XRNodeState.TryGetAngularAcceleration(UnityEngine.Vector3&amp;)">
  2223. <summary>
  2224. <para>Attempt to retrieve a Vector3 representing the current angular acceleration of the tracked node.</para>
  2225. </summary>
  2226. <param name="angularAcceleration"></param>
  2227. <returns>
  2228. <para>True if the angular acceleration was set in the output parameter. False if the angular acceleration is not available due to limitations of the underlying platform or if the node is not presently tracked.</para>
  2229. </returns>
  2230. </member>
  2231. <member name="M:UnityEngine.XR.XRNodeState.TryGetAngularVelocity(UnityEngine.Vector3&amp;)">
  2232. <summary>
  2233. <para>Attempt to retrieve a Vector3 representing the current angular velocity of the tracked node.</para>
  2234. </summary>
  2235. <param name="angularVelocity"></param>
  2236. <returns>
  2237. <para>True if the angular velocity was set in the output parameter. False if the angular velocity is not available due to limitations of the underlying platform or if the node is not presently tracked.</para>
  2238. </returns>
  2239. </member>
  2240. <member name="M:UnityEngine.XR.XRNodeState.TryGetPosition(UnityEngine.Vector3&amp;)">
  2241. <summary>
  2242. <para>Attempt to retrieve a vector representing the current position of the tracked node.</para>
  2243. </summary>
  2244. <param name="position"></param>
  2245. <returns>
  2246. <para>True if the position was set in the output parameter. False if the position is not available due to limitations of the underlying platform or if the node is not presently tracked.</para>
  2247. </returns>
  2248. </member>
  2249. <member name="M:UnityEngine.XR.XRNodeState.TryGetRotation(UnityEngine.Quaternion&amp;)">
  2250. <summary>
  2251. <para>Attempt to retrieve a quaternion representing the current rotation of the tracked node.</para>
  2252. </summary>
  2253. <param name="rotation"></param>
  2254. <returns>
  2255. <para>True if the rotation was set in the output parameter. False if the rotation is not available due to limitations of the underlying platform or if the node is not presently tracked.</para>
  2256. </returns>
  2257. </member>
  2258. <member name="M:UnityEngine.XR.XRNodeState.TryGetVelocity(UnityEngine.Vector3&amp;)">
  2259. <summary>
  2260. <para>Attempt to retrieve a vector representing the current velocity of the tracked node.</para>
  2261. </summary>
  2262. <param name="velocity"></param>
  2263. <returns>
  2264. <para>True if the velocity was set in the output parameter. False if the velocity is not available due to limitations of the underlying platform or if the node is not presently tracked.</para>
  2265. </returns>
  2266. </member>
  2267. </members>
  2268. </doc>