Mercurial > pygame
annotate docs/ref/overlay.html @ 3172:d1b367fc08bc tests-returncode
Use a return code of 1 when the tests fail.
| author | Thomas Kluyver <takowl@gmail.com> |
|---|---|
| date | Wed, 09 Jan 2013 10:13:57 +0000 |
| parents | 0a3be7313aa4 |
| children |
| rev | line source |
|---|---|
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 627 | 3 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
4 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
5 <head> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
7 |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
8 <title>pygame.Overlay — Pygame v1.9.2 documentation</title> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
9 <link rel="stylesheet" href="../_static/pygame.css" type="text/css" /> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
10 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
11 <script type="text/javascript"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
12 var DOCUMENTATION_OPTIONS = { |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
13 URL_ROOT: '../', |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
14 VERSION: '1.9.2', |
| 2225 | 15 COLLAPSE_INDEX: false, |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
16 FILE_SUFFIX: '.html', |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
17 HAS_SOURCE: true |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
18 }; |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
19 </script> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
20 <script type="text/javascript" src="../_static/jquery.js"></script> |
| 2225 | 21 <script type="text/javascript" src="../_static/underscore.js"></script> |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
22 <script type="text/javascript" src="../_static/doctools.js"></script> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
23 <link rel="shortcut icon" href="../_static/pygame.ico"/> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
24 <link rel="top" title="Pygame v1.9.2 documentation" href="../index.html" /> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
25 <link rel="next" title="pygame.PixelArray" href="pixelarray.html" /> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
26 <link rel="prev" title="pygame.mixer.music" href="music.html" /> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
27 </head> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
28 <body> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
29 |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
30 <div class="document"> |
| 627 | 31 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
32 <div class="header"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
33 <table> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
34 <tr> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
35 <td class="logo"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
36 <a href="http://www.pygame.org/"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
37 <img src="../_static/pygame_tiny.png"/> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
38 </a> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
39 <h5>pygame documentation</h5> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
40 </td> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
41 <td class="pagelinks"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
42 <p class="top"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
43 || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
44 <a href="http://www.pygame.org/">Pygame Home</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
45 <a href="../index.html">Help Contents</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
46 <a href="../genindex.html">Reference Index</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
47 </p> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
48 <p class="bottom"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
49 <a href="camera.html">camera</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
50 <a href="cdrom.html">cdrom</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
51 <a href="color.html">Color</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
52 <a href="cursors.html">cursors</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
53 <a href="display.html">display</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
54 <a href="draw.html">draw</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
55 <a href="event.html">event</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
56 <a href="examples.html">examples</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
57 <a href="font.html">font</a> || |
|
3065
0a3be7313aa4
Enable pygame._freetype extension module build by default
Lenard Lindstrom <len-l@telus.net>
parents:
2239
diff
changeset
|
58 <a href="freetype.html">freetype</a> || |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
59 <a href="gfxdraw.html">gfxdraw</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
60 <a href="image.html">image</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
61 <a href="joystick.html">joystick</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
62 <a href="key.html">key</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
63 <a href="locals.html">locals</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
64 <a href="mask.html">mask</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
65 <a href="math.html">math</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
66 <a href="midi.html">midi</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
67 <a href="mixer.html">mixer</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
68 <a href="mouse.html">mouse</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
69 <a href="movie.html">movie</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
70 <a href="music.html">music</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
71 <a href="overlay.html">Overlay</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
72 <a href="pixelarray.html">PixelArray</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
73 <a href="pixelcopy.html">pixelcopy</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
74 <a href="pygame.html">pygame</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
75 <a href="rect.html">Rect</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
76 <a href="scrap.html">scrap</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
77 <a href="sndarray.html">sndarray</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
78 <a href="sprite.html">sprite</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
79 <a href="surface.html">Surface</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
80 <a href="surfarray.html">surfarray</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
81 <a href="tests.html">tests</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
82 <a href="time.html">time</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
83 <a href="transform.html">transform</a> || |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
84 <a href="pygame.html#module-pygame.version">version</a> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
85 </p> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
86 </td> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
87 </tr> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
88 </table> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
89 </div> |
| 627 | 90 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
91 <div class="documentwrapper"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
92 <div class="body"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
93 |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
94 <div class="sectionwrapper"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
95 <div class="section" id="pygame-overlay"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
96 <dl class="definition class"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
97 <dt class="title" id="pygame.Overlay"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
98 <em class="property">class </em><tt class="descclassname">pygame.</tt><tt class="descname">Overlay</tt><a class="headerlink" href="#pygame.Overlay" title="Permalink to this definition">¶</a></dt> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
99 <dd><div class="line-block"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
100 <div class="line"><span class="summaryline">pygame object for video overlay graphics</span></div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
101 <div class="line"><span class="signature">Overlay(format, (width, height)) -> Overlay</span></div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
102 </div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
103 <table border="1" class="toc docutils"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
104 <colgroup> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
105 <col width="35%" /> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
106 <col width="1%" /> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
107 <col width="64%" /> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
108 </colgroup> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
109 <tbody valign="top"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
110 <tr><td><a class="toc reference external" href="overlay.html#pygame.Overlay.display">pygame.Overlay.display</a></td> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
111 <td>—</td> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
112 <td>set the overlay pixel data</td> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
113 </tr> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
114 <tr><td><a class="toc reference external" href="overlay.html#pygame.Overlay.set_location">pygame.Overlay.set_location</a></td> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
115 <td>—</td> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
116 <td>control where the overlay is displayed</td> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
117 </tr> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
118 <tr><td><a class="toc reference external" href="overlay.html#pygame.Overlay.get_hardware">pygame.Overlay.get_hardware</a></td> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
119 <td>—</td> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
120 <td>test if the Overlay is hardware accelerated</td> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
121 </tr> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
122 </tbody> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
123 </table> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
124 <p>The Overlay objects provide support for accessing hardware video overlays. |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
125 Video overlays do not use standard <tt class="docutils literal"><span class="pre">RGB</span></tt> pixel formats, and can use |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
126 multiple resolutions of data to create a single image.</p> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
127 <p>The Overlay objects represent lower level access to the display hardware. To |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
128 use the object you must understand the technical details of video overlays.</p> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
129 <p>The Overlay format determines the type of pixel data used. Not all hardware |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
130 will support all types of overlay formats. Here is a list of available |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
131 format types:</p> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
132 <div class="highlight-python"><div class="highlight"><pre><span class="n">YV12_OVERLAY</span><span class="p">,</span> <span class="n">IYUV_OVERLAY</span><span class="p">,</span> <span class="n">YUV2_OVERLAY</span><span class="p">,</span> <span class="n">UYVY_OVERLAY</span><span class="p">,</span> <span class="n">YVYU_OVERLAY</span> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
133 </pre></div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
134 </div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
135 <p>The width and height arguments control the size for the overlay image data. |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
136 The overlay image can be displayed at any size, not just the resolution of |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
137 the overlay.</p> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
138 <p>The overlay objects are always visible, and always show above the regular |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
139 display contents.</p> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
140 <dl class="definition method"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
141 <dt class="title" id="pygame.Overlay.display"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
142 <tt class="descname">display</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.Overlay.display" title="Permalink to this definition">¶</a></dt> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
143 <dd><div class="line-block"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
144 <div class="line"><span class="summaryline">set the overlay pixel data</span></div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
145 <div class="line"><span class="signature">display((y, u, v)) -> None</span></div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
146 <div class="line"><span class="signature">display() -> None</span></div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
147 </div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
148 <p>Display the yuv data in SDL’s overlay planes. The y, u, and v arguments |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
149 are strings of binary data. The data must be in the correct format used |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
150 to create the Overlay.</p> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
151 <p>If no argument is passed in, the Overlay will simply be redrawn with the |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
152 current data. This can be useful when the Overlay is not really hardware |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
153 accelerated.</p> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
154 <p>The strings are not validated, and improperly sized strings could crash |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
155 the program.</p> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
156 </dd></dl> |
| 627 | 157 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
158 <dl class="definition method"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
159 <dt class="title" id="pygame.Overlay.set_location"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
160 <tt class="descname">set_location</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.Overlay.set_location" title="Permalink to this definition">¶</a></dt> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
161 <dd><div class="line-block"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
162 <div class="line"><span class="summaryline">control where the overlay is displayed</span></div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
163 <div class="line"><span class="signature">set_location(rect) -> None</span></div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
164 </div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
165 <p>Set the location for the overlay. The overlay will always be shown |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
166 relative to the main display Surface. This does not actually redraw the |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
167 overlay, it will be updated on the next call to <tt class="docutils literal"><span class="pre">Overlay.display()</span></tt>.</p> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
168 </dd></dl> |
| 627 | 169 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
170 <dl class="definition method"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
171 <dt class="title" id="pygame.Overlay.get_hardware"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
172 <tt class="descname">get_hardware</tt><big>(</big><big>)</big><a class="headerlink" href="#pygame.Overlay.get_hardware" title="Permalink to this definition">¶</a></dt> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
173 <dd><div class="line-block"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
174 <div class="line"><span class="summaryline">test if the Overlay is hardware accelerated</span></div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
175 <div class="line"><span class="signature">get_hardware(rect) -> int</span></div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
176 </div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
177 <p>Returns a True value when the Overlay is hardware accelerated. If the |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
178 platform does not support acceleration, software rendering is used.</p> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
179 </dd></dl> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
180 |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
181 </dd></dl> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
182 |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
183 </div> |
| 627 | 184 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
185 </div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
186 </div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
187 </div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
188 <div class="clearer"></div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
189 </div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
190 <div class="related"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
191 <h3>Navigation</h3> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
192 <ul> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
193 <li class="right" style="margin-right: 10px"> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
194 <a href="../genindex.html" title="General Index" |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
195 accesskey="I">index</a></li> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
196 <li class="right" > |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
197 <a href="pixelarray.html" title="pygame.PixelArray" |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
198 accesskey="N">next</a> |</li> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
199 <li class="right" > |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
200 <a href="music.html" title="pygame.mixer.music" |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
201 accesskey="P">previous</a> |</li> |
|
2239
ca88e9308d44
regenerated html docs. Should all have doc comments from the website now.
Rene Dudfield <renesd@gmail.com>
parents:
2225
diff
changeset
|
202 <li><a href="../index.html">Pygame v1.9.2 documentation</a> »</li> |
|
ca88e9308d44
regenerated html docs. Should all have doc comments from the website now.
Rene Dudfield <renesd@gmail.com>
parents:
2225
diff
changeset
|
203 <script type="text/javascript" src="jquery.plugin.docscomments.js"></script> |
|
ca88e9308d44
regenerated html docs. Should all have doc comments from the website now.
Rene Dudfield <renesd@gmail.com>
parents:
2225
diff
changeset
|
204 |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
205 </ul> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
206 </div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
207 <div class="footer"> |
| 2225 | 208 © Copyright 2011, Pygame Developers. |
|
2198
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
209 </div> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
210 </body> |
|
da4302429d3b
replace makeref.py generated documents with makeref2.py documents
Lenard Lindstrom <len-l@telus.net>
parents:
2148
diff
changeset
|
211 </html> |
