Image.xml 40 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021
  1. <Type Name="Image" FullName="Urho.Image">
  2. <TypeSignature Language="C#" Value="public class Image : Urho.Resource" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Image extends Urho.Resource" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.Resource</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. %Image resource.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public Image (IntPtr handle);" />
  21. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  22. <MemberType>Constructor</MemberType>
  23. <AssemblyInfo>
  24. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  25. </AssemblyInfo>
  26. <Parameters>
  27. <Parameter Name="handle" Type="System.IntPtr" />
  28. </Parameters>
  29. <Docs>
  30. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  31. <summary>Constructs a new instance of Image, given a raw pointer to an unmanaged object</summary>
  32. <remarks>
  33. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  34. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  35. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  36. </remarks>
  37. </Docs>
  38. </Member>
  39. <Member MemberName=".ctor">
  40. <MemberSignature Language="C#" Value="public Image (Urho.Context context);" />
  41. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  42. <MemberType>Constructor</MemberType>
  43. <AssemblyInfo>
  44. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  45. </AssemblyInfo>
  46. <Parameters>
  47. <Parameter Name="context" Type="Urho.Context" />
  48. </Parameters>
  49. <Docs>
  50. <param name="context">The context that this object will be attached to.</param>
  51. <summary>Creates an instance of Image that is attached to an execution context.</summary>
  52. <remarks>
  53. <para>This creates an instance of Image attached to the specified execution context.</para>
  54. </remarks>
  55. </Docs>
  56. </Member>
  57. <Member MemberName=".ctor">
  58. <MemberSignature Language="C#" Value="public Image (Urho.UrhoObjectFlag emptyFlag);" />
  59. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  60. <MemberType>Constructor</MemberType>
  61. <AssemblyInfo>
  62. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  63. </AssemblyInfo>
  64. <Parameters>
  65. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  66. </Parameters>
  67. <Docs>
  68. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  69. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  70. <remarks>
  71. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  72. <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
  73. <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
  74. </remarks>
  75. </Docs>
  76. </Member>
  77. <Member MemberName="BaseType">
  78. <MemberSignature Language="C#" Value="public override Urho.StringHash BaseType { get; }" />
  79. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash BaseType" />
  80. <MemberType>Property</MemberType>
  81. <AssemblyInfo>
  82. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  83. </AssemblyInfo>
  84. <ReturnValue>
  85. <ReturnType>Urho.StringHash</ReturnType>
  86. </ReturnValue>
  87. <Docs>
  88. <summary>Urho's type system base type.</summary>
  89. <value>StringHash representing the base type for this Urho type.</value>
  90. <remarks>This returns the Urho type system base type and is surfaced for low-level Urho code.</remarks>
  91. </Docs>
  92. </Member>
  93. <Member MemberName="Clear">
  94. <MemberSignature Language="C#" Value="public void Clear (Urho.Color color);" />
  95. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Clear(valuetype Urho.Color color) cil managed" />
  96. <MemberType>Method</MemberType>
  97. <AssemblyInfo>
  98. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  99. </AssemblyInfo>
  100. <ReturnValue>
  101. <ReturnType>System.Void</ReturnType>
  102. </ReturnValue>
  103. <Parameters>
  104. <Parameter Name="color" Type="Urho.Color" />
  105. </Parameters>
  106. <Docs>
  107. <param name="color">To be added.</param>
  108. <summary>
  109. Clear the image with a color.
  110. </summary>
  111. <remarks>To be added.</remarks>
  112. </Docs>
  113. </Member>
  114. <Member MemberName="ClearInt">
  115. <MemberSignature Language="C#" Value="public void ClearInt (uint uintColor);" />
  116. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ClearInt(unsigned int32 uintColor) cil managed" />
  117. <MemberType>Method</MemberType>
  118. <AssemblyInfo>
  119. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  120. </AssemblyInfo>
  121. <ReturnValue>
  122. <ReturnType>System.Void</ReturnType>
  123. </ReturnValue>
  124. <Parameters>
  125. <Parameter Name="uintColor" Type="System.UInt32" />
  126. </Parameters>
  127. <Docs>
  128. <param name="uintColor">To be added.</param>
  129. <summary>
  130. Clear the image with an integer color. R component is in the 8 lowest bits.
  131. </summary>
  132. <remarks>To be added.</remarks>
  133. </Docs>
  134. </Member>
  135. <Member MemberName="Components">
  136. <MemberSignature Language="C#" Value="public uint Components { get; }" />
  137. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 Components" />
  138. <MemberType>Property</MemberType>
  139. <AssemblyInfo>
  140. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  141. </AssemblyInfo>
  142. <ReturnValue>
  143. <ReturnType>System.UInt32</ReturnType>
  144. </ReturnValue>
  145. <Docs>
  146. <summary>
  147. Return number of color components.
  148. </summary>
  149. <value>To be added.</value>
  150. <remarks>To be added.</remarks>
  151. </Docs>
  152. </Member>
  153. <Member MemberName="CompressedFormat">
  154. <MemberSignature Language="C#" Value="public Urho.CompressedFormat CompressedFormat { get; }" />
  155. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.CompressedFormat CompressedFormat" />
  156. <MemberType>Property</MemberType>
  157. <AssemblyInfo>
  158. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  159. </AssemblyInfo>
  160. <ReturnValue>
  161. <ReturnType>Urho.CompressedFormat</ReturnType>
  162. </ReturnValue>
  163. <Docs>
  164. <summary>
  165. Return compressed format.
  166. </summary>
  167. <value>To be added.</value>
  168. <remarks>To be added.</remarks>
  169. </Docs>
  170. </Member>
  171. <Member MemberName="ConvertToRGBA">
  172. <MemberSignature Language="C#" Value="public Urho.Image ConvertToRGBA ();" />
  173. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Image ConvertToRGBA() cil managed" />
  174. <MemberType>Method</MemberType>
  175. <AssemblyInfo>
  176. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  177. </AssemblyInfo>
  178. <ReturnValue>
  179. <ReturnType>Urho.Image</ReturnType>
  180. </ReturnValue>
  181. <Parameters />
  182. <Docs>
  183. <summary>
  184. Return image converted to 4-component (RGBA) to circumvent modern rendering API's not supporting e.g. the luminance-alpha format.
  185. </summary>
  186. <returns>To be added.</returns>
  187. <remarks>To be added.</remarks>
  188. </Docs>
  189. </Member>
  190. <Member MemberName="Data">
  191. <MemberSignature Language="C#" Value="public byte* Data { get; }" />
  192. <MemberSignature Language="ILAsm" Value=".property instance unsigned int8* Data" />
  193. <MemberType>Property</MemberType>
  194. <AssemblyInfo>
  195. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  196. </AssemblyInfo>
  197. <ReturnValue>
  198. <ReturnType>System.Byte*</ReturnType>
  199. </ReturnValue>
  200. <Docs>
  201. <summary>
  202. Return pixel data.
  203. </summary>
  204. <value>To be added.</value>
  205. <remarks>To be added.</remarks>
  206. </Docs>
  207. </Member>
  208. <Member MemberName="Depth">
  209. <MemberSignature Language="C#" Value="public int Depth { get; }" />
  210. <MemberSignature Language="ILAsm" Value=".property instance int32 Depth" />
  211. <MemberType>Property</MemberType>
  212. <AssemblyInfo>
  213. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  214. </AssemblyInfo>
  215. <ReturnValue>
  216. <ReturnType>System.Int32</ReturnType>
  217. </ReturnValue>
  218. <Docs>
  219. <summary>
  220. Return depth.
  221. </summary>
  222. <value>To be added.</value>
  223. <remarks>To be added.</remarks>
  224. </Docs>
  225. </Member>
  226. <Member MemberName="FlipHorizontal">
  227. <MemberSignature Language="C#" Value="public bool FlipHorizontal ();" />
  228. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool FlipHorizontal() cil managed" />
  229. <MemberType>Method</MemberType>
  230. <AssemblyInfo>
  231. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  232. </AssemblyInfo>
  233. <ReturnValue>
  234. <ReturnType>System.Boolean</ReturnType>
  235. </ReturnValue>
  236. <Parameters />
  237. <Docs>
  238. <summary>
  239. Flip image horizontally. Return true if successful.
  240. </summary>
  241. <returns>To be added.</returns>
  242. <remarks>To be added.</remarks>
  243. </Docs>
  244. </Member>
  245. <Member MemberName="FlipVertical">
  246. <MemberSignature Language="C#" Value="public bool FlipVertical ();" />
  247. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool FlipVertical() cil managed" />
  248. <MemberType>Method</MemberType>
  249. <AssemblyInfo>
  250. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  251. </AssemblyInfo>
  252. <ReturnValue>
  253. <ReturnType>System.Boolean</ReturnType>
  254. </ReturnValue>
  255. <Parameters />
  256. <Docs>
  257. <summary>
  258. Flip image vertically. Return true if successful.
  259. </summary>
  260. <returns>To be added.</returns>
  261. <remarks>To be added.</remarks>
  262. </Docs>
  263. </Member>
  264. <Member MemberName="GetCompressedLevel">
  265. <MemberSignature Language="C#" Value="public Urho.CompressedLevel GetCompressedLevel (uint index);" />
  266. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.CompressedLevel GetCompressedLevel(unsigned int32 index) cil managed" />
  267. <MemberType>Method</MemberType>
  268. <AssemblyInfo>
  269. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  270. </AssemblyInfo>
  271. <ReturnValue>
  272. <ReturnType>Urho.CompressedLevel</ReturnType>
  273. </ReturnValue>
  274. <Parameters>
  275. <Parameter Name="index" Type="System.UInt32" />
  276. </Parameters>
  277. <Docs>
  278. <param name="index">To be added.</param>
  279. <summary>
  280. Return a compressed mip level.
  281. </summary>
  282. <returns>To be added.</returns>
  283. <remarks>To be added.</remarks>
  284. </Docs>
  285. </Member>
  286. <Member MemberName="GetPixel">
  287. <MemberSignature Language="C#" Value="public Urho.Color GetPixel (int x, int y);" />
  288. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Color GetPixel(int32 x, int32 y) cil managed" />
  289. <MemberType>Method</MemberType>
  290. <AssemblyInfo>
  291. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  292. </AssemblyInfo>
  293. <ReturnValue>
  294. <ReturnType>Urho.Color</ReturnType>
  295. </ReturnValue>
  296. <Parameters>
  297. <Parameter Name="x" Type="System.Int32" />
  298. <Parameter Name="y" Type="System.Int32" />
  299. </Parameters>
  300. <Docs>
  301. <param name="x">To be added.</param>
  302. <param name="y">To be added.</param>
  303. <summary>
  304. Return a 2D pixel color.
  305. </summary>
  306. <returns>To be added.</returns>
  307. <remarks>To be added.</remarks>
  308. </Docs>
  309. </Member>
  310. <Member MemberName="GetPixel">
  311. <MemberSignature Language="C#" Value="public Urho.Color GetPixel (int x, int y, int z);" />
  312. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Color GetPixel(int32 x, int32 y, int32 z) cil managed" />
  313. <MemberType>Method</MemberType>
  314. <AssemblyInfo>
  315. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  316. </AssemblyInfo>
  317. <ReturnValue>
  318. <ReturnType>Urho.Color</ReturnType>
  319. </ReturnValue>
  320. <Parameters>
  321. <Parameter Name="x" Type="System.Int32" />
  322. <Parameter Name="y" Type="System.Int32" />
  323. <Parameter Name="z" Type="System.Int32" />
  324. </Parameters>
  325. <Docs>
  326. <param name="x">To be added.</param>
  327. <param name="y">To be added.</param>
  328. <param name="z">To be added.</param>
  329. <summary>
  330. Return a 3D pixel color.
  331. </summary>
  332. <returns>To be added.</returns>
  333. <remarks>To be added.</remarks>
  334. </Docs>
  335. </Member>
  336. <Member MemberName="GetPixelBilinear">
  337. <MemberSignature Language="C#" Value="public Urho.Color GetPixelBilinear (float x, float y);" />
  338. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Color GetPixelBilinear(float32 x, float32 y) cil managed" />
  339. <MemberType>Method</MemberType>
  340. <AssemblyInfo>
  341. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  342. </AssemblyInfo>
  343. <ReturnValue>
  344. <ReturnType>Urho.Color</ReturnType>
  345. </ReturnValue>
  346. <Parameters>
  347. <Parameter Name="x" Type="System.Single" />
  348. <Parameter Name="y" Type="System.Single" />
  349. </Parameters>
  350. <Docs>
  351. <param name="x">To be added.</param>
  352. <param name="y">To be added.</param>
  353. <summary>
  354. Return a bilinearly sampled 2D pixel color. X and Y have the range 0-1.
  355. </summary>
  356. <returns>To be added.</returns>
  357. <remarks>To be added.</remarks>
  358. </Docs>
  359. </Member>
  360. <Member MemberName="GetPixelInt">
  361. <MemberSignature Language="C#" Value="public uint GetPixelInt (int x, int y);" />
  362. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int32 GetPixelInt(int32 x, int32 y) cil managed" />
  363. <MemberType>Method</MemberType>
  364. <AssemblyInfo>
  365. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  366. </AssemblyInfo>
  367. <ReturnValue>
  368. <ReturnType>System.UInt32</ReturnType>
  369. </ReturnValue>
  370. <Parameters>
  371. <Parameter Name="x" Type="System.Int32" />
  372. <Parameter Name="y" Type="System.Int32" />
  373. </Parameters>
  374. <Docs>
  375. <param name="x">To be added.</param>
  376. <param name="y">To be added.</param>
  377. <summary>
  378. Return a 2D pixel integer color. R component is in the 8 lowest bits.
  379. </summary>
  380. <returns>To be added.</returns>
  381. <remarks>To be added.</remarks>
  382. </Docs>
  383. </Member>
  384. <Member MemberName="GetPixelInt">
  385. <MemberSignature Language="C#" Value="public uint GetPixelInt (int x, int y, int z);" />
  386. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int32 GetPixelInt(int32 x, int32 y, int32 z) cil managed" />
  387. <MemberType>Method</MemberType>
  388. <AssemblyInfo>
  389. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  390. </AssemblyInfo>
  391. <ReturnValue>
  392. <ReturnType>System.UInt32</ReturnType>
  393. </ReturnValue>
  394. <Parameters>
  395. <Parameter Name="x" Type="System.Int32" />
  396. <Parameter Name="y" Type="System.Int32" />
  397. <Parameter Name="z" Type="System.Int32" />
  398. </Parameters>
  399. <Docs>
  400. <param name="x">To be added.</param>
  401. <param name="y">To be added.</param>
  402. <param name="z">To be added.</param>
  403. <summary>
  404. Return a 3D pixel integer color. R component is in the 8 lowest bits.
  405. </summary>
  406. <returns>To be added.</returns>
  407. <remarks>To be added.</remarks>
  408. </Docs>
  409. </Member>
  410. <Member MemberName="GetPixelTrilinear">
  411. <MemberSignature Language="C#" Value="public Urho.Color GetPixelTrilinear (float x, float y, float z);" />
  412. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Color GetPixelTrilinear(float32 x, float32 y, float32 z) cil managed" />
  413. <MemberType>Method</MemberType>
  414. <AssemblyInfo>
  415. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  416. </AssemblyInfo>
  417. <ReturnValue>
  418. <ReturnType>Urho.Color</ReturnType>
  419. </ReturnValue>
  420. <Parameters>
  421. <Parameter Name="x" Type="System.Single" />
  422. <Parameter Name="y" Type="System.Single" />
  423. <Parameter Name="z" Type="System.Single" />
  424. </Parameters>
  425. <Docs>
  426. <param name="x">To be added.</param>
  427. <param name="y">To be added.</param>
  428. <param name="z">To be added.</param>
  429. <summary>
  430. Return a trilinearly sampled 3D pixel color. X, Y and Z have the range 0-1.
  431. </summary>
  432. <returns>To be added.</returns>
  433. <remarks>To be added.</remarks>
  434. </Docs>
  435. </Member>
  436. <Member MemberName="GetSubimage">
  437. <MemberSignature Language="C#" Value="public Urho.Image GetSubimage (Urho.IntRect rect);" />
  438. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Image GetSubimage(valuetype Urho.IntRect rect) cil managed" />
  439. <MemberType>Method</MemberType>
  440. <AssemblyInfo>
  441. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  442. </AssemblyInfo>
  443. <ReturnValue>
  444. <ReturnType>Urho.Image</ReturnType>
  445. </ReturnValue>
  446. <Parameters>
  447. <Parameter Name="rect" Type="Urho.IntRect" />
  448. </Parameters>
  449. <Docs>
  450. <param name="rect">To be added.</param>
  451. <summary>
  452. Return subimage from the image by the defined rect or null if failed. 3D images are not supported. You must free the subimage yourself.
  453. </summary>
  454. <returns>To be added.</returns>
  455. <remarks>To be added.</remarks>
  456. </Docs>
  457. </Member>
  458. <Member MemberName="Height">
  459. <MemberSignature Language="C#" Value="public int Height { get; }" />
  460. <MemberSignature Language="ILAsm" Value=".property instance int32 Height" />
  461. <MemberType>Property</MemberType>
  462. <AssemblyInfo>
  463. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  464. </AssemblyInfo>
  465. <ReturnValue>
  466. <ReturnType>System.Int32</ReturnType>
  467. </ReturnValue>
  468. <Docs>
  469. <summary>
  470. Return height.
  471. </summary>
  472. <value>To be added.</value>
  473. <remarks>To be added.</remarks>
  474. </Docs>
  475. </Member>
  476. <Member MemberName="IsArray">
  477. <MemberSignature Language="C#" Value="public bool IsArray ();" />
  478. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsArray() cil managed" />
  479. <MemberType>Method</MemberType>
  480. <AssemblyInfo>
  481. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  482. </AssemblyInfo>
  483. <ReturnValue>
  484. <ReturnType>System.Boolean</ReturnType>
  485. </ReturnValue>
  486. <Parameters />
  487. <Docs>
  488. <summary>
  489. Whether this texture has been detected as a volume, only relevant for DDS.
  490. </summary>
  491. <returns>To be added.</returns>
  492. <remarks>To be added.</remarks>
  493. </Docs>
  494. </Member>
  495. <Member MemberName="IsCompressed">
  496. <MemberSignature Language="C#" Value="public bool IsCompressed ();" />
  497. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsCompressed() cil managed" />
  498. <MemberType>Method</MemberType>
  499. <AssemblyInfo>
  500. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  501. </AssemblyInfo>
  502. <ReturnValue>
  503. <ReturnType>System.Boolean</ReturnType>
  504. </ReturnValue>
  505. <Parameters />
  506. <Docs>
  507. <summary>
  508. Return whether is compressed.
  509. </summary>
  510. <returns>To be added.</returns>
  511. <remarks>To be added.</remarks>
  512. </Docs>
  513. </Member>
  514. <Member MemberName="IsCubemap">
  515. <MemberSignature Language="C#" Value="public bool IsCubemap ();" />
  516. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsCubemap() cil managed" />
  517. <MemberType>Method</MemberType>
  518. <AssemblyInfo>
  519. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  520. </AssemblyInfo>
  521. <ReturnValue>
  522. <ReturnType>System.Boolean</ReturnType>
  523. </ReturnValue>
  524. <Parameters />
  525. <Docs>
  526. <summary>
  527. Whether this texture is detected as a cubemap, only relevant for DDS.
  528. </summary>
  529. <returns>To be added.</returns>
  530. <remarks>To be added.</remarks>
  531. </Docs>
  532. </Member>
  533. <Member MemberName="IsSRGB">
  534. <MemberSignature Language="C#" Value="public bool IsSRGB ();" />
  535. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsSRGB() cil managed" />
  536. <MemberType>Method</MemberType>
  537. <AssemblyInfo>
  538. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  539. </AssemblyInfo>
  540. <ReturnValue>
  541. <ReturnType>System.Boolean</ReturnType>
  542. </ReturnValue>
  543. <Parameters />
  544. <Docs>
  545. <summary>
  546. Whether this texture is in sRGB, only relevant for DDS.
  547. </summary>
  548. <returns>To be added.</returns>
  549. <remarks>To be added.</remarks>
  550. </Docs>
  551. </Member>
  552. <Member MemberName="NextLevel">
  553. <MemberSignature Language="C#" Value="public Urho.Image NextLevel { get; }" />
  554. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Image NextLevel" />
  555. <MemberType>Property</MemberType>
  556. <AssemblyInfo>
  557. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  558. </AssemblyInfo>
  559. <ReturnValue>
  560. <ReturnType>Urho.Image</ReturnType>
  561. </ReturnValue>
  562. <Docs>
  563. <summary>
  564. Return next mip level by bilinear filtering.
  565. </summary>
  566. <value>To be added.</value>
  567. <remarks>To be added.</remarks>
  568. </Docs>
  569. </Member>
  570. <Member MemberName="NextSibling">
  571. <MemberSignature Language="C#" Value="public Urho.Image NextSibling { get; }" />
  572. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Image NextSibling" />
  573. <MemberType>Property</MemberType>
  574. <AssemblyInfo>
  575. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  576. </AssemblyInfo>
  577. <ReturnValue>
  578. <ReturnType>Urho.Image</ReturnType>
  579. </ReturnValue>
  580. <Docs>
  581. <summary>
  582. Return the next sibling image of an array or cubemap.
  583. </summary>
  584. <value>To be added.</value>
  585. <remarks>To be added.</remarks>
  586. </Docs>
  587. </Member>
  588. <Member MemberName="NumCompressedLevels">
  589. <MemberSignature Language="C#" Value="public uint NumCompressedLevels { get; }" />
  590. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumCompressedLevels" />
  591. <MemberType>Property</MemberType>
  592. <AssemblyInfo>
  593. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  594. </AssemblyInfo>
  595. <ReturnValue>
  596. <ReturnType>System.UInt32</ReturnType>
  597. </ReturnValue>
  598. <Docs>
  599. <summary>
  600. Return number of compressed mip levels.
  601. </summary>
  602. <value>To be added.</value>
  603. <remarks>To be added.</remarks>
  604. </Docs>
  605. </Member>
  606. <Member MemberName="PrecalculateLevels">
  607. <MemberSignature Language="C#" Value="public void PrecalculateLevels ();" />
  608. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void PrecalculateLevels() cil managed" />
  609. <MemberType>Method</MemberType>
  610. <AssemblyInfo>
  611. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  612. </AssemblyInfo>
  613. <ReturnValue>
  614. <ReturnType>System.Void</ReturnType>
  615. </ReturnValue>
  616. <Parameters />
  617. <Docs>
  618. <summary>
  619. Precalculate the mip levels. Used by asynchronous texture loading.
  620. </summary>
  621. <remarks>To be added.</remarks>
  622. </Docs>
  623. </Member>
  624. <Member MemberName="RegisterObject">
  625. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  626. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  627. <MemberType>Method</MemberType>
  628. <AssemblyInfo>
  629. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  630. </AssemblyInfo>
  631. <ReturnValue>
  632. <ReturnType>System.Void</ReturnType>
  633. </ReturnValue>
  634. <Parameters>
  635. <Parameter Name="context" Type="Urho.Context" />
  636. </Parameters>
  637. <Docs>
  638. <param name="context">To be added.</param>
  639. <summary>
  640. Register object factory.
  641. </summary>
  642. <remarks>To be added.</remarks>
  643. </Docs>
  644. </Member>
  645. <Member MemberName="Resize">
  646. <MemberSignature Language="C#" Value="public bool Resize (int width, int height);" />
  647. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Resize(int32 width, int32 height) cil managed" />
  648. <MemberType>Method</MemberType>
  649. <AssemblyInfo>
  650. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  651. </AssemblyInfo>
  652. <ReturnValue>
  653. <ReturnType>System.Boolean</ReturnType>
  654. </ReturnValue>
  655. <Parameters>
  656. <Parameter Name="width" Type="System.Int32" />
  657. <Parameter Name="height" Type="System.Int32" />
  658. </Parameters>
  659. <Docs>
  660. <param name="width">To be added.</param>
  661. <param name="height">To be added.</param>
  662. <summary>
  663. Resize image by bilinear resampling. Return true if successful.
  664. </summary>
  665. <returns>To be added.</returns>
  666. <remarks>To be added.</remarks>
  667. </Docs>
  668. </Member>
  669. <Member MemberName="SaveBMP">
  670. <MemberSignature Language="C#" Value="public bool SaveBMP (string fileName);" />
  671. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SaveBMP(string fileName) cil managed" />
  672. <MemberType>Method</MemberType>
  673. <AssemblyInfo>
  674. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  675. </AssemblyInfo>
  676. <ReturnValue>
  677. <ReturnType>System.Boolean</ReturnType>
  678. </ReturnValue>
  679. <Parameters>
  680. <Parameter Name="fileName" Type="System.String" />
  681. </Parameters>
  682. <Docs>
  683. <param name="fileName">To be added.</param>
  684. <summary>
  685. Save in BMP format. Return true if successful.
  686. </summary>
  687. <returns>To be added.</returns>
  688. <remarks>To be added.</remarks>
  689. </Docs>
  690. </Member>
  691. <Member MemberName="SaveJPG">
  692. <MemberSignature Language="C#" Value="public bool SaveJPG (string fileName, int quality);" />
  693. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SaveJPG(string fileName, int32 quality) cil managed" />
  694. <MemberType>Method</MemberType>
  695. <AssemblyInfo>
  696. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  697. </AssemblyInfo>
  698. <ReturnValue>
  699. <ReturnType>System.Boolean</ReturnType>
  700. </ReturnValue>
  701. <Parameters>
  702. <Parameter Name="fileName" Type="System.String" />
  703. <Parameter Name="quality" Type="System.Int32" />
  704. </Parameters>
  705. <Docs>
  706. <param name="fileName">To be added.</param>
  707. <param name="quality">To be added.</param>
  708. <summary>
  709. Save in JPG format with compression quality. Return true if successful.
  710. </summary>
  711. <returns>To be added.</returns>
  712. <remarks>To be added.</remarks>
  713. </Docs>
  714. </Member>
  715. <Member MemberName="SavePNG">
  716. <MemberSignature Language="C#" Value="public bool SavePNG (string fileName);" />
  717. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SavePNG(string fileName) cil managed" />
  718. <MemberType>Method</MemberType>
  719. <AssemblyInfo>
  720. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  721. </AssemblyInfo>
  722. <ReturnValue>
  723. <ReturnType>System.Boolean</ReturnType>
  724. </ReturnValue>
  725. <Parameters>
  726. <Parameter Name="fileName" Type="System.String" />
  727. </Parameters>
  728. <Docs>
  729. <param name="fileName">To be added.</param>
  730. <summary>
  731. Save in PNG format. Return true if successful.
  732. </summary>
  733. <returns>To be added.</returns>
  734. <remarks>To be added.</remarks>
  735. </Docs>
  736. </Member>
  737. <Member MemberName="SaveTGA">
  738. <MemberSignature Language="C#" Value="public bool SaveTGA (string fileName);" />
  739. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SaveTGA(string fileName) cil managed" />
  740. <MemberType>Method</MemberType>
  741. <AssemblyInfo>
  742. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  743. </AssemblyInfo>
  744. <ReturnValue>
  745. <ReturnType>System.Boolean</ReturnType>
  746. </ReturnValue>
  747. <Parameters>
  748. <Parameter Name="fileName" Type="System.String" />
  749. </Parameters>
  750. <Docs>
  751. <param name="fileName">To be added.</param>
  752. <summary>
  753. Save in TGA format. Return true if successful.
  754. </summary>
  755. <returns>To be added.</returns>
  756. <remarks>To be added.</remarks>
  757. </Docs>
  758. </Member>
  759. <Member MemberName="SetData">
  760. <MemberSignature Language="C#" Value="public void SetData (byte* pixelData);" />
  761. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetData(unsigned int8* pixelData) cil managed" />
  762. <MemberType>Method</MemberType>
  763. <AssemblyInfo>
  764. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  765. </AssemblyInfo>
  766. <ReturnValue>
  767. <ReturnType>System.Void</ReturnType>
  768. </ReturnValue>
  769. <Parameters>
  770. <Parameter Name="pixelData" Type="System.Byte*" />
  771. </Parameters>
  772. <Docs>
  773. <param name="pixelData">To be added.</param>
  774. <summary>
  775. Set new image data.
  776. </summary>
  777. <remarks>To be added.</remarks>
  778. </Docs>
  779. </Member>
  780. <Member MemberName="SetPixel">
  781. <MemberSignature Language="C#" Value="public void SetPixel (int x, int y, Urho.Color color);" />
  782. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPixel(int32 x, int32 y, valuetype Urho.Color color) cil managed" />
  783. <MemberType>Method</MemberType>
  784. <AssemblyInfo>
  785. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  786. </AssemblyInfo>
  787. <ReturnValue>
  788. <ReturnType>System.Void</ReturnType>
  789. </ReturnValue>
  790. <Parameters>
  791. <Parameter Name="x" Type="System.Int32" />
  792. <Parameter Name="y" Type="System.Int32" />
  793. <Parameter Name="color" Type="Urho.Color" />
  794. </Parameters>
  795. <Docs>
  796. <param name="x">To be added.</param>
  797. <param name="y">To be added.</param>
  798. <param name="color">To be added.</param>
  799. <summary>
  800. Set a 2D pixel.
  801. </summary>
  802. <remarks>To be added.</remarks>
  803. </Docs>
  804. </Member>
  805. <Member MemberName="SetPixel">
  806. <MemberSignature Language="C#" Value="public void SetPixel (int x, int y, int z, Urho.Color color);" />
  807. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPixel(int32 x, int32 y, int32 z, valuetype Urho.Color color) cil managed" />
  808. <MemberType>Method</MemberType>
  809. <AssemblyInfo>
  810. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  811. </AssemblyInfo>
  812. <ReturnValue>
  813. <ReturnType>System.Void</ReturnType>
  814. </ReturnValue>
  815. <Parameters>
  816. <Parameter Name="x" Type="System.Int32" />
  817. <Parameter Name="y" Type="System.Int32" />
  818. <Parameter Name="z" Type="System.Int32" />
  819. <Parameter Name="color" Type="Urho.Color" />
  820. </Parameters>
  821. <Docs>
  822. <param name="x">To be added.</param>
  823. <param name="y">To be added.</param>
  824. <param name="z">To be added.</param>
  825. <param name="color">To be added.</param>
  826. <summary>
  827. Set a 3D pixel.
  828. </summary>
  829. <remarks>To be added.</remarks>
  830. </Docs>
  831. </Member>
  832. <Member MemberName="SetPixelInt">
  833. <MemberSignature Language="C#" Value="public void SetPixelInt (int x, int y, uint uintColor);" />
  834. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPixelInt(int32 x, int32 y, unsigned int32 uintColor) cil managed" />
  835. <MemberType>Method</MemberType>
  836. <AssemblyInfo>
  837. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  838. </AssemblyInfo>
  839. <ReturnValue>
  840. <ReturnType>System.Void</ReturnType>
  841. </ReturnValue>
  842. <Parameters>
  843. <Parameter Name="x" Type="System.Int32" />
  844. <Parameter Name="y" Type="System.Int32" />
  845. <Parameter Name="uintColor" Type="System.UInt32" />
  846. </Parameters>
  847. <Docs>
  848. <param name="x">To be added.</param>
  849. <param name="y">To be added.</param>
  850. <param name="uintColor">To be added.</param>
  851. <summary>
  852. Set a 2D pixel with an integer color. R component is in the 8 lowest bits.
  853. </summary>
  854. <remarks>To be added.</remarks>
  855. </Docs>
  856. </Member>
  857. <Member MemberName="SetPixelInt">
  858. <MemberSignature Language="C#" Value="public void SetPixelInt (int x, int y, int z, uint uintColor);" />
  859. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPixelInt(int32 x, int32 y, int32 z, unsigned int32 uintColor) cil managed" />
  860. <MemberType>Method</MemberType>
  861. <AssemblyInfo>
  862. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  863. </AssemblyInfo>
  864. <ReturnValue>
  865. <ReturnType>System.Void</ReturnType>
  866. </ReturnValue>
  867. <Parameters>
  868. <Parameter Name="x" Type="System.Int32" />
  869. <Parameter Name="y" Type="System.Int32" />
  870. <Parameter Name="z" Type="System.Int32" />
  871. <Parameter Name="uintColor" Type="System.UInt32" />
  872. </Parameters>
  873. <Docs>
  874. <param name="x">To be added.</param>
  875. <param name="y">To be added.</param>
  876. <param name="z">To be added.</param>
  877. <param name="uintColor">To be added.</param>
  878. <summary>
  879. Set a 3D pixel with an integer color. R component is in the 8 lowest bits.
  880. </summary>
  881. <remarks>To be added.</remarks>
  882. </Docs>
  883. </Member>
  884. <Member MemberName="SetSize">
  885. <MemberSignature Language="C#" Value="public bool SetSize (int width, int height, uint components);" />
  886. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetSize(int32 width, int32 height, unsigned int32 components) cil managed" />
  887. <MemberType>Method</MemberType>
  888. <AssemblyInfo>
  889. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  890. </AssemblyInfo>
  891. <ReturnValue>
  892. <ReturnType>System.Boolean</ReturnType>
  893. </ReturnValue>
  894. <Parameters>
  895. <Parameter Name="width" Type="System.Int32" />
  896. <Parameter Name="height" Type="System.Int32" />
  897. <Parameter Name="components" Type="System.UInt32" />
  898. </Parameters>
  899. <Docs>
  900. <param name="width">To be added.</param>
  901. <param name="height">To be added.</param>
  902. <param name="components">To be added.</param>
  903. <summary>
  904. Set 2D size and number of color components. Old image data will be destroyed and new data is undefined. Return true if successful.
  905. </summary>
  906. <returns>To be added.</returns>
  907. <remarks>To be added.</remarks>
  908. </Docs>
  909. </Member>
  910. <Member MemberName="SetSize">
  911. <MemberSignature Language="C#" Value="public bool SetSize (int width, int height, int depth, uint components);" />
  912. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetSize(int32 width, int32 height, int32 depth, unsigned int32 components) cil managed" />
  913. <MemberType>Method</MemberType>
  914. <AssemblyInfo>
  915. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  916. </AssemblyInfo>
  917. <ReturnValue>
  918. <ReturnType>System.Boolean</ReturnType>
  919. </ReturnValue>
  920. <Parameters>
  921. <Parameter Name="width" Type="System.Int32" />
  922. <Parameter Name="height" Type="System.Int32" />
  923. <Parameter Name="depth" Type="System.Int32" />
  924. <Parameter Name="components" Type="System.UInt32" />
  925. </Parameters>
  926. <Docs>
  927. <param name="width">To be added.</param>
  928. <param name="height">To be added.</param>
  929. <param name="depth">To be added.</param>
  930. <param name="components">To be added.</param>
  931. <summary>
  932. Set 3D size and number of color components. Old image data will be destroyed and new data is undefined. Return true if successful.
  933. </summary>
  934. <returns>To be added.</returns>
  935. <remarks>To be added.</remarks>
  936. </Docs>
  937. </Member>
  938. <Member MemberName="Type">
  939. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  940. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  941. <MemberType>Property</MemberType>
  942. <AssemblyInfo>
  943. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  944. </AssemblyInfo>
  945. <ReturnValue>
  946. <ReturnType>Urho.StringHash</ReturnType>
  947. </ReturnValue>
  948. <Docs>
  949. <summary>Urho's type system type.</summary>
  950. <value>StringHash representing the type for this C# type.</value>
  951. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  952. </Docs>
  953. </Member>
  954. <Member MemberName="TypeName">
  955. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  956. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  957. <MemberType>Property</MemberType>
  958. <AssemblyInfo>
  959. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  960. </AssemblyInfo>
  961. <ReturnValue>
  962. <ReturnType>System.String</ReturnType>
  963. </ReturnValue>
  964. <Docs>
  965. <summary>Urho's low-level type name.</summary>
  966. <value>Stringified low-level type name.</value>
  967. <remarks></remarks>
  968. </Docs>
  969. </Member>
  970. <Member MemberName="TypeNameStatic">
  971. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  972. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  973. <MemberType>Property</MemberType>
  974. <AssemblyInfo>
  975. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  976. </AssemblyInfo>
  977. <ReturnValue>
  978. <ReturnType>System.String</ReturnType>
  979. </ReturnValue>
  980. <Docs>
  981. <summary>Urho's low-level type name, accessible as a static method.</summary>
  982. <value>Stringified low-level type name.</value>
  983. <remarks></remarks>
  984. </Docs>
  985. </Member>
  986. <Member MemberName="TypeStatic">
  987. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  988. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  989. <MemberType>Property</MemberType>
  990. <AssemblyInfo>
  991. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  992. </AssemblyInfo>
  993. <ReturnValue>
  994. <ReturnType>Urho.StringHash</ReturnType>
  995. </ReturnValue>
  996. <Docs>
  997. <summary>To be added.</summary>
  998. <value>To be added.</value>
  999. <remarks>To be added.</remarks>
  1000. </Docs>
  1001. </Member>
  1002. <Member MemberName="Width">
  1003. <MemberSignature Language="C#" Value="public int Width { get; }" />
  1004. <MemberSignature Language="ILAsm" Value=".property instance int32 Width" />
  1005. <MemberType>Property</MemberType>
  1006. <AssemblyInfo>
  1007. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1008. </AssemblyInfo>
  1009. <ReturnValue>
  1010. <ReturnType>System.Int32</ReturnType>
  1011. </ReturnValue>
  1012. <Docs>
  1013. <summary>
  1014. Return width.
  1015. </summary>
  1016. <value>To be added.</value>
  1017. <remarks>To be added.</remarks>
  1018. </Docs>
  1019. </Member>
  1020. </Members>
  1021. </Type>