| Graphics-Color documentation | Contained in the Graphics-Color distribution. |
Graphics::Color::RGB - RGB color model
Graphics::Color::RGB represents a Color in the sRGB color space. Individual color channels are expressed as decimal values from 0 to 1, 0 being a lack of that color (or opaque in the case of alpha) and 1 being full color (or transparent in the case of alpha). If no options are provided then new instance of RGB are opaque white, (that is equivalent to red => 1, green => 1, blue => 1, alpha => 1).
Convenience methods are supplied to convert to various string values.
use Graphics::Color::RGB;
my $color = Graphics::Color::RGB->new({
red => 1,
blue => .31,
green => .25,
});
Creates a new Graphics::Color::RGB.
Compares this color to the provided one. Returns 1 if true, else 0;
The opposite of equal_to.
Set/Get the red component of this Color. Aliased to 'r' as well.
Set/Get the green component of this Color. Aliased to 'g' as well.
Set/Get the blue component of this Color. Aliased to 'b' as well.
Set/Get the alpha component of this Color. Aliased to 'a' as well.
Get the name of this color. Only valid if the color was created by name.
Get the RGB values as an array
Get the RGBA values as an array
Return a hex formatted value with a prepended '#' for use in CSS and HTML.
Return a hex formatted value for this color. The output ignores the alpha
channel because, per the W3C, there is no hexadecimal notiation for an RGBA
value. Optionally allows you to include a string that will be prepended. This
is a common way to add the #.
Return an integer formatted value for this color. This format is suitable for CSS RGBA values.
Return a percent formatted value for this color. This format is suitable for CSS RGBA values.
Get a string version of this Color in the form of RED,GREEN,BLUE,ALPHA
Attempts to retrieve the specified color-id using Color::Library. The result is then converted into a Graphics::Color::RGB object.
Attempts to create a Graphics::Color::RGB object from a hex string. Works with or without the leading # and with either 3 or 6 character hex strings.
Creates this RGB color in HSL space. Returns a Graphics::Color::HSL object.
Creates this RGB color in HSV space. Returns a Graphics::Color::HSV object.
Cory Watson, <gphat@cpan.org>
Copyright 2008 - 2009 by Cory G Watson
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
| Graphics-Color documentation | Contained in the Graphics-Color distribution. |
package Graphics::Color::RGB; use Moose; use MooseX::Aliases; extends qw(Graphics::Color); use Color::Library; use Graphics::Color::HSL; use Graphics::Color::HSV; use Graphics::Color::Types qw(NumberOneOrLess); has 'red' => ( is => 'rw', isa => NumberOneOrLess, default => 1, alias => 'r' ); has 'green' => ( is => 'rw', isa => NumberOneOrLess, default => 1, alias => 'g' ); has 'blue' => ( is => 'rw', isa => NumberOneOrLess, default => 1, alias => 'b' ); has 'alpha' => ( is => 'rw', isa => NumberOneOrLess, default => 1, alias => 'a' ); has 'name' => ( is => 'rw', isa => 'Str' ); sub as_string { my ($self) = @_; return sprintf('%0.2f,%0.2f,%0.2f,%0.2f', $self->red, $self->green, $self->blue, $self->alpha ); } sub as_integer_string { my ($self) = @_; return sprintf("%d, %d, %d, %0.2f", $self->red * 255, $self->green * 255, $self->blue * 255, $self->alpha ); } sub as_css_hex { my ($self) = @_; return $self->as_hex_string('#'); } sub as_hex_string { my ($self, $prepend) = @_; $prepend = '' unless defined($prepend); return sprintf('%s%.2x%.2x%.2x', $prepend, $self->red * 255, $self->green * 255, $self->blue * 255 ); } sub as_percent_string { my ($self) = @_; return sprintf("%d%%, %d%%, %d%%, %0.2f", $self->red * 100, $self->green * 100, $self->blue * 100, $self->alpha ); } sub as_array { my ($self) = @_; return ($self->red, $self->green, $self->blue); } sub as_array_with_alpha { my ($self) = @_; return ($self->red, $self->green, $self->blue, $self->alpha); } sub equal_to { my ($self, $other) = @_; return 0 unless defined($other); unless($self->red == $other->red) { return 0; } unless($self->green == $other->green) { return 0; } unless($self->blue == $other->blue) { return 0; } unless($self->alpha == $other->alpha) { return 0; } return 1; } sub from_color_library { my ($self, $id) = @_; my $color; if(ref($id)) { $color = $id; } else { $color = Color::Library->color($id); unless(defined($color)) { die("Couldn't find color for '$id'!"); } } my ($r, $g, $b) = $color->rgb; return Graphics::Color::RGB->new( red => $r / 255, green => $g / 255, blue => $b / 255 ); } sub from_hex_string { my ($self, $hex) = @_; # Get rid of the leading # if it's there $hex =~ s/^#//g; $hex = lc($hex); my $len = length($hex); if(length($hex) == 3) { $hex =~ /([a-f0-9])([a-f0-9])([a-f0-9])/; $hex = "$1$1$2$2$3$3"; } if(length($hex) == 6) { $hex =~ /([a-f0-9]{2})([a-f0-9]{2})([a-f0-9]{2})/; return Graphics::Color::RGB->new( red => hex($1) / 255, green => hex($2) / 255, blue => hex($3) / 255 ); } # Not a valid hex color return undef; } sub to_hsl { my ($self) = @_; my $max = $self->red; my $maxc = 'r'; my $min = $self->red; if($self->green > $max) { $max = $self->green; $maxc = 'g'; } if($self->blue > $max) { $max = $self->blue; $maxc = 'b'; } if($self->green < $min) { $min = $self->green; } if($self->blue < $min) { $min = $self->blue; } my ($h, $s, $l); if($max == $min) { $h = 0; } elsif($maxc eq 'r') { $h = 60 * (($self->green - $self->blue) / ($max - $min)) % 360; } elsif($maxc eq 'g') { $h = (60 * (($self->blue - $self->red) / ($max - $min)) + 120); } elsif($maxc eq 'b') { $h = (60 * (($self->red - $self->green) / ($max - $min)) + 240); } $l = ($max + $min) / 2; if($max == $min) { $s = 0; } elsif($l <= .5) { $s = ($max - $min) / ($max + $min); } else { $s = ($max - $min) / (2 - ($max + $min)); } return Graphics::Color::HSL->new( hue => $h, saturation => $s, lightness => $l, alpha => $self->alpha ); } sub to_hsv { my ($self) = @_; my $max = $self->red; my $maxc = 'r'; my $min = $self->red; if($self->green > $max) { $max = $self->green; $maxc = 'g'; } if($self->blue > $max) { $max = $self->blue; $maxc = 'b'; } if($self->green < $min) { $min = $self->green; } if($self->blue < $min) { $min = $self->blue; } my ($h, $s, $v); if($max == $min) { $h = 0; } elsif($maxc eq 'r') { $h = 60 * (($self->green - $self->blue) / ($max - $min)) % 360; } elsif($maxc eq 'g') { $h = (60 * (($self->blue - $self->red) / ($max - $min)) + 120); } elsif($maxc eq 'b') { $h = (60 * (($self->red - $self->green) / ($max - $min)) + 240); } $v = $max; if($max == 0) { $s = 0; } else { $s = 1 - ($min / $max); } return Graphics::Color::HSV->new( hue => $h, saturation => $s, value => $v, alpha => $self->alpha ); } __PACKAGE__->meta->make_immutable; no Moose; 1; __END__