Color.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/Color.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_Color_h
#define __PCL_Color_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Math.h>
#include <pcl/String.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
using RGBA = uint32;
 
inline uint8 Alpha( RGBA rgba )
{
   return uint8( rgba >> 24 );
}
 
inline uint8 Red( RGBA rgba )
{
   return uint8( rgba >> 16 );
}
 
inline uint8 Green( RGBA rgba )
{
   return uint8( rgba >> 8 );
}
 
inline uint8 Blue( RGBA rgba )
{
   return uint8( rgba );
}
 
inline void ClearAlpha( RGBA& rgba )
{
   rgba &= 0x00fffffful;
}
 
inline void ClearRed( RGBA& rgba )
{
   rgba &= 0xff00fffful;
}
 
inline void ClearGreen( RGBA& rgba )
{
   rgba &= 0xffff00fful;
}
 
inline void ClearBlue( RGBA& rgba )
{
   rgba &= 0xffffff00ul;
}
 
inline void SetAlpha( RGBA& rgba, uint8 a )
{
   ClearAlpha( rgba ); rgba |= uint32( a ) << 24;
}
 
inline void SetRed( RGBA& rgba, uint8 r )
{
   ClearRed( rgba ); rgba |= uint32( r ) << 16;
}
 
inline void SetGreen( RGBA& rgba, uint8 g )
{
   ClearGreen( rgba ); rgba |= uint32( g ) << 8;
}
 
inline void SetBlue( RGBA& rgba, uint8 b )
{
   ClearBlue( rgba ); rgba |= uint32( b );
}
 
inline RGBA RGBAColor( int r, int g, int b, int a )
{
   return (uint32( a ) << 24) | (uint32( r ) << 16) | (uint32( g ) << 8) | uint32( b );
}
 
inline RGBA RGBAColor( int r, int g, int b )
{
   return 0xff000000ul | (uint32( r ) << 16) | (uint32( g ) << 8) | uint32( b );
}
 
inline RGBA RGBAColor( double r, double g, double b, double a )
{
   return RGBAColor( RoundInt( 255*r ), RoundInt( 255*g ), RoundInt( 255*b ), RoundInt( 255*a ) );
}
 
inline RGBA RGBAColor( float r, float g, float b, float a )
{
   return RGBAColor( double( r ), double( g ), double( b ), double( a ) );
}
 
inline RGBA RGBAColor( double r, double g, double b )
{
   return RGBAColor( RoundInt( 255*r ), RoundInt( 255*g ), RoundInt( 255*b ) );
}
 
inline RGBA RGBAColor( float r, float g, float b )
{
   return RGBAColor( double( r ), double( g ), double( b ) );
}
 
RGBA PCL_FUNC RGBAColor( const IsoString& colorNameOrHex );
 
inline RGBA RGBAColor( const IsoString::ustring_base& colorNameOrHex )
{
   return RGBAColor( IsoString( colorNameOrHex ) );
}
 
inline RGBA StringToRGBAColor( const IsoString& colorNameOrHex )
{
   return RGBAColor( colorNameOrHex );
}
 
inline RGBA StringToRGBAColor( const IsoString::ustring_base& colorNameOrHex )
{
   return StringToRGBAColor( IsoString( colorNameOrHex ) );
}
 
inline IsoString RGBColorToHexString( RGBA c )
{
   IsoString s;
   s.Format( "#%02X%02X%02X", Red( c ), Green( c ), Blue( c ) );
   return s;
}
 
inline IsoString RGBAColorToHexString( RGBA c )
{
   IsoString s;
   s.Format( "#%02X%02X%02X%02X", Red( c ), Green( c ), Blue( c ), Alpha( c ) );
   return s;
}
 
IsoString PCL_FUNC CSSColorName( RGBA );
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_Color_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Color.h - Released 2024-06-18T15:48:54Z