Cory Watson > Graphics-Color > Graphics::Color::RGB

Download:
Graphics-Color-0.25.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View Bugs
Report a bug
Source  

NAME ^

Graphics::Color::RGB - RGB color model

DESCRIPTION ^

Graphics::Color::RGB represents a Color in the sRGB color space. Individual color channels are expressed as decimal values from 0 to 1. Convenience methods are supplied to convert to various string values.

SYNOPSIS ^

    use Graphics::Color::RGB;

    my $color = Graphics::Color::RGB->new({
        red     => 1,
        blue    => .31,
        green   => .25,
    });

CONSTRUCTOR ^

Graphics::Color::RGB->new(%options)

Creates a new Graphics::Color::RGB.

METHODS ^

equal_to

Compares this color to the provided one. Returns 1 if true, else 0;

not_equal_to

The opposite of equal_to.

red

r

Set/Get the red component of this Color. Aliased to 'r' as well.

green

g

Set/Get the green component of this Color. Aliased to 'g' as well.

blue

b

Set/Get the blue component of this Color. Aliased to 'b' as well.

alpha

a

Set/Get the alpha component of this Color. Aliased to 'a' as well.

name

Get the name of this color. Only valid if the color was created by name.

as_array

Get the RGB values as an array

as_array_with_alpha

Get the RGBA values as an array

as_css_hex

Return a hex formatted value with a prepended '#' for use in CSS and HTML.

as_hex_string ( [$prepend] )

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 #.

as_integer_string

Return an integer formatted value for this color. This format is suitable for CSS RGBA values.

as_percent_string

Return a percent formatted value for this color. This format is suitable for CSS RGBA values.

as_string

Get a string version of this Color in the form of RED,GREEN,BLUE,ALPHA

from_color_library(color-id)

Attempts to retrieve the specified color-id using Color::Library. The result is then converted into a Graphics::Color::RGB object.

to_hsl

Creates this RGB color in HSL space. Returns a Graphics::Color::HSL object.

to_hsv

Creates this RGB color in HSV space. Returns a Graphics::Color::HSV object.

AUTHOR ^

Cory Watson, <gphat@cpan.org>

SEE ALSO ^

perl(1), http://en.wikipedia.org/wiki/RGB_color_space

COPYRIGHT & LICENSE ^

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.