| blob | 4d9e625b071e8e9c1963074714644b26f7859340 |
4 <head>
8 /* Debug borders */
10 /*
11 border: 1px solid red;
12 */
13 }
15 body {
17 }
19 a {
22 }
25 }
27 em {
29 }
31 strong {
33 }
35 tt {
37 }
45 }
47 h1 {
49 }
50 h2 {
53 }
58 }
60 hr {
62 }
64 p {
67 }
69 pre {
72 }
74 span#author {
79 }
80 span#email {
81 }
82 span#revision {
84 }
86 div#footer {
92 }
93 div#footer-text {
96 }
97 div#footer-badges {
100 }
102 div#preamble,
109 }
113 }
117 }
119 /* Block element titles. */
126 }
129 }
133 }
136 }
139 }
145 }
149 }
154 }
158 }
162 }
165 }
174 }
178 }
183 }
187 }
193 dl {
196 }
197 dt {
201 }
204 }
208 }
211 }
215 }
216 thead {
219 }
220 tfoot {
222 }
227 }
230 }
235 }
238 }
242 }
244 div#toctitle {
251 }
256 }
260 }
264 }
268 }
269 /* Workarounds for IE6's broken and incomplete CSS2. */
275 }
281 }
287 }
291 }
296 }
298 /* IE6 sets dynamically generated links as visited. */
300 </style>
302 /*<![CDATA[*/
304 /* Author: Mihai Bazon, September 2002
305 * http://students.infoiasi.ro/~mishoo
306 *
307 * Table Of Content generator
308 * Version: 0.4
309 *
310 * Feel free to use this script under the terms of the GNU General Public
311 * License, as long as you do not remove or alter this notice.
312 */
314 /* modified by Troy D. Hanson, September 2006. License: GPL */
315 /* modified by Stuart Rackham, October 2006. License: GPL */
324 }
326 }
332 }
337 // Function that scans the DOM tree for header elements (the DOM2
338 // nodeIterator API would be a better technique but not supported by all
339 // browsers).
347 }
348 }
349 }
352 }
354 // This function does the work. toclevels = 1..4.
369 }
370 }
371 /*]]>*/
372 </script>
374 </head>
375 <body>
380 <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
381 </div>
382 </div>
387 return a variable number of arguments. This will usually
388 be explained in the description of the function.</p>
389 </div>
394 If image has not been loaded before, it is loaded. If it has,
395 the pointer is returned.</p>
397 <p>Causes a loaded image to be freed from memory.
398 This is especially useful if one loads an image that is
399 only used for a small portion of the game because normally, an image
400 will stay loaded in memory forever.</p>
402 <p>Causes the screen surface in video memory to be updated from
403 the backbuffer or surface in main memory. This is basically
405 <h3>2.4. blit(image<SDL_Surface*>, x<int>, y<int>, rotation<double>, reposition<bool>, smoothing<bool>)</h3>
406 <p>Blits <strong>image</strong> to the screen at position <strong>(x, y)</strong>. If <strong>rotation</strong> is non-zero, the image will be rotated on the fly.
407 If <strong>reposition</strong> is true, the rotated image will be re-centered (you probably want this). <strong>Smoothing</strong> is whether or
408 not linear interpolation should be used (looks pretty but eats CPU).</p>
409 <h3>2.5. blit_frame(image<SDL_Surface*>, x<int>, y<int>, frames<int>, frame_num<int>)</h3>
410 <p>Blits frame <strong>frame_num</strong> to the screen at position <strong>(x, y)</strong> from <strong>image</strong> with <strong>frames</strong> number of frames.</p>
418 <h3>2.9. rz_image<SDL_Surface*>, w<int>, h<int> rotzoom(image<SDL_Surface*>, angle<double>, zoom<double>, smooth<bool>)</h3>
419 <p>Returns a rotated and/or zoomed version of <strong>image</strong> and also the width <strong>w</strong> and height <strong>h</strong> of the rotated/zoomed image.
420 <strong>Angle</strong> is specified in degrees. <strong>Zoom</strong> is the scaling factor. <strong>Smooth</strong> specifies whether linear interpolation
421 should be used when rotating/zooming the surface. Smoothing is expensive and should be used with care.
423 </div>
427 <p>Returns the number of milliseconds since program intialization. This value overflows after 49 days (32-bit integer).</p>
430 </div>
434 <p>Returns the absolute position (within the window) of the cursor.
435 It also returns the state of the left and right mouse buttons.
436 This function can be used to get the state of the mouse even when
437 and event manager is in use.</p>
441 <p>This function is used by the event manager to pass events
442 from SDL to Lua. It should never need to be explicitly
443 called by the programmer. It returns a varying number of
444 results.</p>
445 </div>
453 <p>Plays the sample specified by <strong>sample</strong>. The sample will play until completion.
454 Sample needs to have been previously loaded using load_sample().</p>
460 <p>Plays music specified by <strong>path</strong>. Music will play <strong>loops</strong> times. If <strong>loops</strong> is -1 then it will loop continuously until stopped.</p>
463 </div>
466 <h3>6.1. draw_pixel(x<int>, y<int>, R<int>, G<int>, B<int>, Alpha<int>)</h3>
468 <h3>6.2. draw_line(x1<int>, y1<int>, x2<int>, y2<int>, R<int>, G<int>, B<int>, Alpha<int>)</h3>
469 <p>Draws a line of color <strong>rgb(R,G,B)</strong> from <strong>(x1,y1)</strong> to <strong>(x2,y2)</strong>.</p>
470 <h3>6.3. draw_rect(x1<int>, y1<int>, x2<int>, y2<int>, R<int>, G<int>, B<int>, Alpha<int>)</h3>
471 <p>Draws a rectangle of color <strong>rgb(R,G,B)</strong> with top left corner <strong>(x1,y1)</strong> and bottom right corner <strong>(x2,y2)</strong>.</p>
472 <h3>6.4. draw_filled_rect(x1<int>, y1<int>, x2<int>, y2<int>, R<int>, G<int>, B<int>, Alpha<int>)</h3>
473 <p>Draws a filled rectangle of color <strong>rgb(R,G,B)</strong> with top left corner <strong>(x1,y1)</strong> and bottom right corner <strong>(x2,y2)</strong>.</p>
474 <h3>6.5. draw_circle(x<int>, y<int>, rad<int>, R<int>, G<int>, B<int>, Alpha<int>)</h3>
475 <p>Draws a circle of color <strong>rgb(R,G,B)</strong> with center at position <strong>(x,y)</strong> and radius of <strong>rad</strong>.</p>
476 <h3>6.6. draw_filled_circle(x<int>, y<int>, rad<int>, R<int>, G<int>, B<int>, Alpha<int>)</h3>
477 <p>Draws a filled circle of color <strong>rgb(R,G,B)</strong> with center at position <strong>(x,y)</strong> and radius of <strong>rad</strong>.</p>
478 <h3>6.7. draw_ellipse(x<int>, y<int>, x_rad<int>, y_rad<int>, R<int>, G<int>, B<int>, Alpha<int>)</h3>
479 <p>Draws an ellipse of color <strong>rgb(R,G,B)</strong> with center at position <strong>(x,y)</strong>, x radius of <strong>x_rad</strong> and y radius of <strong>y_rad</strong>.</p>
480 <h3>6.8. draw_filled_ellipse(x<int>, y<int>, x_rad<int>, y_rad<int>, R<int>, G<int>, B<int>, Alpha<int>)</h3>
481 <p>Draws a filled ellipse of color <strong>rgb(R,G,B)</strong> with center at position <strong>(x,y)</strong>, x radius of <strong>x_rad</strong> and y radius of <strong>y_rad</strong>.</p>
482 </div>
489 <h3>7.3. w<int>, h<int> rendered_string_size(font<TTF_Font*>, text<string>)</h3>
490 <p>Returns the width <strong>w</strong> and height <strong>h</strong> of the string <strong>text</strong> as rendered in <strong>font</strong>.</p>
491 <h3>7.4. txt_image<SDL_Surface*> render_string(font<TTF_Font*>, text<string>, R<int>, G<int>, B<int>)</h3>
492 <p>Renders string <strong>text</strong> in the specified <strong>font</strong> and color <strong>rgb(R,G,B)</strong> and returns it as an SDL_Surface.</p>
493 </div>
498 <p>Begins tracking the time between this call and the end tracking call for <strong>id</strong>.
499 Also keeps track of how many times it has been called (good for profiling).</p>
501 <table><tr>
504 </td>
505 <td class="content">Calls for the same id cannot be nested. This would result in the timer being
506 reset for the id, which means that the statistics will be wrong. An error will be
507 thrown if this is attempted.</td>
508 </tr></table>
509 </div>
511 <p>Ends tracking for <strong>id</strong> and adds the time between the begin call and this one to
514 <p>Adds an entry to the value tracking table for <strong>id</strong> of value <strong>val</strong>.</p>
516 <p>Prints out in a nice formatted way (with colors) the statistics for the time
517 tracking and the value tracking.</p>
519 <p>Adds an entry, <strong>msg</strong>, to the log, recording the time since start of execution.
520 The varying argument at the end is a number of strings that specify message
521 classes. Message classes are optional.</p>
523 <p>Prints out the log entries that match all specified classes. If no classes are
524 specified then it prints out all messages. Prints in ascending order of time recorded.</p>
525 </div>
529 </div>
530 </div>
531 </body>
532 </html>