index.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Developer SDK &#8212; Compressonator Compressonator - latest build documentation</title>
  7. <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
  8. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  9. <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
  10. <script type="text/javascript">
  11. var DOCUMENTATION_OPTIONS = {
  12. URL_ROOT: '../',
  13. VERSION: 'Compressonator - latest build',
  14. COLLAPSE_INDEX: false,
  15. FILE_SUFFIX: '.html',
  16. HAS_SOURCE: true,
  17. SOURCELINK_SUFFIX: '.txt'
  18. };
  19. </script>
  20. <script type="text/javascript" src="../_static/jquery.js"></script>
  21. <script type="text/javascript" src="../_static/underscore.js"></script>
  22. <script type="text/javascript" src="../_static/doctools.js"></script>
  23. <link rel="index" title="Index" href="../genindex.html" />
  24. <link rel="search" title="Search" href="../search.html" />
  25. <link rel="next" title="CMP Core" href="cmp_core/index.html" />
  26. <link rel="prev" title="Compressonator" href="../index.html" />
  27. <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  28. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  29. </head>
  30. <body>
  31. <div class="document">
  32. <div class="documentwrapper">
  33. <div class="bodywrapper">
  34. <div class="body" role="main">
  35. <div class="section" id="developer-sdk">
  36. <h1>Developer SDK<a class="headerlink" href="#developer-sdk" title="Permalink to this headline">¶</a></h1>
  37. <div class="toctree-wrapper compound" id="toc-developer-sdk">
  38. <ul>
  39. <li class="toctree-l1"><a class="reference internal" href="cmp_core/index.html">CMP Core</a><ul>
  40. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#gpu-shaders">GPU Shaders</a></li>
  41. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#error-codes">Error Codes</a></li>
  42. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#codec-quality-settings">Codec Quality Settings</a></li>
  43. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#create-and-destroy-options-pointers">Create and Destroy Options Pointers</a></li>
  44. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#channel-weights">Channel Weights</a></li>
  45. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#quality-settings">Quality Settings</a></li>
  46. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#alpha-threshold">Alpha Threshold</a></li>
  47. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#mode-masks">Mode Masks</a></li>
  48. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#decoder-channel-mapping">Decoder Channel Mapping</a></li>
  49. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#bc7-alpha-options">BC7 Alpha Options</a></li>
  50. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#bc7-error-threshold">BC7 Error Threshold</a></li>
  51. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#compressing-blocks">Compressing Blocks</a></li>
  52. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#decompressing-blocks">Decompressing Blocks</a></li>
  53. <li class="toctree-l2"><a class="reference internal" href="cmp_core/index.html#example-usage-of-core-api">Example Usage of Core API</a><ul class="simple">
  54. </ul>
  55. </li>
  56. </ul>
  57. </li>
  58. <li class="toctree-l1"><a class="reference internal" href="cmp_framework/index.html">CMP Framework</a><ul>
  59. <li class="toctree-l2"><a class="reference internal" href="cmp_framework/index.html#cmp-error-codes">CMP Error Codes</a></li>
  60. <li class="toctree-l2"><a class="reference internal" href="cmp_framework/index.html#kernel-options-and-extensions">Kernel Options and Extensions</a></li>
  61. <li class="toctree-l2"><a class="reference internal" href="cmp_framework/index.html#encoder-settings">Encoder Settings</a></li>
  62. <li class="toctree-l2"><a class="reference internal" href="cmp_framework/index.html#mip-map-interfaces">Mip Map Interfaces</a></li>
  63. <li class="toctree-l2"><a class="reference internal" href="cmp_framework/index.html#user-processing-callback">User Processing Callback</a></li>
  64. <li class="toctree-l2"><a class="reference internal" href="cmp_framework/index.html#texture-load-and-save">Texture Load and Save</a></li>
  65. <li class="toctree-l2"><a class="reference internal" href="cmp_framework/index.html#texture-processing">Texture Processing</a></li>
  66. <li class="toctree-l2"><a class="reference internal" href="cmp_framework/index.html#using-alternate-frameworks">Using Alternate Frameworks</a></li>
  67. <li class="toctree-l2"><a class="reference internal" href="cmp_framework/index.html#block-level-access">Block level Access</a></li>
  68. <li class="toctree-l2"><a class="reference internal" href="cmp_framework/index.html#format-and-processor-utils">Format and Processor Utils</a></li>
  69. <li class="toctree-l2"><a class="reference internal" href="cmp_framework/index.html#framework-example-mip-level-processing">Framework Example: Mip Level Processing</a></li>
  70. <li class="toctree-l2"><a class="reference internal" href="cmp_framework/index.html#using-the-pipeline-api-interfaces">Using the Pipeline API Interfaces</a><ul class="simple">
  71. </ul>
  72. </li>
  73. </ul>
  74. </li>
  75. <li class="toctree-l1"><a class="reference internal" href="cmp_compressonator/index.html">Compressonator SDK</a><ul>
  76. <li class="toctree-l2"><a class="reference internal" href="cmp_compressonator/index.html#error-codes">Error Codes</a></li>
  77. <li class="toctree-l2"><a class="reference internal" href="cmp_compressonator/index.html#convert-texture">Convert Texture</a></li>
  78. <li class="toctree-l2"><a class="reference internal" href="cmp_compressonator/index.html#example-usage-of-compressonator-api">Example Usage of Compressonator API</a><ul class="simple">
  79. </ul>
  80. </li>
  81. </ul>
  82. </li>
  83. <li class="toctree-l1"><a class="reference internal" href="codecs/index.html">Texture Compression and Decompression</a><ul>
  84. <li class="toctree-l2"><a class="reference internal" href="codecs/index.html#bc1-block-s3tc-dxt1">BC1 Block (S3TC/DXT1)</a></li>
  85. <li class="toctree-l2"><a class="reference internal" href="codecs/index.html#bc2-block-dxt2-dxt3">BC2 Block (DXT2/DXT3)</a></li>
  86. <li class="toctree-l2"><a class="reference internal" href="codecs/index.html#bc3-block-dxt4-dxt5">BC3 Block (DXT4/DXT5)</a></li>
  87. <li class="toctree-l2"><a class="reference internal" href="codecs/index.html#bc4-block-ati1-3dc">BC4 Block (ATI1/3Dc+)</a></li>
  88. <li class="toctree-l2"><a class="reference internal" href="codecs/index.html#bc5-block-ati2-3dc">BC5 Block (ATI2/3Dc)</a></li>
  89. <li class="toctree-l2"><a class="reference internal" href="codecs/index.html#bc6h">BC6H</a></li>
  90. <li class="toctree-l2"><a class="reference internal" href="codecs/index.html#bc7">BC7</a><ul class="simple">
  91. </ul>
  92. </li>
  93. </ul>
  94. </li>
  95. <li class="toctree-l1"><a class="reference internal" href="mesh_optimization/index.html">Mesh Optimization</a><ul class="simple">
  96. </ul>
  97. </li>
  98. <li class="toctree-l1"><a class="reference internal" href="mesh_compression/index.html">Mesh Compression</a><ul>
  99. <li class="toctree-l2"><a class="reference internal" href="mesh_compression/index.html#helper-function">Helper function</a><ul class="simple">
  100. </ul>
  101. </li>
  102. </ul>
  103. </li>
  104. </ul>
  105. </div>
  106. </div>
  107. </div>
  108. </div>
  109. </div>
  110. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  111. <div class="sphinxsidebarwrapper">
  112. <p class="logo"><a href="../index.html">
  113. <img class="logo" src="../_static/acompress-128.png" alt="Logo"/>
  114. </a></p>
  115. <h1 class="logo"><a href="../index.html">Compressonator</a></h1>
  116. <h3>Navigation</h3>
  117. <p class="caption"><span class="caption-text">Content</span></p>
  118. <ul class="current">
  119. <li class="toctree-l1 current"><a class="current reference internal" href="#">Developer SDK</a></li>
  120. <li class="toctree-l1"><a class="reference internal" href="../command_line_tool/index.html">Command Line Tool</a></li>
  121. <li class="toctree-l1"><a class="reference internal" href="../gui_tool/index.html">GUI Tool</a></li>
  122. <li class="toctree-l1"><a class="reference internal" href="../build_from_source/build_instructions.html">Build from GitHub Sources</a></li>
  123. <li class="toctree-l1"><a class="reference internal" href="../analysis/index.html">Analysis</a></li>
  124. <li class="toctree-l1"><a class="reference internal" href="../revisions.html">Revision History</a></li>
  125. <li class="toctree-l1"><a class="reference internal" href="../support/contact.html">Contact and Support</a></li>
  126. <li class="toctree-l1"><a class="reference internal" href="../support/license.html">License</a></li>
  127. <li class="toctree-l1"><a class="reference internal" href="../bibliography.html">Bibliography</a></li>
  128. </ul>
  129. <div class="relations">
  130. <h3>Related Topics</h3>
  131. <ul>
  132. <li><a href="../index.html">Documentation overview</a><ul>
  133. <li>Previous: <a href="../index.html" title="previous chapter">Compressonator</a></li>
  134. <li>Next: <a href="cmp_core/index.html" title="next chapter">CMP Core</a></li>
  135. </ul></li>
  136. </ul>
  137. </div>
  138. <div id="searchbox" style="display: none" role="search">
  139. <h3>Quick search</h3>
  140. <form class="search" action="../search.html" method="get">
  141. <div><input type="text" name="q" /></div>
  142. <div><input type="submit" value="Go" /></div>
  143. <input type="hidden" name="check_keywords" value="yes" />
  144. <input type="hidden" name="area" value="default" />
  145. </form>
  146. </div>
  147. <script type="text/javascript">$('#searchbox').show(0);</script>
  148. </div>
  149. </div>
  150. <div class="clearer"></div>
  151. </div>
  152. <div class="footer">
  153. &copy;2017 to 2021, AMD Developer Tools.
  154. |
  155. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.5</a>
  156. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
  157. </div>
  158. </body>
  159. </html>