Mercurial > sdl-ios-xcode
annotate docs/html/sdlsetcolors.html @ 4139:568c9b3c0167 SDL-1.2
* Added configure option --enable-screensaver, to allow enabling the screensaver by default.
* Use XResetScreenSaver() instead of disabling screensaver entirely.
Full discussion summary from Erik on the SDL mailing list:
Current behaviour
=================
SDL changes the user's display power management settings without
permission from the user and without telling the user.
The interface that it uses to do so is DPMSDisable/DPMSEnable, which
should only ever be used by configuration utilities like KControl, never
by normal application programs, let alone by the libraries that they
use. Using an interface that is not at all intended for what SDL tries
to achieve means that it will not work as it should. Firstly, the power
management is completely disabled during the whole lifetime of the SDL
program, not only when it should be. Secondly, it makes SDL
non-reentrant, meaning that things will break when multiple SDL programs
are clients of the same X server simultaneously. Thirdly, no cleanup
mechanism ensures that the setting is restored if the client does not do
that (for example if it crashes).
In addition to that, this interface is broken on xorg,
[http://bugs.freedesktop.org/show_bug.cgi?id=13962], so what SDL tries
to do does not work at all on that implementation of the X Window
System. (The reason that the DPMSEnable works in KControl is that it
calls DPMSSetTimeout immediately after,
[http://websvn.kde.org/tags/KDE/3.5.9/kdebase/kcontrol/energy/energy.cpp?annotate=774532#l343]).
The problems that the current behaviour causes
==============================================
1. Information leak. When the user is away, someone might see what the
user has on the display when the user counts on the screensaver
preventing this. This does not even require physical access to the
workstation, it is enough to see it from a distance.
2. Draining battery. An SDL program that runs on a laptop will quickly
drain the battery while the user is away. The system will soon shut down
and require recharging before being usable again, while it should in
fact have consumed very little energy if the user's settings would have
been obeyed.
3. Wasting energy. Even if battery issues are not considered, energy as
such is wasted.
4. Display wear. The display may be worn out.
The problems that the current behaviour tries to solve
======================================================
1. Preventing screensaver while playing movies.
Many SDL applications are media players. They have reasons to prevent
screensavers from being activated while a movie is being played. When a
user clicks on the play button it can be interpreted as saying "play
this movie, but do not turn off the display while playing it, because I
will watch it even though I do not interact with the system".
2. Preventing screensaver when some input bypasses X.
Sometimes SDL uses input from another source than the X server, so
that the X server is bypassed. This obviously breaks the screensaver
handling. SDL tries to work around that.
3. Preventing screensaver when all input bypasses X.
There is something called Direct Graphics Access mode, where a
program takes control of both the display and the input devices from the
X server. This obviously means that the X server can not handle the
screensaver alone, since screensaver handling depends on input handling.
SDL does not do what it should to help the X server to handle the
screensaver. Nor does SDL take care of screeensaver handling itself. SDL
simply disables the screensaver completely.
How the problems should be solved
=================================
The correct way for an application program to prevent the screensaver
under X is to call XResetScreenSaver. This was recently discovered and
implemented by the mplayer developers,
[http://svn.mplayerhq.hu/mplayer?view=rev&revision=25637]. SDL needs to
wrap this in an API call (SDL_ResetScreenSaver) and implement it for the
other video targets (if they do not have a corresponding call, SDL
should do what it takes on that particular target, for example sending
fake key events).
1. When a movie is played, the player should reset the screensaver when
the animation is advanced to a new frame. The same applies to anything
similar, like slideshows.
2. When the X server is handling input, it must handle all input
(keyboards, mice, gamepads, ...). This is necessary, not only to be able
to handle the screensaver, but also so that it can send the events to
the correct (the currently active) client. If there is an input device
that the X server can not handle for some reason (such as lack of Plug
and Play capability), the program that handles the device as a
workaround must simulate what would happen if the X server would have
handled the device, by calling XResetScreenSaver when input is received
from the device.
3. When the X server is not handling the input, it depends on the
program that does to call XResetScreenSaver whenever an input event
occurs. Alternatively the program must handle the screensaver countdown
internally and call XActivateScreenSaver.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 29 Feb 2008 13:55:44 +0000 |
parents | 355632dca928 |
children |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_SetColors</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
0 | 8 "><LINK |
9 REL="HOME" | |
10 TITLE="SDL Library Documentation" | |
11 HREF="index.html"><LINK | |
12 REL="UP" | |
13 TITLE="Video" | |
14 HREF="video.html"><LINK | |
15 REL="PREVIOUS" | |
16 TITLE="SDL_Flip" | |
17 HREF="sdlflip.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_SetPalette" | |
20 HREF="sdlsetpalette.html"></HEAD | |
21 ><BODY | |
22 CLASS="REFENTRY" | |
23 BGCOLOR="#FFF8DC" | |
24 TEXT="#000000" | |
25 LINK="#0000ee" | |
26 VLINK="#551a8b" | |
27 ALINK="#ff0000" | |
28 ><DIV | |
29 CLASS="NAVHEADER" | |
30 ><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
31 SUMMARY="Header navigation table" |
0 | 32 WIDTH="100%" |
33 BORDER="0" | |
34 CELLPADDING="0" | |
35 CELLSPACING="0" | |
36 ><TR | |
37 ><TH | |
38 COLSPAN="3" | |
39 ALIGN="center" | |
40 >SDL Library Documentation</TH | |
41 ></TR | |
42 ><TR | |
43 ><TD | |
44 WIDTH="10%" | |
45 ALIGN="left" | |
46 VALIGN="bottom" | |
47 ><A | |
48 HREF="sdlflip.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
49 ACCESSKEY="P" |
0 | 50 >Prev</A |
51 ></TD | |
52 ><TD | |
53 WIDTH="80%" | |
54 ALIGN="center" | |
55 VALIGN="bottom" | |
56 ></TD | |
57 ><TD | |
58 WIDTH="10%" | |
59 ALIGN="right" | |
60 VALIGN="bottom" | |
61 ><A | |
62 HREF="sdlsetpalette.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
63 ACCESSKEY="N" |
0 | 64 >Next</A |
65 ></TD | |
66 ></TR | |
67 ></TABLE | |
68 ><HR | |
69 ALIGN="LEFT" | |
70 WIDTH="100%"></DIV | |
71 ><H1 | |
72 ><A | |
73 NAME="SDLSETCOLORS" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
74 ></A |
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
75 >SDL_SetColors</H1 |
0 | 76 ><DIV |
77 CLASS="REFNAMEDIV" | |
78 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
79 NAME="AEN1462" |
0 | 80 ></A |
81 ><H2 | |
82 >Name</H2 | |
83 >SDL_SetColors -- Sets a portion of the colormap for the given 8-bit surface.</DIV | |
84 ><DIV | |
85 CLASS="REFSYNOPSISDIV" | |
86 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
87 NAME="AEN1465" |
0 | 88 ></A |
89 ><H2 | |
90 >Synopsis</H2 | |
91 ><DIV | |
92 CLASS="FUNCSYNOPSIS" | |
93 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
94 NAME="AEN1466" |
0 | 95 ></A |
96 ><P | |
97 ></P | |
98 ><PRE | |
99 CLASS="FUNCSYNOPSISINFO" | |
100 >#include "SDL.h"</PRE | |
101 ><P | |
102 ><CODE | |
103 ><CODE | |
104 CLASS="FUNCDEF" | |
105 >int <B | |
106 CLASS="FSFUNC" | |
107 >SDL_SetColors</B | |
108 ></CODE | |
109 >(SDL_Surface *surface, SDL_Color *colors, int firstcolor, int ncolors);</CODE | |
110 ></P | |
111 ><P | |
112 ></P | |
113 ></DIV | |
114 ></DIV | |
115 ><DIV | |
116 CLASS="REFSECT1" | |
117 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
118 NAME="AEN1472" |
0 | 119 ></A |
120 ><H2 | |
121 >Description</H2 | |
122 ><P | |
123 >Sets a portion of the colormap for the given 8-bit surface.</P | |
124 ><P | |
125 >When <TT | |
126 CLASS="PARAMETER" | |
127 ><I | |
128 >surface</I | |
129 ></TT | |
130 > is the surface associated with the current | |
131 display, the display colormap will be updated with the requested colors. If | |
132 <TT | |
133 CLASS="LITERAL" | |
134 >SDL_HWPALETTE</TT | |
135 > was set in <A | |
136 HREF="sdlsetvideomode.html" | |
137 >SDL_SetVideoMode</A | |
138 > flags, | |
139 <TT | |
140 CLASS="FUNCTION" | |
141 >SDL_SetColors</TT | |
142 > will always return <SPAN | |
143 CLASS="RETURNVALUE" | |
144 >1</SPAN | |
145 >, | |
146 and the palette is guaranteed to be set the way you desire, even if the window | |
147 colormap has to be warped or run under emulation.</P | |
148 ><P | |
149 >The color components of a | |
150 <A | |
151 HREF="sdlcolor.html" | |
152 ><SPAN | |
153 CLASS="STRUCTNAME" | |
154 >SDL_Color</SPAN | |
155 ></A | |
156 > | |
157 structure are 8-bits in size, giving you a total of 256<SUP | |
158 >3</SUP | |
159 > | |
160 =16777216 colors.</P | |
161 ><P | |
162 >Palettized (8-bit) screen surfaces with the <TT | |
163 CLASS="LITERAL" | |
164 >SDL_HWPALETTE</TT | |
165 > | |
166 flag have two palettes, a logical palette that is used for mapping blits | |
167 to/from the surface and a physical palette (that determines how the | |
168 hardware will map the colors to the display). <TT | |
169 CLASS="FUNCTION" | |
170 >SDL_SetColors</TT | |
171 > | |
172 modifies both palettes (if present), and is equivalent to calling | |
173 <A | |
174 HREF="sdlsetpalette.html" | |
175 >SDL_SetPalette</A | |
176 > with the | |
177 <TT | |
178 CLASS="PARAMETER" | |
179 ><I | |
180 >flags</I | |
181 ></TT | |
182 > set to | |
183 <TT | |
184 CLASS="LITERAL" | |
185 >(SDL_LOGPAL | SDL_PHYSPAL)</TT | |
186 >.</P | |
187 ></DIV | |
188 ><DIV | |
189 CLASS="REFSECT1" | |
190 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
191 NAME="AEN1491" |
0 | 192 ></A |
193 ><H2 | |
194 >Return Value</H2 | |
195 ><P | |
196 >If <TT | |
197 CLASS="PARAMETER" | |
198 ><I | |
199 >surface</I | |
200 ></TT | |
201 > is not a palettized surface, this function | |
202 does nothing, returning <SPAN | |
203 CLASS="RETURNVALUE" | |
204 >0</SPAN | |
205 >. If all of the colors were set | |
206 as passed to <TT | |
207 CLASS="FUNCTION" | |
208 >SDL_SetColors</TT | |
209 >, it will return | |
210 <SPAN | |
211 CLASS="RETURNVALUE" | |
212 >1</SPAN | |
213 >. If not all the color entries were set exactly as | |
214 given, it will return <SPAN | |
215 CLASS="RETURNVALUE" | |
216 >0</SPAN | |
217 >, and you should look at the | |
218 surface palette to determine the actual color palette.</P | |
219 ></DIV | |
220 ><DIV | |
221 CLASS="REFSECT1" | |
222 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
223 NAME="AEN1499" |
0 | 224 ></A |
225 ><H2 | |
226 >Example</H2 | |
227 ><PRE | |
228 CLASS="PROGRAMLISTING" | |
229 >/* Create a display surface with a grayscale palette */ | |
230 SDL_Surface *screen; | |
231 SDL_Color colors[256]; | |
232 int i; | |
233 . | |
234 . | |
235 . | |
236 /* Fill colors with color information */ | |
237 for(i=0;i<256;i++){ | |
238 colors[i].r=i; | |
239 colors[i].g=i; | |
240 colors[i].b=i; | |
241 } | |
242 | |
243 /* Create display */ | |
244 screen=SDL_SetVideoMode(640, 480, 8, SDL_HWPALETTE); | |
245 if(!screen){ | |
246 printf("Couldn't set video mode: %s\n", SDL_GetError()); | |
247 exit(-1); | |
248 } | |
249 | |
250 /* Set palette */ | |
251 SDL_SetColors(screen, colors, 0, 256); | |
252 . | |
253 . | |
254 . | |
255 .</PRE | |
256 ></DIV | |
257 ><DIV | |
258 CLASS="REFSECT1" | |
259 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
260 NAME="AEN1502" |
0 | 261 ></A |
262 ><H2 | |
263 >See Also</H2 | |
264 ><P | |
265 ><A | |
266 HREF="sdlcolor.html" | |
267 ><SPAN | |
268 CLASS="STRUCTNAME" | |
269 >SDL_Color</SPAN | |
270 ></A | |
271 > | |
272 <A | |
273 HREF="sdlsurface.html" | |
274 ><SPAN | |
275 CLASS="STRUCTNAME" | |
276 >SDL_Surface</SPAN | |
277 ></A | |
278 >, | |
279 <A | |
280 HREF="sdlsetpalette.html" | |
281 ><TT | |
282 CLASS="FUNCTION" | |
283 >SDL_SetPalette</TT | |
284 ></A | |
285 >, | |
286 <A | |
287 HREF="sdlsetvideomode.html" | |
288 ><TT | |
289 CLASS="FUNCTION" | |
290 >SDL_SetVideoMode</TT | |
291 ></A | |
292 ></P | |
293 ></DIV | |
294 ><DIV | |
295 CLASS="NAVFOOTER" | |
296 ><HR | |
297 ALIGN="LEFT" | |
298 WIDTH="100%"><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
299 SUMMARY="Footer navigation table" |
0 | 300 WIDTH="100%" |
301 BORDER="0" | |
302 CELLPADDING="0" | |
303 CELLSPACING="0" | |
304 ><TR | |
305 ><TD | |
306 WIDTH="33%" | |
307 ALIGN="left" | |
308 VALIGN="top" | |
309 ><A | |
310 HREF="sdlflip.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
311 ACCESSKEY="P" |
0 | 312 >Prev</A |
313 ></TD | |
314 ><TD | |
315 WIDTH="34%" | |
316 ALIGN="center" | |
317 VALIGN="top" | |
318 ><A | |
319 HREF="index.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
320 ACCESSKEY="H" |
0 | 321 >Home</A |
322 ></TD | |
323 ><TD | |
324 WIDTH="33%" | |
325 ALIGN="right" | |
326 VALIGN="top" | |
327 ><A | |
328 HREF="sdlsetpalette.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
329 ACCESSKEY="N" |
0 | 330 >Next</A |
331 ></TD | |
332 ></TR | |
333 ><TR | |
334 ><TD | |
335 WIDTH="33%" | |
336 ALIGN="left" | |
337 VALIGN="top" | |
338 >SDL_Flip</TD | |
339 ><TD | |
340 WIDTH="34%" | |
341 ALIGN="center" | |
342 VALIGN="top" | |
343 ><A | |
344 HREF="video.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
345 ACCESSKEY="U" |
0 | 346 >Up</A |
347 ></TD | |
348 ><TD | |
349 WIDTH="33%" | |
350 ALIGN="right" | |
351 VALIGN="top" | |
352 >SDL_SetPalette</TD | |
353 ></TR | |
354 ></TABLE | |
355 ></DIV | |
356 ></BODY | |
357 ></HTML | |
358 > |