Commit | Line | Data |
162a0989 |
1 | <div class="pod"> |
2 | <!-- INDEX START --> |
3 | <h3 id="TOP">Index</h3> |
4 | |
5 | <ul><li><a href="#NAME">NAME</a></li> |
bfdd9c2e |
6 | <li><a href="#CATEGORY">CATEGORY</a></li> |
162a0989 |
7 | <li><a href="#SYNOPSIS">SYNOPSIS</a></li> |
8 | <li><a href="#DESCRIPTION">DESCRIPTION</a></li> |
9 | <li><a href="#METHODS">METHODS</a> |
10 | <ul><li><a href="#new">new</a></li> |
285d0cd2 |
11 | <li><a href="#title">title()</a></li> |
12 | <li><a href="#title_new_title">title( $new_title )</a></li> |
13 | <li><a href="#title_window_title_icon_title">title( $window_title, $icon_title )</a></li> |
14 | <li><a href="#delay_ms">delay( $ms )</a></li> |
162a0989 |
15 | <li><a href="#ticks">ticks</a></li> |
16 | <li><a href="#error">error</a></li> |
285d0cd2 |
17 | <li><a href="#resize_width_height">resize( $width, $height )</a></li> |
162a0989 |
18 | <li><a href="#fullscreen">fullscreen</a></li> |
19 | <li><a href="#iconify">iconify</a></li> |
285d0cd2 |
20 | <li><a href="#grab_input_CONSTANT">grab_input( $CONSTANT )</a></li> |
21 | <li><a href="#loop_actions">loop( \%actions )</a></li> |
162a0989 |
22 | <li><a href="#sync">sync</a></li> |
285d0cd2 |
23 | <li><a href="#attribute_attr">attribute( $attr )</a></li> |
24 | <li><a href="#attribute_attr_value">attribute( $attr, $value )</a></li> |
162a0989 |
25 | </ul> |
26 | </li> |
27 | <li><a href="#AUTHOR">AUTHOR</a></li> |
28 | <li><a href="#SEE_ALSO">SEE ALSO</a> |
29 | </li> |
30 | </ul><hr /> |
31 | <!-- INDEX END --> |
32 | |
33 | <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p> |
34 | <div id="NAME_CONTENT"> |
ca0a3441 |
35 | <p>SDLx::App - a SDL perl extension</p> |
162a0989 |
36 | |
37 | </div> |
bfdd9c2e |
38 | <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p> |
39 | <div id="CATEGORY_CONTENT"> |
40 | <p>Extension</p> |
41 | |
42 | </div> |
162a0989 |
43 | <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
44 | <div id="SYNOPSIS_CONTENT"> |
f373167e |
45 | <pre> use SDL; |
ca0a3441 |
46 | use SDLx::App; |
f373167e |
47 | use SDL::Event; |
48 | use SDL::Events; |
49 | |
ca0a3441 |
50 | my $app = SDLx::App->new( |
505f308d |
51 | title => 'Application Title', |
52 | width => 640, |
53 | height => 480, |
54 | depth => 32 |
f373167e |
55 | ); |
162a0989 |
56 | |
57 | </pre> |
285d0cd2 |
58 | <p>This is the manual way of doing things</p> |
f373167e |
59 | <pre> my $event = SDL::Event->new; # create a new event |
162a0989 |
60 | |
f373167e |
61 | SDL::Events::pump_events(); |
162a0989 |
62 | |
f373167e |
63 | while ( SDL::Events::poll_event($event) ) { |
64 | my $type = $event->type(); # get event type |
65 | print $type; |
66 | exit if $type == SDL_QUIT; |
67 | } |
162a0989 |
68 | |
69 | </pre> |
285d0cd2 |
70 | <p>An alternative to the manual Event processing is the <a href="http://search.cpan.org/perldoc?SDLx::App::loop">SDLx::App::loop</a>.</p> |
162a0989 |
71 | |
72 | </div> |
73 | <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
74 | <div id="DESCRIPTION_CONTENT"> |
ca0a3441 |
75 | <p><a href="http://search.cpan.org/perldoc?SDLx::App">SDLx::App</a> controls the root window of the of your SDL based application. |
55bbf7a2 |
76 | It extends the <a href="SDL-Surface.html">SDL::Surface</a> class, and provides an interface to the window |
162a0989 |
77 | manager oriented functions.</p> |
78 | |
79 | </div> |
80 | <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
81 | <div id="METHODS_CONTENT"> |
82 | |
83 | </div> |
84 | <h2 id="new">new</h2> |
85 | <div id="new_CONTENT"> |
ca0a3441 |
86 | <p><code>SDLx::App::new</code> initializes the SDL, creates a new screen, |
162a0989 |
87 | and initializes some of the window manager properties. |
ca0a3441 |
88 | <code>SDLx::App::new</code> takes a series of named parameters:</p> |
285d0cd2 |
89 | <dl> |
90 | <dt>* title</dt> |
91 | <dt>* icon_title</dt> |
92 | <dt>* icon</dt> |
93 | <dt>* width</dt> |
94 | <dt>* height</dt> |
95 | <dt>* depth</dt> |
96 | <dt>* flags</dt> |
97 | <dt>* resizeable</dt> |
98 | </dl> |
99 | |
100 | |
101 | |
162a0989 |
102 | |
103 | |
104 | </div> |
285d0cd2 |
105 | <h2 id="title">title()</h2> |
162a0989 |
106 | <div id="title_CONTENT"> |
162a0989 |
107 | |
108 | </div> |
285d0cd2 |
109 | <h2 id="title_new_title">title( $new_title )</h2> |
110 | <div id="title_new_title_CONTENT"> |
111 | |
112 | </div> |
113 | <h2 id="title_window_title_icon_title">title( $window_title, $icon_title )</h2> |
114 | <div id="title_window_title_icon_title_CONTEN"> |
115 | <p><code>SDLx::App::title</code> takes 0, 1, or 2 arguments. If no parameter is given, |
116 | it returns the current application window title. If one parameter is |
117 | passed, both the window title and icon title will be set to its value. |
118 | If two parameters are passed the window title will be set to the first, |
119 | and the icon title to the second.</p> |
120 | |
121 | </div> |
122 | <h2 id="delay_ms">delay( $ms )</h2> |
123 | <div id="delay_ms_CONTENT"> |
ca0a3441 |
124 | <p><code>SDLx::App::delay</code> takes 1 argument, and will sleep the application for |
162a0989 |
125 | that many ms.</p> |
126 | |
127 | </div> |
128 | <h2 id="ticks">ticks</h2> |
129 | <div id="ticks_CONTENT"> |
ca0a3441 |
130 | <p><code>SDLx::App::ticks</code> returns the number of ms since the application began.</p> |
162a0989 |
131 | |
132 | </div> |
133 | <h2 id="error">error</h2> |
134 | <div id="error_CONTENT"> |
ca0a3441 |
135 | <p><code>SDLx::App::error</code> returns the last error message set by the SDL.</p> |
162a0989 |
136 | |
137 | </div> |
285d0cd2 |
138 | <h2 id="resize_width_height">resize( $width, $height )</h2> |
139 | <div id="resize_width_height_CONTENT"> |
140 | <p><code>SDLx::App::resize</code> takes a new width and height of the application. Only |
141 | works if the application was originally created with the resizable option.</p> |
162a0989 |
142 | |
143 | </div> |
144 | <h2 id="fullscreen">fullscreen</h2> |
145 | <div id="fullscreen_CONTENT"> |
ca0a3441 |
146 | <p><code>SDLx::App::fullscreen</code> toggles the application in and out of fullscreen mode.</p> |
162a0989 |
147 | |
148 | </div> |
149 | <h2 id="iconify">iconify</h2> |
150 | <div id="iconify_CONTENT"> |
285d0cd2 |
151 | <p><code>SDLx::App::iconify</code> iconifies the application window.</p> |
162a0989 |
152 | |
153 | </div> |
285d0cd2 |
154 | <h2 id="grab_input_CONSTANT">grab_input( $CONSTANT )</h2> |
155 | <div id="grab_input_CONSTANT_CONTENT"> |
ca0a3441 |
156 | <p><code>SDLx::App::grab_input</code> can be used to change the input focus behavior of |
285d0cd2 |
157 | the application. It takes one argument, which should be one of the following:</p> |
162a0989 |
158 | <dl> |
285d0cd2 |
159 | <dt>* SDL_GRAB_QUERY</dt> |
160 | <dt>* SDL_GRAB_ON</dt> |
161 | <dt>* SDL_GRAB_OFF</dt> |
162a0989 |
162 | </dl> |
163 | |
164 | </div> |
285d0cd2 |
165 | <h2 id="loop_actions">loop( \%actions )</h2> |
166 | <div id="loop_actions_CONTENT"> |
ca0a3441 |
167 | <p><code>SDLx::App::loop</code> is a simple event loop method which takes a reference to a hash |
285d0cd2 |
168 | of event handler subroutines. The keys of the hash must be SDL event types such |
169 | as SDL_QUIT(), SDL_KEYDOWN(), and the like. When called, the event method recieves |
170 | as its parameter the event object used in the loop.</p> |
f373167e |
171 | <p>Example:</p> |
ca0a3441 |
172 | <pre> my $app = SDLx::App->new( |
505f308d |
173 | title => "test.app", |
174 | width => 800, |
175 | height => 600, |
176 | depth => 32 |
f373167e |
177 | ); |
178 | |
179 | my %actions = ( |
180 | SDL_QUIT() => sub { exit(0); }, |
181 | SDL_KEYDOWN() => sub { print "Key Pressed" }, |
182 | ); |
183 | |
184 | $app->loop( \%actions ); |
162a0989 |
185 | |
186 | </pre> |
187 | |
188 | </div> |
189 | <h2 id="sync">sync</h2> |
190 | <div id="sync_CONTENT"> |
ca0a3441 |
191 | <p><code>SDLx::App::sync</code> encapsulates the various methods of syncronizing the screen with the |
285d0cd2 |
192 | current video buffer. <code>SDLx::App::sync</code> will do a fullscreen update, using the double buffer |
193 | or OpenGL buffer if applicable. This is prefered to calling flip on the application window.</p> |
194 | |
195 | </div> |
196 | <h2 id="attribute_attr">attribute( $attr )</h2> |
197 | <div id="attribute_attr_CONTENT"> |
162a0989 |
198 | |
199 | </div> |
285d0cd2 |
200 | <h2 id="attribute_attr_value">attribute( $attr, $value )</h2> |
162a0989 |
201 | <div id="attribute_attr_value_CONTENT"> |
285d0cd2 |
202 | <p><code>SDLx::App::attribute</code> allows one to get and set GL attributes. By passing a value |
203 | in addition to the attribute selector, the value will be set. <code>SDL:::App::attribute</code> |
162a0989 |
204 | always returns the current value of the given attribute, or croaks on failure.</p> |
205 | |
206 | </div> |
207 | <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
208 | <div id="AUTHOR_CONTENT"> |
209 | <p>David J. Goehrig |
210 | Kartik Thakore</p> |
211 | |
212 | </div> |
213 | <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p> |
214 | <div id="SEE_ALSO_CONTENT"> |
55bbf7a2 |
215 | <p><a href="http://search.cpan.org/perldoc?perl">perl</a> <a href="SDL-Surface.html">SDL::Surface</a> <a href="SDL-Event.html">SDL::Event</a> <a href="SDL-OpenGL.html">SDL::OpenGL</a></p> |
162a0989 |
216 | |
217 | </div> |
218 | </div> |