renderPass.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_RENDER_PASS_H
#define PXR_IMAGING_HD_RENDER_PASS_H

#include "pxr/pxr.h"
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/version.h"
#include "pxr/imaging/hd/rprimCollection.h"
#include "pxr/imaging/hd/task.h"

#include <memory>

PXR_NAMESPACE_OPEN_SCOPE

class HdRenderIndex;
class HdSceneDelegate;

using HdRenderPassSharedPtr = std::shared_ptr<class HdRenderPass>;
using HdRenderPassStateSharedPtr = std::shared_ptr<class HdRenderPassState>;

class HdRenderPass 
{
public:
    HD_API
    HdRenderPass(HdRenderIndex *index, HdRprimCollection const& collection);
    HD_API
    virtual ~HdRenderPass();

    HdRprimCollection const& GetRprimCollection() const { return _collection; }

    HD_API
    void SetRprimCollection(HdRprimCollection const& col);

    HdRenderIndex* GetRenderIndex() const { return _renderIndex; }

    // ---------------------------------------------------------------------- //
    // ---------------------------------------------------------------------- //

    HD_API
    void Sync();

    // ---------------------------------------------------------------------- //
    // ---------------------------------------------------------------------- //

    HD_API
    void Execute(HdRenderPassStateSharedPtr const &renderPassState,
                 TfTokenVector const &renderTags);

    // ---------------------------------------------------------------------- //
    // ---------------------------------------------------------------------- //

    virtual bool IsConverged() const { return true; }

protected:
    virtual void _Execute(HdRenderPassStateSharedPtr const &renderPassState,
                         TfTokenVector const &renderTags) = 0;

    virtual void _MarkCollectionDirty() {}

    virtual void _Sync() {}

private:

    // Don't allow copies
    HdRenderPass(const HdRenderPass &) = delete;
    HdRenderPass &operator=(const HdRenderPass &) = delete;

    // ---------------------------------------------------------------------- //
    // \name Change Tracking State
    // ---------------------------------------------------------------------- //
    // The renderIndex to which this renderPass belongs
    // (can't change after construction)
    HdRenderIndex * const _renderIndex;

    // ---------------------------------------------------------------------- //
    // \name Core RenderPass State
    // ---------------------------------------------------------------------- //
    HdRprimCollection _collection;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif //PXR_IMAGING_HD_RENDER_PASS_H