mirror of
https://github.com/SFML/CSFML.git
synced 2026-10-24 13:53:36 +02:00
136 lines
4.9 KiB
C
136 lines
4.9 KiB
C
////////////////////////////////////////////////////////////
|
|
//
|
|
// SFML - Simple and Fast Multimedia Library
|
|
// Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
|
|
//
|
|
// This software is provided 'as-is', without any express or implied warranty.
|
|
// In no event will the authors be held liable for any damages arising from the use of this software.
|
|
//
|
|
// Permission is granted to anyone to use this software for any purpose,
|
|
// including commercial applications, and to alter it and redistribute it freely,
|
|
// subject to the following restrictions:
|
|
//
|
|
// 1. The origin of this software must not be misrepresented;
|
|
// you must not claim that you wrote the original software.
|
|
// If you use this software in a product, an acknowledgment
|
|
// in the product documentation would be appreciated but is not required.
|
|
//
|
|
// 2. Altered source versions must be plainly marked as such,
|
|
// and must not be misrepresented as being the original software.
|
|
//
|
|
// 3. This notice may not be removed or altered from any source distribution.
|
|
//
|
|
////////////////////////////////////////////////////////////
|
|
|
|
#ifndef SFML_COLOR_H
|
|
#define SFML_COLOR_H
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Headers
|
|
////////////////////////////////////////////////////////////
|
|
#include <SFML/Graphics/Export.h>
|
|
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Utility class for manpulating RGBA colors
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
typedef struct
|
|
{
|
|
sfUint8 r;
|
|
sfUint8 g;
|
|
sfUint8 b;
|
|
sfUint8 a;
|
|
} sfColor;
|
|
|
|
|
|
CSFML_GRAPHICS_API sfColor sfBlack; ///< Black predefined color
|
|
CSFML_GRAPHICS_API sfColor sfWhite; ///< White predefined color
|
|
CSFML_GRAPHICS_API sfColor sfRed; ///< Red predefined color
|
|
CSFML_GRAPHICS_API sfColor sfGreen; ///< Green predefined color
|
|
CSFML_GRAPHICS_API sfColor sfBlue; ///< Blue predefined color
|
|
CSFML_GRAPHICS_API sfColor sfYellow; ///< Yellow predefined color
|
|
CSFML_GRAPHICS_API sfColor sfMagenta; ///< Magenta predefined color
|
|
CSFML_GRAPHICS_API sfColor sfCyan; ///< Cyan predefined color
|
|
CSFML_GRAPHICS_API sfColor sfTransparent; ///< Transparent (black) predefined color
|
|
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Construct a color from its 3 RGB components
|
|
///
|
|
/// \param red Red component (0 .. 255)
|
|
/// \param green Green component (0 .. 255)
|
|
/// \param blue Blue component (0 .. 255)
|
|
///
|
|
/// \return sfColor constructed from the components
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_GRAPHICS_API sfColor sfColor_fromRGB(sfUint8 red, sfUint8 green, sfUint8 blue);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Construct a color from its 4 RGBA components
|
|
///
|
|
/// \param red Red component (0 .. 255)
|
|
/// \param green Green component (0 .. 255)
|
|
/// \param blue Blue component (0 .. 255)
|
|
/// \param alpha Alpha component (0 .. 255)
|
|
///
|
|
/// \return sfColor constructed from the components
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_GRAPHICS_API sfColor sfColor_fromRGBA(sfUint8 red, sfUint8 green, sfUint8 blue, sfUint8 alpha);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Construct the color from 32-bit unsigned integer
|
|
///
|
|
/// \param color Number containing the RGBA components (in that order)
|
|
///
|
|
/// \return sfColor constructed from the 32-bit unsigned integer
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_GRAPHICS_API sfColor sfColor_fromInteger(sfUint32 color);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Convert a color to a 32-bit unsigned integer
|
|
///
|
|
/// \return Color represented as a 32-bit unsigned integer
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_GRAPHICS_API sfUint32 sfColor_toInteger(sfColor color);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Add two colors
|
|
///
|
|
/// \param color1 First color
|
|
/// \param color2 Second color
|
|
///
|
|
/// \return Component-wise saturated addition of the two colors
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_GRAPHICS_API sfColor sfColor_add(sfColor color1, sfColor color2);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Subtract two colors
|
|
///
|
|
/// \param color1 First color
|
|
/// \param color2 Second color
|
|
///
|
|
/// \return Component-wise saturated subtraction of the two colors
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_GRAPHICS_API sfColor sfColor_subtract(sfColor color1, sfColor color2);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Modulate two colors
|
|
///
|
|
/// \param color1 First color
|
|
/// \param color2 Second color
|
|
///
|
|
/// \return Component-wise multiplication of the two colors
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_GRAPHICS_API sfColor sfColor_modulate(sfColor color1, sfColor color2);
|
|
|
|
|
|
#endif // SFML_COLOR_H
|