colobot/colobot-base/graphics/core/material.h

/*
 * This file is part of the Colobot: Gold Edition source code
 * Copyright (C) 2001-2023, Daniel Roux, EPSITEC SA & TerranovaTeam
 * http://epsitec.ch; http://colobot.info; http://github.com/colobot
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see http://gnu.org/licenses
 */

/**
 * \file graphics/core/material.h
 * \brief Material struct
 */

#pragma once


#include "graphics/core/color.h"
#include "graphics/core/transparency.h"


// Graphics module namespace
namespace Gfx
{

/**
 * \enum CullFace
 * \brief Specifies which faces to cull while rendering polygons
 */
enum class CullFace : unsigned char
{
    NONE,
    BACK,
    FRONT,
    BOTH,
};

//! PBR material
struct Material
{
    //! Albedo color
    Color albedoColor = Color{ 1.0f, 1.0f, 1.0f, 1.0f };
    //! Albedo texture
    std::string albedoTexture = "";
    //! Roughness
    float roughness = 1.0;
    //! Metalness
    float metalness = 0.0;
    //! AO strength
    float aoStrength = 0.0;
    //! AO-roughness-metalness texture
    std::string materialTexture = "";
    //! Emissive color
    Color emissiveColor = Color{ 0.0f, 0.0f, 0.0f, 0.0f };
    //! Emissive texture
    std::string emissiveTexture = "";
    //! Normal map
    std::string normalTexture = "";
    //! Alpha mode
    AlphaMode alphaMode = AlphaMode::NONE;
    //! Alpha threshold
    float alphaThreshold = 0.5;
    // Cull face
    CullFace cullFace = CullFace::BACK;
    // Special tag
    std::string tag = "";
    // Recolor name
    std::string recolor = "";
    // Recolor reference color
    Color recolorReference = { 0.0f, 0.0f, 0.0f, 0.0f };

    // Legacy functionality
    //! Variable detail texture
    bool variableDetail = false;
    //! Detail texture
    std::string detailTexture = "";

    bool operator==(const Material& other) const
    {
        return albedoColor == other.albedoColor
            && albedoTexture == other.albedoTexture
            && roughness == other.roughness
            && metalness == other.metalness
            && materialTexture == other.materialTexture
            && emissiveColor == other.emissiveColor
            && emissiveTexture == other.emissiveTexture
            && normalTexture == other.normalTexture
            && alphaMode == other.alphaMode
            && alphaThreshold == other.alphaThreshold
            && cullFace == other.cullFace
            && tag == other.tag
            && recolor == other.recolor
            && recolorReference == other.recolorReference
            && variableDetail == other.variableDetail
            && detailTexture == other.detailTexture;
    }

    bool operator!=(const Material& other) const
    {
        return !operator==(other);
    }
};

} // namespace Gfx