UnityEngine.ImageConversionModule.xml 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.ImageConversionModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.ImageConversion">
  8. <summary>
  9. <para>This class provides utility and extension methods to convert image data from or to PNG, EXR, TGA, and JPEG formats.</para>
  10. </summary>
  11. </member>
  12. <member name="P:UnityEngine.ImageConversion.EnableLegacyPngGammaRuntimeLoadBehavior">
  13. <summary>
  14. <para>Enables legacy PNG runtime import behavior.</para>
  15. </summary>
  16. </member>
  17. <member name="M:UnityEngine.ImageConversion.EncodeArrayToEXR(System.Array,UnityEngine.Experimental.Rendering.GraphicsFormat,System.UInt32,System.UInt32,System.UInt32,UnityEngine.Texture2D/EXRFlags)">
  18. <summary>
  19. <para>Encodes this array into the EXR format.</para>
  20. </summary>
  21. <param name="array">The byte array to convert.</param>
  22. <param name="format">The pixel format of the image data.</param>
  23. <param name="width">The width of the image data in pixels.</param>
  24. <param name="height">The height of the image data in pixels.</param>
  25. <param name="rowBytes">The length of a single row in bytes.</param>
  26. <param name="flags">Flags used to control compression and the output format.</param>
  27. </member>
  28. <member name="M:UnityEngine.ImageConversion.EncodeArrayToJPG(System.Array,UnityEngine.Experimental.Rendering.GraphicsFormat,System.UInt32,System.UInt32,System.UInt32,System.Int32)">
  29. <summary>
  30. <para>Encodes this array into JPG format.</para>
  31. </summary>
  32. <param name="array">The byte array to convert.</param>
  33. <param name="format">The pixel format of the image data.</param>
  34. <param name="width">The width of the image data in pixels.</param>
  35. <param name="height">The height of the image data in pixels.</param>
  36. <param name="rowBytes">The length of a single row in bytes.</param>
  37. <param name="quality">JPG quality to encode with, 1..100 (default 75).</param>
  38. </member>
  39. <member name="M:UnityEngine.ImageConversion.EncodeArrayToPNG(System.Array,UnityEngine.Experimental.Rendering.GraphicsFormat,System.UInt32,System.UInt32,System.UInt32)">
  40. <summary>
  41. <para>Encodes this array into PNG format.</para>
  42. </summary>
  43. <param name="array">The byte array to convert.</param>
  44. <param name="format">The pixel format of the image data.</param>
  45. <param name="width">The width of the image data in pixels.</param>
  46. <param name="height">The height of the image data in pixels.</param>
  47. <param name="rowBytes">The length of a single row in bytes.</param>
  48. </member>
  49. <member name="M:UnityEngine.ImageConversion.EncodeArrayToTGA(System.Array,UnityEngine.Experimental.Rendering.GraphicsFormat,System.UInt32,System.UInt32,System.UInt32)">
  50. <summary>
  51. <para>Encodes this array into TGA format.</para>
  52. </summary>
  53. <param name="array">The byte array to convert.</param>
  54. <param name="format">The pixel format of the image data.</param>
  55. <param name="width">The width of the image data in pixels.</param>
  56. <param name="height">The height of the image data in pixels.</param>
  57. <param name="rowBytes">The length of a single row in bytes.</param>
  58. </member>
  59. <member name="M:UnityEngine.ImageConversion.EncodeNativeArrayToEXR(Unity.Collections.NativeArray`1&lt;T&gt;,UnityEngine.Experimental.Rendering.GraphicsFormat,System.UInt32,System.UInt32,System.UInt32,UnityEngine.Texture2D/EXRFlags)">
  60. <summary>
  61. <para>Encodes this native array into the EXR format.</para>
  62. </summary>
  63. <param name="input">The native array to convert.</param>
  64. <param name="format">The pixel format of the image data.</param>
  65. <param name="width">The width of the image data in pixels.</param>
  66. <param name="height">The height of the image data in pixels.</param>
  67. <param name="rowBytes">The length of a single row in bytes.</param>
  68. <param name="flags">Flags used to control compression and the output format.</param>
  69. </member>
  70. <member name="M:UnityEngine.ImageConversion.EncodeNativeArrayToJPG(Unity.Collections.NativeArray`1&lt;T&gt;,UnityEngine.Experimental.Rendering.GraphicsFormat,System.UInt32,System.UInt32,System.UInt32,System.Int32)">
  71. <summary>
  72. <para>Encodes this native array into JPG format.</para>
  73. </summary>
  74. <param name="input">The native array to convert.</param>
  75. <param name="format">The pixel format of the image data.</param>
  76. <param name="width">The width of the image data in pixels.</param>
  77. <param name="height">The height of the image data in pixels.</param>
  78. <param name="rowBytes">The length of a single row in bytes.</param>
  79. <param name="quality">JPG quality to encode with, 1..100 (default 75).</param>
  80. </member>
  81. <member name="M:UnityEngine.ImageConversion.EncodeNativeArrayToPNG(Unity.Collections.NativeArray`1&lt;T&gt;,UnityEngine.Experimental.Rendering.GraphicsFormat,System.UInt32,System.UInt32,System.UInt32)">
  82. <summary>
  83. <para>Encodes this native array into PNG format.</para>
  84. </summary>
  85. <param name="input">The native array to convert.</param>
  86. <param name="format">The pixel format of the image data.</param>
  87. <param name="width">The width of the image data in pixels.</param>
  88. <param name="height">The height of the image data in pixels.</param>
  89. <param name="rowBytes">The length of a single row in bytes.</param>
  90. </member>
  91. <member name="M:UnityEngine.ImageConversion.EncodeNativeArrayToTGA(Unity.Collections.NativeArray`1&lt;T&gt;,UnityEngine.Experimental.Rendering.GraphicsFormat,System.UInt32,System.UInt32,System.UInt32)">
  92. <summary>
  93. <para>Encodes this native array into TGA format.</para>
  94. </summary>
  95. <param name="input">The native array to convert.</param>
  96. <param name="format">The pixel format of the image data.</param>
  97. <param name="width">The width of the image data in pixels.</param>
  98. <param name="height">The height of the image data in pixels.</param>
  99. <param name="rowBytes">The length of a single row in bytes.</param>
  100. </member>
  101. <member name="M:UnityEngine.ImageConversion.EncodeToEXR(UnityEngine.Texture2D,UnityEngine.Texture2D/EXRFlags)">
  102. <summary>
  103. <para>Encodes this texture into the EXR format.</para>
  104. </summary>
  105. <param name="tex">The texture to convert.</param>
  106. <param name="flags">Flags used to control compression and the output format.</param>
  107. </member>
  108. <member name="M:UnityEngine.ImageConversion.EncodeToJPG(UnityEngine.Texture2D,System.Int32)">
  109. <summary>
  110. <para>Encodes this texture into JPG format.</para>
  111. </summary>
  112. <param name="tex">Text texture to convert.</param>
  113. <param name="quality">JPG quality to encode with, 1..100 (default 75).</param>
  114. </member>
  115. <member name="M:UnityEngine.ImageConversion.EncodeToJPG(UnityEngine.Texture2D)">
  116. <summary>
  117. <para>Encodes this texture into JPG format.</para>
  118. </summary>
  119. <param name="tex">Text texture to convert.</param>
  120. <param name="quality">JPG quality to encode with, 1..100 (default 75).</param>
  121. </member>
  122. <member name="M:UnityEngine.ImageConversion.EncodeToPNG(UnityEngine.Texture2D)">
  123. <summary>
  124. <para>Encodes this texture into PNG format.</para>
  125. </summary>
  126. <param name="tex">The texture to convert.</param>
  127. </member>
  128. <member name="M:UnityEngine.ImageConversion.EncodeToTGA(UnityEngine.Texture2D)">
  129. <summary>
  130. <para>Encodes the specified texture in TGA format.</para>
  131. </summary>
  132. <param name="tex">The texture to encode.</param>
  133. </member>
  134. <member name="M:UnityEngine.ImageConversion.LoadImage(UnityEngine.Texture2D,System.Byte[],System.Boolean)">
  135. <summary>
  136. <para>Loads PNG/JPG (or supported format) image byte array into a texture.</para>
  137. </summary>
  138. <param name="tex">The texture to load the image into.</param>
  139. <param name="data">The byte array containing the image data to load.</param>
  140. <param name="markNonReadable">Set to false by default, pass true to optionally mark the texture as non-readable.</param>
  141. <returns>
  142. <para>Returns true if the data can be loaded, false otherwise.</para>
  143. </returns>
  144. </member>
  145. <member name="A:UnityEngine.ImageConversionModule">
  146. <summary>
  147. <para>The ImageConversion module implements the ImageConversion class which provides helper methods to convert images from and to PNG, JPEG or EXR formats.</para>
  148. </summary>
  149. </member>
  150. </members>
  151. </doc>