From: Tobias Leich Date: Thu, 26 Nov 2009 14:08:45 +0000 (+0100) Subject: parser for links X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=sdlgit%2FSDL-Site.git;a=commitdiff_plain;h=46beffd8f76fe150d946bf61c780e61de2affbdf parser for links --- diff --git a/pages/SDL-App.html-inc b/pages/SDL-App.html-inc index f1d4dd3..91d7176 100644 --- a/pages/SDL-App.html-inc +++ b/pages/SDL-App.html-inc @@ -68,8 +68,8 @@ An alternative to the manual Event processing is the L<SDL::App::loop> .

DESCRIPTION

Top

-

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.

@@ -195,7 +195,7 @@ Kartik Thakore

SEE ALSO

Top

-

perl SDL::Surface SDL::Event SDL::OpenGL

+

perl SDL::Surface SDL::Event SDL::OpenGL

\ No newline at end of file diff --git a/pages/SDL-Audio.html-inc b/pages/SDL-Audio.html-inc index 83e5a50..db1182a 100644 --- a/pages/SDL-Audio.html-inc +++ b/pages/SDL-Audio.html-inc @@ -64,7 +64,7 @@ -
The desired audio format. See SDL::AudioSpec
+
The desired audio format. See SDL::AudioSpec
    $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 89a1b89..6fe8c4e 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 @@

SEE ALSO

Top

-

SDL::CDROM, SDL::CDTrack

+

SDL::CDROM, SDL::CDTrack

\ No newline at end of file diff --git a/pages/SDL-CDTrack.html-inc b/pages/SDL-CDTrack.html-inc index 3858133..902ea46 100644 --- a/pages/SDL-CDTrack.html-inc +++ b/pages/SDL-CDTrack.html-inc @@ -98,7 +98,7 @@

SEE ALSO

Top

-

SDL::CDROM, SDL::CD

+

SDL::CDROM, SDL::CD

\ No newline at end of file diff --git a/pages/SDL-Cdrom.html-inc b/pages/SDL-Cdrom.html-inc index 7175daa..7c91efd 100644 --- a/pages/SDL-Cdrom.html-inc +++ b/pages/SDL-Cdrom.html-inc @@ -75,7 +75,7 @@

See Also

Top

-

SDL::CD, SDL::CDTrack

+

SDL::CD, SDL::CDTrack

\ No newline at end of file diff --git a/pages/SDL-Color.html-inc b/pages/SDL-Color.html-inc index 50c6bff..40d057e 100644 --- a/pages/SDL-Color.html-inc +++ b/pages/SDL-Color.html-inc @@ -94,7 +94,7 @@ if not, it returns the blue component of the color:

SEE ALSO

Top

-

SDL::Surface

+

SDL::Surface

\ No newline at end of file diff --git a/pages/SDL-Cursor.html-inc b/pages/SDL-Cursor.html-inc index 9f2914d..805a709 100644 --- a/pages/SDL-Cursor.html-inc +++ b/pages/SDL-Cursor.html-inc @@ -114,7 +114,7 @@ and in your main loop, when you draw graphics, also draw a SDL::Surface

SEE ALSO

Top

-

perl SDL::Mouse

+

perl SDL::Mouse

\ No newline at end of file diff --git a/pages/SDL-Event.html-inc b/pages/SDL-Event.html-inc index bc6bfe8..b1f25a9 100644 --- a/pages/SDL-Event.html-inc +++ b/pages/SDL-Event.html-inc @@ -558,7 +558,7 @@ screen updates will still report success even though the application will no lon

SEE ALSO

Top

-

perl +

perl

diff --git a/pages/SDL-Events.html-inc b/pages/SDL-Events.html-inc index a97ddbd..70b569d 100644 --- a/pages/SDL-Events.html-inc +++ b/pages/SDL-Events.html-inc @@ -88,7 +88,7 @@

pump_events gathers all the pending input information from devices and places it on the event queue. Without calls to pump_events no events would ever be placed on the queue. -Often the need for calls to pump_events is hidden from the user since poll_event and wait_event implicitly call pump_events. +Often the need for calls to pump_events is hidden from the user since poll_event and wait_event implicitly call pump_events. However, if you are not polling or waiting for events (e.g. you are filtering them), then you must call pump_events to force an event queue update.

@@ -126,8 +126,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

@@ -153,7 +153,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

@@ -163,7 +163,7 @@ The event is copied into the queue, and the caller may dispose of the memory poi

SEE ALSO

Top

-

