RenderStates.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 <SFML/Graphics/Export.hpp>
 
#include <SFML/Graphics/BlendMode.hpp>
#include <SFML/Graphics/CoordinateType.hpp>
#include <SFML/Graphics/StencilMode.hpp>
#include <SFML/Graphics/Transform.hpp>
 
 
namespace sf
{
class Shader;
class Texture;

struct SFML_GRAPHICS_API RenderStates
{
    RenderStates() = default;

    RenderStates(const BlendMode& theBlendMode);

    RenderStates(const StencilMode& theStencilMode);

    RenderStates(const Transform& theTransform);

    RenderStates(const Texture* theTexture);

    RenderStates(const Shader* theShader);

    RenderStates(const BlendMode&   theBlendMode,
                 const StencilMode& theStencilMode,
                 const Transform&   theTransform,
                 CoordinateType     theCoordinateType,
                 const Texture*     theTexture,
                 const Shader*      theShader);

    // Static member data
    // NOLINTNEXTLINE(readability-identifier-naming)
    static const RenderStates Default; 

    // Member data
    BlendMode      blendMode{BlendAlpha};                  
    StencilMode    stencilMode;                            
    Transform      transform;                              
    CoordinateType coordinateType{CoordinateType::Pixels}; 
    const Texture* texture{};                              
    const Shader*  shader{};                               
};
 
} // namespace sf