From: Tobias Leich SDL::App controls the root window of the of your SDL based application.
-It extends the SDL::Surface class, and provides an interface to the window
+ SDL::App controls the root window of the of your SDL based application.
+It extends the SDL::Surface class, and provides an interface to the window
manager oriented functions.DESCRIPTION
$desired->format @@ -100,7 +100,7 @@
SDL::Audio::open reads these fields from the desired SDL::AudioSpec structure passed to the function and attempts to find an audio configuration matching your desired. As mentioned above, if the obtained parameter is NULL then SDL with convert from your desired audio settings to the hardware settings as it plays.
-If obtained is NULL then the desired SDL::AudioSpec is your working specification, otherwise the obtained SDL::AudioSpec becomes the working specification and the desired specification can be deleted. The data in the working specification is used when building SDL::AudioCVT's for converting loaded data to the hardware format.
+If obtained is NULL then the desired SDL::AudioSpec is your working specification, otherwise the obtained SDL::AudioSpec becomes the working specification and the desired specification can be deleted. The data in the working specification is used when building SDL::AudioCVT's for converting loaded data to the hardware format.
SDL::Audio::open calculates the size and silence fields for both the $desired and $obtained specifications. The size field stores the total size of the audio buffer in bytes, while the silence stores the value used to represent silence in the audio buffer
The audio device starts out playing silence when it's opened, and should be enabled for playing by calling SDL::Audio::pause(0) when you are ready for your audio callback function to be called. Since the audio driver may modify the requested size of the audio buffer, you should allocate any local mixing buffers after you open the audio device.
diff --git a/pages/SDL-CD.html-inc b/pages/SDL-CD.html-inc index 6fe8c4e..fa9610e 100644 --- a/pages/SDL-CD.html-inc +++ b/pages/SDL-CD.html-inc @@ -226,7 +226,7 @@my $track = $CD->track($number);-
Retrives track description of track $number in CD. See SDL::CDTrack.
+Retrives track description of track $number in CD. See SDL::CDTrack.
@@ -235,7 +235,7 @@SDL::Surface
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-Events.html-inc b/pages/SDL-Events.html-inc
index 864e4ba..3f76c29 100644
--- a/pages/SDL-Events.html-inc
+++ b/pages/SDL-Events.html-inc
@@ -138,8 +138,8 @@ However, if you are not polling or waiting for events (e.g. you are filtering th
poll_event($event)
Polls for currently pending events.
-If $event is not NULL, the next event is removed from the queue and stored in the SDL::Event structure pointed to by $event.
-As this function implicitly calls pump_events, you can only call this function in the thread that set the video mode with SDL::Video::set_video_mode.
+If $event is not NULL, the next event is removed from the queue and stored in the SDL::Event structure pointed to by $event.
+As this function implicitly calls pump_events, you can only call this function in the thread that set the video mode with SDL::Video::set_video_mode.
RETURN
@@ -165,7 +165,7 @@ The event is copied into the queue, and the caller may dispose of the memory poi
Waits indefinitely for the next available $event, returning 0 if there was an error while waiting for events, 1 otherwise.
If $event is not NULL, the next event is removed from the queue and stored in $event.
-As this function implicitly calls SDL_PumpEvents, you can only call this function in the thread that SDL::Video::set_video_mode.
+As this function implicitly calls SDL_PumpEvents, you can only call this function in the thread that SDL::Video::set_video_mode.
RETURN
@@ -227,7 +227,7 @@ The event is copied into the queue, and the caller may dispose of the memory poi
SEE ALSO
diff --git a/pages/SDL-Font.html-inc b/pages/SDL-Font.html-inc
index f037920..56a6737 100644
--- a/pages/SDL-Font.html-inc
+++ b/pages/SDL-Font.html-inc
@@ -30,8 +30,8 @@
DESCRIPTION
-SDL::Font provides an interface to loading and using SFont style
-fonts with SDL::Surface objects.
+SDL::Font provides an interface to loading and using SFont style
+fonts with SDL::Surface objects.
METHOD
@@ -50,7 +50,7 @@ fonts with SDL::Surface objects.
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-Game-Palette.html-inc b/pages/SDL-Game-Palette.html-inc
index 8769580..a7c6973 100644
--- a/pages/SDL-Game-Palette.html-inc
+++ b/pages/SDL-Game-Palette.html-inc
@@ -25,7 +25,7 @@
DESCRIPTION
-SDL::Palette provides an interface to the SDL_Palette structures,
+
SDL::Palette provides an interface to the SDL_Palette structures,
and can be used to set the color values of an existing palette's indexes.
@@ -65,7 +65,7 @@ and can be used to set the color values of an existing palette's indexes.
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-Image.html-inc b/pages/SDL-Image.html-inc
index a54d83d..c3a3166 100644
--- a/pages/SDL-Image.html-inc
+++ b/pages/SDL-Image.html-inc
@@ -147,10 +147,10 @@ HAM6, HAM8, and 24bit types are not supported.
$file Image file name to load a surface from.
-Load file for use as an image in a new SDL::Surface. This actually calls IMG_LoadTyped_RW
the binded function to SDL::Image::load_typed_rw, with the file extension used as the type string. This can load all supported image files, including TGA as long as the filename ends with ".tga". It is best to call this outside of event loops, and rather keep the loaded images around until you are really done with them, as disk speed and image conversion to a surface is not that speedy.
-Note: If the image format loader requires initialization, it will attempt to do that the first time it is needed if you have not already called SDL::Image::init to load support for your image format.
-Note: If the image format supports a transparent pixel, SDL::Image will set the colorkey for the surface. You can enable RLE acceleration on the surface afterwards by calling:
-SDL::Video::set_color_key
+Load file for use as an image in a new SDL::Surface. This actually calls IMG_LoadTyped_RW
the binded function to SDL::Image::load_typed_rw, with the file extension used as the type string. This can load all supported image files, including TGA as long as the filename ends with ".tga". It is best to call this outside of event loops, and rather keep the loaded images around until you are really done with them, as disk speed and image conversion to a surface is not that speedy.
+Note: If the image format loader requires initialization, it will attempt to do that the first time it is needed if you have not already called SDL::Image::init to load support for your image format.
+Note: If the image format supports a transparent pixel, SDL::Image will set the colorkey for the surface. You can enable RLE acceleration on the surface afterwards by calling:
+SDL::Video::set_color_key
my $image = SDL::Image::load( $some_png_file );
SDL::Video::set_color_key($image, SDL_RLEACCEL, $image->format->colorkey);
@@ -159,7 +159,7 @@ Note: If the image format supports a transparent pixel, Return
-An image as a SDL::Surface. NULL is returned on errors, such as no support built for the image, or a file reading error. Use SDL::get_error to get cause of error.
+An image as a SDL::Surface. NULL is returned on errors, such as no support built for the image, or a file reading error. Use SDL::get_error to get cause of error.
load_typed_rw
@@ -170,7 +170,7 @@ Note: If the image format supports a transparent pixel, SDL::RWops as a pointer. The image is loaded from this.
+ The source SDL::RWops as a pointer. The image is loaded from this.
freesrc
@@ -201,9 +201,9 @@ Note: If the image format supports a transparent pixel, SDL::Image::init to load support for your image format.
-Note: If the image format supports a transparent pixel, SDL::Image will set the colorkey for the surface. You can enable RLE acceleration on the surface afterwards by calling:
-SDL::Video::set_color_key
+Note: If the image format loader requires initialization, it will attempt to do that the first time it is needed if you have not already called SDL::Image::init to load support for your image format.
+Note: If the image format supports a transparent pixel, SDL::Image will set the colorkey for the surface. You can enable RLE acceleration on the surface afterwards by calling:
+SDL::Video::set_color_key
Transparency
@@ -222,7 +222,7 @@ Note: If the image format supports a transparent pixel, Return
-The image as a new SDL::Surface. NULL is returned on errors.
+The image as a new SDL::Surface. NULL is returned on errors.
is_[TYPE]
@@ -243,7 +243,7 @@ Note: If the image format supports a transparent pixel, SDL::RWOps as a parameter.
+These functions take a SDL::RWOps as a parameter.
Return
@@ -281,12 +281,12 @@ Note: If the image format supports a transparent pixel, SDL::RWop as a parameter
+These functions take a SDL::RWop as a parameter
Return
-The image as a new SDL::Surface. NULL is returned on errors, like if the [TYPE] is not supported, or a read error.
+The image as a new SDL::Surface. NULL is returned on errors, like if the [TYPE] is not supported, or a read error.
Example
@@ -314,7 +314,7 @@ Note: If the image format supports a transparent pixel, Return
-The image as a new SDL::Surface. NULL is returned on errors, like if XPM is not supported, or a read error.
+The image as a new SDL::Surface. NULL is returned on errors, like if XPM is not supported, or a read error.
Example
@@ -377,7 +377,7 @@ Note: If the image format supports a transparent pixel, Return
-Returns a SDL::Version object
+Returns a SDL::Version object
Example
@@ -424,7 +424,7 @@ Note: this function does not always set the error string, so do not depend on SD
quit
For version SDL_image 1.2.10 and up
-This function cleans up all dynamically loaded library handles, freeing memory. If support is required again it will be initialized again, either by SDL::Image::init or loading an image with dynamic support required. You may call this function when SDL::Image::load functions are no longer needed for the JPG, PNG, and TIF image formats. You only need to call this function once, no matter how many times SDL::Image::init was called.
+This function cleans up all dynamically loaded library handles, freeing memory. If support is required again it will be initialized again, either by SDL::Image::init or loading an image with dynamic support required. You may call this function when SDL::Image::load functions are no longer needed for the JPG, PNG, and TIF image formats. You only need to call this function once, no matter how many times SDL::Image::init was called.
Example
@@ -439,17 +439,17 @@ Note: this function does not always set the error string, so do not depend on SD
set_error
-Same as SDL::set_error
+Same as SDL::set_error
get_error
-Same as SDL::get_error
+Same as SDL::get_error
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-Joystick.html-inc b/pages/SDL-Joystick.html-inc
index 9da305a..4f3fe79 100644
--- a/pages/SDL-Joystick.html-inc
+++ b/pages/SDL-Joystick.html-inc
@@ -163,7 +163,7 @@ A joystick must be opened before it can be used.
int SDL::Joystick::num_buttons( object );
-Gets the number of joystick buttons from a previously opened joystick. See SDL::Joystick::open
+Gets the number of joystick buttons from a previously opened joystick. See SDL::Joystick::open
update
diff --git a/pages/SDL-Mixer-Groups.html-inc b/pages/SDL-Mixer-Groups.html-inc
index 3ba1176..6258735 100644
--- a/pages/SDL-Mixer-Groups.html-inc
+++ b/pages/SDL-Mixer-Groups.html-inc
@@ -4,7 +4,6 @@
- NAME
- CATEGORY
-- DESCRIPTION
- METHODS
- reserve_channels
- group_channel
@@ -23,7 +22,7 @@
NAME
-SDL::Mixer::Groups -- SDL_Mixer groups functions and bindings
+SDL::Mixer::Groups - Audio channel group functions
CATEGORY
@@ -31,48 +30,97 @@
Mixer
-DESCRIPTION
-
-
-
METHODS
reserve_channels
+ my $reserved = SDL::Mixer::Groups::reserve_channels( $num );
+
+
+$num
is the number of channels to reserve from default mixing. Zero removes all reservations.
+Reserve $num
channels from being used when playing samples when passing in -1
as a channel number to playback functions.
+The channels are reserved starting from channel 0
to $num-1
. Passing in zero will unreserve all channels. Normally SDL_mixer starts
+without any channels reserved.
+The following functions are affected by this setting:
+
+ - SDL::Mixer::Channels::play_channel
+ - SDL::Mixer::Channels::play_channel_timed
+ - SDL::Mixer::Channels::fade_in_channel
+ - SDL::Mixer::Channels::fade_in_channel_timed
+
+
+Returns: The number of channels reserved. Never fails, but may return less channels than you ask for, depending on the number of channels
+previously allocated (see SDL::Mixer::Channels::allocate_channels).
group_channel
+ my $grouped = SDL::Mixer::Groups::group_channel( $channel, $group );
+
+
+Add a channel to group id (any positive integer), or reset it's group to the default group by passing (-1).
+Returns: True(1) on success. False(0) is returned when the channel specified is invalid.
group_channels
+ my $grouped = SDL::Mixer::Groups::group_channels( $from_channel, $to_channel, $group );
+
+
+Add a range of channels to group id (any positive integer), or reset their group to the default group by passing (-1).
+Returns: The number of affected channels.
group_available
+ my $channel = SDL::Mixer::Groups::group_count( $group );
+
+
+group_newer
returns the first available channel of this group.
group_count
+ my $channels = SDL::Mixer::Groups::group_count( $group );
+
+
+group_newer
returns the number of channels in this group.
group_oldest
+ my $channel = SDL::Mixer::Groups::group_oldest( $group );
+
+
+group_newer
returns the channel number which started to play at first.
group_newer
+ my $channel = SDL::Mixer::Groups::group_newer( $group );
+
+
+group_newer
returns the channel number which started to play at last.
fade_out_group
+ SDL::Mixer::Groups::fade_out_group( $group, $ms );
+
+
+Fades out the channels by the given group id. The fade-out-time is specified by $ms
.
+Retuns the number of affected channels.
halt_group
+ SDL::Mixer::Groups::hals_group( $group );
+
+
+Halts the channels by the given group id.
+Retuns 0
.
\ No newline at end of file
diff --git a/pages/SDL-Mixer-Music.html-inc b/pages/SDL-Mixer-Music.html-inc
index 12c72a6..90a1931 100644
--- a/pages/SDL-Mixer-Music.html-inc
+++ b/pages/SDL-Mixer-Music.html-inc
@@ -66,7 +66,7 @@ The music player will then be called automatically when the mixer needs it. Musi
All the music playing and stopping functions have no effect on music after this. Pause and resume will work.
Using a custom music player and the internal music player is not possible, the custom music player takes priority.
To stop the custom music player call hook_music()
without arguments.
-Note: NEVER call SDL::Mixer
functions, nor SDL::Audio::lock, from a callback function.
+Note: NEVER call SDL::Mixer
functions, nor SDL::Audio::lock, from a callback function.
Note: At program termination also call SDL::Mixer::Music::hook_music()
to stop this callback.
Example:
my $callback = sub
diff --git a/pages/SDL-Mixer.html-inc b/pages/SDL-Mixer.html-inc
index f3bd509..f963132 100644
--- a/pages/SDL-Mixer.html-inc
+++ b/pages/SDL-Mixer.html-inc
@@ -110,7 +110,7 @@ error code when they fail. The result will be a horrible staticy noise. You can
of SDL should take this parameter only as a hint, then read back the value that the OS (for example, OSS or ALSA) has chosen to use in case the
desired audio type is not supported.
Note: When already initialized, this function will not re-initialize SDL_mixer, nor fail. It will merely increment the number of times
-SDL::Mixer::close_audio must be called to actually get it to uninitialize. This serves as a very simplistic method for multiple application
+SDL::Mixer::close_audio must be called to actually get it to uninitialize. This serves as a very simplistic method for multiple application
components to use SDL_mixer without necessitating a great deal of inter-component awareness. Be warned however that in such a situation, the
latest components to initialize SDL_mixer will probably not get the SDL_mixer settings they're expecting.
Example:
@@ -154,7 +154,7 @@ This function returns 1 as first array element (status) if the audio has been op
SEE ALSO
-perl, SDL::Mixer::Channels, SDL::Mixer::Effects, SDL::Mixer::Groups, SDL::Mixer::Music.
+perl, SDL::Mixer::Channels, SDL::Mixer::Effects, SDL::Mixer::Groups, SDL::Mixer::Music.
\ No newline at end of file
diff --git a/pages/SDL-Music.html-inc b/pages/SDL-Music.html-inc
index 1e0d939..8094d99 100644
--- a/pages/SDL-Music.html-inc
+++ b/pages/SDL-Music.html-inc
@@ -17,7 +17,7 @@
DESCRIPTION
-SDL::Music is used to load music files for use with SDL::Mixer.
+
SDL::Music is used to load music files for use with SDL::Mixer.
To load a music file one simply creates a new object passing the filename
to the constructor:
my $music = new SDL::Music 'my_song.ogg';
@@ -35,7 +35,7 @@ to the constructor:
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-OpenGL.html-inc b/pages/SDL-OpenGL.html-inc
index b17707e..f181f66 100644
--- a/pages/SDL-OpenGL.html-inc
+++ b/pages/SDL-OpenGL.html-inc
@@ -25,7 +25,7 @@
DESCRIPTION
-SDL::OpenGL is a perl module which when used by your application
+
SDL::OpenGL is a perl module which when used by your application
exports the gl* and glu* functions into your application's primary namespace.
Most of the functions described in the OpenGL 1.3 specification are currently
supported in this fashion. As the implementation of the OpenGL bindings that
@@ -80,7 +80,7 @@ glCallLists, so you might want to pack your data like this:
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-Overlay.html-inc b/pages/SDL-Overlay.html-inc
index b341277..c8e66be 100644
--- a/pages/SDL-Overlay.html-inc
+++ b/pages/SDL-Overlay.html-inc
@@ -121,7 +121,7 @@ SDL_YVYU_OVERLAY 0x55595659 /* Packed mode: Y0+V0+Y1+U0 */
As of release 2.3 direct right to overlay is disable.
An array of pointers to the data of each plane. The overlay should be locked before these pointers are used.
-see SDL::Video::lock_YUV_overlay, SDL::Video::unload_YUV_overlay
+see SDL::Video::lock_YUV_overlay, SDL::Video::unload_YUV_overlay
hw_overlay
diff --git a/pages/SDL-Palette.html-inc b/pages/SDL-Palette.html-inc
index ce7e982..ed2b376 100644
--- a/pages/SDL-Palette.html-inc
+++ b/pages/SDL-Palette.html-inc
@@ -54,7 +54,7 @@ values of a SDL::Surface
's palette can be set with the SDL::V
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-PixelFormat.html-inc b/pages/SDL-PixelFormat.html-inc
index 930891c..707fe49 100644
--- a/pages/SDL-PixelFormat.html-inc
+++ b/pages/SDL-PixelFormat.html-inc
@@ -61,7 +61,7 @@
$surface->format->palette;
-Returns the SDL_Palette
and SDL::Palette of the format of the surface.
+Returns the SDL_Palette
and SDL::Palette of the format of the surface.
BitsPerPixel
@@ -142,7 +142,7 @@
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-Rect.html-inc b/pages/SDL-Rect.html-inc
index 8cbf5f1..ccb64a5 100644
--- a/pages/SDL-Rect.html-inc
+++ b/pages/SDL-Rect.html-inc
@@ -106,7 +106,7 @@ if not, it returns the h component of the rectangle:
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-SFont.html-inc b/pages/SDL-SFont.html-inc
index 3551ceb..a57f55b 100644
--- a/pages/SDL-SFont.html-inc
+++ b/pages/SDL-SFont.html-inc
@@ -40,7 +40,7 @@
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-Sound.html-inc b/pages/SDL-Sound.html-inc
index 28737c4..3c3977a 100644
--- a/pages/SDL-Sound.html-inc
+++ b/pages/SDL-Sound.html-inc
@@ -28,8 +28,8 @@
DESCRIPTION
-SDL::Sound is a module for loading WAV files for sound effects.
-The file can be loaded by creating a new SDL::Sound object by
+
SDL::Sound is a module for loading WAV files for sound effects.
+The file can be loaded by creating a new SDL::Sound object by
passing the filename to the constructor;
my $sound = new SDL::Sound 'my_sfx.wav';
@@ -52,7 +52,7 @@ passing the filename to the constructor;
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-Surface.html-inc b/pages/SDL-Surface.html-inc
index d279f55..7772fc1 100644
--- a/pages/SDL-Surface.html-inc
+++ b/pages/SDL-Surface.html-inc
@@ -48,7 +48,7 @@
SYNOPSIS
-The main surface (display) is provided by SDL::Video::set_video_mode.
+
The main surface (display) is provided by SDL::Video::set_video_mode.
use SDL; #provides flags & constants
use SDL::Video; #provides access to set_video_mode
use SDL::Surface; #provides access to SDL_Surface struct internals
@@ -183,7 +183,7 @@
format
-The format of the pixels stored in the surface. See SDL::PixelFormat
+The format of the pixels stored in the surface. See SDL::PixelFormat
my $format = $surface->format;
@@ -263,7 +263,7 @@
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-TTFont.html-inc b/pages/SDL-TTFont.html-inc
index bd294aa..62f29f6 100644
--- a/pages/SDL-TTFont.html-inc
+++ b/pages/SDL-TTFont.html-inc
@@ -47,7 +47,7 @@
DESCRIPTION
-SDL::TTFont is a module for applying true type fonts to SDL::Surface.
+SDL::TTFont is a module for applying true type fonts to SDL::Surface.
METHODS
@@ -176,7 +176,7 @@ for "ae" will not always match the width for "a" + "e&q
print ($surface, $top, $left, @text)
-Directly draws text to an existing surface. Receives the target SDL::Surface
+
Directly draws text to an existing surface. Receives the target SDL::Surface
object and the relative top (y) and left (x) coordinates to put the text in.
The last parameter may be a string or an array or strings with the text to be
written.
@@ -193,7 +193,7 @@ written.
SEE ALSO
-perl, SDL, SDL::Surface
+
diff --git a/pages/SDL-Tool-Font.html-inc b/pages/SDL-Tool-Font.html-inc
index f808086..529f6fb 100644
--- a/pages/SDL-Tool-Font.html-inc
+++ b/pages/SDL-Tool-Font.html-inc
@@ -21,7 +21,7 @@
DESCRIPTION
-SDL::Tool::Font provides a unified interface for applying
+
SDL::Tool::Font provides a unified interface for applying
True Type and SFont fonts to various surfaces.
@@ -42,7 +42,7 @@ with the upper left hand corner starting at the specified coordinates.
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-Tool-Graphic.html-inc b/pages/SDL-Tool-Graphic.html-inc
index 441675e..fa3e057 100644
--- a/pages/SDL-Tool-Graphic.html-inc
+++ b/pages/SDL-Tool-Graphic.html-inc
@@ -31,7 +31,7 @@
DESCRIPTION
-SDL::Tool::Graphic is a module for zooming and rotating SDL::Surface objects.
+SDL::Tool::Graphic is a module for zooming and rotating SDL::Surface objects.
METHODS
@@ -40,17 +40,17 @@
zoom ( surface, xzoom, yzoom, smooth )
-SDL::Tool::Graphic::zoom
scales a SDL::Surface along the two axis independently.
+SDL::Tool::Graphic::zoom
scales a SDL::Surface along the two axis independently.
rotoZoom ( surface, angle, zoom, smooth )
-SDL::Tool::Graphic::rotoZoom
rotates and fixed axis zooms a SDL::Surface.
+SDL::Tool::Graphic::rotoZoom
rotates and fixed axis zooms a SDL::Surface.
grayScale ( surface )
-SDL::Tool::Graphic::grayScale
rotates and fixed axis zooms a SDL::Surface.
+SDL::Tool::Graphic::grayScale
rotates and fixed axis zooms a SDL::Surface.
invertColor ( surface )
@@ -69,7 +69,7 @@
SEE ALSO
\ No newline at end of file
diff --git a/pages/SDL-Tutorial-Animation.html-inc b/pages/SDL-Tutorial-Animation.html-inc
index c5c526c..2fa2c2a 100644
--- a/pages/SDL-Tutorial-Animation.html-inc
+++ b/pages/SDL-Tutorial-Animation.html-inc
@@ -59,8 +59,8 @@ frame and saving and restoring the background for every object drawn.
Since you have to draw the screen in the right order once to start with it's
pretty easy to make this into a loop and redraw things in the right order for
-every frame. Given a SDL::App object $app
, a SDL::Rect $rect
, and
-a SDL::Color $color
, you only have to create a new SDL::Rect $bg
,
+every frame. Given a SDL::App object $app
, a SDL::Rect $rect
, and
+a SDL::Color $color
, you only have to create a new SDL::Rect $bg
,
representing the whole of the background surface and a new SDL::Color
$bg_color
, representing the background color. You can write a
draw_frame()
function as follows:
@@ -155,11 +155,11 @@ them soon.
SEE ALSO
- - SDL::Tutorial::Drawing
+ - SDL::Tutorial::Drawing
-
basic drawing with SDL Perl
- - SDL::Tutorial::Images
+ - SDL::Tutorial::Images
-
animating images
diff --git a/pages/SDL-Tutorial-Images.html-inc b/pages/SDL-Tutorial-Images.html-inc
index 810121b..cda90aa 100644
--- a/pages/SDL-Tutorial-Images.html-inc
+++ b/pages/SDL-Tutorial-Images.html-inc
@@ -55,9 +55,9 @@ need to draw the alternate image beforehand somehow.
Loading Images
-As usual, start with an SDL::App object representing the image window. Then
+
As usual, start with an SDL::App object representing the image window. Then
preload the image file. This is easy; just pass the name
parameter to the
-SDL::Surface constructor:
+SDL::Surface constructor:
use SDL::Surface;
@@ -100,7 +100,7 @@ though. Assuming $app
is the SDL::App object, as usual:
-Here we have two SDL::Rect objects which represent rectangular regions of a
+
Here we have two SDL::Rect objects which represent rectangular regions of a
Surface. $frame_rect
represents the entire area of $frame
, while
$dest_rect
represents the area of the main window in which to blit the
frame. This may be clearer with more descriptive variable names:
@@ -199,11 +199,11 @@ smoothly. More on that next time.
SEE ALSO
- - SDL::Tutorial
+ - SDL::Tutorial
-
basic SDL tutorial
- - SDL::Tutorial::Animation
+ - SDL::Tutorial::Animation
-
non-image animation
diff --git a/pages/SDL-Tutorial-Pong.html-inc b/pages/SDL-Tutorial-Pong.html-inc
index 788f36a..eb61d93 100644
--- a/pages/SDL-Tutorial-Pong.html-inc
+++ b/pages/SDL-Tutorial-Pong.html-inc
@@ -60,7 +60,7 @@
-That creates a new SDL::Game::Rect object, a rectangle, with the given width/height dimensions and in the given top/left position of the screen.
+That creates a new SDL::Game::Rect object, a rectangle, with the given width/height dimensions and in the given top/left position of the screen.
Wait. Did I say... <screen>?
@@ -110,7 +110,7 @@
# TODO
Now let's query some events!
-First, we need to use the SDL::Event module. Add this to the beginning of our code:
+First, we need to use the SDL::Event module. Add this to the beginning of our code:
use SDL::Event;
my $event = SDL::Event->new;
diff --git a/pages/SDL-Tutorial.html-inc b/pages/SDL-Tutorial.html-inc
index fd8d3ec..0f33a14 100644
--- a/pages/SDL-Tutorial.html-inc
+++ b/pages/SDL-Tutorial.html-inc
@@ -53,7 +53,7 @@ though. Here's how to get up and running as quickly as possible.
Surfaces
All graphics in SDL live on a surface. You'll need at least one. That's what
-SDL::App provides.
+SDL::App provides.
Of course, before you can get a surface, you need to initialize your video
mode. SDL gives you several options, including whether to run in a window or
take over the full screen, the size of the window, the bit depth of your
@@ -95,8 +95,8 @@ surface. That's a bit more complicated, but see the -name
paramete
Working With The App
Since $app
from the code above is just an SDL surface with some extra sugar,
-it behaves much like SDL::Surface. In particular, the all-important blit
-and update
methods work. You'll need to create SDL::Rect objects
+it behaves much like SDL::Surface. In particular, the all-important blit
+and update
methods work. You'll need to create SDL::Rect objects
representing sources of graphics to draw onto the $app
's surface, blit
them there, then update
the $app
.
Note: "blitting" is copying a chunk of memory from one place to another.
@@ -106,15 +106,15 @@ them there, then update
the $app
.
SEE ALSO
- - SDL::Tutorial::Drawing
+ - SDL::Tutorial::Drawing
-
basic drawing with rectangles
- - SDL::Tutorial::Animation
+ - SDL::Tutorial::Animation
-
basic rectangle animation
- - SDL::Tutorial::Images
+ - SDL::Tutorial::Images
-
image loading and animation
diff --git a/pages/SDL-Video.html-inc b/pages/SDL-Video.html-inc
index c6a2ac4..041c083 100644
--- a/pages/SDL-Video.html-inc
+++ b/pages/SDL-Video.html-inc
@@ -135,7 +135,7 @@
my $surface = SDL::Video::get_video_surface();
-This function returns the current display SDL::Surface. If SDL is doing format conversion on the display surface, this
+
This function returns the current display SDL::Surface. If SDL is doing format conversion on the display surface, this
function returns the publicly visible surface, not the real video surface.
Example:
# somewhere after you set the video mode
@@ -151,7 +151,7 @@ function returns the publicly visible surface, not the real video surface.
my $video_info = SDL::Video::get_video_info();
-This function returns a read-only SDL::VideoInfo containing information about the video hardware. If it is called before
+
This function returns a read-only SDL::VideoInfo containing information about the video hardware. If it is called before
SDL::Video::set_video_mode, the vfmt
member of the returned structure will contain the pixel
format of the best video mode.
Example:
@@ -262,7 +262,7 @@ It returns 0
if the mode is not supported at all, otherwise the sug
Sets up a video mode with the specified width, height, bits-per-pixel and flags.
-set_video_mode
returns a SDL::Surface on success otherwise it returns undef on error, the error message is retrieved
+set_video_mode
returns a SDL::Surface on success otherwise it returns undef on error, the error message is retrieved
using SDL::get_error
.
@@ -349,12 +349,12 @@ each call to SDL::Video::set_video_mode, for examp
$converted_surface = SDL::Video::convert_surface( $surface, $format, $flags );
-Creates a new SDL::surface of the specified SDL::PixelFormat, and then copies and maps the given surface to it.
+
Creates a new SDL::surface of the specified SDL::PixelFormat, and then copies and maps the given surface to it.
It is also useful for making a copy of a surface.
-The flags parameter is passed to SDL::Surface->new
and has those semantics.
+
The flags parameter is passed to SDL::Surface->new
and has those semantics.
This function is used internally by SDL::Video::display_format.
This function can only be called after SDL::init
.
-it returns a SDL::Surface on success or undef
on error.
+it returns a SDL::Surface on success or undef
on error.
display_format
@@ -391,8 +391,8 @@ segfault.
$surface = SDL::Video::load_BMP( $filename );
-Loads a SDL::Surface from a named Windows BMP file.
-SDL::Video::load_BMP
returns a SDL::Surface on success or undef
on error.
+Loads a SDL::Surface from a named Windows BMP file.
+SDL::Video::load_BMP
returns a SDL::Surface on success or undef
on error.
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).
use SDL;
use SDL::Video;
@@ -429,7 +429,7 @@ segfault.
$saved_BMP = SDL::Video::save_BMP( $surface, $filename );
-Saves the given SDL::Surface as a Windows BMP file named filename.
+
Saves the given SDL::Surface as a Windows BMP file named filename.
it returns 0 on success or -1 on error.
@@ -520,7 +520,7 @@ two arbitrary RGBA surfaces this way and get the result you would expect from &q
$fill_rect = SDL::Video::fill_rect( $dest, $dest_rect, $pixel );
-This function performs a fast fill of the given SDL::Rect with the given SDL::PixelFormat. If dest_rect is NULL, the whole surface
+
This function performs a fast fill of the given SDL::Rect with the given SDL::PixelFormat. If dest_rect is NULL, the whole surface
will be filled with color.
The color should be a pixel of the format used by the surface, and can be generated by the SDL::Video::map_RGB or
SDL::Video::map_RGBA|/map_RGBA
functions. If the color value contains an alpha value then the destination is simply "filled" with that
@@ -543,7 +543,7 @@ surface to see the result. This can happen if you are using a shadowed surface t
int SDL::Video::lock_surface( $surface );
-SDL::Video::lock_surface
sets up the given SDL::Surface for directly accessing the pixels.
+
SDL::Video::lock_surface
sets up the given SDL::Surface for directly accessing the pixels.
Between calls to SDL::lock_surface and SDL::unlock_surface, you can write to ( surface-
set_pixels>) and read from ( surface-
get_pixels> ),
using the pixel format stored in surface-
format>.
Once you are done accessing the surface, you should use SDL::Video::unlock_surface to release the lock.
@@ -660,7 +660,7 @@ Surfaces should be unlocked as soon as possible.
SDL::Video::set_clip_rect( $surface, $rect );
-Sets the clipping rectangle for the given SDL::Surface. When this surface is the destination of a blit, only the area within the clip
+
Sets the clipping rectangle for the given SDL::Surface. When this surface is the destination of a blit, only the area within the clip
rectangle will be drawn into.
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
outside the edges of the surface.
@@ -673,7 +673,7 @@ If rect is NULL the clipping rectangle will be set to the full size of the surfa
SDL::Video::get_clip_rect( $surface, $rect );
-Gets the clipping rectangle for the given SDL::Surface. When this surface is the destination of a blit, only the area within the clip
+
Gets the clipping rectangle for the given SDL::Surface. When this surface is the destination of a blit, only the area within the clip
rectangle is drawn into.
The rectangle pointed to by rect will be filled with the clipping rectangle of the surface.
SDL::Video::get_clip_rect
doesn't returns anything;
@@ -705,7 +705,7 @@ The rectangle pointed to by rect will be filled with the clipping rectangle of t
SDL::Video::blit_surface( $src_surface, $src_rect, $dest_surface, $dest_rect );
-This performs a fast blit from the given source SDL::Surface to the given destination SDL::Surface.
+
This performs a fast blit from the given source SDL::Surface to the given destination SDL::Surface.
The width and height in src_surface
determine the size of the copied rectangle. Only the position is used in the dst_rect
(the width and height are ignored). Blits with negative dst_rect
coordinates will be clipped properly.
If src_rect
is NULL, the entire surface is copied. If dst_rect
is NULL, then the destination position (upper left corner) is (0, 0).
@@ -833,7 +833,7 @@ instead.
When surface is the surface associated with the current display, the display colormap will be updated with the requested colors.
If SDL_HWPALETTE
was set in SDL::Video::set_video_mode flags, SDL::Video::set_colors
will always return 1, and the
palette is guaranteed to be set the way you desire, even if the window colormap has to be warped or run under emulation.
-The color components of a SDL::Color structure are 8-bits in size, giving you a total of 2563 = 16777216 colors.
+The color components of a SDL::Color structure are 8-bits in size, giving you a total of 2563 = 16777216 colors.
Palettized (8-bit) screen surfaces with the SDL_HWPALETTE
flag have two palettes, a logical palette that is used for mapping blits to/from
the surface and a physical palette (that determines how the hardware will map the colors to the display).
SDL::Video::set_colors
modifies both palettes (if present), and is equivalent to calling SDL::Video::set_palette with the
@@ -1007,11 +1007,11 @@ with SDL::Video::set_gamma.
$pixel = SDL::Video::map_RGB( $pixel_format, $r, $g, $b );
-Maps the RGB color value to the specified SDL::PixelFormat and returns the pixel value as a 32-bit int.
+
Maps the RGB color value to the specified SDL::PixelFormat and returns the pixel value as a 32-bit int.
If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned.
If the specified pixel format has an alpha component it will be returned as all 1 bits (fully opaque).
SDL::Video::map_RGB
returns a pixel value best approximating the given RGB color value for a given pixel format.
-If the SDL::PixelFormat's bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored
+If the SDL::PixelFormat's bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored
(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).
use SDL;
use SDL::Video;
@@ -1049,7 +1049,7 @@ If the SDL::PixelFormat's bpp (color depth)
$pixel = SDL::Video::map_RGB( $pixel_format, $r, $g, $b, $a );
-Maps the RGBA color value to the specified SDL::PixelFormat and returns the pixel value as a 32-bit int.
+
Maps the RGBA color value to the specified SDL::PixelFormat and returns the pixel value as a 32-bit int.
If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned.
If the specified pixel format has no alpha component the alpha value will be ignored (as it will be in formats with a palette).
A pixel value best approximating the given RGBA color value for a given pixel format.
@@ -1186,7 +1186,7 @@ or disabled using the SDL_GL_DOUBLEBUFFER
attribute.
Video Overlay Functions
-see SDL::Overlay
+see SDL::Overlay
lock_YUV_overlay
@@ -1212,7 +1212,7 @@ can be displayed. unlock_YUV_overlay
does not return anything.
$display_overlay = SDL::Video::display_YUV_overlay( $overlay, $dstrect );
-Blit the overlay to the display surface specified when the overlay was created. The SDL::Rect structure, dstrect
, specifies a rectangle
+
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
It returns 0
on success or -1
on error.
@@ -1282,7 +1282,7 @@ bar or desktop when the window is minimized). As with title this string may be f
Sets the icon for the display window. Win32 icons must be 32x32.
-This function must be called before the first call to SDL::Video::set_video_mode. Note that this means SDL::Image
+
This function must be called before the first call to SDL::Video::set_video_mode. Note that this means SDL::Image
cannot be used.
The shape is determined by the colorkey or alpha channel of the icon, if any. If neither of those are present, the icon is made opaque
(no transparency).
@@ -1326,7 +1326,7 @@ and not interpreted by a window manager, if any.
If the application is running in a window managed environment SDL attempts to iconify/minimise it. If wm_iconify_window
is successful,
-the application will receive a SDL_APPACTIVE
loss event (see Application visibility events at SDL::Event).
+the application will receive a SDL_APPACTIVE
loss event (see Application visibility events at SDL::Event).
Returns non-zero on success or 0 if iconification is not supported or was refused by the window manager.
Example:
use SDL;
@@ -1368,9 +1368,9 @@ is experimental).
Category Objects
\ No newline at end of file
diff --git a/pages/SDL-VideoInfo.html-inc b/pages/SDL-VideoInfo.html-inc
index b944290..dd4981f 100644
--- a/pages/SDL-VideoInfo.html-inc
+++ b/pages/SDL-VideoInfo.html-inc
@@ -168,7 +168,7 @@
SEE ALSO
\ No newline at end of file
diff --git a/pages/documentation.html-inc b/pages/documentation.html-inc
index f4eaf0d..6db6f7a 100644
--- a/pages/documentation.html-inc
+++ b/pages/documentation.html-inc
@@ -1,2 +1,2 @@
-Documentation (latest development branch)
Core SDL - Simple DirectMedia Layer for Perl SDL::Time - a SDL perl extension for managing timers.
Audio SDL::Audio - SDL Bindings for Audio
Structure SDL::AudioCVT - Audio Conversion Structure SDL::AudioSpec - SDL Bindings for structure SDL::AudioSpec
CDROM SDL::CDROM - SDL Bindings for the CDROM device
Structure SDL::CD - SDL Bindings for structure SDL_CD SDL::CDTrack - SDL Bindings for structure SDL_CDTrack
Events SDL::Events - Bindings to the Events Category in SDL API
Structure SDL::Event - General event structure
Joystick SDL::Joystick - SDL Bindings for the Joystick device
Mouse SDL::Mouse - SDL Bindings for the Mouse device
Structure SDL::Cursor - Mouse cursor structure
Structure SDL::Version - SDL Bindings for structure SDL_Version
Video SDL::Video - Bindings to the video category in SDL API
Structure SDL::Color - Format independent color description SDL::Overlay - YUV Video overlay SDL::Palette - Color palette for 8-bit pixel formats SDL::PixelFormat - Stores surface format information SDL::Rect - Defines a rectangular area SDL::Surface - Graphic surface structure. SDL::VideoInfo - Video Target Information
Cookbook SDL::Cookbook SDL::Cookbook::PDL
Extension SDL::App - a SDL perl extension
GFX SDL::GFX::Framerate - framerate calculating functions SDL::GFX::Primitives - basic drawing functions
Structure SDL::GFX::FPSManager - data structure used by SDL::GFX::Framerate
Image SDL::Image - Bindings for the SDL_Image library
Mixer SDL::Mixer - Sound and music functions SDL::Mixer::Channels - SDL::Mixer channel functions and bindings SDL::Mixer::Effects - SDL_Mixer sound effect functions and bindings SDL::Mixer::Groups - SDL_Mixer groups functions and bindings SDL::Mixer::Music - functions for music SDL::Mixer::Samples - functions for loading sound samples
Structure SDL::Mixer::MixChunk - SDL Bindings for structure SDL_MixChunk SDL::Mixer::MixMusic - SDL Bindings for structure SDL_MixMusic TODO Core
MultiThread SDL::MultiThread - Bindings to the MultiThread category in SDL API
Structure SDL::RWOps - SDL Bindings to SDL_RWOPs
GFX SDL::GFX::BlitFunc - blitting functions SDL::GFX::ImageFilter - image filtering functions SDL::GFX::Rotozoom - rotation and zooming functions for surfaces
Tutorials SDL::Tutorial - introduction to Perl SDL SDL::Tutorial::Animation SDL::Tutorial::Images SDL::Tutorial::LunarLander - a small tutorial on Perl SDL SDL::Tutorial::Pong - Get started pong SDL::Tutorial::Tetris - Let's Make Tetris
UNCATEGORIZED SDL::Font - a SDL perl extension SDL::Game::Palette - a perl extension SDL::MPEG - a SDL perl extension SDL::Music - a perl extension SDL::OpenGL - a perl extension SDL::SFont - a perl extension SDL::SMPEG - a SDL perl extension SDL::Sound - a perl extension SDL::TTFont - a SDL perl extension SDL::Tool::Font - a perl extension SDL::Tool::Graphic
+Documentation (latest development branch)
Core SDL - Simple DirectMedia Layer for Perl SDL::Time - a SDL perl extension for managing timers.
Audio SDL::Audio - SDL Bindings for Audio
Structure SDL::AudioCVT - Audio Conversion Structure SDL::AudioSpec - SDL Bindings for structure SDL::AudioSpec
CDROM SDL::CDROM - SDL Bindings for the CDROM device
Structure SDL::CD - SDL Bindings for structure SDL_CD SDL::CDTrack - SDL Bindings for structure SDL_CDTrack
Events SDL::Events - Bindings to the Events Category in SDL API
Structure SDL::Event - General event structure
Joystick SDL::Joystick - SDL Bindings for the Joystick device
Mouse SDL::Mouse - SDL Bindings for the Mouse device
Structure SDL::Cursor - Mouse cursor structure
Structure SDL::Version - SDL Bindings for structure SDL_Version
Video SDL::Video - Bindings to the video category in SDL API
Structure SDL::Color - Format independent color description SDL::Overlay - YUV Video overlay SDL::Palette - Color palette for 8-bit pixel formats SDL::PixelFormat - Stores surface format information SDL::Rect - Defines a rectangular area SDL::Surface - Graphic surface structure. SDL::VideoInfo - Video Target Information
Cookbook SDL::Cookbook SDL::Cookbook::PDL
Extension SDL::App - a SDL perl extension
GFX SDL::GFX::Framerate - framerate calculating functions SDL::GFX::Primitives - basic drawing functions
Structure SDL::GFX::FPSManager - data structure used by SDL::GFX::Framerate
Image SDL::Image - Bindings for the SDL_Image library
Mixer SDL::Mixer - Sound and music functions SDL::Mixer::Channels - SDL::Mixer channel functions and bindings SDL::Mixer::Effects - SDL_Mixer sound effect functions and bindings SDL::Mixer::Groups - Audio channel group functions SDL::Mixer::Music - functions for music SDL::Mixer::Samples - functions for loading sound samples
Structure SDL::Mixer::MixChunk - SDL Bindings for structure SDL_MixChunk SDL::Mixer::MixMusic - SDL Bindings for structure SDL_MixMusic TODO Core
MultiThread SDL::MultiThread - Bindings to the MultiThread category in SDL API
Structure SDL::RWOps - SDL Bindings to SDL_RWOPs
GFX SDL::GFX::BlitFunc - blitting functions SDL::GFX::ImageFilter - image filtering functions SDL::GFX::Rotozoom - rotation and zooming functions for surfaces
Tutorials SDL::Tutorial - introduction to Perl SDL SDL::Tutorial::Animation SDL::Tutorial::Images SDL::Tutorial::LunarLander - a small tutorial on Perl SDL SDL::Tutorial::Pong - Get started pong SDL::Tutorial::Tetris - Let's Make Tetris
UNCATEGORIZED SDL::Font - a SDL perl extension SDL::Game::Palette - a perl extension SDL::MPEG - a SDL perl extension SDL::Music - a perl extension SDL::OpenGL - a perl extension SDL::SFont - a perl extension SDL::SMPEG - a SDL perl extension SDL::Sound - a perl extension SDL::TTFont - a SDL perl extension SDL::Tool::Font - a perl extension SDL::Tool::Graphic
diff --git a/tools/PM-Pod2html-snippet.pl b/tools/PM-Pod2html-snippet.pl
index 52187f8..c1a67f4 100644
--- a/tools/PM-Pod2html-snippet.pl
+++ b/tools/PM-Pod2html-snippet.pl
@@ -180,11 +180,14 @@ sub node
if($self->SUPER::type() eq 'page')
{
my $page = $self->SUPER::page();
+ my $suff = '';
if($page =~ /^SDL\b/)
{
- $page =~ s/::/-/;
- return "/$page.html";
+ $page =~ s/::([A-Z])+/-$1/g;
+ $page =~ s/(.*)::(.*)/\/$1.html#$2/;
+
+ return $page;
}
else
{