UnityEngine.VFXModule.xml 100 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.VFXModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.VFX.VFXCameraBufferTypes">
  8. <summary>
  9. <para>This enumeration describes Camera buffer types.</para>
  10. </summary>
  11. </member>
  12. <member name="F:UnityEngine.VFX.VFXCameraBufferTypes.Color">
  13. <summary>
  14. <para>The Camera's color buffer.</para>
  15. </summary>
  16. </member>
  17. <member name="F:UnityEngine.VFX.VFXCameraBufferTypes.Depth">
  18. <summary>
  19. <para>The Camera's depth buffer.</para>
  20. </summary>
  21. </member>
  22. <member name="F:UnityEngine.VFX.VFXCameraBufferTypes.None">
  23. <summary>
  24. <para>No Buffer.</para>
  25. </summary>
  26. </member>
  27. <member name="F:UnityEngine.VFX.VFXCameraBufferTypes.Normal">
  28. <summary>
  29. <para>The Camera's normal buffer.</para>
  30. </summary>
  31. </member>
  32. <member name="T:UnityEngine.VFX.VFXCameraXRSettings">
  33. <summary>
  34. <para>Represents settings that specify how the Visual Effect Graph should handle an XR Camera.</para>
  35. </summary>
  36. </member>
  37. <member name="F:UnityEngine.VFX.VFXCameraXRSettings.viewCount">
  38. <summary>
  39. <para>The number of views to render in the pass. In Unity, there are different methods of rendering a Camera in XR. For multiple pass rendering, viewTotal is 2 and viewCount will be 1. For other XR rendering methods, both viewTotal and viewCount are 2.</para>
  40. </summary>
  41. </member>
  42. <member name="F:UnityEngine.VFX.VFXCameraXRSettings.viewOffset">
  43. <summary>
  44. <para>Indicates where to start rendering views in this pass. Currently, the Visual Effect Graph uses this for multiple pass XR rendering. In this case, the first pass value is 0 and the second pass is 1. For other XR rendering methods, this is 0.</para>
  45. </summary>
  46. </member>
  47. <member name="F:UnityEngine.VFX.VFXCameraXRSettings.viewTotal">
  48. <summary>
  49. <para>The number of views the camera has in total. For a normal Camera, this is 1. For a Camera in XR, this is 2.</para>
  50. </summary>
  51. </member>
  52. <member name="T:UnityEngine.VFX.VFXEventAttribute">
  53. <summary>
  54. <para>This class handles the properties that you transmit to a system using a VFX.VisualEffect.SendEvent.</para>
  55. </summary>
  56. </member>
  57. <member name="M:UnityEngine.VFX.VFXEventAttribute.CopyValuesFrom(UnityEngine.VFX.VFXEventAttribute)">
  58. <summary>
  59. <para>Copies the values from a VFXEventAttribute to the one you call this function from.</para>
  60. </summary>
  61. <param name="eventAttibute">The source event attribute.</param>
  62. </member>
  63. <member name="M:UnityEngine.VFX.VFXEventAttribute.#ctor(UnityEngine.VFX.VFXEventAttribute)">
  64. <summary>
  65. <para>The copy constructor for the VFXEventAttribute class.</para>
  66. </summary>
  67. <param name="original">The source VFXEventAttribute to copy from.</param>
  68. </member>
  69. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetBool(System.Int32)">
  70. <summary>
  71. <para>Use this method to get the value of a named bool property from the VFXEventAttribute.</para>
  72. </summary>
  73. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  74. <param name="name">The name of the property.</param>
  75. <returns>
  76. <para>The value for the bool you specify. Returns false if VFX.VFXEventAttribute.HasBool returns false.</para>
  77. </returns>
  78. </member>
  79. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetBool(System.String)">
  80. <summary>
  81. <para>Use this method to get the value of a named bool property from the VFXEventAttribute.</para>
  82. </summary>
  83. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  84. <param name="name">The name of the property.</param>
  85. <returns>
  86. <para>The value for the bool you specify. Returns false if VFX.VFXEventAttribute.HasBool returns false.</para>
  87. </returns>
  88. </member>
  89. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetFloat(System.Int32)">
  90. <summary>
  91. <para>Use this method to get the value of a named float property from the VFXEventAttribute.</para>
  92. </summary>
  93. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  94. <param name="name">The name of the property.</param>
  95. <returns>
  96. <para>The value for the float you specify. Returns 0.0f if VFX.VFXEventAttribute.HasFloat returns false.</para>
  97. </returns>
  98. </member>
  99. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetFloat(System.String)">
  100. <summary>
  101. <para>Use this method to get the value of a named float property from the VFXEventAttribute.</para>
  102. </summary>
  103. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  104. <param name="name">The name of the property.</param>
  105. <returns>
  106. <para>The value for the float you specify. Returns 0.0f if VFX.VFXEventAttribute.HasFloat returns false.</para>
  107. </returns>
  108. </member>
  109. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetInt(System.Int32)">
  110. <summary>
  111. <para>Use this method to get the value of a named integer property from the VFXEventAttribute.</para>
  112. </summary>
  113. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  114. <param name="name">The name of the property.</param>
  115. <returns>
  116. <para>The value for the integer you specify. Returns 0 if VFX.VFXEventAttribute.HasInt returns false.</para>
  117. </returns>
  118. </member>
  119. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetInt(System.String)">
  120. <summary>
  121. <para>Use this method to get the value of a named integer property from the VFXEventAttribute.</para>
  122. </summary>
  123. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  124. <param name="name">The name of the property.</param>
  125. <returns>
  126. <para>The value for the integer you specify. Returns 0 if VFX.VFXEventAttribute.HasInt returns false.</para>
  127. </returns>
  128. </member>
  129. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetMatrix4x4(System.Int32)">
  130. <summary>
  131. <para>Use this method to get the value of a named Matrix4x4 property from the VFXEventAttribute.</para>
  132. </summary>
  133. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  134. <param name="name">The name of the property.</param>
  135. <returns>
  136. <para>The value for the Matrix4x4 you specify. Returns Matrix4x4.identity if VFX.VFXEventAttribute.HasMatrix4x4 returns false.</para>
  137. </returns>
  138. </member>
  139. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetMatrix4x4(System.String)">
  140. <summary>
  141. <para>Use this method to get the value of a named Matrix4x4 property from the VFXEventAttribute.</para>
  142. </summary>
  143. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  144. <param name="name">The name of the property.</param>
  145. <returns>
  146. <para>The value for the Matrix4x4 you specify. Returns Matrix4x4.identity if VFX.VFXEventAttribute.HasMatrix4x4 returns false.</para>
  147. </returns>
  148. </member>
  149. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetUint(System.Int32)">
  150. <summary>
  151. <para>Use this method to get the value of a named unsigned integer property from the VFXEventAttribute.</para>
  152. </summary>
  153. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  154. <param name="name">The name of the property.</param>
  155. <returns>
  156. <para>The value for the int you specify. Returns 0 if VFX.VFXEventAttribute.HasUint returns false.</para>
  157. </returns>
  158. </member>
  159. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetUint(System.String)">
  160. <summary>
  161. <para>Use this method to get the value of a named unsigned integer property from the VFXEventAttribute.</para>
  162. </summary>
  163. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  164. <param name="name">The name of the property.</param>
  165. <returns>
  166. <para>The value for the int you specify. Returns 0 if VFX.VFXEventAttribute.HasUint returns false.</para>
  167. </returns>
  168. </member>
  169. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetVector2(System.Int32)">
  170. <summary>
  171. <para>Use this method to get the value of a named Vector2 property from the VFXEventAttribute.</para>
  172. </summary>
  173. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  174. <param name="name">The name of the property.</param>
  175. <returns>
  176. <para>The value for the Vector2 you specify. Returns Vector2.zero if VFX.VFXEventAttribute.HasVector2 returns false.</para>
  177. </returns>
  178. </member>
  179. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetVector2(System.String)">
  180. <summary>
  181. <para>Use this method to get the value of a named Vector2 property from the VFXEventAttribute.</para>
  182. </summary>
  183. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  184. <param name="name">The name of the property.</param>
  185. <returns>
  186. <para>The value for the Vector2 you specify. Returns Vector2.zero if VFX.VFXEventAttribute.HasVector2 returns false.</para>
  187. </returns>
  188. </member>
  189. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetVector3(System.Int32)">
  190. <summary>
  191. <para>Use this method to get the value of a named Vector3 property from the VFXEventAttribute.</para>
  192. </summary>
  193. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  194. <param name="name">The name of the property.</param>
  195. <returns>
  196. <para>The value for the Vector3 you specify. Returns Vector3.zero if VFX.VFXEventAttribute.HasVector3 returns false.</para>
  197. </returns>
  198. </member>
  199. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetVector3(System.String)">
  200. <summary>
  201. <para>Use this method to get the value of a named Vector3 property from the VFXEventAttribute.</para>
  202. </summary>
  203. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  204. <param name="name">The name of the property.</param>
  205. <returns>
  206. <para>The value for the Vector3 you specify. Returns Vector3.zero if VFX.VFXEventAttribute.HasVector3 returns false.</para>
  207. </returns>
  208. </member>
  209. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetVector4(System.Int32)">
  210. <summary>
  211. <para>Use this method to get the value of a named Vector4 property from the VFXEventAttribute.</para>
  212. </summary>
  213. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  214. <param name="name">The name of the property.</param>
  215. <returns>
  216. <para>The value for the Vector4 you specify. Returns Vector4.zero if VFX.VFXEventAttribute.HasVector4 returns false.</para>
  217. </returns>
  218. </member>
  219. <member name="M:UnityEngine.VFX.VFXEventAttribute.GetVector4(System.String)">
  220. <summary>
  221. <para>Use this method to get the value of a named Vector4 property from the VFXEventAttribute.</para>
  222. </summary>
  223. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  224. <param name="name">The name of the property.</param>
  225. <returns>
  226. <para>The value for the Vector4 you specify. Returns Vector4.zero if VFX.VFXEventAttribute.HasVector4 returns false.</para>
  227. </returns>
  228. </member>
  229. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasBool(System.Int32)">
  230. <summary>
  231. <para>Use this method to check if the VFXEventAttribute stores a bool with the name you pass in.</para>
  232. </summary>
  233. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  234. <param name="name">The name of the property.</param>
  235. </member>
  236. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasBool(System.String)">
  237. <summary>
  238. <para>Use this method to check if the VFXEventAttribute stores a bool with the name you pass in.</para>
  239. </summary>
  240. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  241. <param name="name">The name of the property.</param>
  242. </member>
  243. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasFloat(System.Int32)">
  244. <summary>
  245. <para>Use this method to check if the VFXEventAttribute stores a float with the name you pass in.</para>
  246. </summary>
  247. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  248. <param name="name">The name of the property.</param>
  249. </member>
  250. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasFloat(System.String)">
  251. <summary>
  252. <para>Use this method to check if the VFXEventAttribute stores a float with the name you pass in.</para>
  253. </summary>
  254. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  255. <param name="name">The name of the property.</param>
  256. </member>
  257. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasInt(System.Int32)">
  258. <summary>
  259. <para>Use this method to check if the VFXEventAttribute stores a integer with the name you pass in.</para>
  260. </summary>
  261. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  262. <param name="name">The name of the property.</param>
  263. </member>
  264. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasInt(System.String)">
  265. <summary>
  266. <para>Use this method to check if the VFXEventAttribute stores a integer with the name you pass in.</para>
  267. </summary>
  268. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  269. <param name="name">The name of the property.</param>
  270. </member>
  271. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasMatrix4x4(System.Int32)">
  272. <summary>
  273. <para>Use this method to check if the VFXEventAttribute stores a Matrix4x4 with the name you pass in.</para>
  274. </summary>
  275. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  276. <param name="name">The name of the property.</param>
  277. </member>
  278. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasMatrix4x4(System.String)">
  279. <summary>
  280. <para>Use this method to check if the VFXEventAttribute stores a Matrix4x4 with the name you pass in.</para>
  281. </summary>
  282. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  283. <param name="name">The name of the property.</param>
  284. </member>
  285. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasUint(System.Int32)">
  286. <summary>
  287. <para>Use this method to check if the VFXEventAttribute stores a unsigned integer with the name you pass in.</para>
  288. </summary>
  289. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  290. <param name="name">The name of the property.</param>
  291. </member>
  292. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasUint(System.String)">
  293. <summary>
  294. <para>Use this method to check if the VFXEventAttribute stores a unsigned integer with the name you pass in.</para>
  295. </summary>
  296. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  297. <param name="name">The name of the property.</param>
  298. </member>
  299. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasVector2(System.Int32)">
  300. <summary>
  301. <para>Use this method to check if the VFXEventAttribute stores a Vector2 with the name you pass in.</para>
  302. </summary>
  303. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  304. <param name="name">The name of the property.</param>
  305. </member>
  306. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasVector2(System.String)">
  307. <summary>
  308. <para>Use this method to check if the VFXEventAttribute stores a Vector2 with the name you pass in.</para>
  309. </summary>
  310. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  311. <param name="name">The name of the property.</param>
  312. </member>
  313. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasVector3(System.Int32)">
  314. <summary>
  315. <para>Use this method to check if the VFXEventAttribute stores a Vector3 with the name you pass in.</para>
  316. </summary>
  317. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  318. <param name="name">The name of the property.</param>
  319. </member>
  320. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasVector3(System.String)">
  321. <summary>
  322. <para>Use this method to check if the VFXEventAttribute stores a Vector3 with the name you pass in.</para>
  323. </summary>
  324. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  325. <param name="name">The name of the property.</param>
  326. </member>
  327. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasVector4(System.Int32)">
  328. <summary>
  329. <para>Use this method to check if the VFXEventAttribute stores a Vector4 with the name you pass in.</para>
  330. </summary>
  331. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  332. <param name="name">The name of the property.</param>
  333. </member>
  334. <member name="M:UnityEngine.VFX.VFXEventAttribute.HasVector4(System.String)">
  335. <summary>
  336. <para>Use this method to check if the VFXEventAttribute stores a Vector4 with the name you pass in.</para>
  337. </summary>
  338. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  339. <param name="name">The name of the property.</param>
  340. </member>
  341. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetBool(System.Int32,System.Boolean)">
  342. <summary>
  343. <para>Use this method to set the value of a bool with the name you pass in.</para>
  344. </summary>
  345. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  346. <param name="name">The name of the property.</param>
  347. <param name="b">The new bool value.</param>
  348. </member>
  349. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetBool(System.String,System.Boolean)">
  350. <summary>
  351. <para>Use this method to set the value of a bool with the name you pass in.</para>
  352. </summary>
  353. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  354. <param name="name">The name of the property.</param>
  355. <param name="b">The new bool value.</param>
  356. </member>
  357. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetFloat(System.Int32,System.Single)">
  358. <summary>
  359. <para>Use this method to set the value of a float with the name you pass in.</para>
  360. </summary>
  361. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  362. <param name="name">The name of the property.</param>
  363. <param name="f">The new float value.</param>
  364. </member>
  365. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetFloat(System.String,System.Single)">
  366. <summary>
  367. <para>Use this method to set the value of a float with the name you pass in.</para>
  368. </summary>
  369. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  370. <param name="name">The name of the property.</param>
  371. <param name="f">The new float value.</param>
  372. </member>
  373. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetInt(System.Int32,System.Int32)">
  374. <summary>
  375. <para>Use this method to set the value of an integer with the name you pass in.</para>
  376. </summary>
  377. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  378. <param name="name">The name of the property.</param>
  379. <param name="i">The new integer value.</param>
  380. </member>
  381. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetInt(System.String,System.Int32)">
  382. <summary>
  383. <para>Use this method to set the value of an integer with the name you pass in.</para>
  384. </summary>
  385. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  386. <param name="name">The name of the property.</param>
  387. <param name="i">The new integer value.</param>
  388. </member>
  389. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetMatrix4x4(System.Int32,UnityEngine.Matrix4x4)">
  390. <summary>
  391. <para>Use this method to set the value of a Matrix4x4 with the name you pass in.</para>
  392. </summary>
  393. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  394. <param name="name">The name of the property.</param>
  395. <param name="v">The new Matrix4x4 value.</param>
  396. </member>
  397. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetMatrix4x4(System.String,UnityEngine.Matrix4x4)">
  398. <summary>
  399. <para>Use this method to set the value of a Matrix4x4 with the name you pass in.</para>
  400. </summary>
  401. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  402. <param name="name">The name of the property.</param>
  403. <param name="v">The new Matrix4x4 value.</param>
  404. </member>
  405. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetUint(System.Int32,System.UInt32)">
  406. <summary>
  407. <para>Use this method to set the value of an unsigned integer with the name you pass in.</para>
  408. </summary>
  409. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  410. <param name="name">The name of the property.</param>
  411. <param name="i">The new unsigned integer value.</param>
  412. </member>
  413. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetUint(System.String,System.UInt32)">
  414. <summary>
  415. <para>Use this method to set the value of an unsigned integer with the name you pass in.</para>
  416. </summary>
  417. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  418. <param name="name">The name of the property.</param>
  419. <param name="i">The new unsigned integer value.</param>
  420. </member>
  421. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetVector2(System.Int32,UnityEngine.Vector2)">
  422. <summary>
  423. <para>Use this method to set the value of a Vector2 with the name you pass in.</para>
  424. </summary>
  425. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  426. <param name="name">The name of the property.</param>
  427. <param name="v">The new Vector2 value.</param>
  428. </member>
  429. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetVector2(System.String,UnityEngine.Vector2)">
  430. <summary>
  431. <para>Use this method to set the value of a Vector2 with the name you pass in.</para>
  432. </summary>
  433. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  434. <param name="name">The name of the property.</param>
  435. <param name="v">The new Vector2 value.</param>
  436. </member>
  437. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetVector3(System.Int32,UnityEngine.Vector3)">
  438. <summary>
  439. <para>Use this method to set the value of a Vector3 with the name you pass in.</para>
  440. </summary>
  441. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  442. <param name="name">The name of the property.</param>
  443. <param name="v">The new Vector3 value.</param>
  444. </member>
  445. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetVector3(System.String,UnityEngine.Vector3)">
  446. <summary>
  447. <para>Use this method to set the value of a Vector3 with the name you pass in.</para>
  448. </summary>
  449. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  450. <param name="name">The name of the property.</param>
  451. <param name="v">The new Vector3 value.</param>
  452. </member>
  453. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetVector4(System.Int32,UnityEngine.Vector4)">
  454. <summary>
  455. <para>Use this method to set the value of a Vector4 with the name you pass in.</para>
  456. </summary>
  457. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  458. <param name="name">The name of the property.</param>
  459. <param name="v">The new Vector4 value.</param>
  460. </member>
  461. <member name="M:UnityEngine.VFX.VFXEventAttribute.SetVector4(System.String,UnityEngine.Vector4)">
  462. <summary>
  463. <para>Use this method to set the value of a Vector4 with the name you pass in.</para>
  464. </summary>
  465. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  466. <param name="name">The name of the property.</param>
  467. <param name="v">The new Vector4 value.</param>
  468. </member>
  469. <member name="T:UnityEngine.VFX.VFXExposedProperty">
  470. <summary>
  471. <para>This structure describes an exposed property on a VisualEffectAsset.</para>
  472. </summary>
  473. </member>
  474. <member name="F:UnityEngine.VFX.VFXExposedProperty.name">
  475. <summary>
  476. <para>The name of the exposed property.</para>
  477. </summary>
  478. </member>
  479. <member name="F:UnityEngine.VFX.VFXExposedProperty.type">
  480. <summary>
  481. <para>The type of the exposed property.</para>
  482. </summary>
  483. </member>
  484. <member name="T:UnityEngine.VFX.VFXExpressionValues">
  485. <summary>
  486. <para>This class is a wrapper to the set of expression values.</para>
  487. </summary>
  488. </member>
  489. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetAnimationCurve(System.Int32)">
  490. <summary>
  491. <para>Returns a an animation curve that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  492. </summary>
  493. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  494. <param name="name">The name of the property.</param>
  495. </member>
  496. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetAnimationCurve(System.String)">
  497. <summary>
  498. <para>Returns a an animation curve that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  499. </summary>
  500. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  501. <param name="name">The name of the property.</param>
  502. </member>
  503. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetBool(System.Int32)">
  504. <summary>
  505. <para>Returns a boolean that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  506. </summary>
  507. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  508. <param name="name">The name of the property.</param>
  509. </member>
  510. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetBool(System.String)">
  511. <summary>
  512. <para>Returns a boolean that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  513. </summary>
  514. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  515. <param name="name">The name of the property.</param>
  516. </member>
  517. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetFloat(System.Int32)">
  518. <summary>
  519. <para>Returns a float that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  520. </summary>
  521. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  522. <param name="name">The name of the property.</param>
  523. </member>
  524. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetFloat(System.String)">
  525. <summary>
  526. <para>Returns a float that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  527. </summary>
  528. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  529. <param name="name">The name of the property.</param>
  530. </member>
  531. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetGradient(System.Int32)">
  532. <summary>
  533. <para>Returns a gradient that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  534. </summary>
  535. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  536. <param name="name">The name of the property.</param>
  537. </member>
  538. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetGradient(System.String)">
  539. <summary>
  540. <para>Returns a gradient that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  541. </summary>
  542. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  543. <param name="name">The name of the property.</param>
  544. </member>
  545. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetInt(System.Int32)">
  546. <summary>
  547. <para>Returns an integer that corresponds to the bound named expression. IF this entry is not available, or the type doesn't match, an exception is thrown.</para>
  548. </summary>
  549. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  550. <param name="name">The name of the property.</param>
  551. </member>
  552. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetInt(System.String)">
  553. <summary>
  554. <para>Returns an integer that corresponds to the bound named expression. IF this entry is not available, or the type doesn't match, an exception is thrown.</para>
  555. </summary>
  556. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  557. <param name="name">The name of the property.</param>
  558. </member>
  559. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetMatrix4x4(System.Int32)">
  560. <summary>
  561. <para>Returns a Matrix4 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  562. </summary>
  563. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  564. <param name="name">The name of the property.</param>
  565. </member>
  566. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetMatrix4x4(System.String)">
  567. <summary>
  568. <para>Returns a Matrix4 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  569. </summary>
  570. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  571. <param name="name">The name of the property.</param>
  572. </member>
  573. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetMesh(System.Int32)">
  574. <summary>
  575. <para>Returns a mesh that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  576. </summary>
  577. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  578. <param name="name">The name of the property.</param>
  579. </member>
  580. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetMesh(System.String)">
  581. <summary>
  582. <para>Returns a mesh that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  583. </summary>
  584. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  585. <param name="name">The name of the property.</param>
  586. </member>
  587. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetTexture(System.Int32)">
  588. <summary>
  589. <para>Returns a texture that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  590. </summary>
  591. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  592. <param name="name">The name of the property.</param>
  593. </member>
  594. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetTexture(System.String)">
  595. <summary>
  596. <para>Returns a texture that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  597. </summary>
  598. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  599. <param name="name">The name of the property.</param>
  600. </member>
  601. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetUInt(System.Int32)">
  602. <summary>
  603. <para>Returns an unsigned integer that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  604. </summary>
  605. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  606. <param name="name">The name of the property.</param>
  607. </member>
  608. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetUInt(System.String)">
  609. <summary>
  610. <para>Returns an unsigned integer that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  611. </summary>
  612. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  613. <param name="name">The name of the property.</param>
  614. </member>
  615. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetVector2(System.Int32)">
  616. <summary>
  617. <para>Returns a Vector2 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  618. </summary>
  619. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  620. <param name="name">The name of the property.</param>
  621. </member>
  622. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetVector2(System.String)">
  623. <summary>
  624. <para>Returns a Vector2 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  625. </summary>
  626. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  627. <param name="name">The name of the property.</param>
  628. </member>
  629. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetVector3(System.Int32)">
  630. <summary>
  631. <para>Returns a Vector3 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  632. </summary>
  633. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  634. <param name="name">The name of the property.</param>
  635. </member>
  636. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetVector3(System.String)">
  637. <summary>
  638. <para>Returns a Vector3 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  639. </summary>
  640. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  641. <param name="name">The name of the property.</param>
  642. </member>
  643. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetVector4(System.Int32)">
  644. <summary>
  645. <para>Returns a Vector4 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  646. </summary>
  647. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  648. <param name="name">The name of the property.</param>
  649. </member>
  650. <member name="M:UnityEngine.VFX.VFXExpressionValues.GetVector4(System.String)">
  651. <summary>
  652. <para>Returns a Vector4 that corresponds to the bound named expression. If this entry is not available, or the type doesn't match, an exception is thrown.</para>
  653. </summary>
  654. <param name="nameID">The name ID of the property retrieved by Shader.PropertyToID.</param>
  655. <param name="name">The name of the property.</param>
  656. </member>
  657. <member name="T:UnityEngine.VFX.VFXManager">
  658. <summary>
  659. <para>Use this class to set a number of properties that control VisualEffect behavior within your Unity Project.</para>
  660. </summary>
  661. </member>
  662. <member name="P:UnityEngine.VFX.VFXManager.fixedTimeStep">
  663. <summary>
  664. <para>The fixed interval in which the frame rate updates. The tick rate is in seconds.</para>
  665. </summary>
  666. </member>
  667. <member name="P:UnityEngine.VFX.VFXManager.maxDeltaTime">
  668. <summary>
  669. <para>The maximum allowed delta time for an update interval. This limit affects fixedDeltaTime and deltaTime. The tick rate is in seconds.</para>
  670. </summary>
  671. </member>
  672. <member name="M:UnityEngine.VFX.VFXManager.IsCameraBufferNeeded(UnityEngine.Camera)">
  673. <summary>
  674. <para>Queries which buffers the VFX Manager needs for the given Camera.</para>
  675. </summary>
  676. <param name="cam">The Camera for which to query needed buffers.</param>
  677. <returns>
  678. <para>A list of all needed buffer flags.</para>
  679. </returns>
  680. </member>
  681. <member name="M:UnityEngine.VFX.VFXManager.PrepareCamera(UnityEngine.Camera)">
  682. <summary>
  683. <para>Use this method to prepare per-Camera VFX commands for this frame.</para>
  684. </summary>
  685. <param name="cam">The Camera to prepare for processing VFX commands.</param>
  686. <param name="camXRSettings">The XR settings that the Visual Effect Graph uses to prepare the Camera.</param>
  687. </member>
  688. <member name="M:UnityEngine.VFX.VFXManager.PrepareCamera(UnityEngine.Camera,UnityEngine.VFX.VFXCameraXRSettings)">
  689. <summary>
  690. <para>Use this method to prepare per-Camera VFX commands for this frame.</para>
  691. </summary>
  692. <param name="cam">The Camera to prepare for processing VFX commands.</param>
  693. <param name="camXRSettings">The XR settings that the Visual Effect Graph uses to prepare the Camera.</param>
  694. </member>
  695. <member name="M:UnityEngine.VFX.VFXManager.ProcessCamera(UnityEngine.Camera)">
  696. <summary>
  697. <para>Use this method to prepare and process per-Camera VFX commands for this frame.</para>
  698. </summary>
  699. <param name="cam">The Camera to prepare for processing VFX commands.</param>
  700. </member>
  701. <member name="M:UnityEngine.VFX.VFXManager.ProcessCameraCommand(UnityEngine.Camera,UnityEngine.Rendering.CommandBuffer)">
  702. <summary>
  703. <para>Use this method to process per-Camera VFX commands for the current frame.</para>
  704. </summary>
  705. <param name="cam">The Camera to process the VFX commands for.</param>
  706. <param name="cmd">The CommandBuffer to push commands to (can be null).</param>
  707. <param name="camXRSettings">The XR settings that the Visual Effect Graph uses to process the Camera commands.</param>
  708. </member>
  709. <member name="M:UnityEngine.VFX.VFXManager.ProcessCameraCommand(UnityEngine.Camera,UnityEngine.Rendering.CommandBuffer,UnityEngine.VFX.VFXCameraXRSettings)">
  710. <summary>
  711. <para>Use this method to process per-Camera VFX commands for the current frame.</para>
  712. </summary>
  713. <param name="cam">The Camera to process the VFX commands for.</param>
  714. <param name="cmd">The CommandBuffer to push commands to (can be null).</param>
  715. <param name="camXRSettings">The XR settings that the Visual Effect Graph uses to process the Camera commands.</param>
  716. </member>
  717. <member name="M:UnityEngine.VFX.VFXManager.SetCameraBuffer(UnityEngine.Camera,UnityEngine.VFX.VFXCameraBufferTypes,UnityEngine.Texture,System.Int32,System.Int32,System.Int32,System.Int32)">
  718. <summary>
  719. <para>Use this method to set the buffer of a given type for this Camera. This allows the VFX Manager to use the buffer.</para>
  720. </summary>
  721. <param name="cam">The Camera to set the buffer for.</param>
  722. <param name="type">The type of buffer to set.</param>
  723. <param name="buffer">The buffer to set.</param>
  724. <param name="x">X offset of the viewport in the buffer.</param>
  725. <param name="y">Y offset of the viewport in the buffer.</param>
  726. <param name="width">Width of the viewport in the buffer.</param>
  727. <param name="height">Height of the viewport in the buffer.</param>
  728. </member>
  729. <member name="T:UnityEngine.VFX.VFXOutputEventArgs">
  730. <summary>
  731. <para>This struct holds information about an output event.</para>
  732. </summary>
  733. </member>
  734. <member name="P:UnityEngine.VFX.VFXOutputEventArgs.eventAttribute">
  735. <summary>
  736. <para>Stores the current event attribute.</para>
  737. </summary>
  738. </member>
  739. <member name="P:UnityEngine.VFX.VFXOutputEventArgs.nameId">
  740. <summary>
  741. <para>Stores the nameId of the source output event context that triggered this event.</para>
  742. </summary>
  743. </member>
  744. <member name="T:UnityEngine.VFX.VFXParticleSystemInfo">
  745. <summary>
  746. <para>This structure provides information data on a particle system.</para>
  747. </summary>
  748. </member>
  749. <member name="F:UnityEngine.VFX.VFXParticleSystemInfo.aliveCount">
  750. <summary>
  751. <para>Number of alive particles within the particle system, the value is lower than [[VFXParticleSystemInfo._capacity].</para>
  752. </summary>
  753. </member>
  754. <member name="F:UnityEngine.VFX.VFXParticleSystemInfo.bounds">
  755. <summary>
  756. <para>The rendering bound of this particle system.</para>
  757. </summary>
  758. </member>
  759. <member name="F:UnityEngine.VFX.VFXParticleSystemInfo.capacity">
  760. <summary>
  761. <para>The capacity (maximum VFXParticleSystemInfo._aliveCount) of the particle system.</para>
  762. </summary>
  763. </member>
  764. <member name="F:UnityEngine.VFX.VFXParticleSystemInfo.sleeping">
  765. <summary>
  766. <para>The sleep state of the particle system.</para>
  767. </summary>
  768. </member>
  769. <member name="T:UnityEngine.VFX.VFXSpawnerCallbacks">
  770. <summary>
  771. <para>This abstract class provides a way to implement custom spawner block in C#.</para>
  772. </summary>
  773. </member>
  774. <member name="M:UnityEngine.VFX.VFXSpawnerCallbacks.OnPlay(UnityEngine.VFX.VFXSpawnerState,UnityEngine.VFX.VFXExpressionValues,UnityEngine.VFX.VisualEffect)">
  775. <summary>
  776. <para>Unity invokes this method when a parent spawner system triggers Play.</para>
  777. </summary>
  778. <param name="state">The spawner state.</param>
  779. <param name="vfxValues">The values of expression (input properties for a spawner block).</param>
  780. <param name="vfxComponent">The visual effect.</param>
  781. </member>
  782. <member name="M:UnityEngine.VFX.VFXSpawnerCallbacks.OnStop(UnityEngine.VFX.VFXSpawnerState,UnityEngine.VFX.VFXExpressionValues,UnityEngine.VFX.VisualEffect)">
  783. <summary>
  784. <para>Unity invokes this method when a parent spawner system triggers Stop.</para>
  785. </summary>
  786. <param name="state">The spawner state.</param>
  787. <param name="vfxValues">The values of expression (input properties for a spawner block).</param>
  788. <param name="vfxComponent">The visual effect.</param>
  789. </member>
  790. <member name="M:UnityEngine.VFX.VFXSpawnerCallbacks.OnUpdate(UnityEngine.VFX.VFXSpawnerState,UnityEngine.VFX.VFXExpressionValues,UnityEngine.VFX.VisualEffect)">
  791. <summary>
  792. <para>Unity invokes this method when a parent spawner system triggers Update.</para>
  793. </summary>
  794. <param name="state">The spawner state.</param>
  795. <param name="vfxValues">The values of expression (input properties for a spawner block).</param>
  796. <param name="vfxComponent">The visual effect.</param>
  797. </member>
  798. <member name="T:UnityEngine.VFX.VFXSpawnerLoopState">
  799. <summary>
  800. <para>This enum describes the state of VFXSpawner.</para>
  801. </summary>
  802. </member>
  803. <member name="F:UnityEngine.VFX.VFXSpawnerLoopState.DelayingAfterLoop">
  804. <summary>
  805. <para>If the VFXSpawner is in this state, then it is waiting after a loop has reached the end.</para>
  806. </summary>
  807. </member>
  808. <member name="F:UnityEngine.VFX.VFXSpawnerLoopState.DelayingBeforeLoop">
  809. <summary>
  810. <para>If the VFXSpawner is in this state, then it is waiting before it starts a loop.</para>
  811. </summary>
  812. </member>
  813. <member name="F:UnityEngine.VFX.VFXSpawnerLoopState.Finished">
  814. <summary>
  815. <para>If the VFXSpawner is in this state then it has finished and is currently awaiting a Play invocation. This is the default and final state.</para>
  816. </summary>
  817. </member>
  818. <member name="F:UnityEngine.VFX.VFXSpawnerLoopState.Looping">
  819. <summary>
  820. <para>If the VFXSpawner is in this state, then it is currently looping. When in this state, VFX.VFXSpawnerState._playing is true.</para>
  821. </summary>
  822. </member>
  823. <member name="T:UnityEngine.VFX.VFXSpawnerState">
  824. <summary>
  825. <para>The spawn state of a Spawn system.</para>
  826. </summary>
  827. </member>
  828. <member name="P:UnityEngine.VFX.VFXSpawnerState.delayAfterLoop">
  829. <summary>
  830. <para>The current delay time that the VFXSpawner waits for after it finishes a loop.</para>
  831. </summary>
  832. </member>
  833. <member name="P:UnityEngine.VFX.VFXSpawnerState.delayBeforeLoop">
  834. <summary>
  835. <para>The current delay time that the VFXSpawner waits for before it starts a loop.</para>
  836. </summary>
  837. </member>
  838. <member name="P:UnityEngine.VFX.VFXSpawnerState.deltaTime">
  839. <summary>
  840. <para>The current delta time.</para>
  841. </summary>
  842. </member>
  843. <member name="P:UnityEngine.VFX.VFXSpawnerState.loopCount">
  844. <summary>
  845. <para>The current loop count.</para>
  846. </summary>
  847. </member>
  848. <member name="P:UnityEngine.VFX.VFXSpawnerState.loopDuration">
  849. <summary>
  850. <para>The duration of the looping state.</para>
  851. </summary>
  852. </member>
  853. <member name="P:UnityEngine.VFX.VFXSpawnerState.loopIndex">
  854. <summary>
  855. <para>The current index of loop.</para>
  856. </summary>
  857. </member>
  858. <member name="P:UnityEngine.VFX.VFXSpawnerState.loopState">
  859. <summary>
  860. <para>The current state of VFXSpawnerState.</para>
  861. </summary>
  862. </member>
  863. <member name="P:UnityEngine.VFX.VFXSpawnerState.newLoop">
  864. <summary>
  865. <para>This boolean indicates if a new loop has just started.</para>
  866. </summary>
  867. </member>
  868. <member name="P:UnityEngine.VFX.VFXSpawnerState.playing">
  869. <summary>
  870. <para>The current playing state.</para>
  871. </summary>
  872. </member>
  873. <member name="P:UnityEngine.VFX.VFXSpawnerState.spawnCount">
  874. <summary>
  875. <para>The current Spawn count.</para>
  876. </summary>
  877. </member>
  878. <member name="P:UnityEngine.VFX.VFXSpawnerState.totalTime">
  879. <summary>
  880. <para>The accumulated delta time since the last Play event.</para>
  881. </summary>
  882. </member>
  883. <member name="P:UnityEngine.VFX.VFXSpawnerState.vfxEventAttribute">
  884. <summary>
  885. <para>Gets the modifiable current event attribute (Read Only).</para>
  886. </summary>
  887. </member>
  888. <member name="T:UnityEngine.VFX.VisualEffect">
  889. <summary>
  890. <para>The visual effect class that references an VFX.VisualEffectAsset instance within the Scene.</para>
  891. </summary>
  892. </member>
  893. <member name="P:UnityEngine.VFX.VisualEffect.aliveParticleCount">
  894. <summary>
  895. <para>Returns the sum of all alive particles within the visual effect.</para>
  896. </summary>
  897. </member>
  898. <member name="P:UnityEngine.VFX.VisualEffect.culled">
  899. <summary>
  900. <para>Use this property to determine if this visual effect is not visible from any Camera. (Read Only)</para>
  901. </summary>
  902. </member>
  903. <member name="P:UnityEngine.VFX.VisualEffect.initialEventID">
  904. <summary>
  905. <para>The default event name ID. To retrieve this value, use the Shader.PropertyID after VisualEffect has awakened or after you've invoked VFX.VisualEffect.Reinit.</para>
  906. </summary>
  907. </member>
  908. <member name="P:UnityEngine.VFX.VisualEffect.initialEventName">
  909. <summary>
  910. <para>The default event name. Unity calls this event when the VisualEffect awakes, or when you call VisualEffect.Reinit.</para>
  911. </summary>
  912. </member>
  913. <member name="F:UnityEngine.VFX.VisualEffect.outputEventReceived">
  914. <summary>
  915. <para>Output event are reported trough this callback.</para>
  916. </summary>
  917. </member>
  918. <member name="P:UnityEngine.VFX.VisualEffect.pause">
  919. <summary>
  920. <para>Use this property to set the pause state of the visual effect.</para>
  921. </summary>
  922. </member>
  923. <member name="P:UnityEngine.VFX.VisualEffect.playRate">
  924. <summary>
  925. <para>A multiplier that Unity applies to the delta time when it updates the VisualEffect. The default value is 1.0f.</para>
  926. </summary>
  927. </member>
  928. <member name="P:UnityEngine.VFX.VisualEffect.resetSeedOnPlay">
  929. <summary>
  930. <para>This property controls whether the visual effect generates a new seed for the random number generator with each call to VFX.VisualEffect.Play function.</para>
  931. </summary>
  932. </member>
  933. <member name="P:UnityEngine.VFX.VisualEffect.startSeed">
  934. <summary>
  935. <para>The initial seed used for internal random number generator.</para>
  936. </summary>
  937. </member>
  938. <member name="P:UnityEngine.VFX.VisualEffect.visualEffectAsset">
  939. <summary>
  940. <para>The VisualEffectAsset that the VisualEffect uses.</para>
  941. </summary>
  942. </member>
  943. <member name="M:UnityEngine.VFX.VisualEffect.AdvanceOneFrame">
  944. <summary>
  945. <para>If VFX.VisualEffect._pause is true, this method processes the next visual effect update for exactly one frame with the current delta time.</para>
  946. </summary>
  947. </member>
  948. <member name="M:UnityEngine.VFX.VisualEffect.CreateVFXEventAttribute">
  949. <summary>
  950. <para>Use this method to create a new VFXEventAttribute.</para>
  951. </summary>
  952. </member>
  953. <member name="M:UnityEngine.VFX.VisualEffect.#ctor">
  954. <summary>
  955. <para>The VisualEffect constructor.</para>
  956. </summary>
  957. </member>
  958. <member name="M:UnityEngine.VFX.VisualEffect.GetAnimationCurve(System.Int32)">
  959. <summary>
  960. <para>Gets the value of a named Animation Curve property.</para>
  961. </summary>
  962. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  963. <param name="name">The name of the property.</param>
  964. <returns>
  965. <para>The value for the Animation Curve you specify. Returns an empty Animation Curve if VFX.VisualEffect.HasAnimationCurve returns false.</para>
  966. </returns>
  967. </member>
  968. <member name="M:UnityEngine.VFX.VisualEffect.GetAnimationCurve(System.String)">
  969. <summary>
  970. <para>Gets the value of a named Animation Curve property.</para>
  971. </summary>
  972. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  973. <param name="name">The name of the property.</param>
  974. <returns>
  975. <para>The value for the Animation Curve you specify. Returns an empty Animation Curve if VFX.VisualEffect.HasAnimationCurve returns false.</para>
  976. </returns>
  977. </member>
  978. <member name="M:UnityEngine.VFX.VisualEffect.GetBool(System.Int32)">
  979. <summary>
  980. <para>Gets the value of a named bool property.</para>
  981. </summary>
  982. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  983. <param name="name">The name of the property.</param>
  984. <returns>
  985. <para>The value for the bool you specify. Returns false if VFX.VisualEffect.HasBool returns false.</para>
  986. </returns>
  987. </member>
  988. <member name="M:UnityEngine.VFX.VisualEffect.GetBool(System.String)">
  989. <summary>
  990. <para>Gets the value of a named bool property.</para>
  991. </summary>
  992. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  993. <param name="name">The name of the property.</param>
  994. <returns>
  995. <para>The value for the bool you specify. Returns false if VFX.VisualEffect.HasBool returns false.</para>
  996. </returns>
  997. </member>
  998. <member name="M:UnityEngine.VFX.VisualEffect.GetFloat(System.Int32)">
  999. <summary>
  1000. <para>Gets the value of a named float property.</para>
  1001. </summary>
  1002. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1003. <param name="name">The name of the property.</param>
  1004. <returns>
  1005. <para>The value for the float you specify. Returns 0.0f if VFX.VisualEffect.HasFloat returns false.</para>
  1006. </returns>
  1007. </member>
  1008. <member name="M:UnityEngine.VFX.VisualEffect.GetFloat(System.String)">
  1009. <summary>
  1010. <para>Gets the value of a named float property.</para>
  1011. </summary>
  1012. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1013. <param name="name">The name of the property.</param>
  1014. <returns>
  1015. <para>The value for the float you specify. Returns 0.0f if VFX.VisualEffect.HasFloat returns false.</para>
  1016. </returns>
  1017. </member>
  1018. <member name="M:UnityEngine.VFX.VisualEffect.GetGradient(System.Int32)">
  1019. <summary>
  1020. <para>Gets the value of a named Gradient property.</para>
  1021. </summary>
  1022. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1023. <param name="name">The name of the property.</param>
  1024. <returns>
  1025. <para>The value for the Gradient you specify. Returns an empty Gradient if VFX.VisualEffect.HasGradient returns false.</para>
  1026. </returns>
  1027. </member>
  1028. <member name="M:UnityEngine.VFX.VisualEffect.GetGradient(System.String)">
  1029. <summary>
  1030. <para>Gets the value of a named Gradient property.</para>
  1031. </summary>
  1032. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1033. <param name="name">The name of the property.</param>
  1034. <returns>
  1035. <para>The value for the Gradient you specify. Returns an empty Gradient if VFX.VisualEffect.HasGradient returns false.</para>
  1036. </returns>
  1037. </member>
  1038. <member name="M:UnityEngine.VFX.VisualEffect.GetInt(System.Int32)">
  1039. <summary>
  1040. <para>Get a named exposed integer.</para>
  1041. </summary>
  1042. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1043. <param name="name">The name of the property.</param>
  1044. <returns>
  1045. <para>The value for the integer you specify. Returns 0 if VFX.VisualEffect.HasInt returns false.</para>
  1046. </returns>
  1047. </member>
  1048. <member name="M:UnityEngine.VFX.VisualEffect.GetInt(System.String)">
  1049. <summary>
  1050. <para>Get a named exposed integer.</para>
  1051. </summary>
  1052. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1053. <param name="name">The name of the property.</param>
  1054. <returns>
  1055. <para>The value for the integer you specify. Returns 0 if VFX.VisualEffect.HasInt returns false.</para>
  1056. </returns>
  1057. </member>
  1058. <member name="M:UnityEngine.VFX.VisualEffect.GetMatrix4x4(System.Int32)">
  1059. <summary>
  1060. <para>Gets the value of a named Matrix4x4 property.</para>
  1061. </summary>
  1062. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1063. <param name="name">The name of the property.</param>
  1064. <returns>
  1065. <para>The value for the Matrix4x4 you specify. Returns Matrix4x4.identity if VFX.VisualEffect.HasMatrix4x4 returns false.</para>
  1066. </returns>
  1067. </member>
  1068. <member name="M:UnityEngine.VFX.VisualEffect.GetMatrix4x4(System.String)">
  1069. <summary>
  1070. <para>Gets the value of a named Matrix4x4 property.</para>
  1071. </summary>
  1072. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1073. <param name="name">The name of the property.</param>
  1074. <returns>
  1075. <para>The value for the Matrix4x4 you specify. Returns Matrix4x4.identity if VFX.VisualEffect.HasMatrix4x4 returns false.</para>
  1076. </returns>
  1077. </member>
  1078. <member name="M:UnityEngine.VFX.VisualEffect.GetMesh(System.Int32)">
  1079. <summary>
  1080. <para>Gets the value of a named Mesh property.</para>
  1081. </summary>
  1082. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1083. <param name="name">The name of the property.</param>
  1084. <returns>
  1085. <para>The value for the Mesh you specify. Returns null if VFX.VisualEffect.HasMesh returns false.</para>
  1086. </returns>
  1087. </member>
  1088. <member name="M:UnityEngine.VFX.VisualEffect.GetMesh(System.String)">
  1089. <summary>
  1090. <para>Gets the value of a named Mesh property.</para>
  1091. </summary>
  1092. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1093. <param name="name">The name of the property.</param>
  1094. <returns>
  1095. <para>The value for the Mesh you specify. Returns null if VFX.VisualEffect.HasMesh returns false.</para>
  1096. </returns>
  1097. </member>
  1098. <member name="M:UnityEngine.VFX.VisualEffect.GetOutputEventNames(System.Collections.Generic.List`1&lt;System.String&gt;)">
  1099. <summary>
  1100. <para>Gets the name of every output event system.</para>
  1101. </summary>
  1102. <param name="names">The List that this function populates with the output event system names.</param>
  1103. </member>
  1104. <member name="M:UnityEngine.VFX.VisualEffect.GetParticleSystemInfo(System.String)">
  1105. <summary>
  1106. <para>Gets information on a particle system.</para>
  1107. </summary>
  1108. <param name="nameID">The system ID. This is the same ID that Shader.PropertyToID returns.</param>
  1109. <param name="name">The name of the particle system.</param>
  1110. <returns>
  1111. <para>A VFXSystemInfo instance.</para>
  1112. </returns>
  1113. </member>
  1114. <member name="M:UnityEngine.VFX.VisualEffect.GetParticleSystemInfo(System.Int32)">
  1115. <summary>
  1116. <para>Gets information on a particle system.</para>
  1117. </summary>
  1118. <param name="nameID">The system ID. This is the same ID that Shader.PropertyToID returns.</param>
  1119. <param name="name">The name of the particle system.</param>
  1120. <returns>
  1121. <para>A VFXSystemInfo instance.</para>
  1122. </returns>
  1123. </member>
  1124. <member name="M:UnityEngine.VFX.VisualEffect.GetParticleSystemNames(System.Collections.Generic.List`1&lt;System.String&gt;)">
  1125. <summary>
  1126. <para>Gets the name of every particle system.</para>
  1127. </summary>
  1128. <param name="names">The List that this function populates with the particle system names.</param>
  1129. </member>
  1130. <member name="M:UnityEngine.VFX.VisualEffect.GetSkinnedMeshRenderer(System.String)">
  1131. <summary>
  1132. <para>Gets the value of a named Skinned Mesh Renderer property.</para>
  1133. </summary>
  1134. <param name="name">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1135. <param name="nameID">The name of the property.</param>
  1136. <returns>
  1137. <para>The value for the Skinned Mesh Renderer you specify. Returns null if VFX.VisualEffect.HasSkinnedMeshRenderer returns false.</para>
  1138. </returns>
  1139. </member>
  1140. <member name="M:UnityEngine.VFX.VisualEffect.GetSkinnedMeshRenderer(System.Int32)">
  1141. <summary>
  1142. <para>Gets the value of a named Skinned Mesh Renderer property.</para>
  1143. </summary>
  1144. <param name="name">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1145. <param name="nameID">The name of the property.</param>
  1146. <returns>
  1147. <para>The value for the Skinned Mesh Renderer you specify. Returns null if VFX.VisualEffect.HasSkinnedMeshRenderer returns false.</para>
  1148. </returns>
  1149. </member>
  1150. <member name="M:UnityEngine.VFX.VisualEffect.GetSpawnSystemInfo(System.String)">
  1151. <summary>
  1152. <para>Gets state on a spawn system.</para>
  1153. </summary>
  1154. <param name="nameID">The system ID. This is the same ID that Shader.PropertyToID returns.</param>
  1155. <param name="spawnState">A modified VFXSpawnerState instance.</param>
  1156. <param name="name"></param>
  1157. </member>
  1158. <member name="M:UnityEngine.VFX.VisualEffect.GetSpawnSystemInfo(System.Int32,UnityEngine.VFX.VFXSpawnerState)">
  1159. <summary>
  1160. <para>Gets state on a spawn system.</para>
  1161. </summary>
  1162. <param name="nameID">The system ID. This is the same ID that Shader.PropertyToID returns.</param>
  1163. <param name="spawnState">A modified VFXSpawnerState instance.</param>
  1164. <param name="name"></param>
  1165. </member>
  1166. <member name="M:UnityEngine.VFX.VisualEffect.GetSpawnSystemNames(System.Collections.Generic.List`1&lt;System.String&gt;)">
  1167. <summary>
  1168. <para>Gets the name of every spawn system.</para>
  1169. </summary>
  1170. <param name="names">The List that this function populates with the spawn system names.</param>
  1171. </member>
  1172. <member name="M:UnityEngine.VFX.VisualEffect.GetSystemNames(System.Collections.Generic.List`1&lt;System.String&gt;)">
  1173. <summary>
  1174. <para>Gets the name of every system.</para>
  1175. </summary>
  1176. <param name="names">The List that this function populates with the system names.</param>
  1177. </member>
  1178. <member name="M:UnityEngine.VFX.VisualEffect.GetTexture(System.Int32)">
  1179. <summary>
  1180. <para>Gets the value of a named texture property.</para>
  1181. </summary>
  1182. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1183. <param name="name">The name of the property.</param>
  1184. <returns>
  1185. <para>The value for the texture you specify. Returns null if VFX.VisualEffect.HasTexture returns false.</para>
  1186. </returns>
  1187. </member>
  1188. <member name="M:UnityEngine.VFX.VisualEffect.GetTexture(System.String)">
  1189. <summary>
  1190. <para>Gets the value of a named texture property.</para>
  1191. </summary>
  1192. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1193. <param name="name">The name of the property.</param>
  1194. <returns>
  1195. <para>The value for the texture you specify. Returns null if VFX.VisualEffect.HasTexture returns false.</para>
  1196. </returns>
  1197. </member>
  1198. <member name="M:UnityEngine.VFX.VisualEffect.GetTextureDimension(System.Int32)">
  1199. <summary>
  1200. <para>Gets expected texture dimension for a named exposed texture.</para>
  1201. </summary>
  1202. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1203. <param name="name">The name of the property.</param>
  1204. </member>
  1205. <member name="M:UnityEngine.VFX.VisualEffect.GetTextureDimension(System.String)">
  1206. <summary>
  1207. <para>Gets expected texture dimension for a named exposed texture.</para>
  1208. </summary>
  1209. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1210. <param name="name">The name of the property.</param>
  1211. </member>
  1212. <member name="M:UnityEngine.VFX.VisualEffect.GetUInt(System.Int32)">
  1213. <summary>
  1214. <para>Gets the value of a named unsigned integer property.</para>
  1215. </summary>
  1216. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1217. <param name="name">The name of the property.</param>
  1218. <returns>
  1219. <para>The value for the unsigned integer you specify. Returns 0 if VFX.VisualEffect.HasUInt returns false.</para>
  1220. </returns>
  1221. </member>
  1222. <member name="M:UnityEngine.VFX.VisualEffect.GetUInt(System.String)">
  1223. <summary>
  1224. <para>Gets the value of a named unsigned integer property.</para>
  1225. </summary>
  1226. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1227. <param name="name">The name of the property.</param>
  1228. <returns>
  1229. <para>The value for the unsigned integer you specify. Returns 0 if VFX.VisualEffect.HasUInt returns false.</para>
  1230. </returns>
  1231. </member>
  1232. <member name="M:UnityEngine.VFX.VisualEffect.GetVector2(System.Int32)">
  1233. <summary>
  1234. <para>Gets the value of a named Vector2 property.</para>
  1235. </summary>
  1236. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1237. <param name="name">The name of the property.</param>
  1238. <returns>
  1239. <para>The value for the Vector2 you specify. Returns Vector2.zero if VFX.VisualEffect.HasVector2 returns false.</para>
  1240. </returns>
  1241. </member>
  1242. <member name="M:UnityEngine.VFX.VisualEffect.GetVector2(System.String)">
  1243. <summary>
  1244. <para>Gets the value of a named Vector2 property.</para>
  1245. </summary>
  1246. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1247. <param name="name">The name of the property.</param>
  1248. <returns>
  1249. <para>The value for the Vector2 you specify. Returns Vector2.zero if VFX.VisualEffect.HasVector2 returns false.</para>
  1250. </returns>
  1251. </member>
  1252. <member name="M:UnityEngine.VFX.VisualEffect.GetVector3(System.Int32)">
  1253. <summary>
  1254. <para>Gets the value of a named Vector3 property.</para>
  1255. </summary>
  1256. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1257. <param name="name">The name of the property.</param>
  1258. <returns>
  1259. <para>The value for the Vector3 you specify. Returns Vector3.zero if VFX.VisualEffect.HasVector3 returns false.</para>
  1260. </returns>
  1261. </member>
  1262. <member name="M:UnityEngine.VFX.VisualEffect.GetVector3(System.String)">
  1263. <summary>
  1264. <para>Gets the value of a named Vector3 property.</para>
  1265. </summary>
  1266. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1267. <param name="name">The name of the property.</param>
  1268. <returns>
  1269. <para>The value for the Vector3 you specify. Returns Vector3.zero if VFX.VisualEffect.HasVector3 returns false.</para>
  1270. </returns>
  1271. </member>
  1272. <member name="M:UnityEngine.VFX.VisualEffect.GetVector4(System.Int32)">
  1273. <summary>
  1274. <para>Gets the value of a named Vector4 or Color property.</para>
  1275. </summary>
  1276. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1277. <param name="name">The name of the property.</param>
  1278. <returns>
  1279. <para>The value for the Vector4 you specify. Returns Vector4.zero if VFX.VisualEffect.HasVector4 returns false.</para>
  1280. </returns>
  1281. </member>
  1282. <member name="M:UnityEngine.VFX.VisualEffect.GetVector4(System.String)">
  1283. <summary>
  1284. <para>Gets the value of a named Vector4 or Color property.</para>
  1285. </summary>
  1286. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1287. <param name="name">The name of the property.</param>
  1288. <returns>
  1289. <para>The value for the Vector4 you specify. Returns Vector4.zero if VFX.VisualEffect.HasVector4 returns false.</para>
  1290. </returns>
  1291. </member>
  1292. <member name="M:UnityEngine.VFX.VisualEffect.HasAnimationCurve(System.Int32)">
  1293. <summary>
  1294. <para>Checks if the Visual Effect can override an Animation Curve with the name you pass in.</para>
  1295. </summary>
  1296. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1297. <param name="name">The name of the property.</param>
  1298. </member>
  1299. <member name="M:UnityEngine.VFX.VisualEffect.HasAnimationCurve(System.String)">
  1300. <summary>
  1301. <para>Checks if the Visual Effect can override an Animation Curve with the name you pass in.</para>
  1302. </summary>
  1303. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1304. <param name="name">The name of the property.</param>
  1305. </member>
  1306. <member name="M:UnityEngine.VFX.VisualEffect.HasAnySystemAwake">
  1307. <summary>
  1308. <para>Checks if any particle system in the effect is awake.</para>
  1309. </summary>
  1310. <returns>
  1311. <para>Returns true if at least one of the particle systems of the effect is awake, otherwise returns false.</para>
  1312. </returns>
  1313. </member>
  1314. <member name="M:UnityEngine.VFX.VisualEffect.HasBool(System.Int32)">
  1315. <summary>
  1316. <para>Checks if the Visual Effect can override a bool with the name you pass in.</para>
  1317. </summary>
  1318. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1319. <param name="name">The name of the property.</param>
  1320. </member>
  1321. <member name="M:UnityEngine.VFX.VisualEffect.HasBool(System.String)">
  1322. <summary>
  1323. <para>Checks if the Visual Effect can override a bool with the name you pass in.</para>
  1324. </summary>
  1325. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1326. <param name="name">The name of the property.</param>
  1327. </member>
  1328. <member name="M:UnityEngine.VFX.VisualEffect.HasFloat(System.Int32)">
  1329. <summary>
  1330. <para>Checks if the Visual Effect can override a float with the name you pass in.</para>
  1331. </summary>
  1332. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1333. <param name="name">The name of the property.</param>
  1334. </member>
  1335. <member name="M:UnityEngine.VFX.VisualEffect.HasFloat(System.String)">
  1336. <summary>
  1337. <para>Checks if the Visual Effect can override a float with the name you pass in.</para>
  1338. </summary>
  1339. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1340. <param name="name">The name of the property.</param>
  1341. </member>
  1342. <member name="M:UnityEngine.VFX.VisualEffect.HasGradient(System.Int32)">
  1343. <summary>
  1344. <para>Checks if the Visual Effect can override a Gradient with the name you pass in.</para>
  1345. </summary>
  1346. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1347. <param name="name">The name of the property.</param>
  1348. </member>
  1349. <member name="M:UnityEngine.VFX.VisualEffect.HasGradient(System.String)">
  1350. <summary>
  1351. <para>Checks if the Visual Effect can override a Gradient with the name you pass in.</para>
  1352. </summary>
  1353. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1354. <param name="name">The name of the property.</param>
  1355. </member>
  1356. <member name="M:UnityEngine.VFX.VisualEffect.HasGraphicsBuffer(System.Int32)">
  1357. <summary>
  1358. <para>Checks if the Visual Effect can override a GraphicsBuffer with the name you pass in.</para>
  1359. </summary>
  1360. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1361. <param name="name">The name of the property.</param>
  1362. </member>
  1363. <member name="M:UnityEngine.VFX.VisualEffect.HasGraphicsBuffer(System.String)">
  1364. <summary>
  1365. <para>Checks if the Visual Effect can override a GraphicsBuffer with the name you pass in.</para>
  1366. </summary>
  1367. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1368. <param name="name">The name of the property.</param>
  1369. </member>
  1370. <member name="M:UnityEngine.VFX.VisualEffect.HasInt(System.Int32)">
  1371. <summary>
  1372. <para>Checks if the Visual Effect can override an integer with the name you pass in.</para>
  1373. </summary>
  1374. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1375. <param name="name">The name of the property.</param>
  1376. </member>
  1377. <member name="M:UnityEngine.VFX.VisualEffect.HasInt(System.String)">
  1378. <summary>
  1379. <para>Checks if the Visual Effect can override an integer with the name you pass in.</para>
  1380. </summary>
  1381. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1382. <param name="name">The name of the property.</param>
  1383. </member>
  1384. <member name="M:UnityEngine.VFX.VisualEffect.HasMatrix4x4(System.Int32)">
  1385. <summary>
  1386. <para>Checks if the Visual Effect can override a Matrix4x4 with the name you pass in.</para>
  1387. </summary>
  1388. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1389. <param name="name">The name of the property.</param>
  1390. </member>
  1391. <member name="M:UnityEngine.VFX.VisualEffect.HasMatrix4x4(System.String)">
  1392. <summary>
  1393. <para>Checks if the Visual Effect can override a Matrix4x4 with the name you pass in.</para>
  1394. </summary>
  1395. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1396. <param name="name">The name of the property.</param>
  1397. </member>
  1398. <member name="M:UnityEngine.VFX.VisualEffect.HasMesh(System.Int32)">
  1399. <summary>
  1400. <para>Checks if the Visual Effect can override a Mesh with the name you pass in.</para>
  1401. </summary>
  1402. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1403. <param name="name">The name of the property.</param>
  1404. </member>
  1405. <member name="M:UnityEngine.VFX.VisualEffect.HasMesh(System.String)">
  1406. <summary>
  1407. <para>Checks if the Visual Effect can override a Mesh with the name you pass in.</para>
  1408. </summary>
  1409. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1410. <param name="name">The name of the property.</param>
  1411. </member>
  1412. <member name="M:UnityEngine.VFX.VisualEffect.HasSkinnedMeshRenderer(System.Int32)">
  1413. <summary>
  1414. <para>Checks if the Visual Effect can override a Skinned Mesh Renderer with the name you pass in.</para>
  1415. </summary>
  1416. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1417. <param name="name">The name of the property.</param>
  1418. </member>
  1419. <member name="M:UnityEngine.VFX.VisualEffect.HasSkinnedMeshRenderer(System.String)">
  1420. <summary>
  1421. <para>Checks if the Visual Effect can override a Skinned Mesh Renderer with the name you pass in.</para>
  1422. </summary>
  1423. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1424. <param name="name">The name of the property.</param>
  1425. </member>
  1426. <member name="M:UnityEngine.VFX.VisualEffect.HasSystem(System.Int32)">
  1427. <summary>
  1428. <para>Use this function to determine if the VisualEffect has the system you pass in.</para>
  1429. </summary>
  1430. <param name="nameID">The system ID. This is the same ID that Shader.PropertyToID returns.</param>
  1431. <param name="name">The name of the property.</param>
  1432. <returns>
  1433. <para>true if the VisualEffect has the system you pass in. Returns false otherwise.</para>
  1434. </returns>
  1435. </member>
  1436. <member name="M:UnityEngine.VFX.VisualEffect.HasSystem(System.String)">
  1437. <summary>
  1438. <para>Use this function to determine if the VisualEffect has the system you pass in.</para>
  1439. </summary>
  1440. <param name="nameID">The system ID. This is the same ID that Shader.PropertyToID returns.</param>
  1441. <param name="name">The name of the property.</param>
  1442. <returns>
  1443. <para>true if the VisualEffect has the system you pass in. Returns false otherwise.</para>
  1444. </returns>
  1445. </member>
  1446. <member name="M:UnityEngine.VFX.VisualEffect.HasTexture(System.Int32)">
  1447. <summary>
  1448. <para>Checks if the Visual Effect can override a texture with the name you pass in.</para>
  1449. </summary>
  1450. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1451. <param name="name">The name of the property.</param>
  1452. </member>
  1453. <member name="M:UnityEngine.VFX.VisualEffect.HasTexture(System.String)">
  1454. <summary>
  1455. <para>Checks if the Visual Effect can override a texture with the name you pass in.</para>
  1456. </summary>
  1457. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1458. <param name="name">The name of the property.</param>
  1459. </member>
  1460. <member name="M:UnityEngine.VFX.VisualEffect.HasUInt(System.Int32)">
  1461. <summary>
  1462. <para>Checks if the Visual Effect can override an unsigned integer with the name you pass in.</para>
  1463. </summary>
  1464. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1465. <param name="name">The name of the property.</param>
  1466. </member>
  1467. <member name="M:UnityEngine.VFX.VisualEffect.HasUInt(System.String)">
  1468. <summary>
  1469. <para>Checks if the Visual Effect can override an unsigned integer with the name you pass in.</para>
  1470. </summary>
  1471. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1472. <param name="name">The name of the property.</param>
  1473. </member>
  1474. <member name="M:UnityEngine.VFX.VisualEffect.HasVector2(System.Int32)">
  1475. <summary>
  1476. <para>Checks if the Visual Effect can override a Vector2 with the name you pass in.</para>
  1477. </summary>
  1478. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1479. <param name="name">The name of the property.</param>
  1480. </member>
  1481. <member name="M:UnityEngine.VFX.VisualEffect.HasVector2(System.String)">
  1482. <summary>
  1483. <para>Checks if the Visual Effect can override a Vector2 with the name you pass in.</para>
  1484. </summary>
  1485. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1486. <param name="name">The name of the property.</param>
  1487. </member>
  1488. <member name="M:UnityEngine.VFX.VisualEffect.HasVector3(System.Int32)">
  1489. <summary>
  1490. <para>Checks if the Visual Effect can override a Vector3 with the name you pass in.</para>
  1491. </summary>
  1492. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1493. <param name="name">The name of the property.</param>
  1494. </member>
  1495. <member name="M:UnityEngine.VFX.VisualEffect.HasVector3(System.String)">
  1496. <summary>
  1497. <para>Checks if the Visual Effect can override a Vector3 with the name you pass in.</para>
  1498. </summary>
  1499. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1500. <param name="name">The name of the property.</param>
  1501. </member>
  1502. <member name="M:UnityEngine.VFX.VisualEffect.HasVector4(System.Int32)">
  1503. <summary>
  1504. <para>Checks if the Visual Effect can override a Vector4 or Color with the name you pass in.</para>
  1505. </summary>
  1506. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1507. <param name="name">The name of the property.</param>
  1508. </member>
  1509. <member name="M:UnityEngine.VFX.VisualEffect.HasVector4(System.String)">
  1510. <summary>
  1511. <para>Checks if the Visual Effect can override a Vector4 or Color with the name you pass in.</para>
  1512. </summary>
  1513. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1514. <param name="name">The name of the property.</param>
  1515. </member>
  1516. <member name="M:UnityEngine.VFX.VisualEffect.Play(UnityEngine.VFX.VFXEventAttribute)">
  1517. <summary>
  1518. <para>Use this method to send a play event to every Spawn system.</para>
  1519. </summary>
  1520. <param name="eventAttribute">Can be null or a VFXEventAttribute. To create a VFXEventAttribute, use VFX.VisualEffect.CreateVFXEventAttribute.</param>
  1521. </member>
  1522. <member name="M:UnityEngine.VFX.VisualEffect.Play">
  1523. <summary>
  1524. <para>Use this method to send a play event to every Spawn system.</para>
  1525. </summary>
  1526. <param name="eventAttribute">Can be null or a VFXEventAttribute. To create a VFXEventAttribute, use VFX.VisualEffect.CreateVFXEventAttribute.</param>
  1527. </member>
  1528. <member name="M:UnityEngine.VFX.VisualEffect.Reinit">
  1529. <summary>
  1530. <para>Reintialize visual effect.</para>
  1531. </summary>
  1532. </member>
  1533. <member name="M:UnityEngine.VFX.VisualEffect.ResetOverride(System.Int32)">
  1534. <summary>
  1535. <para>Use this method to set the overridden state to false. This restores the default value that the Visual Effect Asset specifies.</para>
  1536. </summary>
  1537. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1538. <param name="name">The name of the property.</param>
  1539. </member>
  1540. <member name="M:UnityEngine.VFX.VisualEffect.ResetOverride(System.String)">
  1541. <summary>
  1542. <para>Use this method to set the overridden state to false. This restores the default value that the Visual Effect Asset specifies.</para>
  1543. </summary>
  1544. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1545. <param name="name">The name of the property.</param>
  1546. </member>
  1547. <member name="M:UnityEngine.VFX.VisualEffect.SendEvent(System.Int32)">
  1548. <summary>
  1549. <para>Use this method to send a custom named event.</para>
  1550. </summary>
  1551. <param name="eventName">The name of the event.</param>
  1552. <param name="eventNameID">The ID of the event. This is the same ID that Shader.PropertyToID returns.</param>
  1553. <param name="eventAttribute">Can be null or a VFXEventAttribute. To create a VFXEventAttribute, use VFX.VisualEffect.CreateVFXEventAttribute.</param>
  1554. </member>
  1555. <member name="M:UnityEngine.VFX.VisualEffect.SendEvent(System.String)">
  1556. <summary>
  1557. <para>Use this method to send a custom named event.</para>
  1558. </summary>
  1559. <param name="eventName">The name of the event.</param>
  1560. <param name="eventNameID">The ID of the event. This is the same ID that Shader.PropertyToID returns.</param>
  1561. <param name="eventAttribute">Can be null or a VFXEventAttribute. To create a VFXEventAttribute, use VFX.VisualEffect.CreateVFXEventAttribute.</param>
  1562. </member>
  1563. <member name="M:UnityEngine.VFX.VisualEffect.SendEvent(System.Int32,UnityEngine.VFX.VFXEventAttribute)">
  1564. <summary>
  1565. <para>Use this method to send a custom named event.</para>
  1566. </summary>
  1567. <param name="eventName">The name of the event.</param>
  1568. <param name="eventNameID">The ID of the event. This is the same ID that Shader.PropertyToID returns.</param>
  1569. <param name="eventAttribute">Can be null or a VFXEventAttribute. To create a VFXEventAttribute, use VFX.VisualEffect.CreateVFXEventAttribute.</param>
  1570. </member>
  1571. <member name="M:UnityEngine.VFX.VisualEffect.SendEvent(System.String,UnityEngine.VFX.VFXEventAttribute)">
  1572. <summary>
  1573. <para>Use this method to send a custom named event.</para>
  1574. </summary>
  1575. <param name="eventName">The name of the event.</param>
  1576. <param name="eventNameID">The ID of the event. This is the same ID that Shader.PropertyToID returns.</param>
  1577. <param name="eventAttribute">Can be null or a VFXEventAttribute. To create a VFXEventAttribute, use VFX.VisualEffect.CreateVFXEventAttribute.</param>
  1578. </member>
  1579. <member name="M:UnityEngine.VFX.VisualEffect.SetAnimationCurve(System.Int32,UnityEngine.AnimationCurve)">
  1580. <summary>
  1581. <para>Sets the value of a named Animation Curve property.</para>
  1582. </summary>
  1583. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1584. <param name="c">The new Animation Curve.</param>
  1585. <param name="name">The name of the property.</param>
  1586. </member>
  1587. <member name="M:UnityEngine.VFX.VisualEffect.SetAnimationCurve(System.String,UnityEngine.AnimationCurve)">
  1588. <summary>
  1589. <para>Sets the value of a named Animation Curve property.</para>
  1590. </summary>
  1591. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1592. <param name="c">The new Animation Curve.</param>
  1593. <param name="name">The name of the property.</param>
  1594. </member>
  1595. <member name="M:UnityEngine.VFX.VisualEffect.SetBool(System.Int32,System.Boolean)">
  1596. <summary>
  1597. <para>Sets the value of a named bool property.</para>
  1598. </summary>
  1599. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1600. <param name="name">The name of the property.</param>
  1601. <param name="b">The new boolean value.</param>
  1602. </member>
  1603. <member name="M:UnityEngine.VFX.VisualEffect.SetBool(System.String,System.Boolean)">
  1604. <summary>
  1605. <para>Sets the value of a named bool property.</para>
  1606. </summary>
  1607. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1608. <param name="name">The name of the property.</param>
  1609. <param name="b">The new boolean value.</param>
  1610. </member>
  1611. <member name="M:UnityEngine.VFX.VisualEffect.SetFloat(System.Int32,System.Single)">
  1612. <summary>
  1613. <para>Sets the value of a named float property.</para>
  1614. </summary>
  1615. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1616. <param name="name">The name of the property.</param>
  1617. <param name="f">The new float value.</param>
  1618. </member>
  1619. <member name="M:UnityEngine.VFX.VisualEffect.SetFloat(System.String,System.Single)">
  1620. <summary>
  1621. <para>Sets the value of a named float property.</para>
  1622. </summary>
  1623. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1624. <param name="name">The name of the property.</param>
  1625. <param name="f">The new float value.</param>
  1626. </member>
  1627. <member name="M:UnityEngine.VFX.VisualEffect.SetGradient(System.Int32,UnityEngine.Gradient)">
  1628. <summary>
  1629. <para>Sets the value of a named Gradient property.</para>
  1630. </summary>
  1631. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1632. <param name="name">The name of the property.</param>
  1633. <param name="g">The new Gradient value.</param>
  1634. </member>
  1635. <member name="M:UnityEngine.VFX.VisualEffect.SetGradient(System.String,UnityEngine.Gradient)">
  1636. <summary>
  1637. <para>Sets the value of a named Gradient property.</para>
  1638. </summary>
  1639. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1640. <param name="name">The name of the property.</param>
  1641. <param name="g">The new Gradient value.</param>
  1642. </member>
  1643. <member name="M:UnityEngine.VFX.VisualEffect.SetGraphicsBuffer(System.Int32,UnityEngine.GraphicsBuffer)">
  1644. <summary>
  1645. <para>Sets the value of a named GraphicsBuffer property.</para>
  1646. </summary>
  1647. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1648. <param name="name">The name of the property.</param>
  1649. <param name="g">The new GraphicsBuffer value.</param>
  1650. </member>
  1651. <member name="M:UnityEngine.VFX.VisualEffect.SetGraphicsBuffer(System.String,UnityEngine.GraphicsBuffer)">
  1652. <summary>
  1653. <para>Sets the value of a named GraphicsBuffer property.</para>
  1654. </summary>
  1655. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1656. <param name="name">The name of the property.</param>
  1657. <param name="g">The new GraphicsBuffer value.</param>
  1658. </member>
  1659. <member name="M:UnityEngine.VFX.VisualEffect.SetInt(System.Int32,System.Int32)">
  1660. <summary>
  1661. <para>Sets the value of a named integer property.</para>
  1662. </summary>
  1663. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1664. <param name="name">The name of the property.</param>
  1665. <param name="i">The new integer value.</param>
  1666. </member>
  1667. <member name="M:UnityEngine.VFX.VisualEffect.SetInt(System.String,System.Int32)">
  1668. <summary>
  1669. <para>Sets the value of a named integer property.</para>
  1670. </summary>
  1671. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1672. <param name="name">The name of the property.</param>
  1673. <param name="i">The new integer value.</param>
  1674. </member>
  1675. <member name="M:UnityEngine.VFX.VisualEffect.SetMatrix4x4(System.Int32,UnityEngine.Matrix4x4)">
  1676. <summary>
  1677. <para>Sets the value of a named Matrix4x4 property.</para>
  1678. </summary>
  1679. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1680. <param name="name">The name of the property.</param>
  1681. <param name="v">The new Matrix4x4 value.</param>
  1682. </member>
  1683. <member name="M:UnityEngine.VFX.VisualEffect.SetMatrix4x4(System.String,UnityEngine.Matrix4x4)">
  1684. <summary>
  1685. <para>Sets the value of a named Matrix4x4 property.</para>
  1686. </summary>
  1687. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1688. <param name="name">The name of the property.</param>
  1689. <param name="v">The new Matrix4x4 value.</param>
  1690. </member>
  1691. <member name="M:UnityEngine.VFX.VisualEffect.SetMesh(System.Int32,UnityEngine.Mesh)">
  1692. <summary>
  1693. <para>Sets the value of a named Mesh property.</para>
  1694. </summary>
  1695. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1696. <param name="name">The name of the property.</param>
  1697. <param name="m">The new Mesh value.</param>
  1698. </member>
  1699. <member name="M:UnityEngine.VFX.VisualEffect.SetMesh(System.String,UnityEngine.Mesh)">
  1700. <summary>
  1701. <para>Sets the value of a named Mesh property.</para>
  1702. </summary>
  1703. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1704. <param name="name">The name of the property.</param>
  1705. <param name="m">The new Mesh value.</param>
  1706. </member>
  1707. <member name="M:UnityEngine.VFX.VisualEffect.SetSkinnedMeshRenderer(System.String,UnityEngine.SkinnedMeshRenderer)">
  1708. <summary>
  1709. <para>Sets the value of a named Skinned Mesh Renderer property.</para>
  1710. </summary>
  1711. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1712. <param name="name">The name of the property.</param>
  1713. <param name="m">The new Skinned Mesh Renderer value.</param>
  1714. </member>
  1715. <member name="M:UnityEngine.VFX.VisualEffect.SetSkinnedMeshRenderer(System.Int32,UnityEngine.SkinnedMeshRenderer)">
  1716. <summary>
  1717. <para>Sets the value of a named Skinned Mesh Renderer property.</para>
  1718. </summary>
  1719. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1720. <param name="name">The name of the property.</param>
  1721. <param name="m">The new Skinned Mesh Renderer value.</param>
  1722. </member>
  1723. <member name="M:UnityEngine.VFX.VisualEffect.SetTexture(System.Int32,UnityEngine.Texture)">
  1724. <summary>
  1725. <para>Sets the value of a named texture property.</para>
  1726. </summary>
  1727. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1728. <param name="name">The name of the property.</param>
  1729. <param name="t">The new texture value.</param>
  1730. </member>
  1731. <member name="M:UnityEngine.VFX.VisualEffect.SetTexture(System.String,UnityEngine.Texture)">
  1732. <summary>
  1733. <para>Sets the value of a named texture property.</para>
  1734. </summary>
  1735. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1736. <param name="name">The name of the property.</param>
  1737. <param name="t">The new texture value.</param>
  1738. </member>
  1739. <member name="M:UnityEngine.VFX.VisualEffect.SetUInt(System.Int32,System.UInt32)">
  1740. <summary>
  1741. <para>Sets the value of a named unsigned integer property.</para>
  1742. </summary>
  1743. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1744. <param name="name">The name of the property.</param>
  1745. <param name="i">The new unsigned integer value.</param>
  1746. </member>
  1747. <member name="M:UnityEngine.VFX.VisualEffect.SetUInt(System.String,System.UInt32)">
  1748. <summary>
  1749. <para>Sets the value of a named unsigned integer property.</para>
  1750. </summary>
  1751. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1752. <param name="name">The name of the property.</param>
  1753. <param name="i">The new unsigned integer value.</param>
  1754. </member>
  1755. <member name="M:UnityEngine.VFX.VisualEffect.SetVector2(System.Int32,UnityEngine.Vector2)">
  1756. <summary>
  1757. <para>Sets the value of a named Vector2 property.</para>
  1758. </summary>
  1759. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1760. <param name="name">The name of the property.</param>
  1761. <param name="v">The new Vector2 value.</param>
  1762. </member>
  1763. <member name="M:UnityEngine.VFX.VisualEffect.SetVector2(System.String,UnityEngine.Vector2)">
  1764. <summary>
  1765. <para>Sets the value of a named Vector2 property.</para>
  1766. </summary>
  1767. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1768. <param name="name">The name of the property.</param>
  1769. <param name="v">The new Vector2 value.</param>
  1770. </member>
  1771. <member name="M:UnityEngine.VFX.VisualEffect.SetVector3(System.Int32,UnityEngine.Vector3)">
  1772. <summary>
  1773. <para>Sets the value of a named Vector3 property.</para>
  1774. </summary>
  1775. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1776. <param name="name">The name of the property.</param>
  1777. <param name="v">The new Vector3 value.</param>
  1778. </member>
  1779. <member name="M:UnityEngine.VFX.VisualEffect.SetVector3(System.String,UnityEngine.Vector3)">
  1780. <summary>
  1781. <para>Sets the value of a named Vector3 property.</para>
  1782. </summary>
  1783. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1784. <param name="name">The name of the property.</param>
  1785. <param name="v">The new Vector3 value.</param>
  1786. </member>
  1787. <member name="M:UnityEngine.VFX.VisualEffect.SetVector4(System.Int32,UnityEngine.Vector4)">
  1788. <summary>
  1789. <para>Sets the value of a named Vector4 or Color property.</para>
  1790. </summary>
  1791. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1792. <param name="name">The name of the property.</param>
  1793. <param name="v">The new Vector4 value.</param>
  1794. </member>
  1795. <member name="M:UnityEngine.VFX.VisualEffect.SetVector4(System.String,UnityEngine.Vector4)">
  1796. <summary>
  1797. <para>Sets the value of a named Vector4 or Color property.</para>
  1798. </summary>
  1799. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1800. <param name="name">The name of the property.</param>
  1801. <param name="v">The new Vector4 value.</param>
  1802. </member>
  1803. <member name="M:UnityEngine.VFX.VisualEffect.Simulate(System.Single,System.UInt32)">
  1804. <summary>
  1805. <para>Use this method to fast-forward the visual effect by simulating all systems for several step counts using the specified delta time.</para>
  1806. </summary>
  1807. <param name="stepDeltaTime">The delta time, in seconds, the simulation applies to each step.</param>
  1808. <param name="stepCount">Number of steps to proceed.</param>
  1809. </member>
  1810. <member name="M:UnityEngine.VFX.VisualEffect.Stop">
  1811. <summary>
  1812. <para>Use this method to send a stop event to all Spawn systems.</para>
  1813. </summary>
  1814. <param name="eventAttribute">Can be null or a VFXEventAttribute. To create a VFXEventAttribute, use VFX.VisualEffect.CreateVFXEventAttribute.</param>
  1815. </member>
  1816. <member name="M:UnityEngine.VFX.VisualEffect.Stop(UnityEngine.VFX.VFXEventAttribute)">
  1817. <summary>
  1818. <para>Use this method to send a stop event to all Spawn systems.</para>
  1819. </summary>
  1820. <param name="eventAttribute">Can be null or a VFXEventAttribute. To create a VFXEventAttribute, use VFX.VisualEffect.CreateVFXEventAttribute.</param>
  1821. </member>
  1822. <member name="T:UnityEngine.VFX.VisualEffectAsset">
  1823. <summary>
  1824. <para>This class contains a graph of the elements needed to describe a visual effect. These include: the visual effects system, generated shaders, and compiled data.</para>
  1825. </summary>
  1826. </member>
  1827. <member name="M:UnityEngine.VFX.VisualEffectAsset.#ctor">
  1828. <summary>
  1829. <para>The visual effect Asset constructor.</para>
  1830. </summary>
  1831. </member>
  1832. <member name="M:UnityEngine.VFX.VisualEffectAsset.GetEvents(System.Collections.Generic.List`1&lt;System.String&gt;)">
  1833. <summary>
  1834. <para>Gets the name of every Event connected to a system.</para>
  1835. </summary>
  1836. <param name="names">The List that this function populates with the event system names.</param>
  1837. </member>
  1838. <member name="M:UnityEngine.VFX.VisualEffectAsset.GetExposedProperties(System.Collections.Generic.List`1&lt;UnityEngine.VFX.VFXExposedProperty&gt;)">
  1839. <summary>
  1840. <para>Gets the name and type of every exposed property.</para>
  1841. </summary>
  1842. <param name="exposedProperties">The List that this function populates with exposed properties.</param>
  1843. </member>
  1844. <member name="M:UnityEngine.VFX.VisualEffectAsset.GetTextureDimension(System.Int32)">
  1845. <summary>
  1846. <para>Gets the TextureDimension of a named exposed Texture.</para>
  1847. </summary>
  1848. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1849. <param name="name">The name of the property.</param>
  1850. </member>
  1851. <member name="M:UnityEngine.VFX.VisualEffectAsset.GetTextureDimension(System.String)">
  1852. <summary>
  1853. <para>Gets the TextureDimension of a named exposed Texture.</para>
  1854. </summary>
  1855. <param name="nameID">The ID of the property. This is the same ID that Shader.PropertyToID returns.</param>
  1856. <param name="name">The name of the property.</param>
  1857. </member>
  1858. <member name="F:UnityEngine.VFX.VisualEffectAsset.PlayEventID">
  1859. <summary>
  1860. <para>The default name ID of the play event.</para>
  1861. </summary>
  1862. </member>
  1863. <member name="F:UnityEngine.VFX.VisualEffectAsset.PlayEventName">
  1864. <summary>
  1865. <para>The default name of the play event.</para>
  1866. </summary>
  1867. </member>
  1868. <member name="F:UnityEngine.VFX.VisualEffectAsset.StopEventID">
  1869. <summary>
  1870. <para>The default name ID of the stop event.</para>
  1871. </summary>
  1872. </member>
  1873. <member name="F:UnityEngine.VFX.VisualEffectAsset.StopEventName">
  1874. <summary>
  1875. <para>The default name of the stop event.</para>
  1876. </summary>
  1877. </member>
  1878. <member name="T:UnityEngine.VFX.VisualEffectObject">
  1879. <summary>
  1880. <para>This class is the base for VFX.VisualEffectAsset and VFX.VisualEffectSubgraph.</para>
  1881. </summary>
  1882. </member>
  1883. </members>
  1884. </doc>