SDL::Event, SDL::Video +

SDL::Event, SDL::Video

diff --git a/pages/SDL-Font.html-inc b/pages/SDL-Font.html-inc index 3663a55..f037920 100644 --- a/pages/SDL-Font.html-inc +++ b/pages/SDL-Font.html-inc @@ -30,8 +30,8 @@

DESCRIPTION

Top

-

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

Top

@@ -50,7 +50,7 @@ fonts with SDL::Surface objects.

SEE ALSO

Top

-

perl SDL::Surface

+

perl SDL::Surface

\ No newline at end of file diff --git a/pages/SDL-Game-Palette.html-inc b/pages/SDL-Game-Palette.html-inc index 696e4e9..8769580 100644 --- a/pages/SDL-Game-Palette.html-inc +++ b/pages/SDL-Game-Palette.html-inc @@ -25,7 +25,7 @@

DESCRIPTION

Top

-

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

Top

-

perl SDL::Color SDL::Surface

+

perl SDL::Color SDL::Surface

\ No newline at end of file diff --git a/pages/SDL-Joystick.html-inc b/pages/SDL-Joystick.html-inc index bf306f3..9da305a 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.html-inc b/pages/SDL-Mixer.html-inc index 3ad07a2..9dc1690 100644 --- a/pages/SDL-Mixer.html-inc +++ b/pages/SDL-Mixer.html-inc @@ -294,7 +294,7 @@ values:

SEE ALSO

Top

-

perl, SDL::Music and SDL::Sound.

+

perl, SDL::Music and SDL::Sound.

\ No newline at end of file diff --git a/pages/SDL-Music.html-inc b/pages/SDL-Music.html-inc index c66b3e3..1e0d939 100644 --- a/pages/SDL-Music.html-inc +++ b/pages/SDL-Music.html-inc @@ -17,7 +17,7 @@

DESCRIPTION

Top

-

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

Top

-

perl SDL::Mixer

+

perl SDL::Mixer

\ No newline at end of file diff --git a/pages/SDL-OpenGL.html-inc b/pages/SDL-OpenGL.html-inc index c6bb498..b17707e 100644 --- a/pages/SDL-OpenGL.html-inc +++ b/pages/SDL-OpenGL.html-inc @@ -25,7 +25,7 @@

DESCRIPTION

Top

-

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 @@ -48,7 +48,7 @@ to types.

numbers, the Perl equivalent only takes a list of numbers.

Note that this is slow, since it needs to allocate memory and construct a list of numbers from the given scalars. For a faster version see -glCallListsString.

+glCallListsString.

The following methods exist in addition to the normal OpenGL specification:

@@ -58,7 +58,7 @@ list of numbers from the given scalars. For a faster version see
        glCallListsString($string);
 
 
-

Works like glCallLists(), except that it needs only one parameter, a scalar +

Works like glCallLists(), except that it needs only one parameter, a scalar holding a string. The string is interpreted as a set of bytes, and each of these will be passed to glCallLists as GL_BYTE. This is faster than glCallLists, so you might want to pack your data like this:

@@ -80,7 +80,7 @@ glCallLists, so you might want to pack your data like this:

SEE ALSO

Top

-

perl SDL::App

+

perl SDL::App

\ No newline at end of file diff --git a/pages/SDL-Palette.html-inc b/pages/SDL-Palette.html-inc index 417a2d6..ce7e982 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

Top

-

SDL::Color SDL::Surface

+

SDL::Color SDL::Surface

\ No newline at end of file diff --git a/pages/SDL-PixelFormat.html-inc b/pages/SDL-PixelFormat.html-inc index 24d48ad..930891c 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

Top

-

SDL::Surface

+

SDL::Surface

\ No newline at end of file diff --git a/pages/SDL-Rect.html-inc b/pages/SDL-Rect.html-inc index f9129b8..8cbf5f1 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

Top

-

SDL::Surface

+

SDL::Surface

\ No newline at end of file diff --git a/pages/SDL-SFont.html-inc b/pages/SDL-SFont.html-inc index a42c087..3551ceb 100644 --- a/pages/SDL-SFont.html-inc +++ b/pages/SDL-SFont.html-inc @@ -40,7 +40,7 @@

SEE ALSO

Top

-

perl SDL::App

+

perl SDL::App

\ No newline at end of file diff --git a/pages/SDL-Sound.html-inc b/pages/SDL-Sound.html-inc index 7a59f94..28737c4 100644 --- a/pages/SDL-Sound.html-inc +++ b/pages/SDL-Sound.html-inc @@ -28,8 +28,8 @@

