Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

fix spelling errors in pods

  • Loading branch information...
commit 58c1a4dd5f39f6262d8075ba49f3a12b70902ff4 1 parent 6dd1a29
@mig0 mig0 authored
Showing with 121 additions and 121 deletions.
  1. +1 −1  lib/pods/SDL.pod
  2. +2 −2 lib/pods/SDL/Audio.pod
  3. +1 −1  lib/pods/SDL/AudioSpec.pod
  4. +1 −1  lib/pods/SDL/CD.pod
  5. +4 −4 lib/pods/SDL/Cookbook/OpenGL.pod
  6. +3 −3 lib/pods/SDL/Cookbook/PDL.pod
  7. +2 −2 lib/pods/SDL/Deprecated.pod
  8. +5 −5 lib/pods/SDL/Event.pod
  9. +10 −10 lib/pods/SDL/Events.pod
  10. +2 −2 lib/pods/SDL/GFX/Framerate.pod
  11. +2 −2 lib/pods/SDL/GFX/Primitives.pod
  12. +2 −2 lib/pods/SDL/MPEG.pod
  13. +1 −1  lib/pods/SDL/Mixer.pod
  14. +2 −2 lib/pods/SDL/Mixer/Channels.pod
  15. +2 −2 lib/pods/SDL/Mixer/Groups.pod
  16. +1 −1  lib/pods/SDL/Mixer/Music.pod
  17. +1 −1  lib/pods/SDL/Overlay.pod
  18. +3 −3 lib/pods/SDL/Pango.pod
  19. +13 −13 lib/pods/SDL/RWOps.pod
  20. +1 −1  lib/pods/SDL/SMPEG.pod
  21. +9 −9 lib/pods/SDL/TTF.pod
  22. +1 −1  lib/pods/SDL/Tutorial/LunarLander.pod
  23. +6 −6 lib/pods/SDL/Video.pod
  24. +3 −3 lib/pods/SDLx/App.pod
  25. +4 −4 lib/pods/SDLx/Controller.pod
  26. +3 −3 lib/pods/SDLx/Controller/Interface.pod
  27. +4 −4 lib/pods/SDLx/Layer.pod
  28. +4 −4 lib/pods/SDLx/LayerManager.pod
  29. +2 −2 lib/pods/SDLx/Music.pod
  30. +2 −2 lib/pods/SDLx/Rect.pod
  31. +16 −16 lib/pods/SDLx/Sound.pod
  32. +1 −1  lib/pods/SDLx/Sprite.pod
  33. +1 −1  lib/pods/SDLx/Sprite/Animated.pod
  34. +4 −4 lib/pods/SDLx/Surface.pod
  35. +2 −2 lib/pods/SDLx/Text.pod
