yuzu/src/video_core/renderer_opengl/gl_state_tracker.h

// SPDX-FileCopyrightText: Copyright 2019 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later

#pragma once

#include <limits>

#include <glad/glad.h>

#include "common/common_types.h"
#include "video_core/dirty_flags.h"
#include "video_core/engines/maxwell_3d.h"

namespace Tegra {
namespace Control {
struct ChannelState;
}
} // namespace Tegra

namespace OpenGL {

namespace Dirty {

enum : u8 {
    First = VideoCommon::Dirty::LastCommonEntry,

    VertexFormats,
    VertexFormat0,
    VertexFormat31 = VertexFormat0 + 31,

    VertexInstances,
    VertexInstance0,
    VertexInstance31 = VertexInstance0 + 31,

    ViewportTransform,
    Viewports,
    Viewport0,
    Viewport15 = Viewport0 + 15,

    Scissors,
    Scissor0,
    Scissor15 = Scissor0 + 15,

    ColorMaskCommon,
    ColorMasks,
    ColorMask0,
    ColorMask7 = ColorMask0 + 7,

    BlendColor,
    BlendIndependentEnabled,
    BlendStates,
    BlendState0,
    BlendState7 = BlendState0 + 7,

    ClipDistances,

    PolygonModes,
    PolygonModeFront,
    PolygonModeBack,

    ColorMask,
    FrontFace,
    CullTest,
    DepthMask,
    DepthTest,
    StencilTest,
    AlphaTest,
    PrimitiveRestart,
    PolygonOffset,
    MultisampleControl,
    RasterizeEnable,
    FramebufferSRGB,
    LogicOp,
    FragmentClampColor,
    PointSize,
    LineWidth,
    ClipControl,
    DepthClampEnabled,

    Last
};
static_assert(Last <= std::numeric_limits<u8>::max());

} // namespace Dirty

class StateTracker {
public:
    explicit StateTracker();

    void BindIndexBuffer(GLuint new_index_buffer) {
        if (index_buffer == new_index_buffer) {
            return;
        }
        index_buffer = new_index_buffer;
        glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, new_index_buffer);
    }

    void BindFramebuffer(GLuint new_framebuffer) {
        if (framebuffer == new_framebuffer) {
            return;
        }
        framebuffer = new_framebuffer;
        glBindFramebuffer(GL_DRAW_FRAMEBUFFER, framebuffer);
    }

    void ClipControl(GLenum new_origin, GLenum new_depth) {
        if (new_origin == origin && new_depth == depth) {
            return;
        }
        origin = new_origin;
        depth = new_depth;
        glClipControl(origin, depth);
    }

    void SetYNegate(bool new_y_negate) {
        if (new_y_negate == y_negate) {
            return;
        }
        // Y_NEGATE is mapped to gl_FrontMaterial.ambient.a
        y_negate = new_y_negate;
        const std::array ambient{0.0f, 0.0f, 0.0f, y_negate ? -1.0f : 1.0f};
        glMaterialfv(GL_FRONT, GL_AMBIENT, ambient.data());
    }

    void NotifyScreenDrawVertexArray() {
        (*flags)[OpenGL::Dirty::VertexFormats] = true;
        (*flags)[OpenGL::Dirty::VertexFormat0 + 0] = true;
        (*flags)[OpenGL::Dirty::VertexFormat0 + 1] = true;

        (*flags)[VideoCommon::Dirty::VertexBuffers] = true;
        (*flags)[VideoCommon::Dirty::VertexBuffer0] = true;

        (*flags)[OpenGL::Dirty::VertexInstances] = true;
        (*flags)[OpenGL::Dirty::VertexInstance0 + 0] = true;
        (*flags)[OpenGL::Dirty::VertexInstance0 + 1] = true;
    }

    void NotifyPolygonModes() {
        (*flags)[OpenGL::Dirty::PolygonModes] = true;
        (*flags)[OpenGL::Dirty::PolygonModeFront] = true;
        (*flags)[OpenGL::Dirty::PolygonModeBack] = true;
    }

    void NotifyViewport0() {
        (*flags)[OpenGL::Dirty::Viewports] = true;
        (*flags)[OpenGL::Dirty::Viewport0] = true;
    }

    void NotifyScissor0() {
        (*flags)[OpenGL::Dirty::Scissors] = true;
        (*flags)[OpenGL::Dirty::Scissor0] = true;
    }

    void NotifyColorMask(size_t index) {
        (*flags)[OpenGL::Dirty::ColorMasks] = true;
        (*flags)[OpenGL::Dirty::ColorMask0 + index] = true;
    }

    void NotifyBlend0() {
        (*flags)[OpenGL::Dirty::BlendStates] = true;
        (*flags)[OpenGL::Dirty::BlendState0] = true;
    }

    void NotifyFramebuffer() {
        (*flags)[VideoCommon::Dirty::RenderTargets] = true;
    }

    void NotifyFrontFace() {
        (*flags)[OpenGL::Dirty::FrontFace] = true;
    }

    void NotifyCullTest() {
        (*flags)[OpenGL::Dirty::CullTest] = true;
    }

    void NotifyDepthMask() {
        (*flags)[OpenGL::Dirty::DepthMask] = true;
    }

    void NotifyDepthTest() {
        (*flags)[OpenGL::Dirty::DepthTest] = true;
    }

    void NotifyStencilTest() {
        (*flags)[OpenGL::Dirty::StencilTest] = true;
    }

    void NotifyPolygonOffset() {
        (*flags)[OpenGL::Dirty::PolygonOffset] = true;
    }

    void NotifyRasterizeEnable() {
        (*flags)[OpenGL::Dirty::RasterizeEnable] = true;
    }

    void NotifyFramebufferSRGB() {
        (*flags)[OpenGL::Dirty::FramebufferSRGB] = true;
    }

    void NotifyLogicOp() {
        (*flags)[OpenGL::Dirty::LogicOp] = true;
    }

    void NotifyClipControl() {
        (*flags)[OpenGL::Dirty::ClipControl] = true;
    }

    void NotifyAlphaTest() {
        (*flags)[OpenGL::Dirty::AlphaTest] = true;
    }

    void NotifyRange(u8 start, u8 end) {
        for (auto flag = start; flag <= end; flag++) {
            (*flags)[flag] = true;
        }
    }

    void SetupTables(Tegra::Control::ChannelState& channel_state);

    void ChangeChannel(Tegra::Control::ChannelState& channel_state);

    void InvalidateState();

private:
    Tegra::Engines::Maxwell3D::DirtyState::Flags* flags;
    Tegra::Engines::Maxwell3D::DirtyState::Flags default_flags{};

    GLuint framebuffer = 0;
    GLuint index_buffer = 0;
    GLenum origin = GL_LOWER_LEFT;
    GLenum depth = GL_NEGATIVE_ONE_TO_ONE;
    bool y_negate = false;
};

} // namespace OpenGL