Fix most of the screaming spelling errors in pods #225

Merged
merged 2 commits into from May 13, 2012
Jump to file
+121 −121
Split
View
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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;
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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.
@@ -92,15 +92,15 @@ 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
SDL::Mixer::Groups::hals_group( $group );
Halts the channels by the given group id.
-Retuns C<0>.
+Returns C<0>.
=head1 AUTHORS
@@ -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
Deleted file not rendered
View
@@ -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
@@ -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:
Oops, something went wrong.