IUboProfile.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorShaders/phosphorshaders_export.h>
 
#include <QtGlobal>
 
#include <array>
#include <cstddef>
 
namespace PhosphorShaders {
 
struct UboUploadRegion
{
    int offset = 0;
    int size = 0;
};
 
class UboUploadRegionList
{
public:
    static constexpr int kCapacity = 4;
 
    void push(const UboUploadRegion& region)
    {
        // Debug-assert AND release-guard the same bound: a profile emitting
        // more than kCapacity regions is a programming error, and silently
        // dropping the overflow (worst case: one region skipped this frame)
        // beats writing out of bounds.
        Q_ASSERT(m_count < kCapacity);
        if (m_count < kCapacity) {
            m_regions[static_cast<size_t>(m_count++)] = region;
        }
    }
    int size() const
    {
        return m_count;
    }
    bool empty() const
    {
        return m_count == 0;
    }
    const UboUploadRegion& operator[](int i) const
    {
        // Match push()'s defensive style: assert the caller stays within the
        // populated range. Callers iterate [0, size()) via begin()/end(), so a
        // stray index is a programming error.
        Q_ASSERT(i >= 0 && i < m_count);
        return m_regions[static_cast<size_t>(i)];
    }
    const UboUploadRegion* begin() const
    {
        return m_regions.data();
    }
    const UboUploadRegion* end() const
    {
        return m_regions.data() + m_count;
    }
 
private:
    std::array<UboUploadRegion, kCapacity> m_regions{};
    int m_count = 0;
};
 
struct UboDirtyFlags
{
    bool time = false;
    bool timeHi = false;
    bool sceneData = false;
    bool appFields = false;
};
 
struct UboFrameState
{
    // ── Timing (overlay/animation) ─────────────────────────────────────
    float time = 0.0f;
    float timeHi = 0.0f;
    float timeDelta = 0.0f;
    int frame = 0;
 
    // ── Feedback-buffer state (drives iFrame override) ─────────────────
    bool bufferFeedback = false;
    bool bufferFeedbackCleared = false;
 
    // ── Resolution ─────────────────────────────────────────────────────
    float width = 0.0f;
    float height = 0.0f;
 
    // ── Mouse ──────────────────────────────────────────────────────────
    float mouseX = 0.0f;
    float mouseY = 0.0f;
 
    // ── Direction signal ───────────────────────────────────────────────
    bool isReversed = false;
 
    // ── iDate throttle gating ──────────────────────────────────────────
    bool didFullUploadOnce = false;
    bool sceneDataDirty = false;
 
    // ── Custom parameters / colors ─────────────────────────────────────
    float customParams[8][4] = {};
    float customColors[16][4] = {};
 
    // ── Resolved channel / texture sizes (node resolves live) ──────────
    float channelResolution[4][2] = {};
    float textureResolution[4][2] = {};
 
    // ── Audio ──────────────────────────────────────────────────────────
    int audioSpectrumSize = 0;
 
    // ── NDC Y orientation (per render target) ──────────────────────────
    bool yUpInNDC = false;
 
    // ── Surface-only fields (BaseUniformProfile ignores these) ─────────
    float qtOpacity = 1.0f;
    float surfaceScale = 1.0f;
    float surfaceFocused = 0.0f;
    float hasBackdrop = 0.0f;
    float surfaceSize[2] = {};
    float surfaceFrameTopLeft[2] = {};
    float surfaceFrameSize[2] = {};
    float backdropRect[4] = {0.0f, 0.0f, 1.0f, 1.0f};
};
 
class PHOSPHORSHADERS_EXPORT IUboProfile
{
public:
    virtual ~IUboProfile() = default;
 
    virtual int baseSize() const = 0;
 
    virtual const void* data() const = 0;
    virtual void* mutableData() = 0;
 
    virtual void fill(const UboFrameState& state) = 0;
 
    virtual UboUploadRegionList fullUploadRegions() const
    {
        UboUploadRegionList regions;
        regions.push(UboUploadRegion{0, baseSize()});
        return regions;
    }
 
    virtual UboUploadRegionList dirtyRegions(const UboDirtyFlags& flags) const = 0;
 
    virtual bool hasAppFields() const
    {
        return false;
    }
    virtual void setAppField0(int /*value*/)
    {
    }
    virtual void setAppField1(int /*value*/)
    {
    }
};
 
} // namespace PhosphorShaders