DESCRIPTION

Top

-

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

Top

-

perl SDL::Mixer

+

perl SDL::Mixer

\ No newline at end of file diff --git a/pages/SDL-Surface.html-inc b/pages/SDL-Surface.html-inc index 6484908..537155e 100644 --- a/pages/SDL-Surface.html-inc +++ b/pages/SDL-Surface.html-inc @@ -39,7 +39,7 @@

SYNOPSIS

Top

-

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

@@ -111,7 +111,7 @@

SEE ALSO

Top

-

SDL, SDL::PixelFormat, SDL::Video

+

SDL, SDL::PixelFormat, SDL::Video

\ No newline at end of file diff --git a/pages/SDL-TTFont.html-inc b/pages/SDL-TTFont.html-inc index b9714cc..04bb94d 100644 --- a/pages/SDL-TTFont.html-inc +++ b/pages/SDL-TTFont.html-inc @@ -47,7 +47,7 @@

DESCRIPTION

Top

-

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

Top

@@ -176,7 +176,7 @@ for "ae" will not always match the width for "a" + "e&q

SEE ALSO

Top

-

perl, SDL, SDL::Surface +

perl, SDL, SDL::Surface

diff --git a/pages/SDL-Tool-Font.html-inc b/pages/SDL-Tool-Font.html-inc index 0eb3a34..f808086 100644 --- a/pages/SDL-Tool-Font.html-inc +++ b/pages/SDL-Tool-Font.html-inc @@ -21,7 +21,7 @@

DESCRIPTION

Top

-

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

Top

-

perl SDL::Font SDL::TTFont SDL::Surface

+

perl SDL::Font SDL::TTFont SDL::Surface

\ No newline at end of file diff --git a/pages/SDL-Tool-Graphic.html-inc b/pages/SDL-Tool-Graphic.html-inc index 43b669c..441675e 100644 --- a/pages/SDL-Tool-Graphic.html-inc +++ b/pages/SDL-Tool-Graphic.html-inc @@ -31,7 +31,7 @@

DESCRIPTION

Top

-

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

Top

@@ -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

Top

-

perl SDL::Surface

+

perl SDL::Surface

\ No newline at end of file diff --git a/pages/SDL-Tutorial-Animation.html-inc b/pages/SDL-Tutorial-Animation.html-inc index 6c06b63..c5c526c 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

Top

-
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 76d0b1d..810121b 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

Top

-
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 a13a9b1..97c5fe1 100644 --- a/pages/SDL-Tutorial-Pong.html-inc +++ b/pages/SDL-Tutorial-Pong.html-inc @@ -54,7 +54,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>?

@@ -104,7 +104,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 7a04768..fd8d3ec 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

Top

-
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 8d0f9b1..9227060 100644 --- a/pages/SDL-Video.html-inc +++ b/pages/SDL-Video.html-inc @@ -598,9 +598,9 @@ It returns 0 on succés or -1 on error.

Category Objects

-

SDL::Surface, SDL::Overlay, SDL::Color, -SDL::Rect, SDL::Palette, SDL::PixelFormat, -SDL::VideoInfo

+

SDL::Surface, SDL::Overlay, SDL::Color, +SDL::Rect, SDL::Palette, SDL::PixelFormat, +SDL::VideoInfo

\ No newline at end of file diff --git a/pages/SDL-VideoInfo.html-inc b/pages/SDL-VideoInfo.html-inc index 255a427..b944290 100644 --- a/pages/SDL-VideoInfo.html-inc +++ b/pages/SDL-VideoInfo.html-inc @@ -168,7 +168,7 @@

SEE ALSO

Top

-

SDL::Video, SDL::PixelFormat

+

SDL::Video, SDL::PixelFormat

\ No newline at end of file diff --git a/pages/SDL-old-cdrom.html-inc b/pages/SDL-old-cdrom.html-inc index 304c392..2298646 100644 --- a/pages/SDL-old-cdrom.html-inc +++ b/pages/SDL-old-cdrom.html-inc @@ -145,7 +145,7 @@ Documentation by Tels <http://bloodgate.com/>.

SEE ALSO

Top

-

perl SDL::Mixer SDL::App.

+

perl SDL::Mixer SDL::App.

\ No newline at end of file diff --git a/pages/documentation.html-inc b/pages/documentation.html-inc index 133b069..39d788b 100644 --- a/pages/documentation.html-inc +++ b/pages/documentation.html-inc @@ -1,2 +1,2 @@
-

