Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Graphics::Color::RGB(3User Contributed Perl DocumentatiGraphics::Color::RGB(3)

NAME
       Graphics::Color::RGB - RGB color	model

VERSION
       version 0.31

SYNOPSIS
	   use Graphics::Color::RGB;

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

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

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

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

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

   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_percent_string
       Return a	percent	formatted value	for this color.	 This format is
       suitable	for CSS	RGBA values.

   as_array
       Get the RGB values as an	array.

   as_array_with_alpha
       Get the RGBA values as an array

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

   not_equal_to
       The opposite of equal_to.

   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.

   from_hex_string($hex)
       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.

   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 G Watson <gphat@cpan.org>

COPYRIGHT AND LICENSE
       This software is	copyright (c) 2014 by Cold Hard	Code, LLC.

       This is free software; you can redistribute it and/or modify it under
       the same	terms as the Perl 5 programming	language system	itself.

perl v5.32.0			  2014-12-09	       Graphics::Color::RGB(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | ATTRIBUTES | METHODS | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Graphics::Color::RGB&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help