From: Tobias Leich Date: Sun, 10 Oct 2010 16:20:26 +0000 (+0200) Subject: fixed links to methods X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=1dbe16975541da864f8bfa5169c89a2ab8893bf2;p=sdlgit%2FSDL-Site.git fixed links to methods --- diff --git a/pages/SDL-Audio.html-inc b/pages/SDL-Audio.html-inc index b8c5b8f..236d59a 100644 --- a/pages/SDL-Audio.html-inc +++ b/pages/SDL-Audio.html-inc @@ -329,7 +329,7 @@ function is not running. Do not call this from the callback function or you will

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-AudioCVT.html-inc b/pages/SDL-AudioCVT.html-inc index df23396..76fa35c 100644 --- a/pages/SDL-AudioCVT.html-inc +++ b/pages/SDL-AudioCVT.html-inc @@ -110,7 +110,7 @@ see SDL::AudioSpec.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-AudioSpec.html-inc b/pages/SDL-AudioSpec.html-inc index 89ddad0..0442183 100644 --- a/pages/SDL-AudioSpec.html-inc +++ b/pages/SDL-AudioSpec.html-inc @@ -127,7 +127,7 @@ set to 4096.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

diff --git a/pages/SDL-CD.html-inc b/pages/SDL-CD.html-inc index b44c285..1bacb95 100644 --- a/pages/SDL-CD.html-inc +++ b/pages/SDL-CD.html-inc @@ -126,7 +126,7 @@

Plays the given SDL::CD starting at track $start_track, for $ntracks tracks.

$start_frame is the frame offset, from the beginning of the $start_track, at which to start. $nframes is the frame offset, from the beginning of the last track ($start_track+$ntracks), at which to end playing.

-

play_tracks() should only be called after calling status to get information about the CD.

+

play_tracks() should only be called after calling http://search.cpan.org/perldoc? to get information about the CD.

Note: Data tracks are ignored.

Returns 0, or -1 if there was an error.

@@ -229,7 +229,7 @@ beginning of the last track ($start_track+$ntracks), at which to end playing.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-CDROM.html-inc b/pages/SDL-CDROM.html-inc index 5e4527d..13e60ee 100644 --- a/pages/SDL-CDROM.html-inc +++ b/pages/SDL-CDROM.html-inc @@ -76,7 +76,7 @@

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-CDTrack.html-inc b/pages/SDL-CDTrack.html-inc index 87cd3ec..29d4e4e 100644 --- a/pages/SDL-CDTrack.html-inc +++ b/pages/SDL-CDTrack.html-inc @@ -117,7 +117,7 @@

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-Color.html-inc b/pages/SDL-Color.html-inc index 16932ed..115ec4f 100644 --- a/pages/SDL-Color.html-inc +++ b/pages/SDL-Color.html-inc @@ -99,7 +99,7 @@ if not, it returns the blue component of the color.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

diff --git a/pages/SDL-Cookbook-OpenGL.html-inc b/pages/SDL-Cookbook-OpenGL.html-inc index a0794df..8bc33d9 100644 --- a/pages/SDL-Cookbook-OpenGL.html-inc +++ b/pages/SDL-Cookbook-OpenGL.html-inc @@ -149,12 +149,12 @@

SEE ALSO

Top

-

perl SDLx::App OpenGL

+

perl SDLx::App OpenGL

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

diff --git a/pages/SDL-Cookbook-PDL.html-inc b/pages/SDL-Cookbook-PDL.html-inc index 2436684..9e46309 100644 --- a/pages/SDL-Cookbook-PDL.html-inc +++ b/pages/SDL-Cookbook-PDL.html-inc @@ -110,7 +110,7 @@ After that a simple update_rect will so your new surface on the screen.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

diff --git a/pages/SDL-Cookbook.html-inc b/pages/SDL-Cookbook.html-inc index a4896cd..28cf9a3 100644 --- a/pages/SDL-Cookbook.html-inc +++ b/pages/SDL-Cookbook.html-inc @@ -42,7 +42,7 @@

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-Cursor.html-inc b/pages/SDL-Cursor.html-inc index ff7314f..5a7df01 100644 --- a/pages/SDL-Cursor.html-inc +++ b/pages/SDL-Cursor.html-inc @@ -132,7 +132,7 @@ For example, if you wanted a 9 pixel crosshair you might do the following:

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

diff --git a/pages/SDL-Deprecated.html-inc b/pages/SDL-Deprecated.html-inc index 6d865cf..563385e 100644 --- a/pages/SDL-Deprecated.html-inc +++ b/pages/SDL-Deprecated.html-inc @@ -54,11 +54,11 @@ The second argument to move handlers, the t value, is now the third
SDLx::App
-

Now depends on SDLx::Surface. To get the SDL::Surface, use -surface() >. Alternatively SDLx::Surface::display() (display in SDLx::Surface).

+

Now depends on SDLx::Surface. To get the SDL::Surface, use -surface() >. Alternatively SDLx::Surface::display().

SDLx::Surface
-

get_display is now called SDLx::Surface::display (display in SDLx::Surface).

+

get_display is now called SDLx::Surface::display.

