SDL::Video(3) User Contributed Perl Documentation SDL::Video(3)NAME
SDL::Video - a SDL perl extension
SYNOPSIS
$video = new SDL::Video ( -name => 'pr0n.mpg' );
DESCRIPTION
"SDL::Video" adds support for MPEG video to your SDL Perl application. Videos are objects bound to surfaces, whose playback is controled
through the object's interface.
METHODS
o "SDL::Video::error()" returns any error messages associated with playback
o "SDL::Video::audio(bool)" enables or disables audio playback, (on by default)
o "SDL::Video::video(bool)" enables or disable video playback, (on by default)
o "SDL::Video::loop(bool)" enables or disable playback looping (off by default)
o "SDL::Video::volume(int)" set the volume as per the mixer volume
o "SDL::Video:display(surface)" binds the clip to a display surface
o "SDL::Video::scale([x,y]|[surface]|int)" scales the clip by either x,y factors, scales to the image dimensions, or a single scalar.
o "SDL::Video::play()" plays the video clip, call "SDL::Video::display()" before playing
o "SDL::Video::pause()" pauses video playback
o "SDL::Video::stop()" stops video playback
o "SDL::Video::rewind()" resets the clip to the beginning
o "SDL::Video::seek(offset)" seeks to a particular byte offset
o "SDL::Video::skip(time)" skips to a particular time
o "SDL::Video::region(rect)" takes a SDL::Rect and defines the display area
o "SDL::Video::frame(int)" renders a specific frame to the screen
o "SDL::Video::info()" returns a new "SDL::MPEG" object reflecting the current status
o "SDL::Video::status()" returns either SMPEG_PLAYING or SMPEG_STOPPED or SMPEG_ERROR
AUTHOR
David J. Goehrig
SEE ALSO perl(1)SDL::Surface(3)SDL::MPEG(3)perl v5.12.1 2010-07-05 SDL::Video(3)
Check Out this Related Man Page
pods::SDL::Surface(3pm) User Contributed Perl Documentation pods::SDL::Surface(3pm)NAME
SDL::Surface - Graphic surface structure
CATEGORY
Core, Video, Structure
SYNOPSIS
use SDL;
use SDL::Video;
use SDL::Surface;
# Create the main surface (display)
SDL::init(SDL_INIT_VIDEO);
my $display = SDL::Video::set_video_mode(640, 480, 16, SDL_SWSURFACE);
# Create other surfaces attached to the $display.
my $surface = SDL::Surface->new(SDL_ASYNCBLIT | SDL_HWSURFACE, 640, 480, 16, 0, 0, 0, 0);
my $surface2 = SDL::Surface->new_from($surface, 100, 100, 8, 0, 0, 0, 0);
DESCRIPTION
An "SDL_Surface" defines a surfaceangular area of pixels.
CONSTANTS
The constants for SDL::Surface belong to SDL::Video, under the export tag of ':surface'.
SDL_ASYNCBLIT
Use asynchronous blit if possible
SDL_SWSURFACE
Store in system memory
SDL_HWSURFACE
Store in video memory
METHODS
new
my $surface = SDL::Surface->new(
$flags, $width, $height, $depth, $Rmask, $Gmask, $Bmask, $Amask
);
The constructor creates a new surface with the specified parameter values.
The four mask values are the bits that the channel will ignore. For example, an Rmask of 0xFF will ignore that channel completely, making
everything on the surface more green/blue.
new_from
my $surface = SDL::Surface->new_from(
$surface, $width, $height, $depth, $Rmask, $Gmask, $Bmask, $Amask
);
The constructor creates a new surface with the specified parameter values. The flags are taken from the specified $surface.
w
my $w = $surface->w;
Returns the width of the surface. SDL::Surface width is defined at construction so this is read-only.
h
my $h = $surface->h;
Returns the height of the surface. SDL::Surface height is defined at construction so this is read-only.
format
my $format = $surface->format;
The format of the pixels stored in the surface. See SDL::PixelFormat
pitch
my $pitch = $surface->pitch;
The scanline length in bytes.
Direct Write to Surface Pixel
Disclaimer: The following methods can be very slow, making them suitable for creating surfaces, but not for animations
get_pixel
my $pixel = $surface->get_pixel( $offset )
Returns the numeric pixel value for the given $offset. The pixel value depends on current pixel format.
Note: For surfaces with a palette (1 byte per pixel) the palette index is returned instead of color values.
set_pixels
$surface->set_pixels( $offset, $value );
Sets the pixel $value to the given $offset. The pixel value must fit the pixel format of the surface.
Note: For surfaces with a palette (1 byte per pixel) the palette index must be passed instead of color values.
Example:
sub putpixel {
my ($x, $y, $color) = @_;
$display->set_pixels( $x + $y * $display->w, $color);
}
See also examples/pixel_operations/sols/ch02.pl!
get_pixels_ptr
my $ptr = $surface->get_pixels_ptr;
Returns a reference to the surface's pixels.
SEE ALSO
SDL, SDL::PixelFormat, SDL::Video, SDL::Rect
AUTHORS
See "AUTHORS" in SDL.
perl v5.14.2 2012-05-28 pods::SDL::Surface(3pm)