DragonFly On-Line Manual Pages

Search: Section:  

SDLmm::ColorRGB(3)    DragonFly Library Functions Manual    SDLmm::ColorRGB(3)


NAME

       SDLmm::ColorRGB - A small usefull class representing an RGB color.


SYNOPSIS

       #include <sdlmm_color.h>

       Inherited by SDLmm::ColorRGBA.

   Public Methods
       ColorRGB ()
           Default constructor which creates an empty ColorRGB (rgb variables
           set to zero).
       ColorRGB (const ColorRGB &color)
           This is the copy constructor. Simply initializes the value of an
           ColorRGB to that of another ColorRGB.
       ColorRGB (Uint8 nr, Uint8 ng, Uint8 nb)
           Constructor which initializes the class from integer values.
       ColorRGB& operator= (const ColorRGB &color)
           Set the value of an ColorRGB to that of an existing ColorRGB.
       bool operator== (const ColorRGB &color) const
           Compare two colors for equality.

   Public Attributes
       Uint8 r
       Uint8 g
       Uint8 b


DETAILED DESCRIPTION

       A small usefull class representing an RGB color.

       Author:
           Adam Gates

CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
   SDLmm::ColorRGB::ColorRGB () [inline]
       Default constructor which creates an empty ColorRGB (rgb variables set
       to zero).

   SDLmm::ColorRGB::ColorRGB (const ColorRGB & color) [inline]
       This is the copy constructor. Simply initializes the value of an
       ColorRGB to that of another ColorRGB.

       Parameters:

       color  an existing ColorRGB object.

   SDLmm::ColorRGB::ColorRGB (Uint8 nr, Uint8 ng, Uint8 nb) [inline]
       Constructor which initializes the class from integer values.

       Parameters:

       nr, red
              component

       ng, green
              component

       nb, blue
              component


MEMBER FUNCTION DOCUMENTATION

   ColorRGB & SDLmm::ColorRGB::operator= (const ColorRGB & color) [inline]
       Set the value of an ColorRGB to that of an existing ColorRGB.

   bool SDLmm::ColorRGB::operator== (const ColorRGB & color) const [inline]
       Compare two colors for equality.

       Returns:
           true if coordinates are identical in both colors.


MEMBER DATA DOCUMENTATION

   Uint8 SDLmm::ColorRGB::b
   Uint8 SDLmm::ColorRGB::g
   Uint8 SDLmm::ColorRGB::r


AUTHOR

       Generated automatically by Doxygen for SDLmm from the source code.

SDLmm                             16 Jul 2001               SDLmm::ColorRGB(3)

Search: Section: