DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

496 lines
31KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.9.1"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: CairoImage Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">DISTRHO Plugin Framework
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.9.1 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="classCairoImage-members.html">List of all members</a> </div>
  65. <div class="headertitle">
  66. <div class="title">CairoImage Class Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p><code>#include &lt;<a class="el" href="Cairo_8hpp_source.html">Cairo.hpp</a>&gt;</code></p>
  70. <div class="dynheader">
  71. Inheritance diagram for CairoImage:</div>
  72. <div class="dyncontent">
  73. <div class="center">
  74. <img src="classCairoImage.png" usemap="#CairoImage_map" alt=""/>
  75. <map id="CairoImage_map" name="CairoImage_map">
  76. <area href="classImageBase.html" alt="ImageBase" shape="rect" coords="0,0,76,24"/>
  77. </map>
  78. </div></div>
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  81. Public Member Functions</h2></td></tr>
  82. <tr class="memitem:aeadcf789efdf894a61e477b4d64fc0b6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoImage.html#aeadcf789efdf894a61e477b4d64fc0b6">CairoImage</a> ()</td></tr>
  83. <tr class="separator:aeadcf789efdf894a61e477b4d64fc0b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a17ce2733afa4fc080a63b23cd0dd7b18"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoImage.html#a17ce2733afa4fc080a63b23cd0dd7b18">CairoImage</a> (const char *rawData, uint width, uint height, ImageFormat format)</td></tr>
  85. <tr class="separator:a17ce2733afa4fc080a63b23cd0dd7b18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ad3490061bcaae7cc320c5ccfb40ab3dd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoImage.html#ad3490061bcaae7cc320c5ccfb40ab3dd">CairoImage</a> (const char *rawData, const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;size, ImageFormat format)</td></tr>
  87. <tr class="separator:ad3490061bcaae7cc320c5ccfb40ab3dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a89f96493ba7b890a4d43f00672f1a497"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoImage.html#a89f96493ba7b890a4d43f00672f1a497">CairoImage</a> (const <a class="el" href="classCairoImage.html">CairoImage</a> &amp;image)</td></tr>
  89. <tr class="separator:a89f96493ba7b890a4d43f00672f1a497"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a36abbee6a47fc3447f00270aa16a82b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoImage.html#a36abbee6a47fc3447f00270aa16a82b7">~CairoImage</a> () override</td></tr>
  91. <tr class="separator:a36abbee6a47fc3447f00270aa16a82b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a861bdbb5cd592feaef43e2202397deed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoImage.html#a861bdbb5cd592feaef43e2202397deed">loadFromMemory</a> (const char *rawData, const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;size, ImageFormat format=kImageFormatBGRA) noexcept override</td></tr>
  93. <tr class="separator:a861bdbb5cd592feaef43e2202397deed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a94c1707943b9874e362e11473bdcf768"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoImage.html#a94c1707943b9874e362e11473bdcf768">loadFromPNG</a> (const char *pngData, uint dataSize) noexcept</td></tr>
  95. <tr class="separator:a94c1707943b9874e362e11473bdcf768"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:aa60a5e3b68032170e8e59fb506c7d3b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoImage.html#aa60a5e3b68032170e8e59fb506c7d3b7">drawAt</a> (const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;context, const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;pos) override</td></tr>
  97. <tr class="separator:aa60a5e3b68032170e8e59fb506c7d3b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a5ce76c4866b396a771caafa80acf162b"><td class="memItemLeft" align="right" valign="top">cairo_surface_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoImage.html#a5ce76c4866b396a771caafa80acf162b">getSurface</a> () const noexcept</td></tr>
  99. <tr class="separator:a5ce76c4866b396a771caafa80acf162b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:af5f422a5a77f4639a907f8e5dde29ef7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCairoImage.html">CairoImage</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoImage.html#af5f422a5a77f4639a907f8e5dde29ef7">operator=</a> (const <a class="el" href="classCairoImage.html">CairoImage</a> &amp;image) noexcept</td></tr>
  101. <tr class="separator:af5f422a5a77f4639a907f8e5dde29ef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a9d952fe7065dfbf079053a30463214e8"><td class="memItemLeft" align="right" valign="top"><a id="a9d952fe7065dfbf079053a30463214e8"></a>
  103. void&#160;</td><td class="memItemRight" valign="bottom"><b>loadFromMemory</b> (const char *rdata, uint w, uint h, ImageFormat fmt=kImageFormatBGRA)</td></tr>
  104. <tr class="separator:a9d952fe7065dfbf079053a30463214e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ad41816f9a994a98c4a23efaf75797402"><td class="memItemLeft" align="right" valign="top"><a id="ad41816f9a994a98c4a23efaf75797402"></a>
  106. void&#160;</td><td class="memItemRight" valign="bottom"><b>draw</b> (const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;context)</td></tr>
  107. <tr class="separator:ad41816f9a994a98c4a23efaf75797402"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ae2f4f2d5db4d705b971a45733015a020"><td class="memItemLeft" align="right" valign="top"><a id="ae2f4f2d5db4d705b971a45733015a020"></a>
  109. void&#160;</td><td class="memItemRight" valign="bottom"><b>drawAt</b> (const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;context, int x, int y)</td></tr>
  110. <tr class="separator:ae2f4f2d5db4d705b971a45733015a020"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="inherit_header pub_methods_classImageBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classImageBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classImageBase.html">ImageBase</a></td></tr>
  112. <tr class="memitem:a247e1c3259d5943a5766c99f61da9309 inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a247e1c3259d5943a5766c99f61da9309">~ImageBase</a> ()</td></tr>
  113. <tr class="separator:a247e1c3259d5943a5766c99f61da9309 inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:ab5b2bc7d68b0aff3452478f906aa960f inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#ab5b2bc7d68b0aff3452478f906aa960f">isValid</a> () const noexcept</td></tr>
  115. <tr class="separator:ab5b2bc7d68b0aff3452478f906aa960f inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a83ea79fff6adfa0720985f2e9794ed2d inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a83ea79fff6adfa0720985f2e9794ed2d">isInvalid</a> () const noexcept</td></tr>
  117. <tr class="separator:a83ea79fff6adfa0720985f2e9794ed2d inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a82057493bae9af996a9a10b1aa731666 inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a82057493bae9af996a9a10b1aa731666">getWidth</a> () const noexcept</td></tr>
  119. <tr class="separator:a82057493bae9af996a9a10b1aa731666 inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:aff56029a17822f19b518560e82aba878 inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#aff56029a17822f19b518560e82aba878">getHeight</a> () const noexcept</td></tr>
  121. <tr class="separator:aff56029a17822f19b518560e82aba878 inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a7609a68efebd27587bb98e386db0e9e2 inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a7609a68efebd27587bb98e386db0e9e2">getSize</a> () const noexcept</td></tr>
  123. <tr class="separator:a7609a68efebd27587bb98e386db0e9e2 inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:aea60747a216159b14a8d020cb9b19546 inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#aea60747a216159b14a8d020cb9b19546">getRawData</a> () const noexcept</td></tr>
  125. <tr class="separator:aea60747a216159b14a8d020cb9b19546 inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a4b0c40113f956eaf2f2e0e51395b0926 inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">ImageFormat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a4b0c40113f956eaf2f2e0e51395b0926">getFormat</a> () const noexcept</td></tr>
  127. <tr class="separator:a4b0c40113f956eaf2f2e0e51395b0926 inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a1d7893360e704dff3f2da11e7750359c inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a1d7893360e704dff3f2da11e7750359c">loadFromMemory</a> (const char *rawData, uint width, uint height, ImageFormat format=kImageFormatBGRA) noexcept</td></tr>
  129. <tr class="separator:a1d7893360e704dff3f2da11e7750359c inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a94fc564a4bb8c18cd576ee9b456887a9 inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a94fc564a4bb8c18cd576ee9b456887a9">draw</a> (const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;context)</td></tr>
  131. <tr class="separator:a94fc564a4bb8c18cd576ee9b456887a9 inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a16d58063acd1a1e6ae8bc3afdea610f8 inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a16d58063acd1a1e6ae8bc3afdea610f8">drawAt</a> (const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;context, int x, int y)</td></tr>
  133. <tr class="separator:a16d58063acd1a1e6ae8bc3afdea610f8 inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:ac352a5a4291cd0945c663b17631598dc inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classImageBase.html">ImageBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#ac352a5a4291cd0945c663b17631598dc">operator=</a> (const <a class="el" href="classImageBase.html">ImageBase</a> &amp;image) noexcept</td></tr>
  135. <tr class="separator:ac352a5a4291cd0945c663b17631598dc inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a099b6d6fdd222d1fe20f09080ae3fb7c inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top"><a id="a099b6d6fdd222d1fe20f09080ae3fb7c"></a>
  137. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classImageBase.html">ImageBase</a> &amp;image) const noexcept</td></tr>
  138. <tr class="separator:a099b6d6fdd222d1fe20f09080ae3fb7c inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a77aceada26566e8e76699ef7abb3d1ad inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top"><a id="a77aceada26566e8e76699ef7abb3d1ad"></a>
  140. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="classImageBase.html">ImageBase</a> &amp;image) const noexcept</td></tr>
  141. <tr class="separator:a77aceada26566e8e76699ef7abb3d1ad inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. </table><table class="memberdecls">
  143. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  144. Additional Inherited Members</h2></td></tr>
  145. <tr class="inherit_header pro_methods_classImageBase"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classImageBase')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classImageBase.html">ImageBase</a></td></tr>
  146. <tr class="memitem:a1a1f82fcab01adea2f8783547e8a18aa inherit pro_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a1a1f82fcab01adea2f8783547e8a18aa">ImageBase</a> ()</td></tr>
  147. <tr class="separator:a1a1f82fcab01adea2f8783547e8a18aa inherit pro_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a494cd9221fe88f34ce011f004eea7596 inherit pro_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a494cd9221fe88f34ce011f004eea7596">ImageBase</a> (const char *rawData, uint width, uint height, ImageFormat format)</td></tr>
  149. <tr class="separator:a494cd9221fe88f34ce011f004eea7596 inherit pro_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:aa61181afeb3abd0253ae0a25712164ee inherit pro_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#aa61181afeb3abd0253ae0a25712164ee">ImageBase</a> (const char *rawData, const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;size, ImageFormat format)</td></tr>
  151. <tr class="separator:aa61181afeb3abd0253ae0a25712164ee inherit pro_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a56dd89a0a5c0abc604044e33c8b1db59 inherit pro_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a56dd89a0a5c0abc604044e33c8b1db59">ImageBase</a> (const <a class="el" href="classImageBase.html">ImageBase</a> &amp;image)</td></tr>
  153. <tr class="separator:a56dd89a0a5c0abc604044e33c8b1db59 inherit pro_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="inherit_header pro_attribs_classImageBase"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classImageBase')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classImageBase.html">ImageBase</a></td></tr>
  155. <tr class="memitem:a152a43920a235644fb87bbb98c1efaf5 inherit pro_attribs_classImageBase"><td class="memItemLeft" align="right" valign="top"><a id="a152a43920a235644fb87bbb98c1efaf5"></a>
  156. const char *&#160;</td><td class="memItemRight" valign="bottom"><b>rawData</b></td></tr>
  157. <tr class="separator:a152a43920a235644fb87bbb98c1efaf5 inherit pro_attribs_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a2ff8c2d118d086a428bac3a7c7b1f5b0 inherit pro_attribs_classImageBase"><td class="memItemLeft" align="right" valign="top"><a id="a2ff8c2d118d086a428bac3a7c7b1f5b0"></a>
  159. <a class="el" href="classSize.html">Size</a>&lt; uint &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>size</b></td></tr>
  160. <tr class="separator:a2ff8c2d118d086a428bac3a7c7b1f5b0 inherit pro_attribs_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:a8b3eba70f2f1d0b2d2543ab8867ed4ac inherit pro_attribs_classImageBase"><td class="memItemLeft" align="right" valign="top"><a id="a8b3eba70f2f1d0b2d2543ab8867ed4ac"></a>
  162. ImageFormat&#160;</td><td class="memItemRight" valign="bottom"><b>format</b></td></tr>
  163. <tr class="separator:a8b3eba70f2f1d0b2d2543ab8867ed4ac inherit pro_attribs_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. </table>
  165. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  166. <div class="textblock"><p>Cairo Image class.</p>
  167. <p>TODO ... </p>
  168. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  169. <a id="aeadcf789efdf894a61e477b4d64fc0b6"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#aeadcf789efdf894a61e477b4d64fc0b6">&#9670;&nbsp;</a></span>CairoImage() <span class="overload">[1/4]</span></h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">CairoImage::CairoImage </td>
  176. <td>(</td>
  177. <td class="paramname"></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Constructor for a null Image. </p>
  183. </div>
  184. </div>
  185. <a id="a17ce2733afa4fc080a63b23cd0dd7b18"></a>
  186. <h2 class="memtitle"><span class="permalink"><a href="#a17ce2733afa4fc080a63b23cd0dd7b18">&#9670;&nbsp;</a></span>CairoImage() <span class="overload">[2/4]</span></h2>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">CairoImage::CairoImage </td>
  192. <td>(</td>
  193. <td class="paramtype">const char *&#160;</td>
  194. <td class="paramname"><em>rawData</em>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype">uint&#160;</td>
  200. <td class="paramname"><em>width</em>, </td>
  201. </tr>
  202. <tr>
  203. <td class="paramkey"></td>
  204. <td></td>
  205. <td class="paramtype">uint&#160;</td>
  206. <td class="paramname"><em>height</em>, </td>
  207. </tr>
  208. <tr>
  209. <td class="paramkey"></td>
  210. <td></td>
  211. <td class="paramtype">ImageFormat&#160;</td>
  212. <td class="paramname"><em>format</em>&#160;</td>
  213. </tr>
  214. <tr>
  215. <td></td>
  216. <td>)</td>
  217. <td></td><td></td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>Constructor using raw image data. </p><dl class="section note"><dt>Note</dt><dd><em>rawData</em> must remain valid for the lifetime of this Image. </dd></dl>
  222. </div>
  223. </div>
  224. <a id="ad3490061bcaae7cc320c5ccfb40ab3dd"></a>
  225. <h2 class="memtitle"><span class="permalink"><a href="#ad3490061bcaae7cc320c5ccfb40ab3dd">&#9670;&nbsp;</a></span>CairoImage() <span class="overload">[3/4]</span></h2>
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="memname">
  229. <tr>
  230. <td class="memname">CairoImage::CairoImage </td>
  231. <td>(</td>
  232. <td class="paramtype">const char *&#160;</td>
  233. <td class="paramname"><em>rawData</em>, </td>
  234. </tr>
  235. <tr>
  236. <td class="paramkey"></td>
  237. <td></td>
  238. <td class="paramtype">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td>
  239. <td class="paramname"><em>size</em>, </td>
  240. </tr>
  241. <tr>
  242. <td class="paramkey"></td>
  243. <td></td>
  244. <td class="paramtype">ImageFormat&#160;</td>
  245. <td class="paramname"><em>format</em>&#160;</td>
  246. </tr>
  247. <tr>
  248. <td></td>
  249. <td>)</td>
  250. <td></td><td></td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. <p>Constructor using raw image data. </p><dl class="section note"><dt>Note</dt><dd><em>rawData</em> must remain valid for the lifetime of this Image. </dd></dl>
  255. </div>
  256. </div>
  257. <a id="a89f96493ba7b890a4d43f00672f1a497"></a>
  258. <h2 class="memtitle"><span class="permalink"><a href="#a89f96493ba7b890a4d43f00672f1a497">&#9670;&nbsp;</a></span>CairoImage() <span class="overload">[4/4]</span></h2>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">CairoImage::CairoImage </td>
  264. <td>(</td>
  265. <td class="paramtype">const <a class="el" href="classCairoImage.html">CairoImage</a> &amp;&#160;</td>
  266. <td class="paramname"><em>image</em></td><td>)</td>
  267. <td></td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <p>Constructor using another image data. </p>
  272. </div>
  273. </div>
  274. <a id="a36abbee6a47fc3447f00270aa16a82b7"></a>
  275. <h2 class="memtitle"><span class="permalink"><a href="#a36abbee6a47fc3447f00270aa16a82b7">&#9670;&nbsp;</a></span>~CairoImage()</h2>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="mlabels">
  279. <tr>
  280. <td class="mlabels-left">
  281. <table class="memname">
  282. <tr>
  283. <td class="memname">CairoImage::~CairoImage </td>
  284. <td>(</td>
  285. <td class="paramname"></td><td>)</td>
  286. <td></td>
  287. </tr>
  288. </table>
  289. </td>
  290. <td class="mlabels-right">
  291. <span class="mlabels"><span class="mlabel">override</span></span> </td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <p>Destructor. </p>
  296. </div>
  297. </div>
  298. <h2 class="groupheader">Member Function Documentation</h2>
  299. <a id="a861bdbb5cd592feaef43e2202397deed"></a>
  300. <h2 class="memtitle"><span class="permalink"><a href="#a861bdbb5cd592feaef43e2202397deed">&#9670;&nbsp;</a></span>loadFromMemory()</h2>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <table class="mlabels">
  304. <tr>
  305. <td class="mlabels-left">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">void CairoImage::loadFromMemory </td>
  309. <td>(</td>
  310. <td class="paramtype">const char *&#160;</td>
  311. <td class="paramname"><em>rawData</em>, </td>
  312. </tr>
  313. <tr>
  314. <td class="paramkey"></td>
  315. <td></td>
  316. <td class="paramtype">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td>
  317. <td class="paramname"><em>size</em>, </td>
  318. </tr>
  319. <tr>
  320. <td class="paramkey"></td>
  321. <td></td>
  322. <td class="paramtype">ImageFormat&#160;</td>
  323. <td class="paramname"><em>format</em> = <code>kImageFormatBGRA</code>&#160;</td>
  324. </tr>
  325. <tr>
  326. <td></td>
  327. <td>)</td>
  328. <td></td><td></td>
  329. </tr>
  330. </table>
  331. </td>
  332. <td class="mlabels-right">
  333. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td>
  334. </tr>
  335. </table>
  336. </div><div class="memdoc">
  337. <p>Load raw image data from memory. </p><dl class="section note"><dt>Note</dt><dd><em>rawData</em> must remain valid for the lifetime of this Image. </dd></dl>
  338. <p>Reimplemented from <a class="el" href="classImageBase.html#a2c922b2ba7133937e74e1629fdde4f0e">ImageBase</a>.</p>
  339. </div>
  340. </div>
  341. <a id="a94c1707943b9874e362e11473bdcf768"></a>
  342. <h2 class="memtitle"><span class="permalink"><a href="#a94c1707943b9874e362e11473bdcf768">&#9670;&nbsp;</a></span>loadFromPNG()</h2>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <table class="mlabels">
  346. <tr>
  347. <td class="mlabels-left">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname">void CairoImage::loadFromPNG </td>
  351. <td>(</td>
  352. <td class="paramtype">const char *&#160;</td>
  353. <td class="paramname"><em>pngData</em>, </td>
  354. </tr>
  355. <tr>
  356. <td class="paramkey"></td>
  357. <td></td>
  358. <td class="paramtype">uint&#160;</td>
  359. <td class="paramname"><em>dataSize</em>&#160;</td>
  360. </tr>
  361. <tr>
  362. <td></td>
  363. <td>)</td>
  364. <td></td><td></td>
  365. </tr>
  366. </table>
  367. </td>
  368. <td class="mlabels-right">
  369. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  370. </tr>
  371. </table>
  372. </div><div class="memdoc">
  373. <p>Load PNG image from memory. Image size is read from PNG contents. </p><dl class="section note"><dt>Note</dt><dd><em>pngData</em> must remain valid for the lifetime of this Image. </dd></dl>
  374. </div>
  375. </div>
  376. <a id="aa60a5e3b68032170e8e59fb506c7d3b7"></a>
  377. <h2 class="memtitle"><span class="permalink"><a href="#aa60a5e3b68032170e8e59fb506c7d3b7">&#9670;&nbsp;</a></span>drawAt()</h2>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="mlabels">
  381. <tr>
  382. <td class="mlabels-left">
  383. <table class="memname">
  384. <tr>
  385. <td class="memname">void CairoImage::drawAt </td>
  386. <td>(</td>
  387. <td class="paramtype">const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;&#160;</td>
  388. <td class="paramname"><em>context</em>, </td>
  389. </tr>
  390. <tr>
  391. <td class="paramkey"></td>
  392. <td></td>
  393. <td class="paramtype">const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;&#160;</td>
  394. <td class="paramname"><em>pos</em>&#160;</td>
  395. </tr>
  396. <tr>
  397. <td></td>
  398. <td>)</td>
  399. <td></td><td></td>
  400. </tr>
  401. </table>
  402. </td>
  403. <td class="mlabels-right">
  404. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  405. </tr>
  406. </table>
  407. </div><div class="memdoc">
  408. <p>Draw this image at position <em>pos</em> using the graphics context <em>context</em>. </p>
  409. <p>Implements <a class="el" href="classImageBase.html#afef0b2e0d1baa305312435d0de2e027c">ImageBase</a>.</p>
  410. </div>
  411. </div>
  412. <a id="a5ce76c4866b396a771caafa80acf162b"></a>
  413. <h2 class="memtitle"><span class="permalink"><a href="#a5ce76c4866b396a771caafa80acf162b">&#9670;&nbsp;</a></span>getSurface()</h2>
  414. <div class="memitem">
  415. <div class="memproto">
  416. <table class="mlabels">
  417. <tr>
  418. <td class="mlabels-left">
  419. <table class="memname">
  420. <tr>
  421. <td class="memname">cairo_surface_t* CairoImage::getSurface </td>
  422. <td>(</td>
  423. <td class="paramname"></td><td>)</td>
  424. <td> const</td>
  425. </tr>
  426. </table>
  427. </td>
  428. <td class="mlabels-right">
  429. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  430. </tr>
  431. </table>
  432. </div><div class="memdoc">
  433. <p>Get the cairo surface currently associated with this image. FIXME might be removed </p>
  434. </div>
  435. </div>
  436. <a id="af5f422a5a77f4639a907f8e5dde29ef7"></a>
  437. <h2 class="memtitle"><span class="permalink"><a href="#af5f422a5a77f4639a907f8e5dde29ef7">&#9670;&nbsp;</a></span>operator=()</h2>
  438. <div class="memitem">
  439. <div class="memproto">
  440. <table class="mlabels">
  441. <tr>
  442. <td class="mlabels-left">
  443. <table class="memname">
  444. <tr>
  445. <td class="memname"><a class="el" href="classCairoImage.html">CairoImage</a>&amp; CairoImage::operator= </td>
  446. <td>(</td>
  447. <td class="paramtype">const <a class="el" href="classCairoImage.html">CairoImage</a> &amp;&#160;</td>
  448. <td class="paramname"><em>image</em></td><td>)</td>
  449. <td></td>
  450. </tr>
  451. </table>
  452. </td>
  453. <td class="mlabels-right">
  454. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  455. </tr>
  456. </table>
  457. </div><div class="memdoc">
  458. <p>TODO document this. </p>
  459. </div>
  460. </div>
  461. <hr/>The documentation for this class was generated from the following file:<ul>
  462. <li>dgl/<a class="el" href="Cairo_8hpp_source.html">Cairo.hpp</a></li>
  463. </ul>
  464. </div><!-- contents -->
  465. <!-- start footer part -->
  466. <hr class="footer"/><address class="footer"><small>
  467. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
  468. </small></address>
  469. </body>
  470. </html>