drawTarget.h

//
// Copyright 2017 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_ST_DRAW_TARGET_H
#define PXR_IMAGING_HD_ST_DRAW_TARGET_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hdSt/api.h"
#include "pxr/imaging/hdSt/drawTargetRenderPassState.h"
#include "pxr/imaging/hd/rprimCollection.h"
#include "pxr/imaging/hd/sprim.h"
 
#include "pxr/usd/sdf/path.h"
#include "pxr/base/gf/vec2i.h"
#include "pxr/base/tf/staticTokens.h"
 
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
#define HDST_DRAW_TARGET_TOKENS                 \
    (camera)                                    \
    (collection)                                \
    (enable)                                    \
    (resolution)                                \
    (aovBindings)                               \
    (depthPriority)
 
TF_DECLARE_PUBLIC_TOKENS(HdStDrawTargetTokens, HDST_API, HDST_DRAW_TARGET_TOKENS);
 
class HdCamera;
class HdRenderIndex;
using HdStDrawTargetPtrVector = std::vector<class HdStDrawTarget *>;
 
class HdStDrawTarget : public HdSprim
{
public:
    HDST_API
    HdStDrawTarget(SdfPath const & id);
    HDST_API
    ~HdStDrawTarget() override;
 
    enum DirtyBits : HdDirtyBits {
        Clean                   = 0,
        DirtyDTEnable           = 1 <<  0,
        DirtyDTCamera           = 1 <<  1,
        DirtyDTResolution       = 1 <<  2,
        DirtyDTAovBindings      = 1 <<  4,
        DirtyDTDepthPriority    = 1 <<  6,
        DirtyDTCollection       = 1 <<  7,
        AllDirty                = (DirtyDTEnable
                                   |DirtyDTCamera
                                   |DirtyDTResolution
                                   |DirtyDTAovBindings
                                   |DirtyDTDepthPriority
                                   |DirtyDTCollection)
    };
 
    HDST_API
    void Sync(HdSceneDelegate *sceneDelegate,
              HdRenderParam   *renderParam,
              HdDirtyBits     *dirtyBits) override;
    
    HDST_API
    HdDirtyBits GetInitialDirtyBitsMask() const override;
 
 
    // ---------------------------------------------------------------------- //
    // ---------------------------------------------------------------------- //
    bool                       IsEnabled()        const { return  _enabled;    }
    const HdStDrawTargetRenderPassState *GetDrawTargetRenderPassState() const
    {
        return &_drawTargetRenderPassState;
    }
 
    HDST_API
    HdRprimCollection const &GetCollection() const { return _collection; }
 
    HDST_API
    static void GetDrawTargets(HdRenderIndex* renderIndex,
                               HdStDrawTargetPtrVector *drawTargets);
 
    const GfVec2i &GetResolution() const {
        return _resolution;
    }
 
    void Finalize(HdRenderParam *) override;
    
private:
    bool                    _enabled;
    GfVec2i                 _resolution;
    HdRprimCollection       _collection;
 
    HdStDrawTargetRenderPassState _drawTargetRenderPassState;
 
    // No copy
    HdStDrawTarget()                                   = delete;
    HdStDrawTarget(const HdStDrawTarget &)             = delete;
    HdStDrawTarget &operator =(const HdStDrawTarget &) = delete;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif  // PXR_IMAGING_HD_ST_DRAW_TARGET_H