SDLx::Sprite::Animated
@@ -83,7 +83,7 @@ The second argument to move handlers, the t value, is now the third

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-Event.html-inc b/pages/SDL-Event.html-inc index de04a03..542b7b0 100644 --- a/pages/SDL-Event.html-inc +++ b/pages/SDL-Event.html-inc @@ -263,7 +263,7 @@ and when a key is pressed (type=SDL_KEYDOWN or key_state=SDL_ then an SDL_RELEASED when released and pressed again. For these keys KEYUP and KEYDOWN events are therefore analogous to the state of the caps lock and num lock LEDs rather than the keys themselves. These special cases are required for compatibility with Sun workstations.

-

Note: Repeating SDL_KEYDOWN events will occur if key repeat is enabled (see enable_key_repeat).

+

Note: Repeating SDL_KEYDOWN events will occur if key repeat is enabled (see SDL::Events::enable_key_repeat).

key_state

@@ -303,7 +303,7 @@ This field is very useful when you are checking for certain key presses, like so

key_unicode

-

The unicode field is only used when UNICODE translation is enabled with enable_unicode. +

The unicode field is only used when UNICODE translation is enabled with SDL::Events::enable_unicode. If unicode is non-zero then this is the UNICODE character corresponding to the keypress. If the high 9 bits of the character are 0, then this maps to the equivalent ASCII character:

 my $char;
@@ -332,7 +332,7 @@ button states (motion_state).

motion_state

-

The button state can be interpreted using the SDL_BUTTON macro (see get_mouse_state).

+

The button state can be interpreted using the SDL_BUTTON macro (see SDL::Events::get_mouse_state).

motion_x, motion_y

diff --git a/pages/SDL-Events.html-inc b/pages/SDL-Events.html-inc index a943e9e..d23fb17 100644 --- a/pages/SDL-Events.html-inc +++ b/pages/SDL-Events.html-inc @@ -79,15 +79,15 @@ my $event = SDL::Event->new(); # notices 'Event' ne 'Events' while( 1 ) - { - SDL::Events::pump_events(); - while( SDL::Events::poll_event($event) ) - { - #check by event type - on_active() if $event->type == SDL_ACTIVEEVENT; - ... - } - } + { + SDL::Events::pump_events(); + while( SDL::Events::poll_event($event) ) + { + #check by event type + on_active() if $event->type == SDL_ACTIVEEVENT; + ... + } + } @@ -269,8 +269,9 @@ 
	pump_events();
-

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. +

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 http://search.cpan.org/perldoc? and http://search.cpan.org/perldoc? 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.

@@ -285,8 +286,10 @@ However, if you are not polling or waiting for events (e.g. you are filtering th

If action is SDL_ADDEVENT, up to numevents events will be added to the back of the event queue.

-

If action is SDL_PEEKEVENT, up to numevents events at the front of the event queue, matching mask, will be returned and will not be removed from the queue.

-

If action is SDL_GETEVENT, up to numevents events at the front of the event queue, matching mask, will be returned and will be removed from the queue.

+

If action is SDL_PEEKEVENT, up to numevents events at the front of the event queue, matching mask, will be returned and will not be removed from +the queue.

+

If action is SDL_GETEVENT, up to numevents events at the front of the event queue, matching mask, will be returned and will be removed from the +queue.

The mask parameter is a bitwise OR of SDL::Events::SDL_EVENTMASK(event_type), for all event types you are interested in

This function is thread-safe.

You may have to call pump_events before calling this function. Otherwise, the events may not be ready to be filtered when you call peep_events.

@@ -309,7 +312,8 @@ However, if you are not polling or waiting for events (e.g. you are filtering th

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.

+

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

@@ -320,7 +324,8 @@ However, if you are not polling or waiting for events (e.g. you are filtering th

push_event($event)

Pushes an event onto the event queue

-

The event queue can actually be used as a two way communication channel. Not only can events be read from the queue, but the user can also push their own events onto it. event is a pointer to the event structure you wish to push onto the queue. +

The event queue can actually be used as a two way communication channel. Not only can events be read from the queue, but the user can also push +their own events onto it. event is a pointer to the event structure you wish to push onto the queue. The event is copied into the queue, and the caller may dispose of the memory pointed to after push_event returns.

Note: Pushing device input events onto the queue doesn't modify the state of the device within SDL.

This function is thread safe, and can be called from other threads safely.

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

@@ -360,8 +366,10 @@ The event is copied into the queue, and the caller may dispose of the memory poi

to filter the event return a 0, to pass the filter return a 1.

-

One Caveat is if you are filtering SDL_QUIT the event will be filtered if it is non-intterupt call ( Window closes normally ). If it is a interrupt SDL_QUIT it will be process on the next event poll.

-

Events pushed onto to the queue with SDL::Events::push_events or SDL::Events::peep_events do not get filtered.

+

One Caveat is if you are filtering SDL_QUIT the event will be filtered if it is non-intterupt call ( Window closes normally ). If it is a +interrupt SDL_QUIT it will be process on the next event poll.

+

Events pushed onto to the queue with SDL::Events::push_events or SDL::Events::peep_events +do not get filtered.

This callback may run in a different thread.

@@ -373,8 +381,9 @@ The event is copied into the queue, and the caller may dispose of the memory poi print $keys_ref->[SDLK_RETURN]; # 1 if pressed , 0 if not pressed -

Use SDL::Events::pump_events to update the state array.

-

This function gives you the current state after all events have been processed, so if a key or button has been pressed and released before you process events, then the pressed state will never show up in the get_key_state call.

+

Use SDL::Events::pump_events to update the state array.

+

This function gives you the current state after all events have been processed, so if a key or button has been pressed and released before you +process events, then the pressed state will never show up in the get_key_state call.

This function doesn't take into account whether shift has been pressed or not.

@@ -437,12 +446,12 @@ The event is copied into the queue, and the caller may dispose of the memory poi

set_mod_state

Get the state of the modifier keys

-

The inverse of SDL::Events::get_mod_state allows you to impose modifier key states on your application.

+

The inverse of SDL::Events::get_mod_state allows you to impose modifier key states on your application.

Simply pass your desired modifier states into $modstate. This value can be a OR'd combination of any KMOD* constant.

 my $modstate = KMOD_LMETA | KMOD_LSHIFT;
-

Any KMOD_* constant see SDL::Events::get_mod_state for constants. +

Any KMOD_* constant see SDL::Events::get_mod_state for constants. SDL::Events::set_mod_state( $modstate );

@@ -495,7 +504,10 @@ The event is copied into the queue, and the caller may dispose of the memory poi $previous_translation_mode = SDL::Events::enable_unicode( 0 ); #disables -

To obtain the character codes corresponding to received keyboard events, Unicode translation must first be turned on using this function. The translation incurs a slight overhead for each keyboard event and is therefore disabled by default. For each subsequently recieved key down event, the unicode member of the SDL::Event::key_sym provided structure will be then contain the corresponding character code, or otherwise zero.

+

To obtain the character codes corresponding to received keyboard events, Unicode translation must first be turned on using this function. The +translation incurs a slight overhead for each keyboard event and is therefore disabled by default. For each subsequently recieved key down event, +the unicode member of the SDL::Event::key_sym provided structure will be then contain the corresponding character code, or +otherwise zero.

A value of 1 for enabling, 0 for disabling and -1 for unchanged. -1 is usefull for querying the current translation mode.

Only key press events will be translated not release events.

Returns the previous translation mode as (1,0).

@@ -507,7 +519,8 @@ The event is copied into the queue, and the caller may dispose of the memory poi 
 my $success = SDL::Events::enable_key_repeat( $delay, $interval );
-

Enables or disables the keyboard repeat rate. $delay specifies how long the key must be pressed before it begins repeating, it then repleats at the speed specified by $interval. Both $delay and $interval are expressed in milliseconds.

+

Enables or disables the keyboard repeat rate. $delay specifies how long the key must be pressed before it begins repeating, it then repleats at the +speed specified by $interval. Both $delay and $interval are expressed in milliseconds.

Setting $delay to 0 disables key repeating completely. Good default values are SDL_DEFAULT_REPEAT_DELAY and SDL_DEFAULT_REPEAT_INTERVAL.

Return 0 on success and -1 on fail.

@@ -515,15 +528,15 @@ The event is copied into the queue, and the caller may dispose of the memory poi

get_mouse_state

Retrives the current state of the mouse

-
	my ($mask,$x,$y) = @{ SDL::Events::get_mouse_state( ) };
+
  my ($mask,$x,$y) = @{ SDL::Events::get_mouse_state( ) };
 
-        print 'Button Left pressed' if ($mask & SDL_BUTTON_LMASK);    
+  print 'Button Left pressed' if ($mask & SDL_BUTTON_LMASK);    
 
-        print 'Button Right pressed' if ($mask & SDL_BUTTON_RMASK);   
+  print 'Button Right pressed' if ($mask & SDL_BUTTON_RMASK);   
 
-        print 'Button Middle pressed' if ($mask & SDL_BUTTON_MMASK);  
+  print 'Button Middle pressed' if ($mask & SDL_BUTTON_MMASK);  
 
-        print $x.','.$y;
+  print $x.','.$y;
 
 

 
The current button state is returned as a button $bitmask, which can be tested using the the above constants 

@@ -532,15 +545,15 @@ The event is copied into the queue, and the caller may dispose of the memory poi
 
get_relative_mouse_state 

 

 
Retrives the current relative state of the mouse

-
	my ($mask,$x,$y) = @{ SDL::Events::get_mouse_state( ) };
+
  my ($mask,$x,$y) = @{ SDL::Events::get_mouse_state( ) };
 
-        print 'Button Left pressed' if ($mask & SDL_BUTTON_LMASK);    
+  print 'Button Left pressed' if ($mask & SDL_BUTTON_LMASK);    
 
-        print 'Button Right pressed' if ($mask & SDL_BUTTON_RMASK);   
+  print 'Button Right pressed' if ($mask & SDL_BUTTON_RMASK);   
 
-        print 'Button Middle pressed' if ($mask & SDL_BUTTON_MMASK);  
+  print 'Button Middle pressed' if ($mask & SDL_BUTTON_MMASK);  
 
-        print $x.','.$y; # this is relative to the last postion of the mouse
+  print $x.','.$y; # this is relative to the last postion of the mouse
 
 

 
The current button state is returned as a button $bitmask, which can be tested using the the above constants 

@@ -591,7 +604,8 @@ The event is copied into the queue, and the caller may dispose of the memory poi
 
	my $status = SDL::Events::joystick_event_state( $state );
 
 

-
This function is used to enable or disable joystick event processing. With joystick event processing disabled you will have to update joystick states with SDL_JoystickUpdate and read the joystick information manually. $state can be:

+
This function is used to enable or disable joystick event processing. With joystick event processing disabled you will have to update joystick 
+states with SDL::Joystick::update and read the joystick information manually. $state can be:

 

 	
SDL_QUERY

 	
SDL_ENABLE 

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

 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.
\ No newline at end of file diff --git a/pages/SDL-GFX-BlitFunc.html-inc b/pages/SDL-GFX-BlitFunc.html-inc index fe5e2fd..72c97be 100644 --- a/pages/SDL-GFX-BlitFunc.html-inc +++ b/pages/SDL-GFX-BlitFunc.html-inc @@ -26,7 +26,7 @@

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-GFX-FPSManager.html-inc b/pages/SDL-GFX-FPSManager.html-inc index 2d38964..80221dc 100644 --- a/pages/SDL-GFX-FPSManager.html-inc +++ b/pages/SDL-GFX-FPSManager.html-inc @@ -77,7 +77,7 @@

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-GFX-Framerate.html-inc b/pages/SDL-GFX-Framerate.html-inc index 4bbf62f..a759250 100644 --- a/pages/SDL-GFX-Framerate.html-inc +++ b/pages/SDL-GFX-Framerate.html-inc @@ -77,7 +77,7 @@ If the computer cannot keep up with the rate (i.e.drawing too slow), the delay i

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-GFX-ImageFilter.html-inc b/pages/SDL-GFX-ImageFilter.html-inc index d8ae3b1..4228287 100644 --- a/pages/SDL-GFX-ImageFilter.html-inc +++ b/pages/SDL-GFX-ImageFilter.html-inc @@ -653,7 +653,7 @@ gfx_image_restore_stack()

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-GFX-Primitives.html-inc b/pages/SDL-GFX-Primitives.html-inc index 3bb557f..2371174 100644 --- a/pages/SDL-GFX-Primitives.html-inc +++ b/pages/SDL-GFX-Primitives.html-inc @@ -55,7 +55,7 @@

DESCRIPTION

Top

All functions take an SDL::Surface object as first parameter. This can be a new surface that will be blittet afterwads, can be an surface -obtained by SDL::Video::set_video_mode or can be an SDLx::App.

+obtained by SDL::Video::set_video_mode or can be an SDLx::App.

The color values for the _color functions are 0xRRGGBBAA (32bit), even if the surface uses e. g. 8bit colors.

@@ -338,7 +338,7 @@ obtained by SDL::Video::set_video_mode<

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-GFX-Rotozoom.html-inc b/pages/SDL-GFX-Rotozoom.html-inc index 50d9c4d..f60c4ee 100644 --- a/pages/SDL-GFX-Rotozoom.html-inc +++ b/pages/SDL-GFX-Rotozoom.html-inc @@ -192,7 +192,7 @@

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

diff --git a/pages/SDL-Image.html-inc b/pages/SDL-Image.html-inc index b49b366..5fb86b5 100644 --- a/pages/SDL-Image.html-inc +++ b/pages/SDL-Image.html-inc @@ -101,7 +101,8 @@ This is NOT the same as XBM(X11 Bitmap) format, which is for monocolor images. <
XCF

GIMP native (.xcf) (XCF = eXperimental Computing Facility?) -This format is always changing, and since there's no library supplied by the GIMP project to load XCF, the loader may frequently fail to load much of any image from an XCF file. It's better to load this in GIMP and convert to a better supported image format.

+This format is always changing, and since there's no library supplied by the GIMP project to load XCF, the loader may frequently fail to load much +of any image from an XCF file. It's better to load this in GIMP and convert to a better supported image format.

PCX
@@ -121,8 +122,7 @@ This format is always changing, and since there's no library supplied by the GIM
LBM
-

Interleaved Bitmap (.lbm or .iff) FORM : ILBM or PBM(packed bitmap) -HAM6, HAM8, and 24bit types are not supported.

+

Interleaved Bitmap (.lbm or .iff) FORM : ILBM or PBM(packed bitmap), HAM6, HAM8, and 24bit types are not supported.

PNG
@@ -148,10 +148,15 @@ 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 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);
 
@@ -160,7 +165,8 @@ 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

@@ -175,7 +181,8 @@ Note: If the image format supports a transparent pixel, 
 	
freesrc

 	

-		
A non-zero value mean is will automatically close/free the src for you. Since SDL Perl cannot handle the memory inside this function you would most likely want 1 here.

+		
A non-zero value mean is will automatically close/free the src for you. Since SDL Perl cannot handle the memory inside this function you would most 
+likely want 1 here.

 	

 	
type

 	

@@ -201,10 +208,13 @@ Note: If the image format supports a transparent pixel, 
 	

 
-
Load src for use as a surface. This can load all supported image formats. This method does not guarantee that the format specified by type is the format of the loaded image, except in the case when TGA format is specified (or any other non-magicable format in the future). Using SDL_RWops is not covered here, but they enable you to load from almost any source.
-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 src for use as a surface. This can load all supported image formats. This method does not guarantee that the format specified by type is the 
+format of the loaded image, except in the case when TGA format is specified (or any other non-magicable format in the future). Using SDL_RWops is 
+not covered here, but they enable you to load from almost any source.

+
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

@@ -402,10 +412,13 @@ Note: If the image format supports a transparent pixel, IMG_INIT_PNG
IMG_INIT_TIF
-

Initialize by loading support as indicated by the flags, or at least return success if support is already loaded. You may call this multiple times, which will actually require you to call IMG_Quit just once to clean up. You may call this function with a 0 to retrieve whether support was built-in or not loaded yet. -Note: to load JPG, PNG, and/or TIF images you can call IMG_Init with the right IMG_INIT_* flags OR'd together before you program gets busy, to prevent a later hiccup while it loads the library, and to check that you do have the support that you need before you try and use it. -Note: No initialization is needed nor performed when using the SDL::Image::is_JPG, SDL::Image::is_PNG, and SDL::Image::is_TIF functions. -Note: this function does not always set the error string, so do not depend on SDL::Image::get_error being meaningful all the time.

+

Initialize by loading support as indicated by the flags, or at least return success if support is already loaded. You may call this multiple times, +which will actually require you to call IMG_Quit just once to clean up. You may call this function with a 0 to retrieve whether support was built-in +or not loaded yet.

+

Note: to load JPG, PNG, and/or TIF images you can call IMG_Init with the right IMG_INIT_* flags OR'd together before you program gets busy, to +prevent a later hiccup while it loads the library, and to check that you do have the support that you need before you try and use it.

+

Note: No initialization is needed nor performed when using the SDL::Image::is_JPG, SDL::Image::is_PNG, and SDL::Image::is_TIF functions.

+

Note: this function does not always set the error string, so do not depend on SDL::Image::get_error being meaningful all the time.

Return

@@ -425,7 +438,10 @@ 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

@@ -440,12 +456,12 @@ 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

Top

@@ -455,7 +471,7 @@ Note: this function does not always set the error string, so do not depend on SD

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-Joystick.html-inc b/pages/SDL-Joystick.html-inc index 14dd677..6c4979c 100644 --- a/pages/SDL-Joystick.html-inc +++ b/pages/SDL-Joystick.html-inc @@ -274,7 +274,7 @@ it may be necessary to impose certain tolerances on these values to account for

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-Mixer-Channels.html-inc b/pages/SDL-Mixer-Channels.html-inc index 852f8cf..c68613b 100644 --- a/pages/SDL-Mixer-Channels.html-inc +++ b/pages/SDL-Mixer-Channels.html-inc @@ -235,7 +235,7 @@ the audio callback, or SDL_mixer will explicitly lock the audio before calling y

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-Mixer-Effects.html-inc b/pages/SDL-Mixer-Effects.html-inc index 6a530e6..fb61d50 100644 --- a/pages/SDL-Mixer-Effects.html-inc +++ b/pages/SDL-Mixer-Effects.html-inc @@ -109,7 +109,7 @@ space. When a processor is finished being used, any function passed into $

Remove the registered effect function from the effect list for channel. If the channel is active the registered effect will have its $done_callback function called, if it was specified in -SDL::Mixer::Effects::register.

+SDL::Mixer::Effects::register.

Returns: Zero on errors, such as invalid channel, or effect function not registered on channel.

Note: Do not use this on a threaded perl. This will crash.

@@ -120,7 +120,7 @@ If the channel is active the registered effect will have its $done_callbac

This removes all effects registered to $channel. If the channel is active all the registered effects will have their $done_callback -functions called, if they were specified in SDL::Mixer::Effects::register.

+functions called, if they were specified in SDL::Mixer::Effects::register.

Returns: Zero on errors, such as channel not existing.

Note: Do not use this on a threaded perl. This will crash.

@@ -132,8 +132,9 @@ functions called, if they were specified in SDL::Mixer::Effects::register with MIX_CHANNEL_POST to use multiple postmix processors. -This postmix processor is run AFTER all the registered postmixers set up by SDL::Mixer::Effects::register.

+There can only be one postmix function used at a time through this method. Use SDL::Mixer::Effects::register +with MIX_CHANNEL_POST to use multiple postmix processors. +This postmix processor is run AFTER all the registered postmixers set up by SDL::Mixer::Effects::register.

Note: Do not use this on a threaded perl. This will crash.

@@ -144,7 +145,7 @@ This postmix processor is run AFTER all the registered postmixers set up by

This effect simulates a simple attenuation of volume due to distance. The volume never quite reaches silence, even at max distance (255).

NOTE: Using a distance of 0 will cause the effect to unregister itself from channel. You cannot unregister it any other way, unless you use -SDL::Mixer::Effects::unregister_all on the channel.

+SDL::Mixer::Effects::unregister_all on the channel.

Returns: Zero on errors, such as an invalid channel, or if Mix_RegisterEffect failed.

@@ -153,11 +154,11 @@ This postmix processor is run AFTER all the registered postmixers set up by SDL::Mixer::Effects::set_panning( $channel, $left, $right ); -

This effect will only work on stereo audio. Meaning you called SDL::Mixer::open_audio with 2 channels.

+

This effect will only work on stereo audio. Meaning you called SDL::Mixer::open_audio with 2 channels.

Note: Setting both left and right to 255 will unregister the effect from channel. You cannot unregister it any other way, unless you use -SDL::Mixer::Effects::unregister_all on the channel.

+SDL::Mixer::Effects::unregister_all on the channel.

Note: Using this function on a mono audio device will not register the effect, nor will it return an error status.

-

Returns: Zero on errors, such as bad channel, or if SDL::Mixer::Effects::register failed.

+

Returns: Zero on errors, such as bad channel, or if SDL::Mixer::Effects::register failed.

set_position

@@ -178,8 +179,8 @@ angle and distance from the camera's point of view, the effect pans and attenuat

So you can see it goes clockwise starting at directly in front.

$distance is 0(close/loud) to 255(far/quiet).

Note: Using angle and distance of 0, will cause the effect to unregister itself from channel. You cannot unregister it any other way, -unless you use SDL::Mixer::Effects::unregister_all on the channel.

-

Returns: Zero on errors, such as an invalid channel, or if SDL::Mixer::Effects::register failed.

+unless you use SDL::Mixer::Effects::unregister_all on the channel.

+

Returns: Zero on errors, such as an invalid channel, or if SDL::Mixer::Effects::register failed.

set_reverse_stereo

@@ -189,12 +190,12 @@ unless you use SDL::Mixer::Effe

If you pass 1 to $flip it simple reverse stereo, swaps left and right channel sound.

Note: Using a flip of 0, will cause the effect to unregister itself from channel. You cannot unregister it any other way, unless you use -SDL::Mixer::Effects::register on the channel.

+SDL::Mixer::Effects::register on the channel.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-Mixer-Groups.html-inc b/pages/SDL-Mixer-Groups.html-inc index d2ceadc..961490f 100644 --- a/pages/SDL-Mixer-Groups.html-inc +++ b/pages/SDL-Mixer-Groups.html-inc @@ -46,14 +46,14 @@ The channels are reserved starting from channel 0 to $num-1

The following functions are affected by this setting:

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).

+previously allocated (see SDL::Mixer::Channels::allocate_channels).

group_channel

@@ -126,7 +126,7 @@ previously allocated (see S

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-Mixer-MixChunk.html-inc b/pages/SDL-Mixer-MixChunk.html-inc index 4e34915..7beec47 100644 --- a/pages/SDL-Mixer-MixChunk.html-inc +++ b/pages/SDL-Mixer-MixChunk.html-inc @@ -61,7 +61,7 @@

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-Mixer-MixMusic.html-inc b/pages/SDL-Mixer-MixMusic.html-inc index 1fe1b44..0b61425 100644 --- a/pages/SDL-Mixer-MixMusic.html-inc +++ b/pages/SDL-Mixer-MixMusic.html-inc @@ -27,7 +27,7 @@

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-Mixer-Music.html-inc b/pages/SDL-Mixer-Music.html-inc index 0b6c7c4..0251a67 100644 --- a/pages/SDL-Mixer-Music.html-inc +++ b/pages/SDL-Mixer-Music.html-inc @@ -47,7 +47,7 @@ 
 my $music = SDL::Mixer::Music::load_MUS( $file );
-

load_MUS loads a music file into a SDL::Mixer::MixMusic structure. This can be passed to play_music (play_music in SDL::Mixer::Music).

+

load_MUS loads a music file into a SDL::Mixer::MixMusic structure. This can be passed to play_music.

hook_music

@@ -62,7 +62,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 (lock in SDL::Audio), 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:

 sub callback
@@ -91,9 +91,10 @@ Using a custom music player and the internal music player is not possible, the c
 
 SDL::Mixer::Music::hook_music_finished( 'main::callback' );
 
 

-
This callback is called when music called by e.g. SDL::Mixer::Music::play_music or SDL::Mixer::Music::fade_in_music stops naturally. 
+
This callback is called when music called by e.g. SDL::Mixer::Music::play_music or 
+SDL::Mixer::Music::fade_in_music stops naturally. 
 This happens when the music is over or is fading out.

-
Note: If you play music via SDL::Mixer::Music::hook_music, this callback will never be called.

+
Note: If you play music via SDL::Mixer::Music::hook_music, this callback will never be called.

 
Example:

 
 my $music_is_playing = 0;
  my @music            = qw(first.mp3 next.mp3 other.mp3 last.mp3);
@@ -122,7 +123,7 @@ This happens when the music is over or is fading out.

 
 my $position = SDL::Mixer::Music::get_music_hook_data();
 
 

-
Returns the position (first) parameter that will be passed to SDL::Mixer::Music::hook_music's callback.

+
Returns the position (first) parameter that will be passed to SDL::Mixer::Music::hook_music's callback.

 
 
 
play_music

@@ -148,7 +149,7 @@ Passing -1 to $loops will loop the music infinitely. 

 
 my $music = SDL::Mixer::Music::fade_in_music( $mix_music, $loops, $ms );
 
 

-
Same as SDL::Mixer::Music::play_music but you can specify the fade-in time by $ms.

+
Same as SDL::Mixer::Music::play_music but you can specify the fade-in time by $ms.

 
 
 
fade_out_music

@@ -242,7 +243,7 @@ Passing zero is similar to rewinding the song. 

 	
MP3

 	

 		
Jumps to position seconds from the current position in the stream.
-So you may want to call SDL::Mixer::Music::rewind_music before this.
+So you may want to call SDL::Mixer::Music::rewind_music before this.
 Does not go in reverse... negative values do nothing. 

 	

 
@@ -267,7 +268,7 @@ Does not go in reverse... negative values do nothing. 

 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
\ No newline at end of file
diff --git a/pages/SDL-Mixer-Samples.html-inc b/pages/SDL-Mixer-Samples.html-inc
index e71a452..8dca92b 100644
--- a/pages/SDL-Mixer-Samples.html-inc
+++ b/pages/SDL-Mixer-Samples.html-inc
@@ -112,7 +112,7 @@ free the source memory after loading is complete or not.

 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
\ No newline at end of file
diff --git a/pages/SDL-Mixer.html-inc b/pages/SDL-Mixer.html-inc
index 064cb66..4c04743 100644
--- a/pages/SDL-Mixer.html-inc
+++ b/pages/SDL-Mixer.html-inc
@@ -177,7 +177,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:

@@ -221,7 +221,7 @@ This function returns 1 as first array element (status) if the audio has been op
 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
\ No newline at end of file
diff --git a/pages/SDL-Mouse.html-inc b/pages/SDL-Mouse.html-inc
index b0d79eb..537d9df 100644
--- a/pages/SDL-Mouse.html-inc
+++ b/pages/SDL-Mouse.html-inc
@@ -105,7 +105,7 @@ The current state of the mouse cursor can be queried by passing SDL_QUERY<
 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
\ No newline at end of file
diff --git a/pages/SDL-MultiThread.html-inc b/pages/SDL-MultiThread.html-inc
index bf5aac7..cf3fa23 100644
--- a/pages/SDL-MultiThread.html-inc
+++ b/pages/SDL-MultiThread.html-inc
@@ -29,7 +29,7 @@
 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
\ No newline at end of file
diff --git a/pages/SDL-Overlay.html-inc b/pages/SDL-Overlay.html-inc
index 67d749f..199a256 100644
--- a/pages/SDL-Overlay.html-inc
+++ b/pages/SDL-Overlay.html-inc
@@ -132,7 +132,7 @@ SDL_YVYU_OVERLAY  0x55595659  /* Packed mode: Y0+V0+Y1+U0 */
 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
\ No newline at end of file
diff --git a/pages/SDL-Palette.html-inc b/pages/SDL-Palette.html-inc
index f0fc7c9..c759271 100644
--- a/pages/SDL-Palette.html-inc
+++ b/pages/SDL-Palette.html-inc
@@ -60,7 +60,7 @@ values of a SDL::Surface's palette can be set with the SDL::V
 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
\ No newline at end of file
diff --git a/pages/SDL-Pango-Context.html-inc b/pages/SDL-Pango-Context.html-inc
index db375a4..7167d04 100644
--- a/pages/SDL-Pango-Context.html-inc
+++ b/pages/SDL-Pango-Context.html-inc
@@ -38,7 +38,7 @@
 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
SEE ALSO
Top

diff --git a/pages/SDL-Pango.html-inc b/pages/SDL-Pango.html-inc
index 142cdd6..27c99eb 100644
--- a/pages/SDL-Pango.html-inc
+++ b/pages/SDL-Pango.html-inc
@@ -132,7 +132,7 @@
 
 SDL::Pango::init();
 
 

-
Initialize the Glib and Pango API. This must be called before using other functions in this library, excepting SDL::Pango::was_init. 
+
Initialize the Glib and Pango API. This must be called before using other functions in this library, excepting SDL::Pango::was_init. 
 SDL does not have to be initialized before this call.

 
Returns: always 0. 

 
@@ -142,7 +142,7 @@ SDL does not have to be initialized before this call.

 
 my $was_init = SDL::Pango::was_init();
 
 

-
Query the initilization status of the Glib and Pango API. You may, of course, use this before SDL::Pango::init to avoid initilizing twice 
+
Query the initilization status of the Glib and Pango API. You may, of course, use this before SDL::Pango::init to avoid initilizing twice 
 in a row.

 
Returns: Non-zero when already initialized. Zero when not initialized.

 
@@ -213,7 +213,7 @@ background.

 
 

 
Sets the direction of the text to either left-to-right or right-to-left.

-
See CONSTANTS.

+
See http://search.cpan.org/perldoc?.

 
 
 
set_dpi

@@ -250,7 +250,7 @@ background.

 
 SDL::Pango::set_surface_create_args($context, $flags, $bits, $r_mask, $g_mask, $b_mask, $a_mask);
 
 

-
Sets the argumet that are used when creating a surface via SDL::Pango::create_surface_draw.

+
Sets the argumet that are used when creating a surface via SDL::Pango::create_surface_draw.

 
Example:

 
 SDL::Pango::set_surface_create_args(
      $context, 
@@ -270,12 +270,12 @@ background.

 
 my $surface = SDL::Pango::create_surface_draw($context);
 
 

-
Creates a new surface and draws the text/markup. You can specify the attributes of the surfaces using SDL::Pango::set_surface_create_args.

+
Creates a new surface and draws the text/markup. You can specify the attributes of the surfaces using SDL::Pango::set_surface_create_args.

 
 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
SEE ALSO
Top

diff --git a/pages/SDL-PixelFormat.html-inc b/pages/SDL-PixelFormat.html-inc
index 55cfb88..5be459b 100644
--- a/pages/SDL-PixelFormat.html-inc
+++ b/pages/SDL-PixelFormat.html-inc
@@ -148,7 +148,7 @@
 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
\ No newline at end of file
diff --git a/pages/SDL-RWOps.html-inc b/pages/SDL-RWOps.html-inc
index 8c9447e..2ee714c 100644
--- a/pages/SDL-RWOps.html-inc
+++ b/pages/SDL-RWOps.html-inc
@@ -204,7 +204,7 @@ Returns 0 on success, -1 on error. 

 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 
 
diff --git a/pages/SDL-Rect.html-inc b/pages/SDL-Rect.html-inc
index 1a98ec3..ee94032 100644
--- a/pages/SDL-Rect.html-inc
+++ b/pages/SDL-Rect.html-inc
@@ -110,7 +110,7 @@ if not, it returns the h component of the rectangle.

 

 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
\ No newline at end of file
diff --git a/pages/SDL-Surface.html-inc b/pages/SDL-Surface.html-inc
index 8cd7397..d0e3973 100644
--- a/pages/SDL-Surface.html-inc
+++ b/pages/SDL-Surface.html-inc
@@ -189,7 +189,7 @@ The pixel value must fit the pixel format of the surface.

 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
\ No newline at end of file
diff --git a/pages/SDL-TTF-Font.html-inc b/pages/SDL-TTF-Font.html-inc
index c36da90..38815eb 100644
--- a/pages/SDL-TTF-Font.html-inc
+++ b/pages/SDL-TTF-Font.html-inc
@@ -46,7 +46,7 @@ You can specify the face index of a font file containing multiple faces.

 
 
AUTHORS
Top

 

-
See AUTHORS in SDL.

+
See /SDL.html#AUTHORS.

 
 

 
SEE ALSO
Top

diff --git a/pages/SDL-TTF.html-inc b/pages/SDL-TTF.html-inc
index 392a65b..7693e8e 100644
--- a/pages/SDL-TTF.html-inc
+++ b/pages/SDL-TTF.html-inc
@@ -178,7 +178,7 @@ No prior initialization needs to be done before these function is called. 

 
 

 
Initialize the truetype font API.
-This must be called before using other functions in this library, except SDL::TTF::was_init and SDL::TTF::linked_version.
+This must be called before using other functions in this library, except SDL::TTF::was_init and SDL::TTF::linked_version.
 SDL does not have to be initialized before this call.

 
Returns: 0 on success, -1 on any error.

 
@@ -189,8 +189,8 @@ SDL does not have to be initialized before this call.

Query the initilization status of the truetype font API. -You may, of course, use this before SDL::TTF::init to avoid initializing twice in a row. Or use this to determine if you need to call -SDL::TTF::quit.

+You may, of course, use this before SDL::TTF::init to avoid initializing twice in a row. Or use this to determine if you need to +call SDL::TTF::quit.

quit

@@ -199,8 +199,8 @@ You may, of course, use this before SDL::TTF::init<

Shutdown and cleanup the truetype font API. -After calling this the SDL::TTF functions should not be used, excepting SDL::TTF::was_init. You may, of course, use SDL::TTF::init to -use the functionality again

+After calling this the SDL::TTF functions should not be used, excepting SDL::TTF::was_init. You may, of course, use +SDL::TTF::init to use the functionality again

Management functions

@@ -228,7 +228,7 @@ use the functionality again

 my $font = SDL::TTF::open_font($font_file, $point_size, $face_index);
-

This is the same as SDL::TTF::open_font, except you can specify the face index of a font file containing multiple faces. +

This is the same as SDL::TTF::open_font, except you can specify the face index of a font file containing multiple faces. This can load TTF and FON files.

@@ -237,7 +237,7 @@ This can load TTF and FON files. 

 my $font = SDL::TTF::open_font_RW($rwops_object, $free, $point_size);
-

This is the same as SDL::TTF::open_font, except you can pass an SDL::RWOps-object. If you pass true as $free, the SDL::RWOps-object +

This is the same as SDL::TTF::open_font, except you can pass an SDL::RWOps-object. If you pass true as $free, the SDL::RWOps-object will be freed by SDL_ttf library. Don't do this, perl will free this object for you.

Example:

 my $font = SDL::TTF::open_font_RW(SDL::RWOps->new_file($font_file, 'r'), 0, 24);
@@ -250,7 +250,7 @@ will be freed by SDL_ttf library. Don't do this, perl will free this object for
 
 my $font = SDL::TTF::open_font_index_RW($rwops_object, $free, $point_size, $face_index);
 
 

-
This is the same as SDL::TTF::open_font_index, except you can pass an SDL::RWOps-object. If you pass true as $free, the 
+
This is the same as SDL::TTF::open_font_index, except you can pass an SDL::RWOps-object. If you pass true as $free, the 
 SDL::RWOps-object will be freed by SDL_ttf library. Don't do this, perl will free this object for you.

 
 
@@ -405,7 +405,7 @@ overlapping glyphs or abnormal spacing within words.

Get the maximum pixel height of all glyphs of the loaded font. You may use this height for rendering text as close together vertically as possible, though adding at least one pixel height to it will space it so they can't touch. Remember that SDL_ttf doesn't handle multiline -printing, so you are responsible for line spacing, see the SDL::TTF::font_line_skip as well.

+printing, so you are responsible for line spacing, see the SDL::TTF::font_line_skip as well.

font_ascent

@@ -447,7 +447,7 @@ of the rectangle used when blitting the glyph on the screen.

 my $font_line_skip = SDL::TTF::font_line_skip($font);
-

Get the recommended pixel height of a rendered line of text of the loaded font. This is usually larger than the SDL::TTF::font_height of the +

Get the recommended pixel height of a rendered line of text of the loaded font. This is usually larger than the SDL::TTF::font_height of the font.

@@ -545,7 +545,7 @@ in the font is the same width, thus you can assume that a rendered string's widt

Calculate the resulting surface size of the LATIN1 encoded text rendered using $font. No actual rendering is done, however correct kerning -is done to get the actual width. The height returned is the same as you can get using SDL::TTF::font_height.

+is done to get the actual width. The height returned is the same as you can get using SDL::TTF::font_height.

size_utf8

@@ -554,7 +554,7 @@ is done to get the actual width. The height returned is the same as you can get

Calculate the resulting surface size of the UTF8 encoded text rendered using $font. No actual rendering is done, however correct kerning is -done to get the actual width. The height returned in h is the same as you can get using SDL::TTF::font_height.

+done to get the actual width. The height returned in h is the same as you can get using SDL::TTF::font_height.

Note that the first example uses the same text as in the LATIN1 example, that is because plain ASCII is UTF8 compatible.

Examples:

 ($width, $height) = @{ SDL::TTF::size_utf8($font, 'Hallo World!') }; # plain text, if your script is in utf8 or ansi-format
@@ -578,7 +578,7 @@ done to get the actual width. The height returned in h is the same as you can ge

Calculate the resulting surface size of the UNICODE encoded text rendered using $font. No actual rendering is done, however correct kerning -is done to get the actual width. The height returned in h is the same as you can get using SDL::TTF::font_height.

+is done to get the actual width. The height returned in h is the same as you can get using SDL::TTF::font_height.

$text has to be:

UTF16BE without BOM
@@ -611,7 +611,7 @@ is done to get the actual width. The height returned in h is the same as you can

Render the unicode encoded char onto a new surface, using the Solid mode. After that you can blit this surface to your display-surface.

-

Note: The unicode char has to be passed exactly like for SDL::TTF::size_unicode.

+

Note: The unicode char has to be passed exactly like for SDL::TTF::size_unicode.

Note: See space-character bug. You have to upgrade libfreetype2 to at least version 2.3.5

@@ -660,7 +660,7 @@ version 2.3.5

Render the unicode encoded text onto a new surface, using the Solid mode. After that you can blit this surface to your display-surface.

-

Note: The unicode test has to be passed exactly like for SDL::TTF::size_unicode.

+

Note: The unicode test has to be passed exactly like for SDL::TTF::size_unicode.

Note: See space-character bug. You have to upgrade libfreetype2 to at least version 2.3.5

@@ -676,7 +676,7 @@ version 2.3.5

Render the unicode encoded char onto a new surface. The surface is filled with $background_color. After that you can blit this surface to your display-surface.

-

Note: The unicode char has to be passed exactly like for SDL::TTF::size_unicode.

+

Note: The unicode char has to be passed exactly like for SDL::TTF::size_unicode.

render_text_shaded

@@ -727,7 +727,7 @@ your display-surface.

Render the unicode encoded text onto a new surface. The surface is filled with $background_color. After that you can blit this surface to your display-surface.

-

Note: The unicode text has to be passed exactly like for SDL::TTF::size_unicode.

+

Note: The unicode text has to be passed exactly like for SDL::TTF::size_unicode.

Blended

@@ -740,7 +740,7 @@ your display-surface.

Render the unicode encoded char onto a new surface. After that you can blit this surface to your display-surface.

-

Note: The unicode char has to be passed exactly like for SDL::TTF::size_unicode.

+

Note: The unicode char has to be passed exactly like for SDL::TTF::size_unicode.

render_text_blended

@@ -786,12 +786,12 @@ your display-surface.

Render the unicode encoded text onto a new surface. After that you can blit this surface to your display-surface.

-

Note: The unicode char has to be passed exactly like for SDL::TTF::size_unicode.

+

Note: The unicode char has to be passed exactly like for SDL::TTF::size_unicode.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

SEE ALSO

Top

diff --git a/pages/SDL-Time.html-inc b/pages/SDL-Time.html-inc index c31a184..35768eb 100644 --- a/pages/SDL-Time.html-inc +++ b/pages/SDL-Time.html-inc @@ -88,7 +88,7 @@ This ID is the return value of the SDL::Time::add_timer function.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-Tutorial-Animation.html-inc b/pages/SDL-Tutorial-Animation.html-inc index df5b3fb..9cab64b 100644 --- a/pages/SDL-Tutorial-Animation.html-inc +++ b/pages/SDL-Tutorial-Animation.html-inc @@ -59,7 +59,7 @@ 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 SDLx::App object $app, a SDL::Rect $rect, and +every frame. Given a SDLx::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 mapped color $bg_color, representing the background color. The colors need to be mapped @@ -193,7 +193,7 @@ them soon.

chromatic, <chromatic@wgz.org>

Written for and maintained by the Perl SDL project, http://sdl.perl.org/. -See AUTHORS in SDL.

+See /SDL.html#AUTHORS.

BUGS

Top

diff --git a/pages/SDL-Tutorial-LunarLander.html-inc b/pages/SDL-Tutorial-LunarLander.html-inc index 5904c46..9fe2b47 100644 --- a/pages/SDL-Tutorial-LunarLander.html-inc +++ b/pages/SDL-Tutorial-LunarLander.html-inc @@ -432,7 +432,7 @@ of the moon.

COPYRIGHT & LICENSE

Top

Copyright 2009 Nelson Ferraz, all rights reserved.

-

Updated and maintained by the SDL Perl project. See AUTHORS in SDL.

+

Updated and maintained by the SDL Perl project. See /SDL.html#AUTHORS.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

diff --git a/pages/SDL-Tutorial.html-inc b/pages/SDL-Tutorial.html-inc index fdcc078..a415ea4 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 -SDLx::App provides.

+SDLx::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 @@ -120,7 +120,7 @@ them there, then update the $app.

AUTHORS

Top

chromatic, <chromatic@wgz.org>.

-

Written for and maintained by the Perl SDL project, http://sdl.perl.org/. See AUTHORS in SDL for details.

+

Written for and maintained by the Perl SDL project, http://sdl.perl.org/. See /SDL.html#AUTHORS for details.

COPYRIGHT

Top

diff --git a/pages/SDL-Version.html-inc b/pages/SDL-Version.html-inc index ca11ce3..c75aab7 100644 --- a/pages/SDL-Version.html-inc +++ b/pages/SDL-Version.html-inc @@ -74,7 +74,7 @@ The SDL_Perl version is in $SDL::VERSION.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDL-Video.html-inc b/pages/SDL-Video.html-inc index ccf233c..ed3df79 100644 --- a/pages/SDL-Video.html-inc +++ b/pages/SDL-Video.html-inc @@ -615,7 +615,7 @@ filled.

If you call this on the video surface (ie: the value of SDL::Video::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.

SDL::Video::fill_rect returns 0 on success or -1 on error.

-

for an example see SYNOPSIS.

+

for an example see http://search.cpan.org/perldoc?.

Surface Locking and Unlocking

Top

@@ -1443,7 +1443,7 @@ is experimental).

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

SEE ALSO

Top

diff --git a/pages/SDL-VideoInfo.html-inc b/pages/SDL-VideoInfo.html-inc index 0e52a46..7f2fe9b 100644 --- a/pages/SDL-VideoInfo.html-inc +++ b/pages/SDL-VideoInfo.html-inc @@ -174,7 +174,7 @@

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDLx-App.html-inc b/pages/SDLx-App.html-inc index 8db7209..a8127cf 100644 --- a/pages/SDLx-App.html-inc +++ b/pages/SDLx-App.html-inc @@ -70,12 +70,12 @@ } -

An alternative to the manual Event processing is through the SDLx::Controller module. SDLx::App is a Controller so see the CALLBACKS section below.

+

An alternative to the manual Event processing is through the SDLx::Controller module. SDLx::App is a Controller so see the CALLBACKS section below.

DESCRIPTION

Top

-

SDLx::App controls the root window of the of your SDL based application. +

SDLx::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.

@@ -213,12 +213,12 @@ always returns the current value of the given attribute, or Carp::confesss on fa $app->run(); -

see SDLx::Controller for more details.

+

see SDLx::Controller for more details.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

SEE ALSO

Top

diff --git a/pages/SDLx-Controller-Interface.html-inc b/pages/SDLx-Controller-Interface.html-inc index 538df77..22ea183 100644 --- a/pages/SDLx-Controller-Interface.html-inc +++ b/pages/SDLx-Controller-Interface.html-inc @@ -171,7 +171,7 @@ callback.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

\ No newline at end of file diff --git a/pages/SDLx-Controller-State.html-inc b/pages/SDLx-Controller-State.html-inc new file mode 100644 index 0000000..8e64553 --- /dev/null +++ b/pages/SDLx-Controller-State.html-inc @@ -0,0 +1,117 @@ +
+ +

Index

+ +
+ + +

NAME

Top

+
+

SDLx::Controller::State - the state of a SDLx::Controller::Interface

+ +
+

CATEGORY

Top

+
+

Extension, Controller

+ +
+

SYNOPSIS

Top

+
+
  # you'll most likely get a State object from a SDLx::Controller::Interface
+  # object. Just in case, here's how you would construct one by hand:
+  my $state1 = SDLx::Controller::State->new;
+  my $state2 = SDLx::Controller::State->new( $x, $y, $v_x, $v_y, $rotation, $ang_v );
+
+  # attributes are just simple accessors:
+  $state->x(10);
+  $state->x;      # 10
+
+  # same goes for the rest:
+  $state->y;
+  $state->ang_v;
+
+  # etc.
+
+
+ +
+

DESCRIPTION

Top

+
+

A state object is a simple container for any given state inside a running +SDLx::Controller::Interface instance.

+ +
+

METHODS

Top

+
+ +
+

new()

+
+ +
+

new( $x, $y, $v_x, $v_y, $rotation, $ang_v )

+
+

Creates a new state container object. Can optionally set the initial value +of all its attributes (see below).

+ +
+

ACCESSORS

Top

+
+ +
+

x

+
+

Accessor to get/set the x value, usually used to position the item or check for collisions.

+ +
+

y

+
+

Accessor to get/set the y value, usually used to position the item or check for collisions.

+ +
+

v_x

+
+

Accessor to get/set the x velocity of the instance, for moving objects dynamically.

+ +
+

v_y

+
+

Accessor to get/set the y velocity of the instance, for moving objects dynamically.

+ +
+

rotation

+
+

Accessor to get/set the rotation of the object, in degrees (0..360).

+ +
+

ang_v

+
+

Accessor to get/set the angular velocity, for rotating objects dynamically.

+ +
+

AUTHORS

+
+

See /SDL.html#AUTHORS

+ +
+
\ No newline at end of file diff --git a/pages/SDLx-Controller.html-inc b/pages/SDLx-Controller.html-inc index 3851fa2..7b2256a 100644 --- a/pages/SDLx-Controller.html-inc +++ b/pages/SDLx-Controller.html-inc @@ -278,7 +278,7 @@ The first coderef in the handler list that this matches will be removed.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

ACKNOWLEGDEMENTS

diff --git a/pages/SDLx-Layer.html-inc b/pages/SDLx-Layer.html-inc index a6ec35c..d5b2c57 100644 --- a/pages/SDLx-Layer.html-inc +++ b/pages/SDLx-Layer.html-inc @@ -238,7 +238,7 @@ If you omit $x and $y the layer obtains them via SDL::

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

COPYRIGHT

Top

diff --git a/pages/SDLx-LayerManager.html-inc b/pages/SDLx-LayerManager.html-inc index 648d91c..54de0e3 100644 --- a/pages/SDLx-LayerManager.html-inc +++ b/pages/SDLx-LayerManager.html-inc @@ -209,7 +209,7 @@ The other layers are positioned relative to the backmost layer just like before.

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

COPYRIGHT

Top

diff --git a/pages/SDLx-Rect.html-inc b/pages/SDLx-Rect.html-inc index 4bee345..8ccb080 100644 --- a/pages/SDLx-Rect.html-inc +++ b/pages/SDLx-Rect.html-inc @@ -285,7 +285,7 @@

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

ACKNOWLEDGEMENTS

Top

diff --git a/pages/SDLx-SFont.html-inc b/pages/SDLx-SFont.html-inc index 43f3a4a..5d5d645 100644 --- a/pages/SDLx-SFont.html-inc +++ b/pages/SDLx-SFont.html-inc @@ -80,7 +80,7 @@

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

COPYRIGHT

Top

diff --git a/pages/SDLx-Sound.html-inc b/pages/SDLx-Sound.html-inc index bfe5eef..e45afbd 100644 --- a/pages/SDLx-Sound.html-inc +++ b/pages/SDLx-Sound.html-inc @@ -157,7 +157,7 @@

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

COPYRIGHT & LICENSE

Top

diff --git a/pages/SDLx-Sprite-Animated.html-inc b/pages/SDLx-Sprite-Animated.html-inc index 5ad93de..6b18355 100644 --- a/pages/SDLx-Sprite-Animated.html-inc +++ b/pages/SDLx-Sprite-Animated.html-inc @@ -139,7 +139,7 @@ If you care, please join the discussion on the #sdl IRC channel in

ATTRIBUTES AND METHODS

Top

-

SDLx::Sprite::Animated is a subclass of SDLx::Sprite, inheriting +

SDLx::Sprite::Animated is a subclass of SDLx::Sprite, inheriting all its attributes and methods. Please refer to that module's documentation for information on those.

The one difference in behavior is that, while a standard SDLx::Sprite uses @@ -342,7 +342,7 @@ automatically for you every time ->draw() is called

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

SEE ALSO

Top

diff --git a/pages/SDLx-Sprite.html-inc b/pages/SDLx-Sprite.html-inc index 8c7bee8..d58c471 100644 --- a/pages/SDLx-Sprite.html-inc +++ b/pages/SDLx-Sprite.html-inc @@ -196,7 +196,7 @@ library has support for GFX (see SDL::Video::get_video_mode prior to this.

+

MUST CALL SDL::Video::get_video_mode prior to this.

Uses the provided SDL::Color object (or an array reference with red, green and blue values) as the color to be turned into transparent (see 'alpha' below).

@@ -329,7 +329,7 @@ destination rect (position) from rect().

AUTHORS

Top

-

See AUTHORS in SDL.

+

See /SDL.html#AUTHORS.

SEE ALSO

Top

diff --git a/pages/SDLx-Surface.html-inc b/pages/SDLx-Surface.html-inc index 2c71ab2..8628412 100644 --- a/pages/SDLx-Surface.html-inc +++ b/pages/SDLx-Surface.html-inc @@ -16,10 +16,7 @@ - -
  • EXTENSIONS -