Color.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 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.
//
 
#pragma once

// Headers
#include <cstdint>
 
 
namespace sf
{
class Color
{
public:
    constexpr Color() = default;

    constexpr Color(std::uint8_t red, std::uint8_t green, std::uint8_t blue, std::uint8_t alpha = 255);

    constexpr explicit Color(std::uint32_t color);

    [[nodiscard]] constexpr std::uint32_t toInteger() const;

    // Static member data
    // NOLINTBEGIN(readability-identifier-naming)
    static const Color Black;       
    static const Color White;       
    static const Color Red;         
    static const Color Green;       
    static const Color Blue;        
    static const Color Yellow;      
    static const Color Magenta;     
    static const Color Cyan;        
    static const Color Transparent; 
    // NOLINTEND(readability-identifier-naming)

    // Member data
    std::uint8_t r{};    
    std::uint8_t g{};    
    std::uint8_t b{};    
    std::uint8_t a{255}; 
};

[[nodiscard]] constexpr bool operator==(Color left, Color right);

[[nodiscard]] constexpr bool operator!=(Color left, Color right);

[[nodiscard]] constexpr Color operator+(Color left, Color right);

[[nodiscard]] constexpr Color operator-(Color left, Color right);

[[nodiscard]] constexpr Color operator*(Color left, Color right);

constexpr Color& operator+=(Color& left, Color right);

constexpr Color& operator-=(Color& left, Color right);

constexpr Color& operator*=(Color& left, Color right);
 
} // namespace sf
 
#include <SFML/Graphics/Color.inl>