ManagedSquish.XML 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>ManagedSquish</name>
  5. </assembly>
  6. <members>
  7. <member name="T:ManagedSquish.SquishFlags">
  8. <summary>
  9. Flags used when compressing/decompressing DXT data. These are the same values as defined in squish.h.
  10. </summary>
  11. </member>
  12. <member name="F:ManagedSquish.SquishFlags.Dxt1">
  13. <summary>
  14. Use DXT1 compression.
  15. </summary>
  16. </member>
  17. <member name="F:ManagedSquish.SquishFlags.Dxt3">
  18. <summary>
  19. Use DXT3 compression.
  20. </summary>
  21. </member>
  22. <member name="F:ManagedSquish.SquishFlags.Dxt5">
  23. <summary>
  24. Use DXT5 compression.
  25. </summary>
  26. </member>
  27. <member name="F:ManagedSquish.SquishFlags.ColourIterativeClusterFit">
  28. <summary>
  29. Use a very slow but very high quality colour compressor.
  30. </summary>
  31. </member>
  32. <member name="F:ManagedSquish.SquishFlags.ColourClusterFit">
  33. <summary>
  34. Use a slow but high quality colour compressor (the default).
  35. </summary>
  36. </member>
  37. <member name="F:ManagedSquish.SquishFlags.ColourRangeFit">
  38. <summary>
  39. Use a fast but low quality colour compressor.
  40. </summary>
  41. </member>
  42. <member name="F:ManagedSquish.SquishFlags.ColourMetricPerceptual">
  43. <summary>
  44. Use a perceptual metric for colour error (the default).
  45. </summary>
  46. </member>
  47. <member name="F:ManagedSquish.SquishFlags.ColourMetricUniform">
  48. <summary>
  49. Use a uniform metric for colour error.
  50. </summary>
  51. </member>
  52. <member name="F:ManagedSquish.SquishFlags.WeightColourByAlpha">
  53. <summary>
  54. Weight the colour by alpha during cluster fit (disabled by default).
  55. </summary>
  56. </member>
  57. <member name="T:ManagedSquish.Squish">
  58. <summary>
  59. Wrapper for libsquish DXT compression/decompression library.
  60. </summary>
  61. </member>
  62. <member name="M:ManagedSquish.Squish.GetStorageRequirements(System.Int32,System.Int32,ManagedSquish.SquishFlags)">
  63. <summary>
  64. Returns the final size in bytes of DXT data compressed with the parameters specified in <paramref name="flags"/>.
  65. </summary>
  66. <param name="width">Source image width.</param>
  67. <param name="height">Source image height.</param>
  68. <param name="flags">Compression parameters.</param>
  69. <returns>Size in bytes of the DXT data.</returns>
  70. </member>
  71. <member name="M:ManagedSquish.Squish.Compress(System.IntPtr,System.IntPtr,ManagedSquish.SquishFlags)">
  72. <summary>
  73. Compress a 4x4 pixel block using the parameters specified in <paramref name="flags"/>.
  74. </summary>
  75. <param name="rgba">Source RGBA block.</param>
  76. <param name="block">Output DXT compressed block.</param>
  77. <param name="flags">Compression flags.</param>
  78. </member>
  79. <member name="M:ManagedSquish.Squish.Compress(System.Byte[],ManagedSquish.SquishFlags)">
  80. <summary>
  81. Compress a 4x4 pixel block using the parameters specified in <paramref name="flags"/>.
  82. </summary>
  83. <param name="rgba">Source RGBA block.</param>
  84. <param name="flags">Compression flags.</param>
  85. <returns>Output DXT compressed block.</returns>
  86. </member>
  87. <member name="M:ManagedSquish.Squish.CompressMasked(System.IntPtr,System.Int32,System.IntPtr,ManagedSquish.SquishFlags)">
  88. <summary>
  89. Compress a 4x4 pixel block using the parameters specified in <paramref name="flags"/>. The <paramref name="mask"/> parameter is a used as
  90. a bit mask to specifify what pixels are valid for compression, corresponding the lowest bit to the first pixel.
  91. </summary>
  92. <param name="rgba">Source RGBA block.</param>
  93. <param name="mask">Pixel bit mask.</param>
  94. <param name="block">Output DXT compressed block.</param>
  95. <param name="flags">Compression flags.</param>
  96. </member>
  97. <member name="M:ManagedSquish.Squish.CompressMasked(System.Byte[],System.Int32,ManagedSquish.SquishFlags)">
  98. <summary>
  99. Compress a 4x4 pixel block using the parameters specified in <paramref name="flags"/>. The <paramref name="mask"/> parameter is a used as
  100. a bit mask to specifify what pixels are valid for compression, corresponding the lowest bit to the first pixel.
  101. </summary>
  102. <param name="rgba">Source RGBA block.</param>
  103. <param name="mask">Pixel bit mask.</param>
  104. <param name="flags">Compression flags.</param>
  105. <returns>Output DXT compressed block.</returns>
  106. </member>
  107. <member name="M:ManagedSquish.Squish.Decompress(System.IntPtr,System.IntPtr,ManagedSquish.SquishFlags)">
  108. <summary>
  109. Decompresses a 4x4 pixel block using the parameters specified in <paramref name="flags"/>.
  110. </summary>
  111. <param name="rgba">Output RGBA decompressed block.</param>
  112. <param name="block">Source DXT block.</param>
  113. <param name="flags">Decompression flags.</param>
  114. </member>
  115. <member name="M:ManagedSquish.Squish.Decompress(System.Byte[],ManagedSquish.SquishFlags)">
  116. <summary>
  117. Decompresses a 4x4 pixel block using the parameters specified in <paramref name="flags"/>.
  118. </summary>
  119. <param name="block">Source DXT block.</param>
  120. <param name="flags">Decompression flags.</param>
  121. <returns>Output RGBA decompressed block.</returns>
  122. </member>
  123. <member name="M:ManagedSquish.Squish.CompressImage(System.IntPtr,System.Int32,System.Int32,System.IntPtr,ManagedSquish.SquishFlags)">
  124. <summary>
  125. Compresses an image using the parameters specified in <paramref name="flags"/>.
  126. </summary>
  127. <param name="rgba">Source RGBA image.</param>
  128. <param name="width">Width of the image.</param>
  129. <param name="height">Height of the image.</param>
  130. <param name="blocks">Output DXT compressed image.</param>
  131. <param name="flags">Compression flags.</param>
  132. </member>
  133. <member name="M:ManagedSquish.Squish.CompressImage(System.Byte[],System.Int32,System.Int32,ManagedSquish.SquishFlags)">
  134. <summary>
  135. Compresses an image using the parameters specified in <paramref name="flags"/>.
  136. </summary>
  137. <param name="rgba">Source RGBA image.</param>
  138. <param name="width">Width of the image.</param>
  139. <param name="height">Height of the image.</param>
  140. <param name="flags">Compression flags.</param>
  141. <returns>Output DXT compressed image.</returns>
  142. </member>
  143. <member name="M:ManagedSquish.Squish.DecompressImage(System.IntPtr,System.Int32,System.Int32,System.IntPtr,ManagedSquish.SquishFlags)">
  144. <summary>
  145. Decompresses an image using the parameters specified in <paramref name="flags"/>.
  146. </summary>
  147. <param name="rgba">Output RGBA decompressed image.</param>
  148. <param name="width">Width of the image.</param>
  149. <param name="height">Height of the image.</param>
  150. <param name="blocks">Source DXT compressed image.</param>
  151. <param name="flags">Decompression flags.</param>
  152. </member>
  153. <member name="M:ManagedSquish.Squish.DecompressImage(System.Byte[],System.Int32,System.Int32,ManagedSquish.SquishFlags)">
  154. <summary>
  155. Decompresses an image using the parameters specified in <paramref name="flags"/>.
  156. </summary>
  157. <param name="blocks">Source DXT compressed image.</param>
  158. <param name="width">Width of the image.</param>
  159. <param name="height">Height of the image.</param>
  160. <param name="flags">Decompression flags.</param>
  161. <returns>Output RGBA decompressed image.</returns>
  162. </member>
  163. </members>
  164. </doc>