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> |
7067312b |
7 | <li><a href="#SYNOPSIS">SYNOPSIS</a></li> |
162a0989 |
8 | <li><a href="#METHODS">METHODS</a> |
9 | <ul><li><a href="#get_video_surface">get_video_surface</a></li> |
10 | <li><a href="#get_video_info">get_video_info</a></li> |
11 | <li><a href="#video_driver_name">video_driver_name</a></li> |
12 | <li><a href="#list_modes_formats_flags">list_modes(formats,flags)</a></li> |
13 | <li><a href="#video_mode_ok_width_height_bpp_flags">video_mode_ok(width,height,bpp,flags)</a></li> |
14 | <li><a href="#set_video_mode_width_height_bpp_flag">set_video_mode(width,height,bpp,flags)</a> |
162a0989 |
15 | <ul><li><a href="#List_of_avalaibles_flags">List of avalaibles flags</a></li> |
16 | </ul> |
17 | </li> |
162a0989 |
18 | <li><a href="#update_rect_surface_x_y_width_height">update_rect(surface,x,y,width,height)</a></li> |
19 | <li><a href="#update_rects_surface_rects">update_rects(surface,rects) </a></li> |
20 | <li><a href="#flip_surface">flip(surface)</a></li> |
21 | <li><a href="#set_colors_surface_start_colors">set_colors(surface,start,colors)</a></li> |
22 | <li><a href="#set_palette_surface_flags_start_colo">set_palette(surface,flags,start,colors)</a></li> |
23 | <li><a href="#set_gamma_r_g_b">set_gamma(r,g,b)</a></li> |
24 | <li><a href="#get_gamma_ramp_rt_gt_bt_to_be_coded">get_gamma_ramp(rt,gt,bt) * to be coded</a></li> |
25 | <li><a href="#set_gamma_ramp_rt_gt_bt">set_gamma_ramp(rt,gt,bt)</a></li> |
26 | <li><a href="#map_RGB_pixel_format_r_g_b">map_RGB(pixel_format,r,g,b)</a></li> |
27 | <li><a href="#map_RGBA_pixel_format_r_g_b_a">map_RGBA(pixel_format,r,g,b,a)</a></li> |
28 | <li><a href="#get_RGB_pixel_format_pixel">get_RGB(pixel_format,pixel)</a></li> |
29 | <li><a href="#get_RGBA_pixel_format_pixel">get_RGBA(pixel_format,pixel)</a></li> |
30 | <li><a href="#create_RGB_surface_from">create_RGB_surface_from ***</a></li> |
31 | <li><a href="#lock_surface_surface">lock_surface(surface)</a></li> |
32 | <li><a href="#unlock_surface_surface">unlock_surface(surface)</a></li> |
33 | <li><a href="#convert_surface_surface_format_flags">convert_surface(surface,format,flags)</a></li> |
34 | <li><a href="#display_format">display_format</a></li> |
35 | <li><a href="#display_format_alpha">display_format_alpha</a></li> |
36 | <li><a href="#load_BMP_filename">load_BMP(filename)</a></li> |
37 | <li><a href="#save_BMP_surface_filename">save_BMP(surface,filename)</a></li> |
38 | <li><a href="#set_color_key_surface_flag_key">set_color_key(surface,flag,key)</a></li> |
39 | <li><a href="#set_alpha_surface_flag_key">set_alpha(surface,flag,key)</a></li> |
40 | <li><a href="#set_clip_rect_surface_rect">set_clip_rect(surface,rect)</a></li> |
41 | <li><a href="#get_clip_rect_surface_rect">get_clip_rect(surface,rect)</a></li> |
42 | <li><a href="#blit_surface_src_src_rect_dest_dest_">blit_surface(src,src_rect,dest,dest_rect)</a></li> |
43 | <li><a href="#fill_rect_dest_dest_rect_pixel">fill_rect(dest,dest_rect,pixel)</a></li> |
44 | <li><a href="#GL_load_library_path">GL_load_library(path)</a></li> |
45 | <li><a href="#GL_get_proc_address_proc">GL_get_proc_address(proc)</a></li> |
46 | <li><a href="#GL_get_attribute_attr">GL_get_attribute(attr)</a></li> |
47 | <li><a href="#GL_set_attribute_attr_value">GL_set_attribute(attr,value)</a></li> |
48 | <li><a href="#GL_swap_buffers">GL_swap_buffers</a></li> |
49 | <li><a href="#GL_attr_to_be_coded">GL_attr *** to be coded</a></li> |
50 | <li><a href="#lock_YUV_overlay_overlay">lock_YUV_overlay(overlay)</a></li> |
51 | <li><a href="#unlock_YUV_overlay_overlay">unlock_YUV_overlay(overlay)</a></li> |
52 | <li><a href="#display_YUV_overlay_overlay_dstrect">display_YUV_overlay(overlay,dstrect)</a></li> |
53 | </ul> |
54 | </li> |
55 | <li><a href="#SEE_ALSO">SEE ALSO</a> |
56 | <ul><li><a href="#Category_Objects">Category Objects</a> |
57 | </li> |
58 | </ul> |
59 | </li> |
60 | </ul><hr /> |
61 | <!-- INDEX END --> |
62 | |
63 | <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p> |
64 | <div id="NAME_CONTENT"> |
65 | <p>SDL::Video - Bindings to the video category in SDL API</p> |
66 | |
67 | </div> |
bfdd9c2e |
68 | <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p> |
69 | <div id="CATEGORY_CONTENT"> |
70 | <p>Core, Video</p> |
162a0989 |
71 | |
72 | </div> |
7067312b |
73 | <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
74 | <div id="SYNOPSIS_CONTENT"> |
75 | <pre> use SDL; |
76 | use SDL::Video; |
77 | use SDL::Surface; |
78 | use SDL::Rect; |
162a0989 |
79 | |
7067312b |
80 | # the size of the window box or the screen resolution if fullscreen |
81 | my $screen_width = 800; |
82 | my $screen_height = 600; |
162a0989 |
83 | |
7067312b |
84 | SDL::init(SDL_INIT_VIDEO); |
162a0989 |
85 | |
7067312b |
86 | # setting video mode |
87 | my $screen_surface = SDL::Video::set_video_mode($screen_width, $screen_height, 32, SDL_SWSURFACE); |
162a0989 |
88 | |
7067312b |
89 | # drawing something somewhere |
90 | my $mapped_color = SDL::Video::map_RGB($screen_surface->format(), 0, 0, 255); # blue |
91 | SDL::Video::fill_rect($screen_surface, |
92 | SDL::Rect->new($screen_width / 4, $screen_height / 4, |
93 | $screen_width / 2, $screen_height / 2), $mapped_color); |
94 | |
95 | # update an area on the screen so its visible |
96 | SDL::Video::update_rect($screen_surface, 0, 0, $screen_width, $screen_height); |
97 | |
98 | sleep(5); # just to have time to see it |
99 | |
52432657 |
100 | SDL::quit(); |
101 | |
7067312b |
102 | </pre> |
162a0989 |
103 | |
104 | </div> |
105 | <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
106 | <div id="METHODS_CONTENT"> |
107 | |
108 | </div> |
109 | <h2 id="get_video_surface">get_video_surface</h2> |
110 | <div id="get_video_surface_CONTENT"> |
7067312b |
111 | <pre> my $surface = SDL::Video::get_video_surface(); |
112 | |
113 | </pre> |
52432657 |
114 | <p>This function returns the current display <a href="/SDL-Surface.html">SDL::Surface</a>. If SDL is doing format conversion on the display surface, this |
7067312b |
115 | function returns the publicly visible surface, not the real video surface.</p> |
52432657 |
116 | <p>Example:</p> |
117 | <pre> # somewhere after you set the video mode |
118 | my $surface = SDL::Video::get_video_surface(); |
119 | |
120 | printf( "our screen is %d pixels wide and %d pixels high\n", $surface->w, $surface->h ); |
121 | |
122 | </pre> |
162a0989 |
123 | |
124 | </div> |
125 | <h2 id="get_video_info">get_video_info</h2> |
126 | <div id="get_video_info_CONTENT"> |
52432657 |
127 | <pre> my $video_info = SDL::Video::get_video_info(); |
128 | |
129 | </pre> |
130 | <p>This function returns a read-only <a href="/SDL-VideoInfo.html">SDL::VideoInfo</a> containing information about the video hardware. If it is called before |
131 | <a href="#set_video_mode_width_height_bpp_flag">SDL::Video::set_video_mode</a>, the <code>vfmt</code> member of the returned structure will contain the pixel |
132 | format of the <strong>best</strong> video mode. </p> |
133 | <p>Example:</p> |
134 | <pre> use SDL; |
135 | use SDL::Video; |
136 | use SDL::VideoInfo; |
137 | use SDL::PixelFormat; |
138 | |
139 | SDL::init(SDL_INIT_VIDEO); |
140 | |
141 | my $video_info = SDL::Video::get_video_info(); |
142 | |
143 | printf( "we can have %dbits per pixel\n", $video_info->vfmt->BitsPerPixel ); |
144 | |
145 | SDL::quit(); |
146 | |
147 | </pre> |
162a0989 |
148 | |
149 | </div> |
150 | <h2 id="video_driver_name">video_driver_name</h2> |
151 | <div id="video_driver_name_CONTENT"> |
52432657 |
152 | <pre> my $driver_name = SDL::Video::video_driver_name(); |
153 | |
154 | </pre> |
155 | <p>This function will return the name of the initialized video driver up to a maximum of 1024 characters. The driver name is a simple one |
156 | word identifier like <code>"x11"</code>, <code>"windib"</code> or <code>"directx"</code>.</p> |
157 | <p><strong>Note</strong>: Some platforms allow selection of the video driver through the <code>SDL_VIDEODRIVER</code> environment variable. </p> |
158 | <p>Example:</p> |
159 | <pre> use SDL; |
160 | use SDL::Video; |
161 | |
162 | SDL::init(SDL_INIT_VIDEO); |
163 | |
164 | print SDL::Video::video_driver_name() . "\n"; |
165 | |
166 | SDL::quit(); |
167 | |
168 | </pre> |
162a0989 |
169 | |
170 | </div> |
171 | <h2 id="list_modes_formats_flags">list_modes(formats,flags)</h2> |
172 | <div id="list_modes_formats_flags_CONTENT"> |
52432657 |
173 | <pre> my @modes = @{ SDL::Video::list_modes($video_info->vfmt, SDL_NOFRAME) }; |
174 | |
175 | </pre> |
162a0989 |
176 | <p>Returns a pointer to an array of available screen dimensions for the given format and video flags, |
177 | or it return undef if no modes are avalaibles.</p> |
52432657 |
178 | <p>Example:</p> |
179 | <pre> use SDL; |
180 | use SDL::Video; |
181 | use SDL::VideoInfo; |
182 | use SDL::PixelFormat; |
183 | use SDL::Rect; |
184 | |
185 | SDL::init(SDL_INIT_VIDEO); |
186 | |
187 | my $video_info = SDL::Video::get_video_info(); |
188 | |
189 | my @modes = @{ SDL::Video::list_modes($video_info->vfmt, SDL_NOFRAME) }; |
190 | |
191 | if($#modes > 0) |
192 | { |
193 | print("available modes:\n"); |
194 | foreach my $index ( @modes ) |
195 | { |
196 | printf("%03d: %d x %d\n", $index, $modes[$index]->w, $modes[$index]->h ); |
197 | } |
198 | } |
199 | elsif($#modes == 0) |
200 | { |
201 | printf("%s video modes available\n", $modes[0]); |
202 | } |
203 | |
204 | SDL::quit(); |
205 | |
206 | </pre> |
162a0989 |
207 | |
208 | </div> |
209 | <h2 id="video_mode_ok_width_height_bpp_flags">video_mode_ok(width,height,bpp,flags)</h2> |
210 | <div id="video_mode_ok_width_height_bpp_flags-2"> |
211 | <p>Checks to see if a particular video mode of the given width,height,bpp and flags is supported. |
212 | It returns 0 if the mode is not supported at all, or the suggested bpp.</p> |
213 | |
214 | </div> |
215 | <h2 id="set_video_mode_width_height_bpp_flag">set_video_mode(width,height,bpp,flags)</h2> |
216 | <div id="set_video_mode_width_height_bpp_flag-2"> |
7067312b |
217 | <pre> my $surface = SDL::Video::set_video_mode( 800, 600, 32, SDL_SWSURFACE|SDL_DOUBLEBUF|SDL_FULLSCREEN); |
218 | |
219 | </pre> |
162a0989 |
220 | <p>Sets up a video mode with the specified width, height, bits-per-pixel and flags. |
7067312b |
221 | <code>set_video_mode</code> returns a <a href="/SDL-Surface.html">SDL::Surface</a> on success or it returns undef on error, the error message is retrieved using <code>SDL::get_error</code>.</p> |
162a0989 |
222 | |
223 | </div> |
449a007b |
224 | <h3 id="List_of_avalaibles_flags">List of avalaibles flags</h3> |
162a0989 |
225 | <div id="List_of_avalaibles_flags_CONTENT"> |
449a007b |
226 | <dl> |
7067312b |
227 | <dt><code>SDL_SWSURFACE</code></dt> |
449a007b |
228 | <dd> |
229 | <p>Create the video surface in system memory</p> |
230 | </dd> |
7067312b |
231 | <dt><code>SDL_HWSURFACE</code></dt> |
449a007b |
232 | <dd> |
233 | <p>Create the video surface in video memory</p> |
234 | </dd> |
7067312b |
235 | <dt><code>SDL_ASYNCBLIT</code></dt> |
449a007b |
236 | <dd> |
237 | <p>Enables the use of asynchronous updates of the display surface. |
238 | This will usually slow down blitting on single CPU machines, but may provide a speed increase on SMP systems.</p> |
239 | </dd> |
7067312b |
240 | <dt><code>SDL_ANYFORMAT</code></dt> |
449a007b |
241 | <dd> |
242 | <p>Normally, if a video surface of the requested bits-per-pixel (bpp) is not available, SDL will emulate one with a shadow surface. |
7067312b |
243 | Passing <code>SDL_ANYFORMAT</code> prevents this and causes SDL to use the video surface, regardless of its pixel depth.</p> |
449a007b |
244 | </dd> |
7067312b |
245 | <dt><code>SDL_HWPALETTE</code></dt> |
449a007b |
246 | <dd> |
247 | <p>Give SDL exclusive palette access. Without this flag you may not always get the colors you request with SDL::set_colors or SDL::set_palette.</p> |
248 | </dd> |
7067312b |
249 | <dt><code>SDL_DOUBLEBUF</code></dt> |
449a007b |
250 | <dd> |
7067312b |
251 | <p>Enable hardware double buffering; only valid with <code>SDL_HWSURFACE</code>. Calling <a href="#flip_surface">SDL::Video::flip</a> will flip the buffers and update |
252 | the screen. |
449a007b |
253 | All drawing will take place on the surface that is not displayed at the moment. |
7067312b |
254 | If double buffering could not be enabled then <a href="#flip_surface">SDL::Video::flip</a> will just perform a |
255 | <a href="#update_rect_surface_x_y_width_height">SDL::Video::update_rect</a> on the entire screen.</p> |
449a007b |
256 | </dd> |
7067312b |
257 | <dt><code>SDL_FULLSCREEN</code></dt> |
449a007b |
258 | <dd> |
259 | <p>SDL will attempt to use a fullscreen mode. If a hardware resolution change is not possible (for whatever reason), |
260 | the next higher resolution will be used and the display window centered on a black background.</p> |
261 | </dd> |
7067312b |
262 | <dt><code>SDL_OPENGL</code></dt> |
449a007b |
263 | <dd> |
7067312b |
264 | <p>Create an OpenGL rendering context. You should have previously set OpenGL video attributes with |
265 | <a href="#GL_set_attribute_attr_value">SDL::Video::GL_set_attribute</a>.</p> |
449a007b |
266 | </dd> |
7067312b |
267 | <dt><code>SDL_OPENGLBLIT</code></dt> |
449a007b |
268 | <dd> |
269 | <p>Create an OpenGL rendering context, like above, but allow normal blitting operations. |
270 | The screen (2D) surface may have an alpha channel, and SDL::update_rects must be used for updating changes to the screen surface. |
271 | NOTE: This option is kept for compatibility only, and will be removed in next versions. Is not recommended for new code.</p> |
272 | </dd> |
7067312b |
273 | <dt><code>SDL_RESIZABLE</code></dt> |
449a007b |
274 | <dd> |
275 | <p>Create a resizable window. |
7067312b |
276 | When the window is resized by the user a <code>SDL_VIDEORESIZE</code> event is generated and |
277 | <a href="#set_video_mode_width_height_bpp_flag">SDL::Video::set_video_mode</a> can be called again with the new size.</p> |
449a007b |
278 | </dd> |
7067312b |
279 | <dt><code>SDL_NOFRAME</code></dt> |
449a007b |
280 | <dd> |
281 | <p>If possible, SDL_NOFRAME causes SDL to create a window with no title bar or frame decoration. |
282 | Fullscreen modes automatically have this flag set.</p> |
283 | </dd> |
284 | </dl> |
7067312b |
285 | <p>Note 1: Use SDL_SWSURFACE if you plan on doing per-pixel manipulations, or blit surfaces with alpha channels, and require a high framerate. |
286 | When you use hardware surfaces (by passing the flag SDL_HWSURFACE as parameter), SDL copies the surfaces from video memory to system memory |
287 | when you lock them, and back when you unlock them. This can cause a major performance hit. Be aware that you may request a hardware surface, |
288 | but receive a software surface because the video driver doesn't support hardware surface. Many platforms can only provide a hardware surface |
289 | when using SDL_FULLSCREEN. The SDL_HWSURFACE flag is best used when the surfaces you'll be blitting can also be stored in video memory.</p> |
290 | <p>Note 2: If you want to control the position on the screen when creating a windowed surface, you may do so by setting the environment |
291 | variables SDL_VIDEO_CENTERED=center or SDL_VIDEO_WINDOW_POS=x,y. You can also set them via <code>SDL::putenv</code>.</p> |
162a0989 |
292 | <p>Note 3: This function should be called in the main thread of your application.</p> |
7067312b |
293 | <p>User note 1: Some have found that enabling OpenGL attributes like SDL_GL_STENCIL_SIZE (the stencil buffer size) before the video mode has |
294 | been set causes the application to simply ignore those attributes, while enabling attributes after the video mode has been set works fine.</p> |
295 | <p>User note 2: Also note that, in Windows, setting the video mode resets the current OpenGL context. You must execute again the OpenGL |
296 | initialization code (set the clear color or the shade model, or reload textures, for example) after calling SDL::set_video_mode. In Linux, |
297 | however, it works fine, and the initialization code only needs to be executed after the first call to SDL::set_video_mode (although there |
298 | is no harm in executing the initialization code after each call to SDL::set_video_mode, for example for a multiplatform application). </p> |
162a0989 |
299 | |
300 | |
301 | |
302 | |
303 | |
304 | |
305 | |
306 | |
307 | |
308 | |
309 | |
310 | </div> |
311 | <h2 id="update_rect_surface_x_y_width_height">update_rect(surface,x,y,width,height)</h2> |
312 | <div id="update_rect_surface_x_y_width_height-2"> |
313 | <p>Makes sure the given area is updated on the given screen. |
314 | The rectangle must be confined within the screen boundaries because there's no clipping. |
315 | update_rect doesn't returns any value.</p> |
316 | <p>Note : This function should not be called while screen is locked by SDL::lock_surface |
317 | Note2 : If x, y, width and height are all equal to 0, SDL_UpdateRect will update the entire screen. </p> |
318 | |
319 | </div> |
320 | <h2 id="update_rects_surface_rects">update_rects(surface,rects) </h2> |
321 | <div id="update_rects_surface_rects_CONTENT"> |
322 | <p>Makes sure the given list of rectangles is updated on the given screen. |
323 | The rectangle must be confined within the screen boundaries because there's no clipping. |
324 | update_rects doesn't returns any value.</p> |
325 | <p>Note : This function should not be called while screen is locked by SDL::lock_surface</p> |
326 | |
327 | </div> |
328 | <h2 id="flip_surface">flip(surface)</h2> |
329 | <div id="flip_surface_CONTENT"> |
330 | <p>On hardware that supports double-buffering, this function sets up a flip and returns. |
331 | The hardware will wait for vertical retrace, and then swap video buffers before the next video surface blit or lock will return. |
332 | On hardware that doesn't support double-buffering or if SDL_SWSURFACE was set, this is equivalent to calling SDL::update_rect(screen, 0, 0, 0, 0)</p> |
7067312b |
333 | <p>A software screen surface is also updated automatically when parts of a SDL window are redrawn, caused by overlapping windows or by |
334 | restoring from an iconified state. As a result there is no proper double buffer behavior in windowed mode for a software screen, in |
335 | contrast to a full screen software mode.</p> |
336 | <p>The SDL_DOUBLEBUF flag must have been passed to SDL::set_video_mode, when setting the video mode for this function to perform hardware |
337 | flipping. |
338 | flip returns 0 on success or -1 on error.</p> |
162a0989 |
339 | <p>Note : If you want to swap the buffers of an initialized OpenGL context, use the function SDL::gl_swap_buffers instead. </p> |
340 | |
341 | </div> |
342 | <h2 id="set_colors_surface_start_colors">set_colors(surface,start,colors)</h2> |
343 | <div id="set_colors_surface_start_colors_CONT"> |
344 | <p>Sets a portion of the colormap for the given 8-bit surface. </p> |
345 | <p>When surface is the surface associated with the current display, the display colormap will be updated with the requested colors. |
7067312b |
346 | If SDL_HWPALETTE was set in SDL::set_video_mode flags, SDL::set_colors will always return 1, and the palette is guaranteed to be set the |
347 | way you desire, even if the window colormap has to be warped or run under emulation. |
162a0989 |
348 | The color components of a SDL::Color structure are 8-bits in size, giving you a total of 2563 = 16777216 colors. |
7067312b |
349 | Palettized (8-bit) screen surfaces with the SDL_HWPALETTE flag have two palettes, a logical palette that is used for mapping blits to/from |
350 | the surface and a physical palette (that determines how the hardware will map the colors to the display). |
351 | SDL::SetColors modifies both palettes (if present), and is equivalent to calling SDL::SetPalette with the flags set to |
352 | (SDL_LOGPAL | SDL_PHYSPAL). </p> |
162a0989 |
353 | <p>If surface is not a palettized surface, this function does nothing, returning 0. |
354 | If all of the colors were set as passed to SDL::set_colors, it will return 1. |
7067312b |
355 | If not all the color entries were set exactly as given, it will return 0, and you should look at the surface palette to determine the |
356 | actual color palette.</p> |
162a0989 |
357 | |
358 | </div> |
359 | <h2 id="set_palette_surface_flags_start_colo">set_palette(surface,flags,start,colors)</h2> |
360 | <div id="set_palette_surface_flags_start_colo-2"> |
361 | <p>Sets a portion of the palette for the given 8-bit surface.</p> |
7067312b |
362 | <p>Palettized (8-bit) screen surfaces with the SDL_HWPALETTE flag have two palettes, a logical palette that is used for mapping blits to/from |
363 | the surface and a physical palette (that determines how the hardware will map the colors to the display). |
364 | Non screen surfaces have a logical palette only. SDL::blit_surface always uses the logical palette when blitting surfaces (if it has to |
365 | convert between surface pixel formats). Because of this, it is often useful to modify only one or the other palette to achieve various |
366 | special color effects (e.g., screen fading, color flashes, screen dimming).</p> |
162a0989 |
367 | <p>This function can modify either the logical or physical palette by specifying SDL_LOGPAL or SDL_PHYSPAL the in the flags parameter.</p> |
368 | <p>When surface is the surface associated with the current display, the display colormap will be updated with the requested colors. |
7067312b |
369 | If SDL_HWPALETTE was set in SDL::set_video_mode flags, SDL::set_palette will always return 1, and the palette is guaranteed to be set the |
370 | way you desire, even if the window colormap has to be warped or run under emulation. |
162a0989 |
371 | The color components of a SDL::Color structure are 8-bits in size, giving you a total of 2563 = 16777216 colors. </p> |
7067312b |
372 | <p>If surface is not a palettized surface, this function does nothing, returning 0. If all of the colors were set as passed to SDL_SetPalette, |
373 | it will return 1. If not all the color entries were set exactly as given, it will return 0, and you should look at the surface palette |
374 | to determine the actual color palette.</p> |
162a0989 |
375 | |
376 | </div> |
377 | <h2 id="set_gamma_r_g_b">set_gamma(r,g,b)</h2> |
378 | <div id="set_gamma_r_g_b_CONTENT"> |
379 | <p>Sets the "gamma function" for the display of each color component. Gamma controls the brightness/contrast of colors displayed on the screen. |
380 | A gamma value of 1.0 is identity (i.e., no adjustment is made).</p> |
7067312b |
381 | <p>This function adjusts the gamma based on the "gamma function" parameter, you can directly specify lookup tables for gamma adjustment |
382 | with SDL::set_gamma_ramp.</p> |
162a0989 |
383 | <p>Not all display hardware is able to change gamma. |
384 | SDL::set_gamma returns -1 on error.</p> |
385 | <p>Warning: Under Linux (X.org Gnome and Xfce), gamma settings affects the entire display (including the desktop)! </p> |
386 | |
387 | </div> |
388 | <h2 id="get_gamma_ramp_rt_gt_bt_to_be_coded">get_gamma_ramp(rt,gt,bt) * to be coded</h2> |
389 | <div id="get_gamma_ramp_rt_gt_bt_to_be_coded_"> |
390 | <p>Gets the gamma translation lookup tables currently used by the display. Each table is an array of 256 Uint16 values. |
391 | SDL::get_gamma_ramp returns -1 on error.</p> |
392 | |
393 | </div> |
394 | <h2 id="set_gamma_ramp_rt_gt_bt">set_gamma_ramp(rt,gt,bt)</h2> |
395 | <div id="set_gamma_ramp_rt_gt_bt_CONTENT"> |
7067312b |
396 | <p>Sets the gamma lookup tables for the display for each color component. Each table is an array of 256 Uint16 values, representing a |
397 | mapping between the input and output for that channel. |
162a0989 |
398 | The input is the index into the array, and the output is the 16-bit gamma value at that index, scaled to the output color precision. |
399 | You may pass NULL to any of the channels to leave them unchanged.</p> |
7067312b |
400 | <p>This function adjusts the gamma based on lookup tables, you can also have the gamma calculated based on a "gamma function" parameter |
401 | with SDL::set_gamma.</p> |
162a0989 |
402 | <p>Not all display hardware is able to change gamma. |
403 | SDL::set_gamma_ramp returns -1 on error.</p> |
404 | |
405 | </div> |
406 | <h2 id="map_RGB_pixel_format_r_g_b">map_RGB(pixel_format,r,g,b)</h2> |
407 | <div id="map_RGB_pixel_format_r_g_b_CONTENT"> |
408 | <p>Maps the RGB color value to the specified SDL::pixel_format and returns the pixel value as a 32-bit int. |
409 | If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned. |
410 | If the specified pixel format has an alpha component it will be returned as all 1 bits (fully opaque). </p> |
411 | <p>SDL::map_RGP returns a pixel value best approximating the given RGB color value for a given pixel format. |
7067312b |
412 | If the SDL::pixel_format's bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored |
413 | (e.g., with a 16-bpp format the return value can be assigned to a Uint16, and similarly a Uint8 for an 8-bpp format).</p> |
162a0989 |
414 | |
415 | </div> |
416 | <h2 id="map_RGBA_pixel_format_r_g_b_a">map_RGBA(pixel_format,r,g,b,a)</h2> |
417 | <div id="map_RGBA_pixel_format_r_g_b_a_CONTEN"> |
418 | <p>Maps the RGBA color value to the specified SDL::pixel_format and returns the pixel value as a 32-bit int. |
419 | If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned. |
420 | If the specified pixel format has no alpha component the alpha value will be ignored (as it will be in formats with a palette). </p> |
421 | <p>A pixel value best approximating the given RGBA color value for a given pixel format. |
7067312b |
422 | If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e.g., |
423 | with a 16-bpp format the return value can be assigned to a Uint16, and similarly a Uint8 for an 8-bpp format).</p> |
162a0989 |
424 | |
425 | </div> |
426 | <h2 id="get_RGB_pixel_format_pixel">get_RGB(pixel_format,pixel)</h2> |
427 | <div id="get_RGB_pixel_format_pixel_CONTENT"> |
428 | <p>Returns RGB values from a pixel in the specified pixel format. |
7067312b |
429 | This function uses the entire 8-bit [0..255] range when converting color components from pixel formats with less than 8-bits per RGB |
430 | component (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).</p> |
162a0989 |
431 | |
432 | </div> |
433 | <h2 id="get_RGBA_pixel_format_pixel">get_RGBA(pixel_format,pixel)</h2> |
434 | <div id="get_RGBA_pixel_format_pixel_CONTENT"> |
435 | <p>Gets RGBA values from a pixel in the specified pixel format. |
7067312b |
436 | This function uses the entire 8-bit [0..255] range when converting color components from pixel formats with less than 8-bits per RGB |
437 | component (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).</p> |
162a0989 |
438 | <p>If the surface has no alpha component, the alpha will be returned as 0xff (100% opaque). </p> |
439 | |
440 | </div> |
441 | <h2 id="create_RGB_surface_from">create_RGB_surface_from ***</h2> |
442 | <div id="create_RGB_surface_from_CONTENT"> |
443 | <p>Creates an empty SDL::Surface from pixel data |
444 | Allocate an empty surface (must be called after SDL::set_video_mode) |
7067312b |
445 | If bitsPerPixel is 8 an empty palette is allocated for the surface, otherwise a 'packed-pixel' SDL::pixel_format is created using the |
446 | [RGBA]mask's provided (see SDL::pixel_format). The flags specifies the type of surface that should be created, it is an OR'd combination |
447 | of the following possible values. </p> |
449a007b |
448 | <dl> |
449 | <dt>SDL_SWSURFACE</dt> |
450 | <dd> |
451 | <p>SDL will create the surface in system memory. |
452 | This improves the performance of pixel level access, however you may not be able to take advantage of some types of hardware blitting.</p> |
453 | </dd> |
454 | <dt>SDL_HWSURFACE</dt> |
455 | <dd> |
456 | <p>SDL will attempt to create the surface in video memory. |
457 | This will allow SDL to take advantage of Video->Video blits (which are often accelerated).</p> |
458 | </dd> |
459 | <dt>SDL_SRCCOLORKEY</dt> |
460 | <dd> |
461 | <p>This flag turns on color keying for blits from this surface. |
462 | If SDL_HWSURFACE is also specified and color keyed blits are hardware-accelerated, then SDL will attempt to place the surface in video memory. |
463 | If the screen is a hardware surface and color keyed blits are hardware-accelerated then the SDL_HWSURFACE flag will be set. |
464 | Use SDL_SetColorKey to set or clear this flag after surface creation.</p> |
465 | </dd> |
466 | <dt>SDL_SRCALPHA</dt> |
467 | <dd> |
468 | <p>This flag turns on alpha-blending for blits from this surface. |
469 | If SDL_HWSURFACE is also specified and alpha-blending blits are hardware-accelerated, |
470 | then the surface will be placed in video memory if possible. |
471 | If the screen is a hardware surface and alpha-blending blits are hardware-accelerated then the SDL_HWSURFACE flag will be set. |
472 | Use SDL_SetAlpha to set or clear this flag after surface creation.</p> |
473 | </dd> |
474 | </dl> |
162a0989 |
475 | |
476 | |
477 | |
478 | |
162a0989 |
479 | <p>[RGBA]mask are the bitmasks used to extract that colour from a pixel. |
480 | For instance, Rmask being FF000000 means the red data is stored in the most significant byte. |
481 | Using zeros for the RGB masks sets a default value, based on the depth. (e.g. SDL::create_RGB_surface(flags,w,h,32,0,0,0,0);). |
482 | However, using zero for the Amask results in an Amask of 0. |
483 | It returns a SDL::Surface on success or undef on error. |
484 | Notes: If an alpha-channel is specified (that is, if Amask is nonzero), then the SDL_SRCALPHA flag is automatically set. |
485 | You may remove this flag by calling SDL::set_alpha after surface creation. |
486 | Also, if the SDL_HWSURFACE flag is set on the returned surface, its format might not match the requested format. </p> |
487 | <p>Notes: Sometimes specifying an Alpha mask value could cause strange results. |
7067312b |
488 | This can be worked around by setting the Amask parameter to 0, but still including the SDL_SRCALPHA flag, and then using SDL::set_alpha, |
489 | also with the SDL_SRCALPHA flag. </p> |
162a0989 |
490 | |
491 | </div> |
492 | <h2 id="lock_surface_surface">lock_surface(surface)</h2> |
493 | <div id="lock_surface_surface_CONTENT"> |
494 | <p>SDL::lock_surface sets up the given SDL::surface for directly accessing the pixels. |
7067312b |
495 | Between calls to SDL::lock_surface and SDL::unlock_surface, you can write to and read from surface->pixels, using the pixel format stored |
496 | in surface->format. |
162a0989 |
497 | Once you are done accessing the surface, you should use SDL::unlock_surface to release the lock.</p> |
7067312b |
498 | <p>Not all surfaces require locking. If SDL::MUSTLOCK(surface) evaluates to 0, then reading and writing pixels to the surface can be performed |
499 | at any time, and the pixel format of the surface will not change. |
162a0989 |
500 | No operating system or library calls should be made between the lock/unlock pairs, as critical system locks may be held during this time. |
7067312b |
501 | SDL::lock_surface returns 0 on success or -1 on error.</p> |
502 | <p>Note : Since SDL 1.1.8, the surface locks are recursive. This means that you can lock a surface multiple times, but each lock must have |
503 | a matching unlock.</p> |
162a0989 |
504 | |
505 | </div> |
506 | <h2 id="unlock_surface_surface">unlock_surface(surface)</h2> |
507 | <div id="unlock_surface_surface_CONTENT"> |
7067312b |
508 | <p>Surfaces that were previously locked using SDL::lock_surface must be unlocked with SDL::unlock_surface. Surfaces should be unlocked as |
509 | soon as possible. |
162a0989 |
510 | SDL::unlock_surface doesn't return anything.</p> |
511 | <p>Note : Since 1.1.8, the surface locks are recursive. See <code>SDL::lock_surface</code> for more information. </p> |
512 | |
513 | </div> |
514 | <h2 id="convert_surface_surface_format_flags">convert_surface(surface,format,flags)</h2> |
515 | <div id="convert_surface_surface_format_flags-2"> |
516 | <p>Creates a new SDL::surface of the specified SDL::pixel_format, and then copies and maps the given surface to it. |
517 | It is also useful for making a copy of a surface.</p> |
518 | <p>The flags parameter is passed to SDL::create_RGB_surface and has those semantics. |
519 | This function is used internally by SDL::display_format. |
520 | This function can only be called after SDL::init. </p> |
7067312b |
521 | <p>it returns a SDL::surface on success or undef on error.</p> |
162a0989 |
522 | |
523 | </div> |
524 | <h2 id="display_format">display_format</h2> |
525 | <div id="display_format_CONTENT"> |
526 | <p>Converts a surface to the display format </p> |
527 | |
528 | </div> |
529 | <h2 id="display_format_alpha">display_format_alpha</h2> |
530 | <div id="display_format_alpha_CONTENT"> |
531 | <p>Converts a surface to the display format </p> |
532 | |
533 | </div> |
534 | <h2 id="load_BMP_filename">load_BMP(filename)</h2> |
535 | <div id="load_BMP_filename_CONTENT"> |
536 | <p>Loads a SDL::surface from a named Windows BMP file. |
7067312b |
537 | SDL::load_BMP returns a SDL::surface on success or undef on error.</p> |
162a0989 |
538 | <p>Note: When loading a 24-bit Windows BMP file, pixel data points are loaded as blue, green, red, and NOT red, green, blue (as one might expect). </p> |
539 | |
540 | |
541 | |
542 | |
543 | |
544 | |
545 | |
546 | |
547 | </div> |
548 | <h2 id="save_BMP_surface_filename">save_BMP(surface,filename)</h2> |
549 | <div id="save_BMP_surface_filename_CONTENT"> |
550 | <p>Saves the given SDL::Surface surface as a Windows BMP file named filename. |
7067312b |
551 | it returns 0 on success or -1 on error.</p> |
162a0989 |
552 | |
553 | </div> |
554 | <h2 id="set_color_key_surface_flag_key">set_color_key(surface,flag,key)</h2> |
555 | <div id="set_color_key_surface_flag_key_CONTE"> |
556 | <p>Sets the color key (transparent pixel) in a blittable surface and enables or disables RLE blit acceleration.</p> |
7067312b |
557 | <p>RLE acceleration can substantially speed up blitting of images with large horizontal runs of transparent pixels (i.e., pixels that match |
558 | the key value). |
162a0989 |
559 | The key must be of the same pixel format as the surface, SDL::map_RGB is often useful for obtaining an acceptable value. |
560 | If flag is SDL_SRCCOLORKEY then key is the transparent pixel value in the source image of a blit.</p> |
561 | <p>If flag is OR'd with SDL_RLEACCEL then the surface will be drawn using RLE acceleration when drawn with SDL::Blit_surface. |
562 | The surface will actually be encoded for RLE acceleration the first time SDL::blit_surface or SDL::display_format is called on the surface. |
563 | If flag is 0, this function clears any current color key. </p> |
7067312b |
564 | <p>SDL::set_color_key returns 0 on success or -1 on error.</p> |
162a0989 |
565 | |
566 | |
567 | |
568 | |
569 | |
570 | </div> |
571 | <h2 id="set_alpha_surface_flag_key">set_alpha(surface,flag,key)</h2> |
572 | <div id="set_alpha_surface_flag_key_CONTENT"> |
573 | <p>SDL::set_alpha is used for setting the per-surface alpha value and/or enabling and disabling alpha blending.</p> |
574 | <p>The surface parameter specifies which SDL::surface whose alpha attributes you wish to adjust. |
7067312b |
575 | flags is used to specify whether alpha blending should be used (SDL_SRCALPHA) and whether the surface should use RLE acceleration for |
576 | blitting (SDL_RLEACCEL). |
162a0989 |
577 | flags can be an OR'd combination of these two options, one of these options or 0. |
578 | If SDL_SRCALPHA is not passed as a flag then all alpha information is ignored when blitting the surface. |
7067312b |
579 | The alpha parameter is the per-surface alpha value; a surface need not have an alpha channel to use per-surface alpha and blitting can |
580 | still be accelerated with SDL_RLEACCEL.</p> |
162a0989 |
581 | <p>Note: The per-surface alpha value of 128 is considered a special case and is optimised, so it's much faster than other per-surface values.</p> |
582 | <p>Alpha affects surface blitting in the following ways: </p> |
449a007b |
583 | <dl> |
584 | <dt>RGBA->RGB with SDL_SRCALPHA</dt> |
585 | <dd> |
586 | <p>The source is alpha-blended with the destination, using the alpha channel. |
587 | SDL_SRCCOLORKEY and the per-surface alpha are ignored.</p> |
588 | </dd> |
589 | <dt>RGBA->RGB without SDL_SRCALPHA</dt> |
590 | <dd> |
591 | <p>The RGB data is copied from the source. The source alpha channel and the per-surface alpha value are ignored. |
592 | If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.</p> |
593 | </dd> |
594 | <dt>RGB->RGBA with SDL_SRCALPHA</dt> |
595 | <dd> |
596 | <p>The source is alpha-blended with the destination using the per-surface alpha value. |
597 | If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied. |
598 | The alpha channel of the copied pixels is set to opaque.</p> |
599 | </dd> |
600 | <dt>RGB->RGBA without SDL_SRCALPHA</dt> |
601 | <dd> |
602 | <p>The RGB data is copied from the source and the alpha value of the copied pixels is set to opaque. |
603 | If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.</p> |
604 | </dd> |
605 | <dt>RGBA->RGBA with SDL_SRCALPHA</dt> |
606 | <dd> |
607 | <p>The source is alpha-blended with the destination using the source alpha channel. |
608 | The alpha channel in the destination surface is left untouched. SDL_SRCCOLORKEY is ignored.</p> |
609 | </dd> |
610 | <dt>RGBA->RGBA without SDL_SRCALPHA</dt> |
611 | <dd> |
612 | <p>The RGBA data is copied to the destination surface. |
613 | If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.</p> |
614 | </dd> |
615 | <dt>RGB->RGB with SDL_SRCALPHA</dt> |
616 | <dd> |
617 | <p>The source is alpha-blended with the destination using the per-surface alpha value. |
618 | If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.</p> |
619 | </dd> |
620 | <dt>RGB->RGB without SDL_SRCALPHA</dt> |
621 | <dd> |
622 | <p>The RGB data is copied from the source. |
623 | If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.</p> |
624 | </dd> |
625 | </dl> |
162a0989 |
626 | <p>Note: When blitting, the presence or absence of SDL_SRCALPHA is relevant only on the source surface, not the destination. |
7067312b |
627 | Note: Note that RGBA->RGBA blits (with SDL_SRCALPHA set) keep the alpha of the destination surface. This means that you cannot compose |
628 | two arbitrary RGBA surfaces this way and get the result you would expect from "overlaying" them; the destination alpha will work as a mask.</p> |
162a0989 |
629 | <p>Note: Also note that per-pixel and per-surface alpha cannot be combined; the per-pixel alpha is always used if available. </p> |
7067312b |
630 | <p>SDL::set_alpha returns 0 on success or -1 on error.</p> |
162a0989 |
631 | |
632 | </div> |
633 | <h2 id="set_clip_rect_surface_rect">set_clip_rect(surface,rect)</h2> |
634 | <div id="set_clip_rect_surface_rect_CONTENT"> |
7067312b |
635 | <p>Sets the clipping rectangle for the given SDL::surface. When this surface is the destination of a blit, only the area within the clip |
636 | rectangle will be drawn into. |
637 | The rectangle pointed to by rect will be clipped to the edges of the surface so that the clip rectangle for a surface can never fall |
638 | outside the edges of the surface. |
162a0989 |
639 | If rect is NULL the clipping rectangle will be set to the full size of the surface. |
640 | SDL::set_clip_rect doesn't returns anything.</p> |
641 | |
642 | </div> |
643 | <h2 id="get_clip_rect_surface_rect">get_clip_rect(surface,rect)</h2> |
644 | <div id="get_clip_rect_surface_rect_CONTENT"> |
7067312b |
645 | <p>Gets the clipping rectangle for the given SDL::surface. When this surface is the destination of a blit, only the area within the clip |
646 | rectangle is drawn into. |
162a0989 |
647 | The rectangle pointed to by rect will be filled with the clipping rectangle of the surface. |
648 | SDL::get_clip_rect doesn't returns anything;</p> |
649 | |
650 | |
651 | |
652 | |
653 | |
654 | </div> |
655 | <h2 id="blit_surface_src_src_rect_dest_dest_">blit_surface(src,src_rect,dest,dest_rect)</h2> |
656 | <div id="blit_surface_src_src_rect_dest_dest_-2"> |
657 | <p>This performs a fast blit from the given source SDL::surface to the given destination SDL::surface. |
7067312b |
658 | The width and height in srcrect determine the size of the copied rectangle. Only the position is used in the dstrect (the width and height |
659 | are ignored). Blits with negative dstrect coordinates will be clipped properly. |
162a0989 |
660 | If srcrect is NULL, the entire surface is copied. If dstrect is NULL, then the destination position (upper left corner) is (0, 0). |
661 | The final blit rectangle is saved in dstrect after all clipping is performed (srcrect is not modified). |
7067312b |
662 | The blit function should not be called on a locked surface. I.e. when you use your own drawing functions you may need to lock a surface, |
663 | but this is not the case with SDL::blit_surface. Like most surface manipulation functions in SDL, it should not be used together with OpenGL.</p> |
664 | <p>The results of blitting operations vary greatly depending on whether SDL_SRCALPHA is set or not. See SDL::set_alpha for an explanation of |
665 | how this affects your results. Colorkeying and alpha attributes also interact with surface blitting. |
162a0989 |
666 | SDL::blit_surface doesn't returns anything.</p> |
667 | |
668 | </div> |
669 | <h2 id="fill_rect_dest_dest_rect_pixel">fill_rect(dest,dest_rect,pixel)</h2> |
670 | <div id="fill_rect_dest_dest_rect_pixel_CONTE"> |
7067312b |
671 | <p>This function performs a fast fill of the given SDL::rectangle with the given SDL::pixel_format. If dstrect is NULL, the whole surface |
672 | will be filled with color.</p> |
162a0989 |
673 | <p>The color should be a pixel of the format used by the surface, and can be generated by the SDL::MapRGB or SDL::map_RGBA functions. |
674 | If the color value contains an alpha value then the destination is simply "filled" with that alpha information, no blending takes place.</p> |
7067312b |
675 | <p>If there is a clip rectangle set on the destination (set via SDL::set_clip_rect), then this function will clip based on the intersection |
676 | of the clip rectangle and the dstrect rectangle, and the dstrect rectangle will be modified to represent the area actually filled.</p> |
677 | <p>If you call this on the video surface (ie: the value of SDL::get_video_surface()) you may have to update the video surface to see the |
678 | result. This can happen if you are using a shadowed surface that is not double buffered in Windows XP using build 1.2.9. </p> |
679 | <p>SDL::fill_rect returns 0 on success or -1 on error.</p> |
162a0989 |
680 | |
681 | </div> |
682 | <h2 id="GL_load_library_path">GL_load_library(path)</h2> |
683 | <div id="GL_load_library_path_CONTENT"> |
684 | <p>If you wish, you may load the OpenGL library from the given path at runtime, this must be done before SDL::set_video_mode is called. |
7067312b |
685 | The path of the GL library is passed to SDL::GL_load_library and it returns 0 on success, or -1 on an error. You must then use |
686 | SDL::GL_get_proc_address to retrieve function pointers to GL functions. </p> |
687 | <p>SDL::GL_load_library returns 0 on success or -1 or error.</p> |
162a0989 |
688 | |
689 | </div> |
690 | <h2 id="GL_get_proc_address_proc">GL_get_proc_address(proc)</h2> |
691 | <div id="GL_get_proc_address_proc_CONTENT"> |
7067312b |
692 | <p>Returns the address of the GL function proc, or NULL if the function is not found. If the GL library is loaded at runtime, with |
693 | SDL::GL_load_library, then all GL functions must be retrieved this way. Usually this is used to retrieve function pointers to OpenGL |
694 | extensions. Note that this function needs an OpenGL context to function properly, so it should be called after SDL::set_video_mode |
695 | has been called (with the SDL_OPENGL flag).</p> |
696 | <p>OpenGL function pointers must be declared APIENTRY . This will ensure the proper calling convention is followed on platforms where this |
697 | matters (Win32) thereby avoiding stack corruption. In a Win32 build environment, APIENTRY should be defined as __stdcall. </p> |
162a0989 |
698 | <p>it returns undef if the function is not found.</p> |
699 | |
700 | </div> |
701 | <h2 id="GL_get_attribute_attr">GL_get_attribute(attr)</h2> |
702 | <div id="GL_get_attribute_attr_CONTENT"> |
7067312b |
703 | <p>It returns SDL/OpenGL attribute attr . This is useful after a call to SDL::set_video_mode to check whether your attributes have been set |
704 | as you expected. |
162a0989 |
705 | SDL::GL_get_attribute returns undef if the attribute is not found.</p> |
706 | |
707 | </div> |
708 | <h2 id="GL_set_attribute_attr_value">GL_set_attribute(attr,value)</h2> |
709 | <div id="GL_set_attribute_attr_value_CONTENT"> |
710 | <p>This function sets the given OpenGL attribute attr to value. The requested attributes will take effect after a call to SDL::set_video_mode. |
7067312b |
711 | You should use SDL::GL_get_attribute to check the values after a SDL::set_video_mode call, since the values obtained can differ from the |
712 | requested ones. |
162a0989 |
713 | See SDL_GLattr for the full list of available attributes. |
7067312b |
714 | SDL::GL_set_attribute returns 0 on success or -1 on error.</p> |
715 | <p>Note : The SDL_DOUBLEBUF flag is not required to enable double buffering when setting an OpenGL video mode. Double buffering is enabled |
716 | or disabled using the SDL_GL_DOUBLEBUFFER attribute. </p> |
162a0989 |
717 | |
718 | </div> |
719 | <h2 id="GL_swap_buffers">GL_swap_buffers</h2> |
720 | <div id="GL_swap_buffers_CONTENT"> |
721 | <p>Swap the OpenGL buffers, if double-buffering is supported. |
722 | SDL::GL_swap_buffers doesn't returns any value.</p> |
723 | |
724 | </div> |
725 | <h2 id="GL_attr_to_be_coded">GL_attr *** to be coded</h2> |
726 | <div id="GL_attr_to_be_coded_CONTENT"> |
727 | |
728 | |
729 | |
730 | |
731 | |
732 | </div> |
733 | <h2 id="lock_YUV_overlay_overlay">lock_YUV_overlay(overlay)</h2> |
734 | <div id="lock_YUV_overlay_overlay_CONTENT"> |
735 | <p>Much the same as <code>SDL::lock_surface</code>, SDL::lock_YUV_overlay locks the overlay for direct access to pixel data. |
7067312b |
736 | It returns 0 on success or -1 on error.</p> |
162a0989 |
737 | |
738 | </div> |
739 | <h2 id="unlock_YUV_overlay_overlay">unlock_YUV_overlay(overlay)</h2> |
740 | <div id="unlock_YUV_overlay_overlay_CONTENT"> |
449a007b |
741 | <p>The opposite to <code>SDL::lock_YUV_overlay</code>. Unlocks a previously locked overlay. An overlay must be unlocked before it can be displayed. |
7067312b |
742 | It returns 0 on success or -1 on error.</p> |
162a0989 |
743 | |
744 | </div> |
745 | <h2 id="display_YUV_overlay_overlay_dstrect">display_YUV_overlay(overlay,dstrect)</h2> |
746 | <div id="display_YUV_overlay_overlay_dstrect_"> |
7067312b |
747 | <p>Blit the overlay to the display surface specified when the overlay was created. The SDL::rect structure, dstrect, specifies a rectangle |
748 | on the display where the overlay is drawn. The .x and .y fields of dstrect specify the upper left location in display coordinates. |
749 | The overlay is scaled (independently in x and y dimensions) to the size specified by dstrect, and is optimized for 2x scaling</p> |
750 | <p>It returns 0 on success or -1 on error.</p> |
162a0989 |
751 | |
752 | |
753 | |
754 | |
755 | |
756 | </div> |
757 | <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p> |
758 | <div id="SEE_ALSO_CONTENT"> |
759 | |
760 | </div> |
761 | <h2 id="Category_Objects">Category Objects</h2> |
762 | <div id="Category_Objects_CONTENT"> |
46beffd8 |
763 | <p><a href="/SDL-Surface.html">SDL::Surface</a>, <a href="/SDL-Overlay.html">SDL::Overlay</a>, <a href="/SDL-Color.html">SDL::Color</a>, |
764 | <a href="/SDL-Rect.html">SDL::Rect</a>, <a href="/SDL-Palette.html">SDL::Palette</a>, <a href="/SDL-PixelFormat.html">SDL::PixelFormat</a>, |
765 | <a href="/SDL-VideoInfo.html">SDL::VideoInfo</a></p> |
162a0989 |
766 | |
767 | </div> |
768 | </div> |