/docs/api/gamejs/font/index.html

https://github.com/tnajdek/gamejs · HTML · 199 lines · 174 code · 22 blank · 3 comment · 0 complexity · 51fb7f002bfd1f4f644a55f9a41e093f MD5 · raw file 

    

  1. <!DOCTYPE html >
    2. 

  2. 

  3. <html lang="de" dir="ltr">
    4. 

  4. <head>
    5. 

  5.     <title>gamejs/font - GameJs API</title>
    6. 

  6.     <link rel="shortcut icon" href="http://ringojs.org/favicon.ico" type="image/x-icon" />
    7. 

  7.     <link rel="icon" href="http://ringojs.org/favicon.ico" type="image/x-icon" />
    8. 

  8.     <link rel="stylesheet" href="../../static/style.css" />
    9. 

  9.     <link rel="stylesheet" href="../../static/jsdoc.css" />
    10. 

  10. <script type="text/javascript" src="../../static/jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="../../static/jsdoc.js"></script>
    12. 

  12. <script>
    13. 

  13. $(document).ready(jsdocSetup);
    14. 

  14. </script>
    15. 

  15. 

  16. </head>
    17. 

  17. 

  18. <body>
    19. 

  19. <div class="wrap">
    20. 

  20. 

  21.     <div class="main">
    22. 

  22.         <div class="content">
    23. 

  23.                     <h1 class="modulename">Module gamejs/font</h1>
    24. 

  24.             <div class="fileoverview">
    25. 

  25.                 <p>Methods for creating Font objects which can render text
    26. 

  26. to a Surface.</p>
    27. 

  27. 

  28. Example:
    29. 

  29. <pre><code>// create a font
    30. 

  30. var font = new Font('20px monospace');
    31. 

  31. // render text - this returns a surface with the text written on it.
    32. 

  32. var helloSurface = font.render('Hello World')</code></pre>
    33. 

  33. 

  34. 

  35.             </div>
    36. 

  36. 

  37.             <div class="classoverview">
    38. 

  38. 

  39.                 <div class="classes">
    40. 

  40.                                         <h2>Class <a href="#Font" class="jsdoc-title">Font</a></h2>
    41. 

  41.                                         <div>
    42. 

  42.                         <h3>Instance Methods</h3>
    43. 

  43.                         <ul class="propertyoverview">
    44. 

  44.                                                         <li>
    45. 

  45.                                 <a href="#Font.prototype.render" class="jsdoc-title"> render</a>(text, color)
    46. 

  46.                             </li>
    47. 

  47.                                                         <li>
    48. 

  48.                                 <a href="#Font.prototype.size" class="jsdoc-title"> size</a>(text)
    49. 

  49.                             </li>
    50. 

  50.                             </ul>
    51. 

  51.                     </div>
    52. 

  52.                     </div>
    53. 

  53.             </div>
    54. 

  54.                 <hr/>
    55. 

  55.                 <div class="details">
    56. 

  56.                                         <!-- tpl-docitem -->
    57. 

  57.                     <div>
    58. 

  58.                         <div class="docitem" docitem="Font">
    59. 

  59.                             <h3>
    60. 

  60.                                 <span class="itemtitle"><a id="Font" href="#Font" class="itemtitle itemname">Font</a></span>
    61. 

  61.                                 <span class="itemtitle light">(fontSettings, backgroundColor)</span></h3>
    62. 

  62.                             <div>
    63. 

  63.                                 <p>Create a Font to draw on the screen. The Font allows you to
    64. 

  64. <code>render()</code> text. Rendering text returns a Surface which
    65. 

  65. in turn can be put on screen.</p>
    66. 

  66. 

  67. 

  68.                             </div>
    69. 

  69.                                                         <div>
    70. 

  70.                                 <h4>Parameters</h4>
    71. 

  71.                                 <table>
    72. 

  72.                                                                         <tr>
    73. 

  73.                                         <td>String</td>
    74. 

  74.                                         <td class="paramname">fontSettings</td>
    75. 

  75.                                         <td>a css font definition, e.g., "20px monospace"</td>
    76. 

  76.                                     </tr>
    77. 

  77.                                                                         <tr>
    78. 

  78.                                         <td>STring</td>
    79. 

  79.                                         <td class="paramname">backgroundColor</td>
    80. 

  80.                                         <td>valid #rgb string, "#ff00cc"</td>
    81. 

  81.                                     </tr>
    82. 

  82.                                     </table>
    83. 

  83.                             </div>
    84. 

  84.                             </div>
    85. 

  85.                         <hr/>
    86. 

  86.                     </div>
    87. 

  87. 

  88.                                         <!-- tpl-docitem -->
    89. 

  89.                     <div>
    90. 

  90.                         <div class="docitem" docitem="Font.prototype.render">
    91. 

  91.                             <h3>
    92. 

  92.                                 <span class="itemtitle">Font.prototype.<a id="Font.prototype.render" href="#Font.prototype.render" class="itemtitle itemname">render</a></span>
    93. 

  93.                                 <span class="itemtitle light">(text, color)</span></h3>
    94. 

  94.                             <div>
    95. 

  95.                                 <p>Returns a Surface with the given text on it.</p>
    96. 

  96. 

  97. 

  98.                             </div>
    99. 

  99.                                                         <div>
    100. 

  100.                                 <h4>Parameters</h4>
    101. 

  101.                                 <table>
    102. 

  102.                                                                         <tr>
    103. 

  103.                                         <td>String</td>
    104. 

  104.                                         <td class="paramname">text</td>
    105. 

  105.                                         <td>the text to render</td>
    106. 

  106.                                     </tr>
    107. 

  107.                                                                         <tr>
    108. 

  108.                                         <td>String</td>
    109. 

  109.                                         <td class="paramname">color</td>
    110. 

  110.                                         <td>a valid #RGB String, "#ffcc00"</td>
    111. 

  111.                                     </tr>
    112. 

  112.                                     </table>
    113. 

  113.                             </div>
    114. 

  114.                                                         <div>
    115. 

  115.                                 <h4>Returns</h4>
    116. 

  116.                                 <table>
    117. 

  117.                                     <tr>
    118. 

  118.                                         <td>gamejs.Surface</td>
    119. 

  119.                                         <td> Surface with the rendered text on it.</td>
    120. 

  120.                                     </tr>
    121. 

  121.                                 </table>
    122. 

  122.                             </div>
    123. 

  123.                             </div>
    124. 

  124.                         <hr/>
    125. 

  125.                     </div>
    126. 

  126. 

  127.                                         <!-- tpl-docitem -->
    128. 

  128.                     <div>
    129. 

  129.                         <div class="docitem" docitem="Font.prototype.size">
    130. 

  130.                             <h3>
    131. 

  131.                                 <span class="itemtitle">Font.prototype.<a id="Font.prototype.size" href="#Font.prototype.size" class="itemtitle itemname">size</a></span>
    132. 

  132.                                 <span class="itemtitle light">(text)</span></h3>
    133. 

  133.                             <div>
    134. 

  134.                                 <p>Determine the width and height of the given text if rendered
    135. 

  135. with this Font.</p>
    136. 

  136. 

  137. 

  138.                             </div>
    139. 

  139.                                                         <div>
    140. 

  140.                                 <h4>Parameters</h4>
    141. 

  141.                                 <table>
    142. 

  142.                                                                         <tr>
    143. 

  143.                                         <td>String</td>
    144. 

  144.                                         <td class="paramname">text</td>
    145. 

  145.                                         <td>the text to measure</td>
    146. 

  146.                                     </tr>
    147. 

  147.                                     </table>
    148. 

  148.                             </div>
    149. 

  149.                                                         <div>
    150. 

  150.                                 <h4>Returns</h4>
    151. 

  151.                                 <table>
    152. 

  152.                                     <tr>
    153. 

  153.                                         <td>Array</td>
    154. 

  154.                                         <td> the [width, height] of the text if rendered with this Font</td>
    155. 

  155.                                     </tr>
    156. 

  156.                                 </table>
    157. 

  157.                             </div>
    158. 

  158.                             </div>
    159. 

  159.                         <hr/>
    160. 

  160.                     </div>
    161. 

  161. 

  162.                     </div>
    163. 

  163.             </div>
    164. 

  164.         </div>
    165. 

  165. 

  166. 

  167. 

  168.     <div class="menu" style="margin-top: 1em; font-size: 13px;">
    169. 

  169.     GameJs API<br/>
    170. 

  170.         <a href="../../index.html">Module list</a>
    171. 

  171.     <a href="../../index_all.html">Full index</a><br/>
    172. 

  172.     <input id="jsdoc-leftnavsearch" type="search" placeholder="Filter module list" size="14">
    173. 

  173.     <ul class="jsdoc-leftnav leftnav">
    174. 

  174.                 <li><a href="../../gamejs/index.html"> gamejs </a></li>
    175. 

  175.                 <li><a href="../../gamejs/display/index.html"> gamejs/display </a></li>
    176. 

  176.                 <li><a href="../../gamejs/draw/index.html"> gamejs/draw </a></li>
    177. 

  177.                 <li><a href="../../gamejs/event/index.html"> gamejs/event </a></li>
    178. 

  178.                 <li><a href="../../gamejs/font/index.html"> gamejs/font </a></li>
    179. 

  179.                 <li><a href="../../gamejs/http/index.html"> gamejs/http </a></li>
    180. 

  180.                 <li><a href="../../gamejs/image/index.html"> gamejs/image </a></li>
    181. 

  181.                 <li><a href="../../gamejs/mask/index.html"> gamejs/mask </a></li>
    182. 

  182.                 <li><a href="../../gamejs/mixer/index.html"> gamejs/mixer </a></li>
    183. 

  183.                 <li><a href="../../gamejs/sprite/index.html"> gamejs/sprite </a></li>
    184. 

  184.                 <li><a href="../../gamejs/surfacearray/index.html"> gamejs/surfacearray </a></li>
    185. 

  185.                 <li><a href="../../gamejs/time/index.html"> gamejs/time </a></li>
    186. 

  186.                 <li><a href="../../gamejs/transform/index.html"> gamejs/transform </a></li>
    187. 

  187.                 <li><a href="../../gamejs/pathfinding/astar/index.html"> gamejs/pathfinding/astar </a></li>
    188. 

  188.                 <li><a href="../../gamejs/utils/arrays/index.html"> gamejs/utils/arrays </a></li>
    189. 

  189.                 <li><a href="../../gamejs/utils/binaryheap/index.html"> gamejs/utils/binaryheap </a></li>
    190. 

  190.                 <li><a href="../../gamejs/utils/math/index.html"> gamejs/utils/math </a></li>
    191. 

  191.                 <li><a href="../../gamejs/utils/matrix/index.html"> gamejs/utils/matrix </a></li>
    192. 

  192.                 <li><a href="../../gamejs/utils/objects/index.html"> gamejs/utils/objects </a></li>
    193. 

  193.                 <li><a href="../../gamejs/utils/vectors/index.html"> gamejs/utils/vectors </a></li>
    194. 

  194.         </ul>
    195. 

  195. 

  196. </div>
    197. 

  197. </div>
    198. 

  198. </body>
    199. 

  199. </html>
    200.