group__ImageFileManipulation.html 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  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" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TorqueScript Reference: Image File Manipulation</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="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17. <div id="titlearea">
  18. <table cellspacing="0" cellpadding="0">
  19. <tbody>
  20. <tr id="projectrow">
  21. <td id="projectalign">
  22. <div id="projectname">TorqueScript Reference
  23. </div>
  24. </td>
  25. </tr>
  26. </tbody>
  27. </table>
  28. </div>
  29. <!-- end header part -->
  30. <!-- Generated by Doxygen 1.9.8 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */
  39. </script>
  40. <div id="main-nav"></div>
  41. </div><!-- top -->
  42. <div class="header">
  43. <div class="summary">
  44. <a href="#func-members">Functions</a> </div>
  45. <div class="headertitle"><div class="title">Image File Manipulation<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
  46. </div><!--header-->
  47. <div class="contents">
  48. <table class="memberdecls">
  49. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  50. Functions</h2></td></tr>
  51. <tr class="memitem:gac5638dd466d7a9f10819c5499e6052fc" id="r_gac5638dd466d7a9f10819c5499e6052fc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ImageFileManipulation.html#gac5638dd466d7a9f10819c5499e6052fc">CaptureScreenArea</a> (posX, posY, width, height, <a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, fileType)</td></tr>
  52. <tr class="separator:gac5638dd466d7a9f10819c5499e6052fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:gadf95c9f21f8a6aad3c5c33bcf0e71703" id="r_gadf95c9f21f8a6aad3c5c33bcf0e71703"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ImageFileManipulation.html#gadf95c9f21f8a6aad3c5c33bcf0e71703">png2jpg</a> (pngFilename, [quality]?)</td></tr>
  54. <tr class="separator:gadf95c9f21f8a6aad3c5c33bcf0e71703"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. </table>
  56. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  57. <h2 class="groupheader">Function Documentation</h2>
  58. <a id="gac5638dd466d7a9f10819c5499e6052fc" name="gac5638dd466d7a9f10819c5499e6052fc"></a>
  59. <h2 class="memtitle"><span class="permalink"><a href="#gac5638dd466d7a9f10819c5499e6052fc">&#9670;&#160;</a></span>CaptureScreenArea()</h2>
  60. <div class="memitem">
  61. <div class="memproto">
  62. <table class="memname">
  63. <tr>
  64. <td class="memname">bool CaptureScreenArea </td>
  65. <td>(</td>
  66. <td class="paramtype">posX&#160;</td>
  67. <td class="paramname">, </td>
  68. </tr>
  69. <tr>
  70. <td class="paramkey"></td>
  71. <td></td>
  72. <td class="paramtype">posY&#160;</td>
  73. <td class="paramname">, </td>
  74. </tr>
  75. <tr>
  76. <td class="paramkey"></td>
  77. <td></td>
  78. <td class="paramtype">width&#160;</td>
  79. <td class="paramname">, </td>
  80. </tr>
  81. <tr>
  82. <td class="paramkey"></td>
  83. <td></td>
  84. <td class="paramtype">height&#160;</td>
  85. <td class="paramname">, </td>
  86. </tr>
  87. <tr>
  88. <td class="paramkey"></td>
  89. <td></td>
  90. <td class="paramtype"><a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
  91. <td class="paramname">, </td>
  92. </tr>
  93. <tr>
  94. <td class="paramkey"></td>
  95. <td></td>
  96. <td class="paramtype">fileType&#160;</td>
  97. <td class="paramname">&#160;</td>
  98. </tr>
  99. <tr>
  100. <td></td>
  101. <td>)</td>
  102. <td></td><td></td>
  103. </tr>
  104. </table>
  105. </div><div class="memdoc">
  106. <p>Capture a specific area of the screen </p>
  107. </div>
  108. </div>
  109. <a id="gadf95c9f21f8a6aad3c5c33bcf0e71703" name="gadf95c9f21f8a6aad3c5c33bcf0e71703"></a>
  110. <h2 class="memtitle"><span class="permalink"><a href="#gadf95c9f21f8a6aad3c5c33bcf0e71703">&#9670;&#160;</a></span>png2jpg()</h2>
  111. <div class="memitem">
  112. <div class="memproto">
  113. <table class="memname">
  114. <tr>
  115. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> png2jpg </td>
  116. <td>(</td>
  117. <td class="paramtype">pngFilename&#160;</td>
  118. <td class="paramname">, </td>
  119. </tr>
  120. <tr>
  121. <td class="paramkey"></td>
  122. <td></td>
  123. <td class="paramtype">[quality ] ?&#160;</td>
  124. <td class="paramname">&#160;</td>
  125. </tr>
  126. <tr>
  127. <td></td>
  128. <td>)</td>
  129. <td></td><td></td>
  130. </tr>
  131. </table>
  132. </div><div class="memdoc">
  133. <p>Use the png2jpg function to save a PNG file specified by pngFilename as a similarly named JPEG file with the optionally specified quality. </p><dl class="params"><dt>Parameters</dt><dd>
  134. <table class="params">
  135. <tr><td class="paramname">pngFilename</td><td>The path and file name of the PNG file to convert. </td></tr>
  136. <tr><td class="paramname">quality</td><td>An optional quality between 0 and 100. The default quality is 90. </td></tr>
  137. </table>
  138. </dd>
  139. </dl>
  140. <dl class="section return"><dt>Returns</dt><dd>Returns -1 if the file could not be opened, 0 on other failures, and 1 if the conversion worked </dd></dl>
  141. </div>
  142. </div>
  143. </div><!-- contents -->
  144. <!-- start footer part -->
  145. <hr class="footer"/><address class="footer"><small>
  146. 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.8
  147. </small></address>
  148. </body>
  149. </html>