From: kthakore Shuts down audio processing and closes the audio device. See AUTHORS in SDL.
@@ -326,4 +327,9 @@ function is not running. Do not call this from the callback function or you will
AUTHORS
+
@@ -108,9 +108,9 @@ see SDL::AudioSpec
.
Final audio size is len*len_ratio
To be documented.
+See AUTHORS in SDL.
+ + + + + +See AUTHORS in SDL.
+ +See AUTHORS in SDL.
+ +See AUTHORS in SDL.
+ +See AUTHORS in SDL.
+ + + + + +See AUTHORS in SDL.
+ + + + + +See AUTHORS in SDL.
+ + + + + +Sending textures to Perl OpenGL. SDL::Cookbook::POGL
+See AUTHORS in SDL.
+ +The hotspot is offset by 4 pixels because a crosshair clicks from the center instead of the top left.
-David J. Goehrig, Tobias Leich, Blaizer
+See AUTHORS in SDL.
+ + + +See AUTHORS in SDL.
+ +Note: The macro SDL_QuitRequested will return non-zero if a quit event is pending
-See AUTHORS in SDL.
See AUTHORS in SDL.
See AUTHORS in SDL.
+ +Returns the rate
.
See AUTHORS in SDL.
+ +Generate a delay to accomodate currently set framerate. Call once in thegraphics/rendering loop. If the computer cannot keep up with the rate (i.e.drawing too slow), the delay is zero and the delay interpolation is reset.
- - - + +See AUTHORS in SDL.
void gfx_image_restore_stack() CODE: - SDL_imageFilterRestoreStack(); -
+ SDL_imageFilterRestoreStack(); + + + + + + +See AUTHORS in SDL.
Tobias Leich [FROGGS] -
+See AUTHORS in SDL.
See AUTHORS in SDL.
+ + + + + +SDL, SDL::Surface, SDL::Video, SDL::RWOps
+See AUTHORS in SDL.
+ +See AUTHORS in SDL.
+ +Note: Never pass -1
to this function!
See AUTHORS in SDL.
+ +See AUTHORS in SDL.
+ +Retuns 0
.
See AUTHORS in SDL.
+ +Per-sample volume, 0-128 (normally MIX_MAX_VOLUME
after loading)
See AUTHORS in SDL.
+ +This structure is not directly usable. SDL Perl bindings handle the construction and destruction for you.
+See AUTHORS in SDL.
+ +Returns 1
if the music is playing sound, otherwise 0
. It does'nt check if the music is paused.
If you pass -1
as $new_volume
you just get its volume without changing it.
Tobias Leich [FROGGS]
- -See AUTHORS in SDL.
+ +SDL_QUERY<
+AUTHORS
+
+See AUTHORS in SDL.
+
+
\ No newline at end of file
diff --git a/pages/SDL-MultiThread.html-inc b/pages/SDL-MultiThread.html-inc
index 3505b25..bf5aac7 100644
--- a/pages/SDL-MultiThread.html-inc
+++ b/pages/SDL-MultiThread.html-inc
@@ -6,7 +6,8 @@
-SYNOPSIS
+ SYNOPSIS
+AUTHORS
@@ -25,9 +26,10 @@
This module is not an object.
-
-
-
+
+AUTHORS
+
+See AUTHORS in SDL.
\ No newline at end of file
diff --git a/pages/SDL-Overlay.html-inc b/pages/SDL-Overlay.html-inc
index c8e66be..4d4f2f5 100644
--- a/pages/SDL-Overlay.html-inc
+++ b/pages/SDL-Overlay.html-inc
@@ -18,10 +18,11 @@
planes
pitches
pixels
-hw_overlay
-
+hw_overlay
+AUTHORS
+
@@ -128,9 +129,10 @@ SDL_YVYU_OVERLAY 0x55595659 /* Packed mode: Y0+V0+Y1+U0 */
This will be set to 1 if the overlay is hardware accelerated.
-
-
-
+
+AUTHORS
+
+See AUTHORS in SDL.
\ No newline at end of file
diff --git a/pages/SDL-Palette.html-inc b/pages/SDL-Palette.html-inc
index a420ef1..f0fc7c9 100644
--- a/pages/SDL-Palette.html-inc
+++ b/pages/SDL-Palette.html-inc
@@ -11,7 +11,8 @@
color_index ( index )
-SEE ALSO
+ SEE ALSO
+AUTHORS
@@ -57,4 +58,9 @@ values of a SDL::Surface
's palette can be set with the SDL::V
+AUTHORS
+
+See AUTHORS in SDL.
+
+
\ No newline at end of file
diff --git a/pages/SDL-Pango-Context.html-inc b/pages/SDL-Pango-Context.html-inc
index 06127f5..db375a4 100644
--- a/pages/SDL-Pango-Context.html-inc
+++ b/pages/SDL-Pango-Context.html-inc
@@ -8,7 +8,7 @@
-AUTHOR
+AUTHORS
SEE ALSO
@@ -36,9 +36,9 @@
Creates a new SDL::Pango context object. See SDL::Pango.
-AUTHOR
-
-Tobias Leich [FROGGS]
+AUTHORS
+
+See AUTHORS in SDL.
SEE ALSO
diff --git a/pages/SDL-Pango.html-inc b/pages/SDL-Pango.html-inc
index 54b8861..0aaf1be 100644
--- a/pages/SDL-Pango.html-inc
+++ b/pages/SDL-Pango.html-inc
@@ -23,7 +23,7 @@
create_surface_draw
-AUTHOR
+AUTHORS
SEE ALSO
@@ -273,9 +273,9 @@ background.
Creates a new surface and draws the text/markup. You can specify the attributes of the surfaces using SDL::Pango::set_surface_create_args.
-AUTHOR
-
-Tobias Leich [FROGGS]
+AUTHORS
+
+See AUTHORS in SDL.
SEE ALSO
diff --git a/pages/SDL-PixelFormat.html-inc b/pages/SDL-PixelFormat.html-inc
index 1e61b9f..55cfb88 100644
--- a/pages/SDL-PixelFormat.html-inc
+++ b/pages/SDL-PixelFormat.html-inc
@@ -19,7 +19,8 @@
alpha
-SEE ALSO
+ SEE ALSO
+AUTHORS
@@ -145,4 +146,9 @@
+AUTHORS
+
+See AUTHORS in SDL.
+
+
\ No newline at end of file
diff --git a/pages/SDL-RWOps.html-inc b/pages/SDL-RWOps.html-inc
index b60eec1..8c9447e 100644
--- a/pages/SDL-RWOps.html-inc
+++ b/pages/SDL-RWOps.html-inc
@@ -16,10 +16,11 @@
rw_tell(ctx)
rw_read(ctx,ptr,size,n)
rw_write(ctx,ptr,size,n)
-rw_close(ctx)
-
+rw_close(ctx)
+AUTHORS
+
@@ -200,8 +201,10 @@ If it couldn't write that exact number of blocks, or the write didn't work at al
SDL::rw_close calls the close function in an SDL::RWOps structure. It only takes one parameter, an SDL::RWOps structure.
Returns 0 on success, -1 on error.
-
-
+
+AUTHORS
+
+See AUTHORS in SDL.
diff --git a/pages/SDL-Rect.html-inc b/pages/SDL-Rect.html-inc
index d425df0..1a98ec3 100644
--- a/pages/SDL-Rect.html-inc
+++ b/pages/SDL-Rect.html-inc
@@ -16,7 +16,8 @@
h
-SEE ALSO
+ SEE ALSO
+AUTHORS
@@ -107,4 +108,9 @@ if not, it returns the h component of the rectangle.
+AUTHORS
+
+See AUTHORS in SDL.
+
+
\ No newline at end of file
diff --git a/pages/SDL-Surface.html-inc b/pages/SDL-Surface.html-inc
index 6fe35f3..8cd7397 100644
--- a/pages/SDL-Surface.html-inc
+++ b/pages/SDL-Surface.html-inc
@@ -22,7 +22,8 @@
get_pixels_ptr
-SEE ALSO
+ SEE ALSO
+AUTHORS
@@ -186,4 +187,9 @@ The pixel value must fit the pixel format of the surface.
SDL, SDL::PixelFormat, SDL::Video, SDL::Rect
+AUTHORS
+
+See AUTHORS in SDL.
+
+
\ No newline at end of file
diff --git a/pages/SDL-TTF-Font.html-inc b/pages/SDL-TTF-Font.html-inc
index ed5eccc..c36da90 100644
--- a/pages/SDL-TTF-Font.html-inc
+++ b/pages/SDL-TTF-Font.html-inc
@@ -6,7 +6,7 @@
CATEGORY
METHODS
CONSTRUCTOR
-AUTHOR
+AUTHORS
SEE ALSO
@@ -44,9 +44,9 @@ You can specify the face index of a font file containing multiple faces.
-AUTHOR
-
-Tobias Leich [FROGGS]
+AUTHORS
+
+See AUTHORS in SDL.
SEE ALSO
diff --git a/pages/SDL-TTF.html-inc b/pages/SDL-TTF.html-inc
index 29189a2..2602f6d 100644
--- a/pages/SDL-TTF.html-inc
+++ b/pages/SDL-TTF.html-inc
@@ -93,7 +93,7 @@
-AUTHOR
+AUTHORS
SEE ALSO
@@ -114,9 +114,6 @@
The constants are exported by default. You can avoid this by doing:
use SDL::TTF ();
-
-
-
and access them directly:
SDL::TTF::TTF_HINTING_NORMAL;
@@ -627,22 +624,22 @@ is done to get the actual width. The height returned in h is the same as you can
Note: See space-character bug. You have to upgrade libfreetype2 to at least
version 2.3.5
Example:
- use SDL;
- use SDL::Rect;
- use SDL::Video;
- use SDL::Color;
- use SDL::TTF;
- use SDL::TTF::Font;
+ use SDL;
+ use SDL::Rect;
+ use SDL::Video;
+ use SDL::Color;
+ use SDL::TTF;
+ use SDL::TTF::Font;
- SDL::init(SDL_INIT_VIDEO);
- SDL::TTF::init();
- my $display = SDL::Video::set_video_mode(640, 480, 32, SDL_SWSURFACE);
- my $font = SDL::TTF::open_font('test/data/aircut3.ttf', '24');
- die 'Coudnt make font '. SDL::get_error if !$font;
- my $surface = SDL::TTF::render_text_solid($font, 'Hallo!', SDL::Color->new(0xFF,0xFF,0xFF));
- SDL::Video::blit_surface($surface, SDL::Rect->new(0, 0, 640, 480), $display, SDL::Rect->new(10, 10, 640, 480));
- SDL::Video::update_rect($display, 0, 0, 0, 0);
- SDL::delay(5000);
+ SDL::init(SDL_INIT_VIDEO);
+ SDL::TTF::init();
+ my $display = SDL::Video::set_video_mode(640, 480, 32, SDL_SWSURFACE);
+ my $font = SDL::TTF::open_font('test/data/aircut3.ttf', '24');
+ die 'Coudnt make font '. SDL::get_error if !$font;
+ my $surface = SDL::TTF::render_text_solid($font, 'Hallo!', SDL::Color->new(0xFF,0xFF,0xFF));
+ SDL::Video::blit_surface($surface, SDL::Rect->new(0, 0, 640, 480), $display, SDL::Rect->new(10, 10, 640, 480));
+ SDL::Video::update_rect($display, 0, 0, 0, 0);
+ SDL::delay(5000);
@@ -792,9 +789,9 @@ your display-surface.
Note: The unicode char has to be passed exactly like for SDL::TTF::size_unicode.
-AUTHOR
-
-Tobias Leich [FROGGS]
+AUTHORS
+
+See AUTHORS in SDL.
SEE ALSO
diff --git a/pages/SDL-Time.html-inc b/pages/SDL-Time.html-inc
index 4fc5489..c31a184 100644
--- a/pages/SDL-Time.html-inc
+++ b/pages/SDL-Time.html-inc
@@ -7,10 +7,11 @@
SYNOPSIS
METHODS
+AUTHORS
+
@@ -85,4 +86,9 @@ This ID is the return value of the SDL::Time::add_timer
function.
SDL::Time::remove_timer
returns 0
on success or -1
on error.
+AUTHORS
+
+See AUTHORS in SDL.
+
+
\ No newline at end of file
diff --git a/pages/SDL-Tutorial-Animation.html-inc b/pages/SDL-Tutorial-Animation.html-inc
index 66647e9..2f15476 100644
--- a/pages/SDL-Tutorial-Animation.html-inc
+++ b/pages/SDL-Tutorial-Animation.html-inc
@@ -192,8 +192,8 @@ them soon.
AUTHOR
chromatic, <chromatic@wgz.org>
-updated by kthakore, <kthakore@cpan.org>
-Written for and maintained by the Perl SDL project, http://sdl.perl.org/.
+Written for and maintained by the Perl SDL project, http://sdl.perl.org/.
+See AUTHORS in SDL.
BUGS
diff --git a/pages/SDL-Tutorial-LunarLander.html-inc b/pages/SDL-Tutorial-LunarLander.html-inc
index 182132c..5904c46 100644
--- a/pages/SDL-Tutorial-LunarLander.html-inc
+++ b/pages/SDL-Tutorial-LunarLander.html-inc
@@ -432,6 +432,7 @@ of the moon.
COPYRIGHT & LICENSE
Copyright 2009 Nelson Ferraz, all rights reserved.
+Updated and maintained by the SDL Perl project. See AUTHORS in SDL.
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 444f720..fdcc078 100644
--- a/pages/SDL-Tutorial.html-inc
+++ b/pages/SDL-Tutorial.html-inc
@@ -14,7 +14,7 @@
SEE ALSO
-AUTHOR
+AUTHORS
COPYRIGHT
@@ -117,12 +117,10 @@ them there, then update
the $app
.
-AUTHOR
-
+AUTHORS
+
chromatic, <chromatic@wgz.org>.
-nelson ferraz, <nferraz@cpan.org>.
-Updated by kthakore and garu.
-Written for and maintained by the Perl SDL project, http://sdl.perl.org/.
+Written for and maintained by the Perl SDL project, http://sdl.perl.org/. See AUTHORS in SDL for details.
COPYRIGHT
diff --git a/pages/SDL-Version.html-inc b/pages/SDL-Version.html-inc
index 512c582..ca11ce3 100644
--- a/pages/SDL-Version.html-inc
+++ b/pages/SDL-Version.html-inc
@@ -9,10 +9,11 @@
METHODS
+AUTHORS
+
@@ -71,4 +72,9 @@ The SDL_Perl version is in $SDL::VERSION
.
Returns the patch version number.
+AUTHORS
+
+See AUTHORS in SDL.
+
+
\ No newline at end of file
diff --git a/pages/SDL-Video.html-inc b/pages/SDL-Video.html-inc
index 7151631..0bddd09 100644
--- a/pages/SDL-Video.html-inc
+++ b/pages/SDL-Video.html-inc
@@ -76,7 +76,7 @@
wm_toggle_fullscreen
-AUTHOR
+AUTHORS
SEE ALSO
- Category Objects
@@ -1441,9 +1441,9 @@ the application will receive a SDL_APPACTIVE
loss event (see Applic
is experimental).
-AUTHOR
-
-magnet, Tobias Leich (FROGGS)
+AUTHORS
+
+See AUTHORS in SDL.
SEE ALSO
diff --git a/pages/SDL-VideoInfo.html-inc b/pages/SDL-VideoInfo.html-inc
index c8ba508..0e52a46 100644
--- a/pages/SDL-VideoInfo.html-inc
+++ b/pages/SDL-VideoInfo.html-inc
@@ -23,7 +23,8 @@
- current_w, current_h
-- SEE ALSO
+
- SEE ALSO
+- AUTHORS
@@ -171,4 +172,9 @@
+AUTHORS
+
+See AUTHORS in SDL.
+
+
\ No newline at end of file
diff --git a/pages/SDL.html-inc b/pages/SDL.html-inc
index ee6419f..c5147c2 100644
--- a/pages/SDL.html-inc
+++ b/pages/SDL.html-inc
@@ -22,7 +22,14 @@
- delay
-AUTHOR
+ AUTHORS
+
+
+COPYRIGHT & LICENSE
+DISCLAIMER OF WARRANTY
@@ -212,9 +219,92 @@ The actual delay may be longer than specified depending on the underlying OS.
-AUTHOR
-
-magnet, kthakore, Blaizer
+AUTHORS
+
+
+
+Project Founder
+
+David J. Goehrig
+
+
+Current Maintainers
+
+Kartik Thakore (kthakore)
+Tobias Leich (FROGGS)
+
+
+Core Developers and Contributors
+
+The following people have dedicated blood sweat and tears to making SDL Perl possible.
+See the impact graph on our github repository.
+Andy Bakun <sdlperl@thwartedefforts.org>
+Benedikt Meurer <bmeurer@fwdn.de>
+Blaise Roth (Blaizer) <blaiseroth@gmail.com>
+Breno G. de Oliveira (garu)
+Brian Cassidy (bricas)
+chromatic <chromatic@wgz.org>
+Daniel Mantovani <daniel.oliveira.mantovani@gmail.com>
+Daniel Ruoso http://daniel.ruoso.com/
+David J. Goehrig <dgoehrig@cpan.org>
+Dustin Mays (dorkfish) <dork.fish.wat.@gmail.com>
+Fedora
+Gabor Szabo (szabgab) <szabgab@gmail.com>
+Guillaue Cottenceau (gc) <gc@mandrakesoft.com>
+Heikki Meht&195;nen (hmehta/hejki) <heikki@mehtanen.fi>
+James King
+James Wright <jwright@cpan.org>
+Jeffrey T. Palmer (jtpalmer) <jeffrey.t.palmer@gmail.com>
+Kartik Thakore (kthakore) <thakore.kartik@gmail.com>
+KatrinaTheLamia
+kmx <kmx@cpan.org>
+Luke
+Michael Lamertz <mike@perl-ronin.de>
+morgoth.666
+Peter BARABAS <z0d@artifact.hu>
+Russell Valentine <russ_allegro@yahoo.com>
+Ryan Hanlon
+Stephane Desneux <sdx@desneux.com>
+Tels <http://www.bloodgate.com>
+Thomas Tongue
+Tobias Leich (FROGGS)
+Tony C
+Yuval Kogman (nothingmuch)
+Wayne Keenan <wayne@metaverse.fsnet.co.uk>
+If you would like to contribute to SDL Perl, please post a message on the mailing list:
+sdl-devel@perl.org
+And request access to the github repository. Or drop us a line on #sdl over at irc.perl.org
+
+
+COPYRIGHT & LICENSE
+
+Copyright 2002-2010 SDL Authors as listed above, all rights reserved.
+This program is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.
+
+
+DISCLAIMER OF WARRANTY
+
+BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
+EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
+ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
+YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
+NECESSARY SERVICING, REPAIR, OR CORRECTION.
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
+LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
+OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
+THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
\ No newline at end of file
diff --git a/pages/SDLx-App.html-inc b/pages/SDLx-App.html-inc
index 72ae752..ca61336 100644
--- a/pages/SDLx-App.html-inc
+++ b/pages/SDLx-App.html-inc
@@ -24,7 +24,7 @@
attribute( $attr, $value )
-AUTHOR
+AUTHORS
SEE ALSO
@@ -87,14 +87,22 @@ manager oriented functions.
and initializes some of the window manager properties.
SDLx::App::new
takes a series of named parameters:
- - * title
- - * icon_title
- - * icon
- - * width
- - * height
- - * depth
- - * flags
- - * resizeable
+ - * title
+the window title. Defaults to the file name. Shorter alias: 't'
+ - * icon_title
+the icon title. Defaults to file name. Shortcut: 'it'
+ - * icon
+the icon itself. Defaults to none. Shortcut: 'i'
+ - * width
+Window width, in pixels. Defaults to 800. Shortcut: 'w'
+ - * height
+Window height, in pixels. Defaults to 600. Shortcut: 'h'
+ - * depth
+Screen depth. Defaults to 16. Shortcut: 'd'.
+ - * flags
+Any flags you want to pass to SDL::Video upon initialization. Defaults to SDL_ANYFORMAT. Flags should be or'ed together if you're passing more than one (flags => FOO|BAR). Shortcut: 'f'.
+ - * resizeable
+Set this to a true value to make the window resizeable by the user. Default is off.
@@ -204,10 +212,9 @@ in addition to the attribute selector, the value will be set. SDL:::App::a
always returns the current value of the given attribute, or croaks on failure.
-AUTHOR
-
-David J. Goehrig
-Kartik Thakore
+AUTHORS
+
+See AUTHORS in SDL.
SEE ALSO
diff --git a/pages/SDLx-Controller.html-inc b/pages/SDLx-Controller.html-inc
index 2fb7f70..ecfccd0 100644
--- a/pages/SDLx-Controller.html-inc
+++ b/pages/SDLx-Controller.html-inc
@@ -189,15 +189,10 @@ The first coderef in the handler list that this matches will be removed.
Quick access to removing all handlers at once.
-
-
-
-
AUTHORS
-Kartik Thakore
-Breno G. de Oliveira
+See AUTHORS in SDL.
ACKNOWLEGDEMENTS
diff --git a/pages/SDLx-Layer.html-inc b/pages/SDLx-Layer.html-inc
index 556b041..a6ec35c 100644
--- a/pages/SDLx-Layer.html-inc
+++ b/pages/SDLx-Layer.html-inc
@@ -14,8 +14,8 @@
w
h
surface
-clip
pos
+clip
data
ahead
behind
@@ -26,7 +26,7 @@
BUGS
SUPPORT
-AUTHOR
+AUTHORS
COPYRIGHT
SEE ALSO
@@ -35,7 +35,7 @@
NAME
-SDLx::Layer - Extension ...
+SDLx::Layer - Storage object for surface and position information
CATEGORY
@@ -48,15 +48,30 @@
use SDLx::Layer;
use SDLx::LayerManager;
-
+ use SDL::Image;
+ use SDL::Surface;
+ use SDL::Video;
-
-DESCRIPTION
-
+ # creating layers
+ my $layer1 = SDLx::Layer->new( SDL::Image::load('image1.png'), {userdata => '7'} );
+ my $layer2 = SDLx::Layer->new( SDL::Image::load('image2.png'), 100, 200, {userdata => '42'} );
+
+ # creating the manager that holds the layers
+ my $layermanager = SDLx::LayerManager->new();
+ $layermanager->add( $layer1 );
+ $layermanager->add( $layer2 );
+ my $display = # create your video surface here
+ $layer1->foreground;
+ printf( "%s\n", $layer1->behind->[0]->data->{userdata} ); # prints 42
+
+
+DESCRIPTION
+
+A layer (see SDLx::Layer) is an SDL::Surface, the position of the surface on screen and some additional information, e.g. ingame states.
METHODS
@@ -65,62 +80,150 @@
new
+ my $layer = SDLx::Layer->new( $surface );
+ my $layer = SDLx::Layer->new( $surface, %data );
+ my $layer = SDLx::Layer->new( $surface, $pos_x, %data );
+ my $layer = SDLx::Layer->new( $surface, $pos_x, $pos_y, %data );
+ my $layer = SDLx::Layer->new( $surface, $pos_x, $pos_y, $clip_w, %data );
+ my $layer = SDLx::Layer->new( $surface, $pos_x, $pos_y, $clip_w, $clip_h, %data );
+
+
+This constructs the layer object. See how you can omit the position and dimension of the layer. The hash %data
is for your use only.
+The layer object just pass it through.
index
+ my $index = $layer->index;
+
+
+The method index
represents the z-index ot this layer within its layermanager.
x
+ my $x = $layer->x;
+
+
+This is a shortcut for $layer->pos->x.
y
+ my $y = $layer->y;
+
+
+This is a shortcut for $layer->pos->y.
w
+ my $w = $layer->w;
+
+
+This is a shortcut for $layer->clip->w.
h
+ my $h = $layer->h;
+
+
+This is a shortcut for $layer->pos->h.
surface
+ my $surface = $layer->surface;
+ my $surface = $layer->surface( $new_surface );
-
-clip
-
+
+Example:
+ SDL::Video::blit_surface( $layer->surface, $layer->clip, $destination_surface, $layer->pos );
+
+
+This method let you retrive the current or set a new surface.
pos
+ my $rect = $layer->pos;
+
+
+The method pos
returns an SDL::Rect object. The pos x and y are stored there.
+Example:
+ SDL::Video::blit_surface( $layer->surface, $layer->clip, $destination_surface, $layer->pos );
+
+
+
+
+clip
+
+ my $rect = $layer->clip;
+
+
+The method clip
returns an SDL::Rect object. The clip width and height are stored there.
+Example:
+ SDL::Video::blit_surface( $layer->surface, $layer->clip, $destination_surface, $layer->pos );
+
+
data
+ my %data = %{ $layer->data };
+ my %data = %{ $layer->data( %new_data) };
+
+
+This method returns the hash %data
. You can set %data
by passing a hash.
ahead
+ my @layers = $layer->ahead;
+
+
+This method returns all layers that are ahead of the given layer.
+Ahead means that a layer has a higher z-index and is blitted over the given layer.
+Note: This method doesn't check for transparency. This will change in future versions.
behind
+ my @layers = $layer->behind;
+
+
+This method returns all layers that are behind of the given layer.
+Behind means that a layer has a lower z-index and is blitted over the given layer.
+Note: This method doesn't check for transparency. This will change in future versions.
attach
+ $layer->attach( $x, $y );
+
+
+This function makes the given layer sticky to the mouse. If you move the mouse the layer will follow.
+The layermanager blits this layer at last, so they will appear on top of all layers.
+$x
and $y
should be set to the coords of the mouse, e.g. the coords of the mouse click.
+If you omit $x
and $y
the layer obtains them via SDL::Events::get_mouse_state.
+Note: The z-index is not changed for the given layer.
detach_xy
+ $layer->detach_xy( $x, $y );
+
+
+detach_xy
detaches the prevously attached layer to the given coords. The upper left corner of this layer will be at $x
and $y
.
foreground
+ $layer->foreground;
+
+
+This method moves the given layer to the foreground so that it is blittet on top of the other layers.
BUGS
@@ -133,15 +236,9 @@
#sdl irc.perl.org
-AUTHOR
-
- Tobias Leich
- CPAN ID: FROGGS
- ---
- froggs@cpan.org
- http://sdl.perl.org
-
-
+AUTHORS
+
+See AUTHORS in SDL.
COPYRIGHT
diff --git a/pages/SDLx-LayerManager.html-inc b/pages/SDLx-LayerManager.html-inc
index 5429bca..648d91c 100644
--- a/pages/SDLx-LayerManager.html-inc
+++ b/pages/SDLx-LayerManager.html-inc
@@ -24,7 +24,7 @@
BUGS
SUPPORT
-AUTHOR
+AUTHORS
COPYRIGHT
SEE ALSO
@@ -71,7 +71,9 @@
DESCRIPTION
-The LayerManager ...
+SDLx::LayerManager is a package to handle a bunch of layers. A layer (see SDLx::Layer) is an SDL::Surface, the position of the surface on screen and some additional information.
+The layermanager gives you the opportunity to obtain the layer at a given point on screen and get the layers that are ahead or behind a layer.
+You will even be able to attach one or more layers to the mouse, e.g. for simulation some drag&drop functionality.
METHODS
@@ -80,26 +82,52 @@
new
+ my $layermanager = SDLx::LayerManager->new();
+
+
+This creates your layermanager object. It doesn't take any parameters.
add
+ $layermanager->add( $layer );
+ $layermanager->add( SDLx::Layer->new( $surface, $x, $y, $options ) );
+
+
+Call add
to push an SDLx::Layer object to the layermanager.
layers
+ my @layers = @{ $layermanager->layers };
+ my $first_layer = $layermanager->layers->[0];
+
+
+The method layers
returns all layers that were added before.
layer
+ my $layer = $layermanager->layer( $index );
+
+
+To obtain only one layer at index $index
use this function. $index
ranges from 0
to lenght - 1
.
length
+ my $length = $layermanager->length();
+
+
+This method returns the count of the added layers.
blit
+ $layermanager->blit( $surface );
+
+
+This method blits all layers to the surface (e.g. your video surface).
by_position
@@ -107,30 +135,66 @@
my $layer = $layermanager->by_position( $x, $y );
+by_position
returns the SDLx::Layer
object at point $x $y
, which is not fully transparent at this pixel.
ahead
+ my @layers = @{ $layermanager->ahead( $index ) };
+
+
+This method returns all layers that are ahead of the given layer indicated by $index
.
+Ahead means that a layer has a higher z-index and is blitted over the given layer.
+Note: This method doesn't check for transparency. This will change in future versions.
behind
+ my @layers = @{ $layermanager->behind( $index ) };
+
+
+This method returns all layers that are behind of the given layer indicated by $index
.
+Behind means that a layer has a lower z-index and is blitted before the given layer.
+Note: This method doesn't check for transparency. This will change in future versions.
attach
+ $layermanager->attach( $layer, $x, $y );
+ $layermanager->attach( @layers, $x, $y );
+
+
+This function makes the given layer(s) sticky to the mouse. If you move the mouse the layer(s) will follow.
+The layermanager blits these layers at last, so they will appear on top of all layers.
+$x
and $y
should be set to the coords of the mouse, e.g. the coords of the mouse click.
+If you omit $x
and $y
the layermanager obtains them via SDL::Events::get_mouse_state.
+Note: The z-index is not changed for the given layers.
detach_xy
+ $layermanager->detach_xy( $x, $y );
+
+
+detach_xy
detaches the prevously attached layers to the given coords. The upper left corner of the backmost layer will be at $x
and $y
.
+The other layers are positioned relative to the backmost layer just like before.
detach_back
+ $layermanager->detach_back( );
+
+
+detach_back
detaches the prevously attached layers back to the position where they were attached.
foreground
+ $layermanager->foreground( $layer );
+ $layermanager->foreground( @layers );
+
+
+This method moves the given layer(s) to the foreground so that they are blittet on top of the other layers.
BUGS
@@ -143,15 +207,9 @@
#sdl irc.perl.org
-AUTHOR
-
- Tobias Leich
- CPAN ID: FROGGS
- ---
- froggs@cpan.org
- http://sdl.perl.org
-
-
+AUTHORS
+
+See AUTHORS in SDL.
COPYRIGHT
diff --git a/pages/SDLx-Rect.html-inc b/pages/SDLx-Rect.html-inc
index e3bedfa..4bee345 100644
--- a/pages/SDLx-Rect.html-inc
+++ b/pages/SDLx-Rect.html-inc
@@ -37,9 +37,9 @@
-AUTHOR
BUGS
SUPPORT
+AUTHORS
ACKNOWLEDGEMENTS
COPYRIGHT & LICENSE
SEE ALSO
@@ -266,11 +266,6 @@
-AUTHOR
-
-Breno G. de Oliveira, <garu at cpan.org>
-
-
BUGS
Please report any bugs or feature requests to the bug tracker. I will be notified, and then you'll automatically be notified of progress on your bug as we make changes.
@@ -285,20 +280,21 @@
You can find documentation for this module with the perldoc command.
perldoc SDLx::Rect
-
-
-
+AUTHORS
+
+See AUTHORS in SDL.
+
+
ACKNOWLEDGEMENTS
-Many thanks to all SDL_Perl contributors, and to the authors of pygame.rect, in which this particular module is heavily based.
+Many thanks to the authors of pygame.rect, in which this particular module is heavily based.
COPYRIGHT & LICENSE
-Copyright 2009 Breno G. de Oliveira, all rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
diff --git a/pages/SDLx-SFont.html-inc b/pages/SDLx-SFont.html-inc
index 6023db4..43f3a4a 100644
--- a/pages/SDLx-SFont.html-inc
+++ b/pages/SDLx-SFont.html-inc
@@ -9,7 +9,7 @@
USAGE
BUGS
SUPPORT
-AUTHOR
+AUTHORS
COPYRIGHT
SEE ALSO
@@ -78,15 +78,9 @@
#sdl irc.perl.org
-AUTHOR
-
- Kartik Thakore
- CPAN ID: KTHAKORE
- ---
- kthakore@cpan.org
- http://sdl.perl.org
-
-
+AUTHORS
+
+See AUTHORS in SDL.
COPYRIGHT
diff --git a/pages/SDLx-Sprite-Animated.html-inc b/pages/SDLx-Sprite-Animated.html-inc
index 1cb7575..5ad93de 100644
--- a/pages/SDLx-Sprite-Animated.html-inc
+++ b/pages/SDLx-Sprite-Animated.html-inc
@@ -337,18 +337,12 @@ automatically for you every time ->draw()
is called
If you want to restart autoplay from the initial frame, just do:
$sprite->reset->start;
-
-
-
AUTHORS
-Jeffrey T. Palmer <jeffrey.t.palmer at gmail.com>
-Dustin Mays, <dork.fish.wat@gmail.com>
-Breno G. de Oliveira, <garu at cpan.org>
-Kartik thakore <kthakore at cpan.org>
+See AUTHORS in SDL.
SEE ALSO
diff --git a/pages/SDLx-Sprite.html-inc b/pages/SDLx-Sprite.html-inc
index 9f50564..6751c8b 100644
--- a/pages/SDLx-Sprite.html-inc
+++ b/pages/SDLx-Sprite.html-inc
@@ -185,14 +185,14 @@ be used together with 'rect' (see above).
* draw_xy => $surface, $x, $y
- A shortcut to draw at coordinates quickly. Calles x() , y() and draw()
+ A shortcut to draw at coordinates quickly. Calls x() , y() and draw()
* rotation => $degrees, [$smooth]
Uses $degrees as the angle to rotate the surface to, in degrees
(0..360, remember? :). This option is only available if your compiled SDL
library has support for GFX (see Alien::SDL for details).
- if $smooth is set the spirte is antialiased. This may mess with your alpha_key.
+ if $smooth is set the sprite is antialiased. This may mess with your alpha_key.
* alpha_key => SDL::Color
@@ -329,9 +329,7 @@ destination rect (position) from rect().
AUTHORS
-Dustin Mays, <dork.fish.wat@gmail.com>
-Breno G. de Oliveira, <garu at cpan.org>
-Kartik thakore <kthakore at cpan.org>
+See AUTHORS in SDL.
SEE ALSO
diff --git a/pages/SDLx-Surface.html-inc b/pages/SDLx-Surface.html-inc
index 9a7db49..34e51ec 100644
--- a/pages/SDLx-Surface.html-inc
+++ b/pages/SDLx-Surface.html-inc
@@ -26,10 +26,12 @@
update
draw_rect
draw_line
+draw_circle
+draw_circle_filled
draw_gfx_text
-AUTHOR
+ AUTHORS
@@ -226,6 +228,31 @@ This is useful when the surface you have isn't an SDLx::Surface
, bu
Returns $self
+draw_circle
+
+ $sdlx_surface->draw_circle( [$x1, $y1], $radius, \@color );
+
+
+Draws an unfilled circle at ($x1,$y1)
of size $radius and $color.
+Returns $self
+
+
+draw_circle_filled
+
+ $sdlx_surface->draw_filled_circle( [$x1, $y1], $radius, \@color );
+
+
+Draws an filled circle at ($x1,$y1)
of size $radius and $color.
+Returns $self
+
+
+
+
+
+
+
+
+
draw_gfx_text
Draw text using gfx (not pretty but fast) at give vector, color.
@@ -247,11 +274,9 @@ This is useful when the surface you have isn't an SDLx::Surface
, bu
Returns $self
-AUTHOR
-
\ No newline at end of file
diff --git a/pages/documentation.html-inc b/pages/documentation.html-inc
index f8096f2..bcf6d99 100644
--- a/pages/documentation.html-inc
+++ b/pages/documentation.html-inc
@@ -1,2 +1,2 @@
-Documentation (latest development branch)
Core SDL - Simple DirectMedia Layer for Perl SDL::Credits - Authors and contributors of the SDL Perl project SDL::Deprecated - Log of Deprecated items per release SDL::Time - An SDL Perl extension for managing timers
Audio SDL::Audio - SDL Bindings for Audio
Structure SDL::AudioCVT - Audio Conversion Structure SDL::AudioSpec - SDL Bindings for structure SDL::AudioSpec
CDROM SDL::CDROM - SDL Bindings for the CDROM device
Structure SDL::CD - SDL Bindings for structure SDL_CD SDL::CDTrack - SDL Bindings for structure SDL_CDTrack
Events SDL::Events - Bindings to the Events Category in SDL API
Structure SDL::Event - General event structure
Joystick SDL::Joystick - SDL Bindings for the Joystick device
Mouse SDL::Mouse - SDL Bindings for the Mouse device
Structure SDL::Cursor - Mouse cursor structure
Structure SDL::Version - SDL Bindings for structure SDL_Version
Video SDL::Video - Bindings to the video category in SDL API
Structure SDL::Color - Format independent color description SDL::Overlay - YUV Video overlay SDL::Palette - Color palette for 8-bit pixel formats SDL::PixelFormat - Stores surface format information SDL::Rect - Defines a rectangular area SDL::Surface - Graphic surface structure SDL::VideoInfo - Video Target Information
Cookbook SDL::Cookbook SDL::Cookbook::OpenGL - Using SDL with OpenGL SDL::Cookbook::PDL
Extension SDLx::App - a SDL perl extension SDLx::Layer - Extension ... SDLx::LayerManager - Extension for managing layers in a 2D world SDLx::Rect - SDL extension for storing and manipulating rectangular coordinates SDLx::SFont - Extension making fonts out of images and printing them SDLx::Sprite - interact with images quick and easily in SDL SDLx::Sprite::Animated - create animated SDL sprites easily! SDLx::Surface - Graphic surface matrix extension
GFX SDL::GFX::Framerate - framerate calculating functions SDL::GFX::Primitives - basic drawing functions
Structure SDL::GFX::FPSManager - data structure used by SDL::GFX::Framerate
Image SDL::Image - Bindings for the SDL_Image library
Mixer SDL::Mixer - Sound and music functions SDL::Mixer::Channels - SDL::Mixer channel functions and bindings SDL::Mixer::Effects - sound effect functions SDL::Mixer::Groups - Audio channel group functions SDL::Mixer::Music - functions for music SDL::Mixer::Samples - functions for loading sound samples
Structure SDL::Mixer::MixChunk - SDL Bindings for structure SDL_MixChunk SDL::Mixer::MixMusic - SDL Bindings for structure SDL_MixMusic
Pango SDL::Pango - Text rendering engine
Structure SDL::Pango::Context - Context object for SDL::Pango
TODO SDL::MPEG - a SDL perl extension SDL::SMPEG - a SDL perl extension
MultiThread SDL::MultiThread - Bindings to the MultiThread category in SDL API
Structure SDL::RWOps - SDL Bindings to SDL_RWOPs
GFX SDL::GFX::BlitFunc - blitting functions SDL::GFX::ImageFilter - image filtering functions SDL::GFX::Rotozoom - rotation and zooming functions for surfaces
TTF SDL::TTF - True Type Font functions (libfreetype)
Structure SDL::TTF::Font - Font object type for SDL_ttf
Tutorials SDL::Tutorial - introduction to Perl SDL SDL::Tutorial::Animation SDL::Tutorial::LunarLander - a small tutorial on Perl SDL
UNCATEGORIZED SDLx::Controller - Handles the loops for event, movement and rendering SDLx::Sound
+Documentation (latest development branch)
Core SDL - Simple DirectMedia Layer for Perl SDL::Credits - Authors and contributors of the SDL Perl project SDL::Deprecated - Log of Deprecated items per release SDL::Time - An SDL Perl extension for managing timers
Audio SDL::Audio - SDL Bindings for Audio
Structure SDL::AudioCVT - Audio Conversion Structure SDL::AudioSpec - SDL Bindings for structure SDL::AudioSpec
CDROM SDL::CDROM - SDL Bindings for the CDROM device
Structure SDL::CD - SDL Bindings for structure SDL_CD SDL::CDTrack - SDL Bindings for structure SDL_CDTrack
Events SDL::Events - Bindings to the Events Category in SDL API
Structure SDL::Event - General event structure
Joystick SDL::Joystick - SDL Bindings for the Joystick device
Mouse SDL::Mouse - SDL Bindings for the Mouse device
Structure SDL::Cursor - Mouse cursor structure
Structure SDL::Version - SDL Bindings for structure SDL_Version
Video SDL::Video - Bindings to the video category in SDL API
Structure SDL::Color - Format independent color description SDL::Overlay - YUV Video overlay SDL::Palette - Color palette for 8-bit pixel formats SDL::PixelFormat - Stores surface format information SDL::Rect - Defines a rectangular area SDL::Surface - Graphic surface structure SDL::VideoInfo - Video Target Information
Cookbook SDL::Cookbook SDL::Cookbook::OpenGL - Using SDL with OpenGL SDL::Cookbook::PDL
Extension SDLx::App - a SDL perl extension SDLx::Layer - Storage object for surface and position information SDLx::LayerManager - Extension for managing layers in a 2D world SDLx::Rect - SDL extension for storing and manipulating rectangular coordinates SDLx::SFont - Extension making fonts out of images and printing them SDLx::Sprite - interact with images quick and easily in SDL SDLx::Sprite::Animated - create animated SDL sprites easily! SDLx::Surface - Graphic surface matrix extension
GFX SDL::GFX::Framerate - framerate calculating functions SDL::GFX::Primitives - basic drawing functions
Structure SDL::GFX::FPSManager - data structure used by SDL::GFX::Framerate
Image SDL::Image - Bindings for the SDL_Image library
Mixer SDL::Mixer - Sound and music functions SDL::Mixer::Channels - SDL::Mixer channel functions and bindings SDL::Mixer::Effects - sound effect functions SDL::Mixer::Groups - Audio channel group functions SDL::Mixer::Music - functions for music SDL::Mixer::Samples - functions for loading sound samples
Structure SDL::Mixer::MixChunk - SDL Bindings for structure SDL_MixChunk SDL::Mixer::MixMusic - SDL Bindings for structure SDL_MixMusic
Pango SDL::Pango - Text rendering engine
Structure SDL::Pango::Context - Context object for SDL::Pango
TODO SDL::MPEG - a SDL perl extension SDL::SMPEG - a SDL perl extension
MultiThread SDL::MultiThread - Bindings to the MultiThread category in SDL API
Structure SDL::RWOps - SDL Bindings to SDL_RWOPs
GFX SDL::GFX::BlitFunc - blitting functions SDL::GFX::ImageFilter - image filtering functions SDL::GFX::Rotozoom - rotation and zooming functions for surfaces
TTF SDL::TTF - True Type Font functions (libfreetype)
Structure SDL::TTF::Font - Font object type for SDL_ttf
Tutorials SDL::Tutorial - introduction to Perl SDL SDL::Tutorial::Animation SDL::Tutorial::LunarLander - a small tutorial on Perl SDL
UNCATEGORIZED SDLx::Controller - Handles the loops for event, movement and rendering