DragonFly On-Line Manual Pages

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

NAME
       SDLmm::ColorRGBA - A small usefull class representing an RGBA color.

SYNOPSIS
       #include <sdlmm_color.h>

       Inherits SDLmm::ColorRGB.

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

   Public Attributes
       Uint8 a

DETAILED DESCRIPTION
       A small usefull class representing an RGBA color.

       Author:
           Adam Gates

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

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

       Parameters:

       color  an existing ColorRGBA object.

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

       Parameters:

       nr, red
              component

       ng, green
              component

       nb, blue
              component

       na, alpha
              component

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

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

       Returns:
           true if coordinates are identical in both colors.

MEMBER DATA DOCUMENTATION
   Uint8 SDLmm::ColorRGBA::a

AUTHOR
       Generated automatically by Doxygen for SDLmm from the source code.

SDLmm                             16 Jul 2001              SDLmm::ColorRGBA(3)