Documentation (latest development branch)

Core
thumbSDL- Simple DirectMedia Layer for Perl
Structure
thumbSDL::AudioCVT- Audio Conversion Structure
thumbSDL::AudioSpec- SDL Bindings for structure SDL::AudioSpec
CDROM
thumbSDL::CDROM- SDL Bindings for the CDROM device
Structure
thumbSDL::CD- SDL Bindings for structure SDL_CD
thumbSDL::CDTrack- SDL Bindings for structure SDL_CDTrack
Events
thumbSDL::Events- Bindings to the Events Category in SDL API
Structure
thumbSDL::Event- General event structure
Joystick
thumbSDL::Joystick- SDL Bindings for the Joystick device
Structure
thumbSDL::Mixer::MixChunk- SDL Bindings for structure SDL_MixChunk
Mouse
thumbSDL::Mouse- SDL Bindings for the Mouse device
Structure
thumbSDL::Cursor- Mouse cursor structure
MultiThread
thumbSDL::MultiThread- Bindings to the MultiThread category in SDL API
Structure
thumbSDL::Version- SDL Bindings for structure SDL_Version
Video
thumbSDL::Video- Bindings to the video category in SDL API
Structure
thumbSDL::Color- Format independent color description
thumbSDL::Overlay- YUV Video overlay
thumbSDL::Palette- Color palette for 8-bit pixel formats
thumbSDL::PixelFormat- Stores surface format information
thumbSDL::Rect- Defines a rectangular area
thumbSDL::Surface
thumbSDL::VideoInfo- Video Target Information

Cookbook
thumbSDL::Cookbook
thumbSDL::Cookbook::PDL

Extension
thumbSDL::App- a SDL perl extension

Mixer
thumbSDL::Mixer- a SDL perl extension
TODO
Core
Audio
thumbSDL::Audio- SDL Bindings for Audio
Structure
thumbSDL::Mixer::MixMusic- SDL Bindings for structure SDL_MixMusic
Structure
thumbSDL::RWOps- SDL Bindings to SDL_RWOPs

Tutorials
thumbSDL::Tutorial- introduction to Perl SDL
thumbSDL::Tutorial::Animation
thumbSDL::Tutorial::Images
thumbSDL::Tutorial::LunarLander- a small tutorial on Perl SDL
thumbSDL::Tutorial::Pong
thumbSDL::Tutorial::Tetris

UNCATEGORIZED
thumbSDL::Font- a SDL perl extension
thumbSDL::Game::Palette- a perl extension
thumbSDL::MPEG- a SDL perl extension
thumbSDL::Music- a perl extension
thumbSDL::OpenGL- a perl extension
thumbSDL::SFont- a perl extension
thumbSDL::SMPEG- a SDL perl extension
thumbSDL::Sound- a perl extension
thumbSDL::TTFont- a SDL perl extension
thumbSDL::Timer- a SDL perl extension for managing timers.
thumbSDL::Tool::Font- a perl extension
thumbSDL::Tool::Graphic
thumbSDL::old-cdrom- a SDL perl extension for managing CD-ROM drives
+

Documentation (latest development branch)

Core
thumbSDL- Simple DirectMedia Layer for Perl
Structure
thumbSDL::AudioCVT- Audio Conversion Structure
thumbSDL::AudioSpec- SDL Bindings for structure SDL::AudioSpec
CDROM
thumbSDL::CDROM- SDL Bindings for the CDROM device
Structure
thumbSDL::CD- SDL Bindings for structure SDL_CD
thumbSDL::CDTrack- SDL Bindings for structure SDL_CDTrack
Events
thumbSDL::Events- Bindings to the Events Category in SDL API
Structure
thumbSDL::Event- General event structure
Joystick
thumbSDL::Joystick- SDL Bindings for the Joystick device
Structure
thumbSDL::Mixer::MixChunk- SDL Bindings for structure SDL_MixChunk
Mouse
thumbSDL::Mouse- SDL Bindings for the Mouse device
Structure
thumbSDL::Cursor- Mouse cursor structure
MultiThread
thumbSDL::MultiThread- Bindings to the MultiThread category in SDL API
Structure
thumbSDL::Version- SDL Bindings for structure SDL_Version
Video
thumbSDL::Video- Bindings to the video category in SDL API
Structure
thumbSDL::Color- Format independent color description
thumbSDL::Overlay- YUV Video overlay
thumbSDL::Palette- Color palette for 8-bit pixel formats
thumbSDL::PixelFormat- Stores surface format information
thumbSDL::Rect- Defines a rectangular area
thumbSDL::Surface
thumbSDL::VideoInfo- Video Target Information

Cookbook
thumbSDL::Cookbook
thumbSDL::Cookbook::PDL

Extension
thumbSDL::App- a SDL perl extension

Mixer
thumbSDL::Mixer- a SDL perl extension
TODO
Core
Audio
thumbSDL::Audio- SDL Bindings for Audio
Structure
thumbSDL::Mixer::MixMusic- SDL Bindings for structure SDL_MixMusic
Structure
thumbSDL::RWOps- SDL Bindings to SDL_RWOPs

Tutorials
thumbSDL::Tutorial- introduction to Perl SDL
thumbSDL::Tutorial::Animation
thumbSDL::Tutorial::Images
thumbSDL::Tutorial::LunarLander- a small tutorial on Perl SDL
thumbSDL::Tutorial::Pong
thumbSDL::Tutorial::Tetris

UNCATEGORIZED
thumbSDL::Font- a SDL perl extension
thumbSDL::Game::Palette- a perl extension
thumbSDL::MPEG- a SDL perl extension
thumbSDL::Music- a perl extension
thumbSDL::OpenGL- a perl extension
thumbSDL::SFont- a perl extension
thumbSDL::SMPEG- a SDL perl extension
thumbSDL::Sound- a perl extension
thumbSDL::TTFont- a SDL perl extension
thumbSDL::Timer- a SDL perl extension for managing timers.
thumbSDL::Tool::Font- a perl extension
thumbSDL::Tool::Graphic
thumbSDL::old-cdrom- a SDL perl extension for managing CD-ROM drives
diff --git a/tools/LinkResolver.pm b/tools/LinkResolver.pm new file mode 100644 index 0000000..998cd46 --- /dev/null +++ b/tools/LinkResolver.pm @@ -0,0 +1,42 @@ + +package LinkResolver; +use Pod::ParseUtils; +use base qw(Pod::Hyperlink); + +sub new +{ + my $class = shift; + my $css = shift; + my $self = $class->SUPER::new(); + $self->{css} = $css; + return $self; +} + +sub node +{ + my $self = shift; + if($self->SUPER::type() eq 'page') + { + my $url = "?module=".$self->SUPER::page(); + $url.=";css=".$_ for @{$self->{css}}; + return $url; + } + $self->SUPER::node(@_); +} + +sub text +{ + my $self = shift; + return $self->SUPER::page() if($self->SUPER::type() eq 'page'); + $self->SUPER::text(@_); +} + +sub type +{ + my $self = shift; + return "hyperlink" if($self->SUPER::type() eq 'page'); + $self->SUPER::type(@_); +} + +1; + diff --git a/tools/PM-Pod2html-snippet.pl b/tools/PM-Pod2html-snippet.pl index ba587c7..7021b66 100644 --- a/tools/PM-Pod2html-snippet.pl +++ b/tools/PM-Pod2html-snippet.pl @@ -16,7 +16,7 @@ pop(@directories); my $parent_dir = catpath($volume, catdir(@directories)); my $pages_path = catdir($parent_dir, 'pages'); my $assets_path = catdir($parent_dir, 'htdocs/assets'); -my $parser = Pod::Xhtml->new(FragmentOnly => 1, StringMode => 1); +my $parser = Pod::Xhtml->new(FragmentOnly => 1, StringMode => 1, LinkParser => new LinkResolver()); my %module_names = (); my %thumbnails = (); my %files = (); @@ -161,3 +161,52 @@ sub read_file } } } + +package LinkResolver; +use Pod::ParseUtils; +use base qw(Pod::Hyperlink); + +sub new +{ + my $class = shift; + my $css = shift; + my $self = $class->SUPER::new(); + return $self; +} + +sub node +{ + my $self = shift; + if($self->SUPER::type() eq 'page') + { + my $page = $self->SUPER::page(); + + if($page =~ /^SDL::/) + { + $page =~ s/::/-/; + return "/$page.html"; + } + else + { + return "http://search.cpan.org/perldoc?$page"; + } + } + $self->SUPER::node(@_); +} + +sub text +{ + my $self = shift; + return $self->SUPER::page() if($self->SUPER::type() eq 'page'); + $self->SUPER::text(@_); +} + +sub type +{ + my $self = shift; + return "hyperlink" if($self->SUPER::type() eq 'page'); + $self->SUPER::type(@_); +} + +1; +