View
2  lib/pods/SDL.pod
@@ -88,7 +88,7 @@ C<SDL::quit> doesn't return any values.
my $flags = SDL::was_init( $flags );
-C<SDL::was_init> allows you to see which SDL subsytems have been initialized.
+C<SDL::was_init> allows you to see which SDL subsystems have been initialized.
The C<$flags> tell C<SDL::was_init> which subsystems to check, and are taken in the same way as C<SDL::init>.
C<SDL::was_init> returns a mask of the initialized subsystems it checks.
View
4 lib/pods/SDL/Audio.pod
@@ -189,7 +189,7 @@ Converts audio data to a desired audio format.
C<convert> takes as first parameter C<cvt>, which was previously initialized. Initializing a C<SDL::AudioCVT> is a two step process.
First of all, the structure must be created via C<SDL::AudioCVT-E<gt>build> along with source and destination format parameters. Secondly,
-the C<data> and C<len> fields must be setup. C<data> should point to the audio data buffer beeing source and destination at
+the C<data> and C<len> fields must be setup. C<data> should point to the audio data buffer being source and destination at
once and C<len> should be set to the buffer length in bytes. Remember, the length of the buffer pointed to by buf should be
C<len*len_mult> bytes in length.
@@ -256,7 +256,7 @@ Example:
# And now we're ready to convert
SDL::Audio::convert($wav_cvt, $wav_buf, $wav_len);
- # We can freeto original WAV data now
+ # We can free original WAV data now
SDL::Audio::free_wav($wav_buf);
B<TODO>: What to do with it? How to use callback? See http://www.libsdl.org/cgi/docwiki.cgi/SDL_ConvertAudio
View
2  lib/pods/SDL/AudioSpec.pod
@@ -29,7 +29,7 @@ Core, Audio, Structure
# do something here
}
-=head1 DESCIPTION
+=head1 DESCRIPTION
The C<SDL::AudioSpec> structure is used to describe the format of some audio data. This structure is used by C<SDL::Audio::open_audio>
and C<SDL::Audio::load_wav>.
View
2  lib/pods/SDL/CD.pod
@@ -170,7 +170,7 @@ Current track on the CD;
my $track = $CD->track($number);
-Retrives track description of track $number in CD. See L<SDL::CDTrack>.
+Retrieves track description of track $number in CD. See L<SDL::CDTrack>.
=head2 FRAMES_TO_MSF
View
8 lib/pods/SDL/Cookbook/OpenGL.pod
@@ -11,9 +11,9 @@ Cookbook
=head1 DESCRIPTION
-As of release 2.5 SDL no longer maintains it's own bindings of openGL. Support for openGL has been moved over to a more mature implementation.
+As of release 2.5 SDL no longer maintains it's own bindings of OpenGL. Support for OpenGL has been moved over to a more mature implementation.
-This implementation is the POGL project. L<OpenGL> is faster and more complete; and works with SDL seemlessly.
+This implementation is the POGL project. L<OpenGL> is faster and more complete; and works with SDL seamlessly.
=head2 EXAMPLE
@@ -37,7 +37,7 @@ You can use OpenGL as needed here.
$| = 1;
$WIDTH = 1024;
$HEIGHT = 768;
- $SDLAPP = SDLx::App->new(title => "Opengl App", width => $WIDTH, height => $HEIGHT, gl => 1);
+ $SDLAPP = SDLx::App->new(title => "OpenGL App", width => $WIDTH, height => $HEIGHT, gl => 1);
$SDLEVENT = SDL::Event->new;
SDLx::App can start an OpenGL application with the parameter gl => 1.
@@ -48,7 +48,7 @@ SDLx::App can start an OpenGL application with the parameter gl => 1.
gluPerspective(60, $WIDTH / $HEIGHT, 1, 1000);
glTranslatef(0, 0, -20);
-Above we enable GL and set the correct prespective
+Above we enable GL and set the correct perspective
while (1) {
&handlepolls;
View
6 lib/pods/SDL/Cookbook/PDL.pod
@@ -38,7 +38,7 @@ Create a normal $piddle with zeros, byte format and the Bpp x width x height dim
my $pointer = $piddle->get_dataref();
-Here is where we get the acutal data the piddle is pointing to. We will have SDL create a new surface from this function.
+Here is where we get the actual data the piddle is pointing to. We will have SDL create a new surface from this function.
my $surface = SDL::Surface->new_from( $pointer, $width, $height, 32,
$width * $bytes_per_pixel );
@@ -48,7 +48,7 @@ Using the same dimensions we create the surface using new_form. The width * Bpp
warn "Made surface of $width, $height and ". $surface->format->BytesPerPixel;
return ( $piddle, $surface );
-Finally make sure that the surface acutally has the correct dimensions we gave.
+Finally make sure that the surface actually has the correct dimensions we gave.
B<NOTE:> $surface->format->BytesPerPixel must return 1,2,3,4. !!
@@ -79,7 +79,7 @@ When blitting the new surface check for the return value to see if there has bee
die "Could not blit: " . SDL::get_error() if ( $b == -1 );
-If the error message is 'Blit combination not supported' that means that the BPP is incorrect or incosistent with the dimensions.
+If the error message is 'Blit combination not supported' that means that the BPP is incorrect or inconsistent with the dimensions.
After that a simple update_rect will so your new surface on the screen.
=head1 AUTHORS
View
4 lib/pods/SDL/Deprecated.pod
@@ -28,7 +28,7 @@ C<min_t> will limit apps to a framerate of 60 by default.
=item SDLx::App
-C<SDLx::App::loop()> is depreceated.
+C<SDLx::App::loop()> is deprecated.
=back
@@ -56,7 +56,7 @@ Has drastically changed, and is still volatile.
=item SDL::App
-SDL::App has migrated to SDLx::App namespace. The reason for this is because it is an extenstion and not a 1:1 XS/Constant Module to the c library.
+SDL::App has migrated to SDLx::App namespace. The reason for this is because it is an extension and not a 1:1 XS/Constant Module to the c library.
=item SDL::Game::Rect
View
10 lib/pods/SDL/Event.pod
@@ -57,7 +57,7 @@ and it is then up to the application to process the information stored with them
=head2 new
C<new> creates an empty event-object, which can be used store information.
-Either by calling C<poll_event($event)> that transferes one event from the queue into our object
+Either by calling C<poll_event($event)> that transfers one event from the queue into our object
or by setting all the needed data manually in order to push the event to the queue.
use SDL::Event;
@@ -105,7 +105,7 @@ L<SDL_JOYAXISMOTION|/Joystick_axis_events> - Joystick axis motion event structur
=item *
-L<SDL_JOYBALLMOTION|/Joystrick_trackball_events> - Joystick trackball motion event structure
+L<SDL_JOYBALLMOTION|/Joystick_trackball_events> - Joystick trackball motion event structure
=item *
@@ -361,7 +361,7 @@ This is currently only implemented on Windows and Linux/Unix-alikes.
When a mouse button press or release is detected, the number of the button pressed (from 1 to 255,
with 1 usually being the left button and 2 the right) is placed into C<button_button>. The position of the mouse
-when this event occured is stored in the C<button_x> and the C<button_y> fields. Like a keyboard event,
+when this event occurred is stored in the C<button_x> and the C<button_y> fields. Like a keyboard event,
information on whether the event was a press or a release event is stored in both the C<button_type>
and C<button_state> fields, but this should be obvious.
@@ -395,7 +395,7 @@ The field C<jaxis_which> is the index of the joystick that reported the event.
=head3 jaxis_axis
-The C<jaxis_axis> is the index of the axis (for a more detailed explaination see the Joystick section).
+The C<jaxis_axis> is the index of the axis (for a more detailed explanation see the Joystick section).
=head3 jaxis_value
@@ -482,7 +482,7 @@ C<SDL_HAT_LEFTDOWN>
=back
-=head2 Joystrick trackball events
+=head2 Joystick trackball events
A C<SDL_JOYBALLMOTION> event occurs when a user moves a trackball on the joystick.
View
20 lib/pods/SDL/Events.pod
@@ -218,12 +218,12 @@ Checks the event queue for messages and optionally returns them.
my $num_peep_events = SDL::Events::peep_events($event, 127, SDL_PEEKEVENT, SDL_ALLEVENTS);
-If action is SDL_ADDEVENT, up to numevents events will be added to the back of the event queue.
+If action is SDL_ADDEVENT, up to num_events 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
+If action is SDL_PEEKEVENT, up to num_events 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
+If action is SDL_GETEVENT, up to num_events 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
@@ -310,7 +310,7 @@ set_event_filter takes a coderef that it checks all events again. The callback g
to filter the event return a 0, to pass the filter return a 1.
-One B<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
+One B<Caveat> is if you are filtering SDL_QUIT the event will be filtered if it is non-interrupt 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 L<SDL::Events::push_events|SDL::Events/"push_events"> or L<SDL::Events::peep_events|SDL::Events/"peep_events">
@@ -462,11 +462,11 @@ Enable/Disable UNICODE translation
$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,
+translation incurs a slight overhead for each keyboard event and is therefore disabled by default. For each subsequently received key down event,
the unicode member of the L<SDL::Event::key_sym|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.
+A value of 1 for enabling, 0 for disabling and -1 for unchanged. -1 is useful for querying the current translation mode.
Only key press events will be translated not release events.
@@ -478,7 +478,7 @@ Sets keyboard repeat rate
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
+Enables or disables the keyboard repeat rate. $delay specifies how long the key must be pressed before it begins repeating, it then repeats 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.
@@ -487,7 +487,7 @@ Return 0 on success and -1 on fail.
=head2 get_mouse_state
-Retrives the current state of the mouse
+Retrieves the current state of the mouse
my ($mask,$x,$y) = @{ SDL::Events::get_mouse_state( ) };
@@ -503,7 +503,7 @@ The current button state is returned as a button $bitmask, which can be tested u
=head2 get_relative_mouse_state
-Retrives the current relative state of the mouse
+Retrieves the current relative state of the mouse
my ($mask,$x,$y) = @{ SDL::Events::get_mouse_state( ) };
@@ -513,7 +513,7 @@ Retrives the current relative state of the mouse
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 position of the mouse
The current button state is returned as a button $bitmask, which can be tested using the the above constants
View
4 lib/pods/SDL/GFX/Framerate.pod
@@ -41,8 +41,8 @@ Get the currently set framerate of the manager.
SDL::GFX::Framerate::delay($fps);
-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.
+Generate a delay to accommodate the currently set framerate. Call once in the graphics/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.
=head1 AUTHORS
View
4 lib/pods/SDL/GFX/Primitives.pod
@@ -9,7 +9,7 @@ GFX
=head1 DESCRIPTION
-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
+All functions take an SDL::Surface object as first parameter. This can be a new surface that will be blitted afterwards, can be an surface
obtained by L<SDL::Video::set_video_mode|SDL::Video/"set_video_mode"> or can be an L<SDLx::App>.
The C<color> values for the C<_color> functions are C<0xRRGGBBAA> (32bit), even if the surface uses e. g. 8bit colors.
@@ -30,7 +30,7 @@ Draws a pixel at point C<x>/C<$y>. You can pass the color by C<0xRRGGBBAA> or by
my $surface = SDL::Video::set_video_mode(640, 480, 32, SDL_SWSURFACE);
- SDL::GFX::Primitives::pixel_color($surface, 2, 2, 0xFF0000FF); # red pixcel
+ SDL::GFX::Primitives::pixel_color($surface, 2, 2, 0xFF0000FF); # red pixel
SDL::GFX::Primitives::pixel_RGBA( $surface, 4, 4, 0x00, 0xFF, 0x00, 0xFF); # green pixel
=head2 hline
View
4 lib/pods/SDL/MPEG.pod
@@ -15,7 +15,7 @@ TODO
=head1 DESCRIPTION
-C<SDL::MPEG> provides an interface to quering the status
+C<SDL::MPEG> provides an interface to querying the status
of a SMPEG stream.
=head2 METHODS
@@ -48,7 +48,7 @@ C<SDL::MPEG::offset> returns the offset into the clip in bytes
=item *
-C<SDL::MPEG::frame> returns the offset into the clip in fames
+C<SDL::MPEG::frame> returns the offset into the clip in frames
=item *
View
2  lib/pods/SDL/Mixer.pod
@@ -163,7 +163,7 @@ B<Note>: Only available for SDL_mixer >= 1.2.10
SDL::Mixer::quit();
-This function unloads the liraries previously loaded with L<init()|/init>.
+This function unloads the libraries previously loaded with L<init()|/init>.
B<Note>: Only available for SDL_mixer >= 1.2.10
View
4 lib/pods/SDL/Mixer/Channels.pod
@@ -17,7 +17,7 @@ Mixer
my $ret = SDL::Mixer::Channels::allocate_channels( $number_of_channels );
-Dynamically change the number of channels managed by the mixer. If decreasing the number of channels, the upper channels arestopped.
+Dynamically change the number of channels managed by the mixer. If decreasing the number of channels, the upper channels are stopped.
This function returns the new number of allocated channels.
Example
@@ -142,7 +142,7 @@ Example 2:
my $playing = SDL::Mixer::Channels::playing( $channel );
-Returns C<1> if the given channel is playing sound, otherwise C<0>. It does'nt check if the channel is paused.
+Returns C<1> if the given channel is playing sound, otherwise C<0>. It doesn't check if the channel is paused.
B<Note>: If you pass C<-1> you will get the number of playing channels.
View
4 lib/pods/SDL/Mixer/Groups.pod
@@ -92,7 +92,7 @@ C<group_newer> returns the channel number which started to play at last.
Fades out the channels by the given group id. The fade-out-time is specified by C<$ms>.
-Retuns the number of affected channels.
+Returns the number of affected channels.
=head2 halt_group
@@ -100,7 +100,7 @@ Retuns the number of affected channels.
Halts the channels by the given group id.
-Retuns C<0>.
+Returns C<0>.
=head1 AUTHORS
View
2  lib/pods/SDL/Mixer/Music.pod
@@ -240,7 +240,7 @@ Returns C<1> if the music is paused, otherwise C<0>.
my $playing_music = SDL::Mixer::Music::playing_music();
-Returns C<1> if the music is playing sound, otherwise C<0>. It does'nt check if the music is paused.
+Returns C<1> if the music is playing sound, otherwise C<0>. It doesn't check if the music is paused.
=head1 AUTHORS
View
2  lib/pods/SDL/Overlay.pod
@@ -17,7 +17,7 @@ First import the following modules to get access to constants and functions need
use SDL::Video;
use SDL::Overlay;
-Init the video susbsystem.
+Init the video subsystem.
SDL::Init(SDL_INIT_VIDEO);
View
6 lib/pods/SDL/Pango.pod
@@ -25,7 +25,7 @@ Pango
my $context = SDL::Pango::Context->new;
SDL::Pango::set_default_color($context, 0xA7C344FF, 0);
- SDL::Pango::set_markup($context, 'Hallo <b>W<span foreground="red">o</span><i>r</i><u>l</u>d</b>!', -1);
+ SDL::Pango::set_markup($context, 'Hello <b>W<span foreground="red">o</span><i>r</i><u>l</u>d</b>!', -1);
SDL::init(SDL_INIT_VIDEO);
@@ -110,7 +110,7 @@ Returns: always C<0>.
my $was_init = SDL::Pango::was_init();
-Query the initilization status of the Glib and Pango API. You may, of course, use this before L<SDL::Pango::init|SDL::Pango/"init"> to avoid initilizing twice
+Query the initialization status of the Glib and Pango API. You may, of course, use this before L<SDL::Pango::init|SDL::Pango/"init"> to avoid initializing twice
in a row.
Returns: Non-zero when already initialized. Zero when not initialized.
@@ -212,7 +212,7 @@ Draws the text or markup to an existing surface at position C<$x>/C<$y>.
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 L<SDL::Pango::create_surface_draw|SDL::Pango/"create_surface_draw">.
+Sets the argument that are used when creating a surface via L<SDL::Pango::create_surface_draw|SDL::Pango/"create_surface_draw">.
Example:
View
26 lib/pods/SDL/RWOps.pod
@@ -3,7 +3,7 @@
=head1 NAME
-SDL::RWOps -- SDL Bindings to SDL_RWOPs
+SDL::RWOps -- SDL Bindings to SDL_RWops
=head1 CATEGORY
@@ -13,7 +13,7 @@ TODO, Core, Structure
=head1 SYNOPSIS
# The following example will load several png's from a single file to an array of SDL::Surface's.
- # Usefull for e.g. levelfiles.
+ # Useful for e.g. levelfiles.
use SDL;
use SDL::Image;
use SDL::RWOps;
@@ -52,9 +52,9 @@ An example usage would be to put a bunch of resources in a zip file and use Zzip
=head2 rw_from_file(file,mode)
-rw_from_file creates a new SDL::RWops structure for reading from and/or writing to a named file.
+rw_from_file creates a new SDL::RWOps structure for reading from and/or writing to a named file.
The mode string is treated the same as in a call to the C library's fopen().
-SDL::rw_from_file() returns a SDL::RWops structure on succés or undef on failure.
+SDL::rw_from_file() returns a SDL::RWOps structure on success or undef on failure.
Mode Strings:
@@ -80,16 +80,16 @@ This additional "b" character can either be appended at the end of the string (t
=head2 rw_from_fp(fp,autoclose)
-SDL::rw_from_fp creates a new SDL::RWops structure from a file pointer, opened with stdio. If autoclose is nonzero, the file will be automatically closed when the SDL::RWops structure is closed.
-It returns a SDL::RWops on succés or undef on error.
+SDL::rw_from_fp creates a new SDL::RWOps structure from a file pointer, opened with stdio. If autoclose is nonzero, the file will be automatically closed when the SDL::RWOps structure is closed.
+It returns a SDL::RWOps on success or undef on error.
Note: This is not available under Win32, since files opened in an application on that platform cannot be used by a dynamically linked library.
=head2 rw_from_mem(mem,size)
-SDL::rw_from_mem sets up a SDL::RWops struct based on a chunk of memory of a certain size.
-It returns a SDL::Rwops on succés or undef on error.
+SDL::rw_from_mem sets up a SDL::RWOps struct based on a chunk of memory of a certain size.
+It returns a SDL::RWOps on success or undef on error.
Note: If the memory is not writable, use SDL::rw_from_const_mem instead.
@@ -104,14 +104,14 @@ It assumes the memory area is not writable. It returns a SDL::RWOps on success o
=head2 alloc_rw()
-alloc_rw allocates an empty, unpopulated SDL::RWops structure. You must fill out the fields yourself.
-It returns a SDL::RWops structure on succés or undef on error.
+alloc_rw allocates an empty, unpopulated SDL::RWOps structure. You must fill out the fields yourself.
+It returns a SDL::RWOps structure on success or undef on error.
Note: You must free any memory allocated with SDL::alloc_rw with SDL::free_rw.
=head2 free_rw(context)
-SDL::free_rw frees an SDL::RWops structure previously allocated by SDL::alloc_rw. Only use it on memory allocated by SDL::alloc_rw.
+SDL::free_rw frees an SDL::RWOps structure previously allocated by SDL::alloc_rw. Only use it on memory allocated by SDL::alloc_rw.
It doesn't returns anything.
@@ -119,7 +119,7 @@ It doesn't returns anything.
SDL::rw_seek calls the seek function pointer in an SDL::RWOps structure. It takes the same 3 parameters as the function pointer:
- 1. A pointer to an SDL::rwops structure
+ 1. A pointer to an SDL::RWOps structure
2. An offset in bytes. This can be a negative value.
3.SEEK_SET, SEEK_CUR, or SEEK_END. SEEK_SET seeks from the beginning of the file, SEEK_CUR from the current position, and SEEK_END from the end of the file.
@@ -137,7 +137,7 @@ SDL_RWread calls the function pointed to by an SDL::RWOps structure's read membe
1. A pointer to an SDL::RWOps structure
2. A pointer to an area of memory to read data into
3. The size of each block of memory to read
- 4. The maxinum number of memory blocks to read(it may read less)
+ 4. The maximum number of memory blocks to read(it may read less)
It returns the number of memory blocks read, or -1 if the read failed.
View
2  lib/pods/SDL/SMPEG.pod
@@ -18,7 +18,7 @@ TODO
C<SDL::SMPEG> adds support for MPEG video to your
SDL Perl application. SMPEGs are objects bound to
-surfaces, whose playback is controled through the
+surfaces, whose playback is controlled through the
object's interface.
=head2 METHODS
View
18 lib/pods/SDL/TTF.pod
@@ -107,7 +107,7 @@ Returns: C<0> on success, C<-1> on any error.
my $was_init = SDL::TTF::was_init();
-Query the initilization status of the truetype font API.
+Query the initialization status of the truetype font API.
You may, of course, use this before L<SDL::TTF::init|SDL::TTF/"init"> to avoid initializing twice in a row. Or use this to determine if you need to
call L<SDL::TTF::quit|SDL::TTF/"quit">.
@@ -456,7 +456,7 @@ Note that the first example uses the same text as in the LATIN1 example, that is
Examples:
- ($width, $height) = @{ SDL::TTF::size_utf8($font, 'Hallo World!') }; # plain text, if your script is in utf8 or ansi-format
+ ($width, $height) = @{ SDL::TTF::size_utf8($font, 'Hello World!') }; # plain text, if your script is in utf8 or ansi-format
# or
@@ -465,7 +465,7 @@ Examples:
# or
use Unicode::String;
- my $unicode = utf8($data_from_somwhere);
+ my $unicode = utf8($data_from_somewhere);
($width, $height) = @{ SDL::TTF::size_utf8($font, $unicode->utf8) }; # utf8 via Unicode::String
=head4 size_unicode
@@ -481,15 +481,15 @@ C<$text> has to be:
=item UTF16BE without BOM
-"hallo" will look like "\0h\0a\0l\0l\0o"
+"hello" will look like "\0h\0e\0l\0l\0o"
=item UTF16BE with BOM
-"hallo" will look like "\xFE\xFF\0h\0a\0l\0l\0o"
+"hello" will look like "\xFE\xFF\0h\0e\0l\0l\0o"
=item UTF16LE with BOM
-"hallo" will look like "\xFF\xFEh\0a\0l\0l\0o\0"
+"hello" will look like "\xFF\xFEh\0e\0l\0l\0o\0"
=back
@@ -532,7 +532,7 @@ Example:
my $display = SDL::Video::set_video_mode(640, 480, 32, SDL_SWSURFACE);
my $font = SDL::TTF::open_font('somefont.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));
+ my $surface = SDL::TTF::render_text_solid($font, 'Hello!', 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);
@@ -591,7 +591,7 @@ Example:
my $font = SDL::TTF::open_font('arial.ttf', '24');
my $white = SDL::Color->new(0xFF, 0xFF, 0xFF);
my $black = SDL::Color->new(0x00, 0x00, 0x00);
- my $surface = SDL::TTF::render_text_solid($font, 'Hallo!', $white, $black);
+ my $surface = SDL::TTF::render_text_solid($font, 'Hello!', $white, $black);
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);
@@ -644,7 +644,7 @@ Example:
my $display = SDL::Video::set_video_mode(640, 480, 32, SDL_SWSURFACE);
my $font = SDL::TTF::open_font('arial.ttf', '24');
- my $surface = SDL::TTF::render_text_blended($font, 'Hallo!', SDL::Color->new(0xFF,0xFF,0xFF));
+ my $surface = SDL::TTF::render_text_blended($font, 'Hello!', 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);
View
2  lib/pods/SDL/Tutorial/LunarLander.pod
@@ -146,7 +146,7 @@ So the middle section of the program will become:
if ( $up{$t} ) {
my $a = $up{$t};
- print "(accellerating $a m/s^2)\n";
+ print "(accelerating $a m/s^2)\n";
$velocity = $velocity - $a;
}
View
12 lib/pods/SDL/Video.pod
@@ -65,7 +65,7 @@ Export tag: ':video'
NOTE: This option is kept for compatibility only, and is not recommended for new code.
SDL_RESIZABLE Resizable surface
SDL_NOFRAME No window caption or edge frame
- SDL_HWACCEL Use Hardware acceleration blit
+ SDL_HWACCEL Use hardware acceleration blit
SDL_SRCCOLORKEY Use colorkey blitting
SDL_RLEACCELOK Private flag
SDL_RLEACCEL Accelerated colorkey blitting with RLE
@@ -90,7 +90,7 @@ Export tag ':grab'
SDL_GRAB_QUERY
SDL_GRAB_OFF
SDL_GRAB_ON
- SDL_GRAB_FULLSCREEN Used interally
+ SDL_GRAB_FULLSCREEN Used internally
Export tag ':gl'
@@ -248,7 +248,7 @@ Sets up a video mode with the specified width, height, bits-per-pixel and flags.
C<set_video_mode> returns a L<SDL::Surface> on success otherwise it returns undef on error, the error message is retrieved
using C<SDL::get_error>.
-=head3 List of avalaibles flags
+=head3 List of available flags
=over 4
@@ -630,7 +630,7 @@ Surfaces that were previously locked using L<SDL::Video::lock_surface|/lock_sruf
Surfaces should be unlocked as soon as possible.
C<SDL::Video::unlock_surface> doesn't return anything.
-B<Note>: Since 1.1.8, the surface locks are recursive. See L<SDL::Video::lock_surface|/lock_sruface> for more information.
+B<Note>: Since 1.1.8, the surface locks are recursive. See L<SDL::Video::lock_surface|/lock_surface> for more information.
=head2 MUSTLOCK
@@ -919,7 +919,7 @@ C<SDL::Video::get_gamma_ramp> returns -1 on error.
if( -1 == $ret )
{
- print( "an error occoured" );
+ print( "an error occurred" );
}
else
{
@@ -962,7 +962,7 @@ Example:
if( -1 == $ret )
{
- print( "an error occoured" );
+ print( "an error occurred" );
}
else
{
View
6 lib/pods/SDLx/App.pod
@@ -139,9 +139,9 @@ the application. It takes one argument, which should be one of the following:
=head2 sync
-C<SDLx::App::sync> encapsulates the various methods of syncronizing the screen with the
+C<SDLx::App::sync> encapsulates the various methods of synchronizing the screen with the
current video buffer. C<SDLx::App::sync> will do a fullscreen update, using the double buffer
-or OpenGL buffer if applicable. This is prefered to calling flip on the application window.
+or OpenGL buffer if applicable. This is preferred to calling flip on the application window.
=head2 attribute( $attr )
@@ -149,7 +149,7 @@ or OpenGL buffer if applicable. This is prefered to calling flip on the applicat
C<SDLx::App::attribute> allows one to get and set GL attributes. By passing a value
in addition to the attribute selector, the value will be set. C<SDL:::App::attribute>
-always returns the current value of the given attribute, or Carp::confesss on failure.
+always returns the current value of the given attribute, or Carp::confess on failure.
=head1 CALLBACKS
View
8 lib/pods/SDLx/Controller.pod
@@ -41,7 +41,7 @@ the screen update is independent of the frame rate. Otherwise, your game will
run at different speeds on different machines and this is never good (old
MS-DOS games, anyone?).
-One way to circumveint this is by capping the frame rate so it's the same no
+One way to circumvent this is by capping the frame rate so it's the same no
matter what, but this is not the right way to do it as it penalizes better
hardware.
@@ -97,7 +97,7 @@ All hooked functions will be called during the main loop, in this order:
=back
Please refer to each handler below for information on received arguments.
-Note that the second argument every callback recieves is the C<SDLx::Controller> object.
+Note that the second argument every callback receives is the C<SDLx::Controller> object.
=head2 stop
@@ -108,7 +108,7 @@ Returns from the C<run> loop.
Attempts to pause the application with a call to C<SDL::Events::wait_event>. See L<SDL::Events>.
Takes 1 argument which is a callback. The application waits for the next event with C<wait_event>.
-When one is recieved, it is passed to the callback as the first argument, along with the C<SDLx::Controller> object as the second argument.
+When one is received, it is passed to the callback as the first argument, along with the C<SDLx::Controller> object as the second argument.
If the callback then returns a true value, C<pause> will return.
If the callback returns a false value, C<pause> will repeat the process.
@@ -266,7 +266,7 @@ Returns the corresponding value.
See L<SDL/AUTHORS>.
-=head2 ACKNOWLEGDEMENTS
+=head2 ACKNOWLEDGEMENTS
The idea and base for this module comes from Lazy Foo's L<< Frame Independent
Movement|http://www.lazyfoo.net/SDL_tutorials/lesson32/index.php >> tutorial,
View
6 lib/pods/SDLx/Controller/Interface.pod
@@ -49,7 +49,7 @@ Extension, Controller
=head2 set_acceleration
-Allows you to set the acceleration callback for defining the inferface's
+Allows you to set the acceleration callback for defining the interface's
behaviour in terms of x,y and rotation.
$interface->set_acceleration (
@@ -60,7 +60,7 @@ behaviour in terms of x,y and rotation.
}
);
-These accelerations are arbitary and can be set to any frame of reference.
+These accelerations are arbitrary and can be set to any frame of reference.
Your render callback will handle how to interpret it.
The callback will receive the time and the current state as a
@@ -115,7 +115,7 @@ Interpolate the current state
=head2 evaluate
-Evaluate the new currrent and previous state.
+Evaluate the new current and previous state.
=head2 update
View
8 lib/pods/SDLx/Layer.pod
@@ -52,7 +52,7 @@ The layer object just pass it through.
my $index = $layer->index;
-The method C<index> represents the z-index ot this layer within its layermanager.
+The method C<index> represents the z-index of this layer within its layermanager.
=head2 x
@@ -87,7 +87,7 @@ B<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.
+This method let you retrieve the current or set a new surface.
=head2 pos
@@ -150,13 +150,13 @@ B<Note>: The z-index is not changed for the given layer.
$layer->detach_xy( $x, $y );
-C<detach_xy> detaches the prevously attached layer to the given coords. The upper left corner of this layer will be at C<$x> and C<$y>.
+C<detach_xy> detaches the previously attached layer to the given coords. The upper left corner of this layer will be at C<$x> and C<$y>.
=head2 foreground
$layer->foreground;
-This method moves the given layer to the foreground so that it is blittet on top of the other layers.
+This method moves the given layer to the foreground so that it is blitted on top of the other layers.
=head1 BUGS
View
8 lib/pods/SDLx/LayerManager.pod
@@ -66,7 +66,7 @@ The method C<layers> returns all layers that were added before.
my $layer = $layermanager->layer( $index );
-To obtain only one layer at index C<$index> use this function. C<$index> ranges from C<0> to C<lenght - 1>.
+To obtain only one layer at index C<$index> use this function. C<$index> ranges from C<0> to C<length - 1>.
=head2 length
@@ -121,21 +121,21 @@ B<Note>: The z-index is not changed for the given layers.
$layermanager->detach_xy( $x, $y );
-C<detach_xy> detaches the prevously attached layers to the given coords. The upper left corner of the backmost layer will be at C<$x> and C<$y>.
+C<detach_xy> detaches the previously attached layers to the given coords. The upper left corner of the backmost layer will be at C<$x> and C<$y>.
The other layers are positioned relative to the backmost layer just like before.
=head2 detach_back
$layermanager->detach_back( );
-C<detach_back> detaches the prevously attached layers back to the position where they were attached.
+C<detach_back> detaches the previously attached layers back to the position where they were attached.
=head2 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.
+This method moves the given layer(s) to the foreground so that they are blitted on top of the other layers.
=head1 BUGS
View
4 lib/pods/SDLx/Music.pod
@@ -130,7 +130,7 @@ B<Please note:> do not mix use of this class with L<SDL::Mixer::Music> if you wa
-Creates the new music object. Inits audio with a call to L<SDLx::Mixer::init|SDLx::Mixer/init>, if it isn't already (if you want more precise control over what is initialized, make sure you call L<SDLx::Mixer::init|SDLx::Mixer/init> before you call thiihs method). Creates an empty default data object for object-wide defaults. If arguments are supplied, calls L</data> with them to set up any initial data objects. Returns the new music object.
+Creates the new music object. Inits audio with a call to L<SDLx::Mixer::init|SDLx::Mixer/init>, if it isn't already (if you want more precise control over what is initialized, make sure you call L<SDLx::Mixer::init|SDLx::Mixer/init> before you call this method). Creates an empty default data object for object-wide defaults. If arguments are supplied, calls L</data> with them to set up any initial data objects. Returns the new music object.
=head2 data
@@ -149,7 +149,7 @@ With a hash of arguments: for each pair, and returns a L<SDLx::Music::Data>. Re
$music->data_for( @names_or_data_objects );
-Calls L</data> repeatedly, passing it one element of the list at a time, to initialise mulitiple empty names and/or add data objects. Returns C<$music>.
+Calls L</data> repeatedly, passing it one element of the list at a time, to initialise multiple empty names and/or add data objects. Returns C<$music>.
=head2 has_data
View
4 lib/pods/SDLx/Rect.pod
@@ -29,7 +29,7 @@ All C<< SDLx::Rect >> methods that change either position or size of a Rect retu
=head2 ATTRIBUTES
-All Rect attributes are acessors, meaning you can get them by name, and set them by passing a value:
+All Rect attributes are accessors, meaning you can get them by name, and set them by passing a value:
$rect->left(15);
$rect->left; # 15
@@ -113,7 +113,7 @@ Same as C<<move>> above, but moves the current Rect in place and returns nothing
=head3 inflate(x, y)
-Grows or shrinks the rectangle. Returns a new Rect with the size changed by the given offset. The rectangle remains centered around its current center. Negative values will return a shrinked rectangle instead.
+Grows or shrinks the rectangle. Returns a new Rect with the size changed by the given offset. The rectangle remains centered around its current center. Negative values will return a shrunken rectangle instead.
=head3 inflate_ip(x, y)
View
32 lib/pods/SDLx/Sound.pod
@@ -24,15 +24,15 @@ Extension
# more sounds
my %files = (
- chanell_01 => "/my_sound1.wav",
- chanell_02 => "/my_sound2.ogg"
+ channel_01 => "/my_sound1.wav",
+ channel_02 => "/my_sound2.ogg"
);
# times sounds bangs
my %times = (
- chanell_01 => 0, # start
- chanell_01 => 1256, # miliseconds
- chanell_02 => 2345
+ channel_01 => 0, # start
+ channel_01 => 1256, # milliseconds
+ channel_02 => 2345
);
# Load files in channels for realtime play
@@ -43,17 +43,17 @@ Extension
$snd->play(%times); # play loaded files at times
$snd->play; # play again
- # plays sound channel_01 at 578 miliseconds from now
+ # plays sound channel_01 at 578 milliseconds from now
$snd->play('channel_01', 578);
# fades sound
$snd->fade('channel_02', 2345, 3456, -20);
- # in a single act do the wole Sound
+ # in a single act do the whole Sound
my $snd = SDLx::Sound->new(
files => (
- chanell_01 => "/my_sound1.wav",
- chanell_02 => "/my_sound2.ogg"
+ channel_01 => "/my_sound1.wav",
+ channel_02 => "/my_sound2.ogg"
),
loud => (
@@ -61,19 +61,19 @@ Extension
channel_02 => 75
),
times => (
- chanell_01 => 0, # start
- chanell_01 => 1256, # miliseconds
- chanell_02 => 2345
+ channel_01 => 0, # start
+ channel_01 => 1256, # milliseconds
+ channel_02 => 2345
),
fade => (
- chanell_02 => [2345, 3456, -20]
+ channel_02 => [2345, 3456, -20]
)
)->play();
=head1 DESCRIPTION
-You can think about the SDLx::Sound at 2 aproaches.
+You can think about the SDLx::Sound at 2 approaches.
=over 4
@@ -83,9 +83,9 @@ You can think about the SDLx::Sound at 2 aproaches.
=back
-Your application will say what the best aproach.
+Your application will say what the best approach.
-In a taste that resembles to perl and to SDL, our SDLx:Sound hooks at SDL::Audio and SDL::Mixer with a gracefull and simple interface that can offer to monks a modern perlish way to manage sounds.
+In a taste that resembles to perl and to SDL, our SDLx:Sound hooks at SDL::Audio and SDL::Mixer with a graceful and simple interface that can offer to monks a modern perlish way to manage sounds.
An SDLx::Sound object can load sounds from filesystem, play it, adjust this loudness level or stops the sound.
View
2  lib/pods/SDLx/Sprite.pod
@@ -105,7 +105,7 @@ Available options are:
=item * image => $filename
-Uses $filename as source image for the Sprite's surface. See suported
+Uses $filename as source image for the Sprite's surface. See supported
formats in L<< SDL::Image >>. This option B<cannot> be used together
with the 'surface' option (see below).
View
2  lib/pods/SDLx/Sprite/Animated.pod
@@ -43,7 +43,7 @@ Extension
# just like a regular Sprite, we fetch our source rect from ->clip,
# updating it on each call to ->next (or ->previous, or ->reset).
- # If source rects for your animation are further appart (or less)
+ # If source rects for your animation are further apart (or less)
# than the rect's width and height, you can adjust the animation
# x/y offsets:
$animation->step_x(15);
View
8 lib/pods/SDLx/Surface.pod
@@ -118,7 +118,7 @@ Returns the new Surface.
$sdlx_surface->blit( $dest, $src_rect, $dest_rect );
Blits C<SDLx::Surface> onto $dest surface.
-$src_rect or $dest_rect are optional. If $src_rect is ommited, it will be the size of the entire surface. If $dest_rect is ommited,
+$src_rect or $dest_rect are optional. If $src_rect is omitted, it will be the size of the entire surface. If $dest_rect is omitted,
it will be blitted at C<(0, 0)>. $src_rect or $dest_rect can be array refs or C<SDL::Rect>. $dest can be C<SDLx::Surface> or C<SDL::Surface>.
Note that the final blit rectangle is stored in $dest_rect after clipping is performed.
@@ -158,7 +158,7 @@ Returns $self
$sdlx_surface->draw_rect( [$x,$y,$w,$h], 0xFFFF00FF );
$sdlx_surface->draw_rect( SDL::Rect->new($x,$y,$w,$h), 0xFFFF00FF );
-Draws a rect on the surface with the given color. If the rect is ommited, the colored rect will be drawn to the entire surface.
+Draws a rect on the surface with the given color. If the rect is omitted, the colored rect will be drawn to the entire surface.
Returns $self
@@ -235,7 +235,7 @@ Returns $self
$sdlx_surface->draw_ellipse( [ $x, $y ], $rx, $ry, $color );
Draws an unfilled ellipse centered at C<($x,$y)> with horizontal radius $rx,
-vetical radius $ry and $color.
+vertical radius $ry and $color.
Antialias is turned on if $antialias is true.
Returns $self
@@ -245,7 +245,7 @@ Returns $self
$sdlx_surface->draw_ellipse_filled( [ $x, $y ], $rx, $ry, $color );
Draws an B<filled> ellipse centered at C<($x,$y)> with horizontal radius $rx,
-vetical radius $ry and $color.
+vertical radius $ry and $color.
Antialias is turned on automatically.
Returns $self
View
4 lib/pods/SDLx/Text.pod
@@ -147,7 +147,7 @@ Sets the font style to italic.
Sets the font style to underline.
-B<Note>: Due to libsdl design and depending on the chosen font, sometimes
+B<Note>: Due to libSDL design and depending on the chosen font, sometimes
the underline may be outside of the generated text surface, and thus not
visible when blitted to the screen. In these cases, you should probably turn
off the option and draw your own underlines in the target surface.
@@ -156,7 +156,7 @@ off the option and draw your own underlines in the target surface.
Sets the font style to strikethrough.
-B<Note>: Due to libsdl design and depending on the chosen font, sometimes
+B<Note>: Due to libSDL design and depending on the chosen font, sometimes
the strikethrough may be outside of the generated text surface, and thus not
visible when blitted to the screen. In these cases, you should probably turn
off the option and draw your own strikethroughs in the target surface.
Please sign in to comment.
Something went wrong with that request. Please try again.