<li><a href="#list_modes_formats_flags">list_modes(formats,flags)</a></li>
<li><a href="#video_mode_ok_width_height_bpp_flags">video_mode_ok(width,height,bpp,flags)</a></li>
<li><a href="#set_video_mode_width_height_bpp_flag">set_video_mode(width,height,bpp,flags)</a>
-<ul>
-<li>
<ul><li><a href="#List_of_avalaibles_flags">List of avalaibles flags</a></li>
</ul>
</li>
-</ul>
-</li>
<li><a href="#update_rect_surface_x_y_width_height">update_rect(surface,x,y,width,height)</a></li>
<li><a href="#update_rects_surface_rects">update_rects(surface,rects) </a></li>
<li><a href="#flip_surface">flip(surface)</a></li>
</div>
<h2 id="get_video_surface">get_video_surface</h2>
<div id="get_video_surface_CONTENT">
-<p>It return the current SDL::Surface on succés or undef on error.
+<p>It return the current SDL::Surface on succés or undef on error.
get_video_surface doesn't take any parameters.</p>
</div>
<h2 id="set_video_mode_width_height_bpp_flag">set_video_mode(width,height,bpp,flags)</h2>
<div id="set_video_mode_width_height_bpp_flag-2">
<p>Sets up a video mode with the specified width, height, bits-per-pixel and flags.
-set_video_mode returns a SDL::Surface on succés or it returns undef on error, the error message is retrieved using <code>SDL::get_error</code>.</p>
+set_video_mode returns a SDL::Surface on succés or it returns undef on error, the error message is retrieved using <code>SDL::get_error</code>.</p>
</div>
-<h4 id="List_of_avalaibles_flags">List of avalaibles flags</h4>
+<h3 id="List_of_avalaibles_flags">List of avalaibles flags</h3>
<div id="List_of_avalaibles_flags_CONTENT">
-<pre>
-
-
- SDL_SWSURFACE Create the video surface in system memory
- SDL_HWSURFACE Create the video surface in video memory
- SDL_ASYNCBLIT Enables the use of asynchronous updates of the display surface.
- This will usually slow down blitting on single CPU machines, but may provide a speed increase on SMP systems.
- SDL_ANYFORMAT Normally, if a video surface of the requested bits-per-pixel (bpp) is not available, SDL will emulate one with a shadow surface.
- Passing SDL_ANYFORMAT prevents this and causes SDL to use the video surface, regardless of its pixel depth.
- SDL_HWPALETTE 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.
- SDL_DOUBLEBUF Enable hardware double buffering; only valid with SDL_HWSURFACE. Calling SDL::flip will flip the buffers and update the screen.
- All drawing will take place on the surface that is not displayed at the moment.
- If double buffering could not be enabled then SDL_Flip will just perform a SDL::update_rect on the entire screen.
- SDL_FULLSCREEN SDL will attempt to use a fullscreen mode. If a hardware resolution change is not possible (for whatever reason),
- the next higher resolution will be used and the display window centered on a black background.
- SDL_OPENGL Create an OpenGL rendering context. You should have previously set OpenGL video attributes with SDL::gl_setattribute.
- SDL_OPENGLBLIT Create an OpenGL rendering context, like above, but allow normal blitting operations.
- The screen (2D) surface may have an alpha channel, and SDL::update_rects must be used for updating changes to the screen surface.
- NOTE: This option is kept for compatibility only, and will be removed in next versions. Is not recommended for new code.
- SDL_RESIZABLE Create a resizable window.
- When the window is resized by the user a SDL_VIDEORESIZE event is generated and SDL::set_video_mode can be called again with the new size.
- SDL_NOFRAME If possible, SDL_NOFRAME causes SDL to create a window with no title bar or frame decoration.
- Fullscreen modes automatically have this flag set.
-
-
-
-
-</pre>
+<dl>
+ <dt>SDL_SWSURFACE</dt>
+ <dd>
+ <p>Create the video surface in system memory</p>
+ </dd>
+ <dt>SDL_HWSURFACE</dt>
+ <dd>
+ <p>Create the video surface in video memory</p>
+ </dd>
+ <dt>SDL_ASYNCBLIT</dt>
+ <dd>
+ <p>Enables the use of asynchronous updates of the display surface.
+This will usually slow down blitting on single CPU machines, but may provide a speed increase on SMP systems.</p>
+ </dd>
+ <dt>SDL_ANYFORMAT</dt>
+ <dd>
+ <p>Normally, if a video surface of the requested bits-per-pixel (bpp) is not available, SDL will emulate one with a shadow surface.
+Passing SDL_ANYFORMAT prevents this and causes SDL to use the video surface, regardless of its pixel depth.</p>
+ </dd>
+ <dt>SDL_HWPALETTE</dt>
+ <dd>
+ <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>
+ </dd>
+ <dt>SDL_DOUBLEBUF</dt>
+ <dd>
+ <p>Enable hardware double buffering; only valid with SDL_HWSURFACE. Calling SDL::flip will flip the buffers and update the screen.
+All drawing will take place on the surface that is not displayed at the moment.
+If double buffering could not be enabled then SDL_Flip will just perform a SDL::update_rect on the entire screen.</p>
+ </dd>
+ <dt>SDL_FULLSCREEN</dt>
+ <dd>
+ <p>SDL will attempt to use a fullscreen mode. If a hardware resolution change is not possible (for whatever reason),
+the next higher resolution will be used and the display window centered on a black background.</p>
+ </dd>
+ <dt>SDL_OPENGL</dt>
+ <dd>
+ <p>Create an OpenGL rendering context. You should have previously set OpenGL video attributes with SDL::gl_setattribute.</p>
+ </dd>
+ <dt>SDL_OPENGLBLIT</dt>
+ <dd>
+ <p>Create an OpenGL rendering context, like above, but allow normal blitting operations.
+The screen (2D) surface may have an alpha channel, and SDL::update_rects must be used for updating changes to the screen surface.
+NOTE: This option is kept for compatibility only, and will be removed in next versions. Is not recommended for new code.</p>
+ </dd>
+ <dt>SDL_RESIZABLE</dt>
+ <dd>
+ <p>Create a resizable window.
+When the window is resized by the user a SDL_VIDEORESIZE event is generated and SDL::set_video_mode can be called again with the new size.</p>
+
+
+
+
+ </dd>
+ <dt>SDL_NOFRAME</dt>
+ <dd>
+ <p>If possible, SDL_NOFRAME causes SDL to create a window with no title bar or frame decoration.
+Fullscreen modes automatically have this flag set.</p>
+ </dd>
+</dl>
<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. When you use hardware surfaces (by passing the flag SDL_HWSURFACE as parameter), SDL copies the surfaces from video memory to system memory 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, but receive a software surface because the video driver doesn't support hardware surface. Many platforms can only provide a hardware surface 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>
<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 variables SDL_VIDEO_CENTERED=center or SDL_VIDEO_WINDOW_POS=x,y. You can also set them via <code>SDL::putenv</code>.</p>
<p>Note 3: This function should be called in the main thread of your application.</p>
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>
<p>A software screen surface is also updated automatically when parts of a SDL window are redrawn, caused by overlapping windows or by restoring from an iconified state. As a result there is no proper double buffer behavior in windowed mode for a software screen, in contrast to a full screen software mode.</p>
<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 flipping.
-flip returns 0 on succés or -1 on error.</p>
+flip returns 0 on succés or -1 on error.</p>
<p>Note : If you want to swap the buffers of an initialized OpenGL context, use the function SDL::gl_swap_buffers instead. </p>
</div>
<p>Creates an empty SDL::Surface from pixel data
Allocate an empty surface (must be called after SDL::set_video_mode)
If bitsPerPixel is 8 an empty palette is allocated for the surface, otherwise a 'packed-pixel' SDL::pixel_format is created using the [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 of the following possible values. </p>
-<pre> SDL_SWSURFACE SDL will create the surface in system memory.
- This improves the performance of pixel level access, however you may not be able to take advantage of some types of hardware blitting.
-
- SDL_HWSURFACE SDL will attempt to create the surface in video memory.
- This will allow SDL to take advantage of Video->Video blits (which are often accelerated).
-
- SDL_SRCCOLORKEY This flag turns on color keying for blits from this surface.
- If SDL_HWSURFACE is also specified and color keyed blits are hardware-accelerated, then SDL will attempt to place the surface in video memory.
- If the screen is a hardware surface and color keyed blits are hardware-accelerated then the SDL_HWSURFACE flag will be set.
- Use SDL_SetColorKey to set or clear this flag after surface creation.
-
- SDL_SRCALPHA This flag turns on alpha-blending for blits from this surface.
- If SDL_HWSURFACE is also specified and alpha-blending blits are hardware-accelerated,
- then the surface will be placed in video memory if possible.
- If the screen is a hardware surface and alpha-blending blits are hardware-accelerated then the SDL_HWSURFACE flag will be set.
- Use SDL_SetAlpha to set or clear this flag after surface creation.
+<dl>
+ <dt>SDL_SWSURFACE</dt>
+ <dd>
+ <p>SDL will create the surface in system memory.
+This improves the performance of pixel level access, however you may not be able to take advantage of some types of hardware blitting.</p>
+ </dd>
+ <dt>SDL_HWSURFACE</dt>
+ <dd>
+ <p>SDL will attempt to create the surface in video memory.
+This will allow SDL to take advantage of Video->Video blits (which are often accelerated).</p>
+ </dd>
+ <dt>SDL_SRCCOLORKEY</dt>
+ <dd>
+ <p>This flag turns on color keying for blits from this surface.
+If SDL_HWSURFACE is also specified and color keyed blits are hardware-accelerated, then SDL will attempt to place the surface in video memory.
+If the screen is a hardware surface and color keyed blits are hardware-accelerated then the SDL_HWSURFACE flag will be set.
+Use SDL_SetColorKey to set or clear this flag after surface creation.</p>
+ </dd>
+ <dt>SDL_SRCALPHA</dt>
+ <dd>
+ <p>This flag turns on alpha-blending for blits from this surface.
+If SDL_HWSURFACE is also specified and alpha-blending blits are hardware-accelerated,
+then the surface will be placed in video memory if possible.
+If the screen is a hardware surface and alpha-blending blits are hardware-accelerated then the SDL_HWSURFACE flag will be set.
+Use SDL_SetAlpha to set or clear this flag after surface creation.</p>
+ </dd>
+</dl>
-</pre>
<p>[RGBA]mask are the bitmasks used to extract that colour from a pixel.
For instance, Rmask being FF000000 means the red data is stored in the most significant byte.
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);).
Once you are done accessing the surface, you should use SDL::unlock_surface to release the lock.</p>
<p>Not all surfaces require locking. If SDL::MUSTLOCK(surface) evaluates to 0, then reading and writing pixels to the surface can be performed at any time, and the pixel format of the surface will not change.
No operating system or library calls should be made between the lock/unlock pairs, as critical system locks may be held during this time.
-SDL::lock_surface returns 0 on succés or -1 on error.</p>
+SDL::lock_surface returns 0 on succés or -1 on error.</p>
<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 a matching unlock.</p>
</div>
<p>The flags parameter is passed to SDL::create_RGB_surface and has those semantics.
This function is used internally by SDL::display_format.
This function can only be called after SDL::init. </p>
-<p>it returns a SDL::surface on succés or undef on error.</p>
+<p>it returns a SDL::surface on succés or undef on error.</p>
</div>
<h2 id="display_format">display_format</h2>
<h2 id="load_BMP_filename">load_BMP(filename)</h2>
<div id="load_BMP_filename_CONTENT">
<p>Loads a SDL::surface from a named Windows BMP file.
-SDL::load_BMP returns a SDL::surface on succés or undef on error.</p>
+SDL::load_BMP returns a SDL::surface on succés or undef on error.</p>
<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>
<h2 id="save_BMP_surface_filename">save_BMP(surface,filename)</h2>
<div id="save_BMP_surface_filename_CONTENT">
<p>Saves the given SDL::Surface surface as a Windows BMP file named filename.
-it returns 0 on succés or -1 on error.</p>
+it returns 0 on succés or -1 on error.</p>
</div>
<h2 id="set_color_key_surface_flag_key">set_color_key(surface,flag,key)</h2>
<p>If flag is OR'd with SDL_RLEACCEL then the surface will be drawn using RLE acceleration when drawn with SDL::Blit_surface.
The surface will actually be encoded for RLE acceleration the first time SDL::blit_surface or SDL::display_format is called on the surface.
If flag is 0, this function clears any current color key. </p>
-<p>SDL::set_color_key returns 0 on succés or -1 on error.</p>
+<p>SDL::set_color_key returns 0 on succés or -1 on error.</p>
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 still be accelerated with SDL_RLEACCEL.</p>
<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>
<p>Alpha affects surface blitting in the following ways: </p>
-<pre> RGBA->RGB with SDL_SRCALPHA The source is alpha-blended with the destination, using the alpha channel.
- SDL_SRCCOLORKEY and the per-surface alpha are ignored.
-
- RGBA->RGB without SDL_SRCALPHA The RGB data is copied from the source. The source alpha channel and the per-surface alpha value are ignored.
- If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.
-
- RGB->RGBA with SDL_SRCALPHA The source is alpha-blended with the destination using the per-surface alpha value.
- If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.
- The alpha channel of the copied pixels is set to opaque.
-
- RGB->RGBA without SDL_SRCALPHA The RGB data is copied from the source and the alpha value of the copied pixels is set to opaque.
- If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.
-
- RGBA->RGBA with SDL_SRCALPHA The source is alpha-blended with the destination using the source alpha channel.
- The alpha channel in the destination surface is left untouched. SDL_SRCCOLORKEY is ignored.
-
- RGBA->RGBA without SDL_SRCALPHA The RGBA data is copied to the destination surface.
- If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.
-
- RGB->RGB with SDL_SRCALPHA The source is alpha-blended with the destination using the per-surface alpha value.
- If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.
-
- RGB->RGB without SDL_SRCALPHA The RGB data is copied from the source.
- If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.
-
-
-
-
-</pre>
+<dl>
+ <dt>RGBA->RGB with SDL_SRCALPHA</dt>
+ <dd>
+ <p>The source is alpha-blended with the destination, using the alpha channel.
+SDL_SRCCOLORKEY and the per-surface alpha are ignored.</p>
+ </dd>
+ <dt>RGBA->RGB without SDL_SRCALPHA</dt>
+ <dd>
+ <p>The RGB data is copied from the source. The source alpha channel and the per-surface alpha value are ignored.
+If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.</p>
+ </dd>
+ <dt>RGB->RGBA with SDL_SRCALPHA</dt>
+ <dd>
+ <p>The source is alpha-blended with the destination using the per-surface alpha value.
+If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.
+The alpha channel of the copied pixels is set to opaque.</p>
+ </dd>
+ <dt>RGB->RGBA without SDL_SRCALPHA</dt>
+ <dd>
+ <p>The RGB data is copied from the source and the alpha value of the copied pixels is set to opaque.
+If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.</p>
+ </dd>
+ <dt>RGBA->RGBA with SDL_SRCALPHA</dt>
+ <dd>
+ <p>The source is alpha-blended with the destination using the source alpha channel.
+The alpha channel in the destination surface is left untouched. SDL_SRCCOLORKEY is ignored.</p>
+ </dd>
+ <dt>RGBA->RGBA without SDL_SRCALPHA</dt>
+ <dd>
+ <p>The RGBA data is copied to the destination surface.
+If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.</p>
+ </dd>
+ <dt>RGB->RGB with SDL_SRCALPHA</dt>
+ <dd>
+ <p>The source is alpha-blended with the destination using the per-surface alpha value.
+If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.</p>
+ </dd>
+ <dt>RGB->RGB without SDL_SRCALPHA</dt>
+ <dd>
+ <p>The RGB data is copied from the source.
+If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.</p>
+ </dd>
+</dl>
<p>Note: When blitting, the presence or absence of SDL_SRCALPHA is relevant only on the source surface, not the destination.
Note: Note that RGBA->RGBA blits (with SDL_SRCALPHA set) keep the alpha of the destination surface. This means that you cannot compose 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>
<p>Note: Also note that per-pixel and per-surface alpha cannot be combined; the per-pixel alpha is always used if available. </p>
-<p>SDL::set_alpha returns 0 on succés or -1 on error.</p>
+<p>SDL::set_alpha returns 0 on succés or -1 on error.</p>
</div>
<h2 id="set_clip_rect_surface_rect">set_clip_rect(surface,rect)</h2>
If the color value contains an alpha value then the destination is simply "filled" with that alpha information, no blending takes place.</p>
<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 of the clip rectangle and the dstrect rectangle, and the dstrect rectangle will be modified to represent the area actually filled.</p>
<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 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>
-<p>SDL::fill_rect returns 0 on succés or -1 on error.</p>
+<p>SDL::fill_rect returns 0 on succés or -1 on error.</p>
</div>
<h2 id="GL_load_library_path">GL_load_library(path)</h2>
<div id="GL_load_library_path_CONTENT">
<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.
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 SDL::GL_get_proc_address to retrieve function pointers to GL functions. </p>
-<p>SDL::GL_load_library returns 0 on succés or -1 or error.</p>
+<p>SDL::GL_load_library returns 0 on succés or -1 or error.</p>
</div>
<h2 id="GL_get_proc_address_proc">GL_get_proc_address(proc)</h2>
<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.
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 requested ones.
See SDL_GLattr for the full list of available attributes.
-SDL::GL_set_attribute returns 0 on succés or -1 on error.</p>
+SDL::GL_set_attribute returns 0 on succés or -1 on error.</p>
<p>Note : The SDL_DOUBLEBUF flag is not required to enable double buffering when setting an OpenGL video mode. Double buffering is enabled or disabled using the SDL_GL_DOUBLEBUFFER attribute. </p>
</div>
<h2 id="lock_YUV_overlay_overlay">lock_YUV_overlay(overlay)</h2>
<div id="lock_YUV_overlay_overlay_CONTENT">
<p>Much the same as <code>SDL::lock_surface</code>, SDL::lock_YUV_overlay locks the overlay for direct access to pixel data.
-It returns 0 on succés or -1 on error.</p>
+It returns 0 on succés or -1 on error.</p>
</div>
<h2 id="unlock_YUV_overlay_overlay">unlock_YUV_overlay(overlay)</h2>
<div id="unlock_YUV_overlay_overlay_CONTENT">
-<p>The opposite to <code>SDL::lock_YUV_overlay. Unlocks a previously locked overlay. An overlay must be unlocked before it can be displayed.
-It returns 0 on succés or -1 on error.
-
-</code></p>
+<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.
+It returns 0 on succés or -1 on error.</p>
</div>
<h2 id="display_YUV_overlay_overlay_dstrect">display_YUV_overlay(overlay,dstrect)</h2>
<div id="display_YUV_overlay_overlay_dstrect_">
<p>Blit the overlay to the display surface specified when the overlay was created. The SDL::rect structure, dstrect, specifies a rectangle on the display where the overlay is drawn. The .x and .y fields of dstrect specify the upper left location in display coordinates. The overlay is scaled (independently in x and y dimensions) to the size specified by dstrect, and is optimized for 2x scaling</p>
-<p>It returns 0 on succés or -1 on error.</p>
+<p>It returns 0 on succés or -1 on error.</p>
projects / sdlgit/SDL-Site.git / blobdiff