gls_color.h

Go to the documentation of this file.

#ifndef _GLS_COLOR_H
#define _GLS_COLOR_H

/*! \file gls_color.h
\brief  This header defines a 4 component RGBA color for use in
        the GL Studio DO-178B Runtime Library.

\par Copyright Information
Copyright (C) 1999-2012 The DiSTI Corporation<br>
Orlando, FL USA<br>
All rights reserved.<br>

  This file is copyrighted software and contains proprietary trade secrets of
DiSTI, and embodies substantial creative efforts as well as confidential
information, ideas, and expressions.

  Permission to use, and copy this software and its documentation for any
purpose is hereby granted per the Distribution Agreement and/or the Licensing
Agreement signed with DiSTI. This permission is granted provided that:
    1.  The above copyright notice appears in all copies.
    2.  That both the copyright notice and this permission notice appear in
        the supporting documentation.
    3.  That the names DiSTI and GL Studio not be used in advertising or
        publicity pertaining to distribution of the software without specific,
        written prior permission of DiSTI.
 
  Permission to modify the software is granted, but not the right to
distribute the source code whether modified, or non-modified.  Modifying the
software might invalidate the DO-178B certification package.

  Permission to distribute binaries produced by compiling source code, or
modified source code is granted, provided you:
    1.  Provide your name and address as the primary contact for the support
        of your modified version.
    2.  Retain our contact information in regard to use of the base software. 

   DiSTI does not provide warranty for this software or guarantee that it
satisfies any specification or requirement unless otherwise stated in a
specific contractual arrangement between the customer and DiSTI.

*/

#include "gls_include.h"
#include "gls_types.h"

/** A 4 component RGBA color. */
struct GlsColor
{
    GlsUChar r;  /**< Red   0-255 range */
    GlsUChar g;  /**< Green 0-255 range */
    GlsUChar b;  /**< Blue, 0-255 range */
    GlsUChar a;  /**< Alpha 0-255 range */

    /** largest possible value for a color component */
    static const GlsUChar MAX_COMPONENT_VALUE = GLSUCHAR_MAX;

    #if defined( GLS_DEBUG )
        /** Determine if this color is valid
          * \return GLS_TRUE if valid else GLS_FALSE
          * \pre none
          * \post none
          */
        GlsBool IsValid( void ) const;
    #endif // GLS_DEBUG
};

#if defined( GLS_DEBUG )
#pragma BullseyeCoverage save off
/* Determine if this color is valid ( GLS_DEBUG only )
 * \return GLS_TRUE if valid else GLS_FALSE
 * \pre none
 * \post none
 */
inline GlsBool GlsColor::IsValid( void ) const
{
    // all values are valid
    return( GLS_TRUE );
}
#pragma BullseyeCoverage restore
#endif // GLS_DEBUG


#endif // _GLS_COLOR_H