rhi_compositor.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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://www.gnu.org/licenses/>.
 */
 
#ifndef RHI_COMPOSITOR_H
#define RHI_COMPOSITOR_H
 
#include <rhi/rhi_bind_group.h>
#include <rhi/rhi_handle.h>
 
#include <cstdint>
#include <functional>
#include <unordered_map>
#include <vector>
 
 
class RHI_DEVICE;
 

struct COMPOSITOR_LAYER
{
    RHI_FramebufferHandle fbo;
    float                 alpha = 1.0f;
    float                 uvScale[2] = { 1.0f, 1.0f };
    float                 uvOffset[2] = { 0.0f, 0.0f };
};
 

struct COMPOSITOR_PUSH_CONSTANTS
{
    float alpha = 1.0f;
    float _pad0 = 0.0f;
    float uvScale[2] = { 1.0f, 1.0f };
    float uvOffset[2] = { 0.0f, 0.0f };
};
 

class RHI_COMPOSITOR
{
public:
    RHI_COMPOSITOR( RHI_DEVICE& aDevice );
    ~RHI_COMPOSITOR();

    bool Initialize( RHI_BindGroupLayoutHandle aSingleTexLayout = {} );

    void Destroy();

    void SetCompositorPipeline( RHI_PipelineHandle aPipeline );

    RHI_FramebufferHandle Composite( RHI_FramebufferHandle aAccumulationFBO, uint32_t aWidth, uint32_t aHeight,
                                     const std::vector<COMPOSITOR_LAYER>& aLayers,
                                     const float* aBackgroundColor = nullptr,
                                     const std::function<void()>& aDrawOnTop = {} );
 
    RHI_BindGroupLayoutHandle GetSingleTexLayout() const { return m_singleTexLayout; }
    RHI_BufferHandle          GetQuadVB() const { return m_quadVB; }
 
    bool IsInitialized() const { return m_initialized; }

    void InvalidateCachedBindGroups() { destroyFBOBindGroups(); }
 
private:
    void compositeLayer( const COMPOSITOR_LAYER& aLayer );
 
    RHI_BindGroupHandle bindFBOTexture( RHI_FramebufferHandle aFBO,
                                        RHI_BindGroupLayoutHandle aLayout,
                                        uint32_t aGroupIndex );
 
    RHI_DEVICE& m_device;
 
    RHI_RenderPassHandle      m_clearRenderPass;
    RHI_BufferHandle          m_quadVB;
    RHI_BindGroupLayoutHandle m_singleTexLayout;
    bool                      m_ownsSingleTexLayout = true;
 
    RHI_PipelineHandle m_compositorPipeline;
 
    bool m_initialized = false;

    std::unordered_map<uint64_t, RHI_BindGroupHandle> m_fboBindGroups;
 
    void destroyFBOBindGroups();
};
 
 
#endif // RHI_COMPOSITOR_H