Split out SDL_Color into its own C-level class

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

package SDL::Color;
use strict;
use warnings;
use Carp;
require Exporter;
require DynaLoader;
our @ISA = qw(Exporter DynaLoader);
bootstrap SDL::Color;

1;

__END__

=pod

=head1 NAME

SDL::Color - Format independent color description

=head1 SYNOPSIS

  my $black = SDL::Color->new( 0, 0, 0);
  my $color = SDL::Color->new(255, 0, 0);
  my $r = $color->r; # 255
  my $g = $color->g; # 0
  my $b = $color->b; # 0
  $color->g(255);
  $color->b(255);
  # $color is now white

=head1 DESCRIPTION

C<SDL_Color> describes a color in a format independent way.

=head1 METHODS

=head2 new ( $r, $g, $b )

The constructor creates a new color with the specified red, green and
blue values:

  my $color = SDL::Color->new(255, 0, 0);

=head2 r

If passed a value, this method sets the red component of the color;
if not, it returns the red component of the color:

  my $r = $color->r; # 255
  $color->r(128);

=head2 g

If passed a value, this method sets the green component of the color;
if not, it returns the green component of the color:

  my $g = $color->g; # 255
  $color->g(128);

=head2 b

If passed a value, this method sets the blue component of the color;
if not, it returns the blue component of the color:

  my $b = $color->b; # 255
  $color->b(128);

=head1 SEE ALSO

L<SDL::Surface>

=cut