[sdlgit/SDL_perl.git] / lib / SDL / Palette.pm

#!perl
package SDL::Palette;
use strict;
use warnings;
require Exporter;
require DynaLoader;
our @ISA = qw(Exporter DynaLoader);
bootstrap SDL::Palette;

1;

__END__

=pod

=head1 NAME

SDL::Palette - a perl extension

=head1 DESCRIPTION

L<SDL::Palette> provides an interface to the C<SDL_Palette> structures,
and can be used to set the color values of an existing palette's indexes.

=head1 METHODS

=head2 ncolors ( )

Fetches the number of colors in palette

=head2 colors ( index )

Fetches an array of colors in palette

=head2 color_index ( index )

Fetches the SDL_Color at the provide index in palette

=head2 size

Returns the size of the palette.


=head1 SEE ALSO

L<SDL::Color> L<SDL::Surface>

=cut
Commit	Line	Data
60891a9e	1	#!perl
bfd90409	2	package SDL::Palette;
bfd90409	3	use strict;
084b921f	4	use warnings;
60891a9e	5	require Exporter;
	6	require DynaLoader;
	7	our @ISA = qw(Exporter DynaLoader);
	8	bootstrap SDL::Palette;
bfd90409	9
	10	1;
	11
60891a9e	12	__END__
bfd90409	13
	14	=pod
	15
	16	=head1 NAME
	17
	18	SDL::Palette - a perl extension
	19
	20	=head1 DESCRIPTION
	21
60891a9e	22	L<SDL::Palette> provides an interface to the C<SDL_Palette> structures,
bfd90409	23	and can be used to set the color values of an existing palette's indexes.
	24
	25	=head1 METHODS
	26
60891a9e	27	=head2 ncolors ( )
bfd90409	28
60891a9e	29	Fetches the number of colors in palette
bfd90409	30
60891a9e	31	=head2 colors ( index )
bfd90409	32
60891a9e	33	Fetches an array of colors in palette
bfd90409	34
60891a9e	35	=head2 color_index ( index )
bfd90409	36
60891a9e	37	Fetches the SDL_Color at the provide index in palette
bfd90409	38
	39	=head2 size
	40
	41	Returns the size of the palette.
	42
bfd90409	43
	44	=head1 SEE ALSO
	45
60891a9e	46	L<SDL::Color> L<SDL::Surface>
bfd90409	47
bfd90409	48	=cut