renderTask.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HDX_RENDER_TASK_H
#define PXR_IMAGING_HDX_RENDER_TASK_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hd/renderIndex.h"
#include "pxr/imaging/hdx/api.h"
#include "pxr/imaging/hdx/version.h"
#include "pxr/imaging/hdx/task.h"
#include "pxr/imaging/hdx/renderSetupTask.h"  // for short-term compatibility.
#include "pxr/imaging/hdSt/renderPassState.h"
 
#include <memory>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
class HdSceneDelegate;
struct HdxRenderTaskParams;
 
using HdRenderPassStateSharedPtr = std::shared_ptr<class HdRenderPassState>;
using HdRenderPassSharedPtr = std::shared_ptr<class HdRenderPass>;
using HdxRenderSetupTaskSharedPtr = std::shared_ptr<class HdxRenderSetupTask>;
 
class HdxRenderTask : public HdxTask
{
public:
    using TaskParams = HdxRenderTaskParams;
 
    HDX_API
    HdxRenderTask(HdSceneDelegate* delegate, SdfPath const& id);
 
    HDX_API
    ~HdxRenderTask() override;
 
    HDX_API
    bool IsConverged() const override;
 
    HDX_API
    void Prepare(HdTaskContext* ctx,
                 HdRenderIndex* renderIndex) override;
 
    HDX_API
    void Execute(HdTaskContext* ctx) override;
 
    HDX_API
    const TfTokenVector &GetRenderTags() const override;
 
protected:
    HDX_API
    void _Sync(HdSceneDelegate* delegate,
               HdTaskContext* ctx,
               HdDirtyBits* dirtyBits) override;
 
    HDX_API
    HdRenderPassStateSharedPtr _GetRenderPassState() const;
 
    HDX_API
    HdRenderPassSharedPtr _GetRenderPass() const;
 
    HDX_API
    void _PrepareRenderPassState(HdTaskContext* ctx,
                                 HdRenderIndex* renderIndex);
 
    // XXX: Storm specific API
    // While HdDrawItem is currently a core-Hydra concept, it'll be moved
    // to Storm. Until then, allow querying the render pass to know if there's
    // draw submission work.
    //
    // Returns whether the render pass has any draw items to submit.
    // For non-Storm backends, this returns true.
    // When using with Storm tasks, make sure to call it after
    // HdxRenderTask::Prepare().
    HDX_API
    bool _HasDrawItems() const;
 
    // XXX: Storm specific API
    // Binds the selection highlight buffers published by HdxSelectionTask onto
    // the given render pass shader.
    HDX_API
    void _AddStormSelectionBindings(
        HdTaskContext* ctx,
        HdStRenderPassShaderSharedPtr passShader);
 
    // XXX: Storm specific API
    // Binds the lighting shader published by HdxSimpleLightTask onto
    // the given render pass state.
    HDX_API
    void _AddStormLightingShader(
        HdTaskContext* ctx,
        HdStRenderPassStateSharedPtr passState);
 
private:
    HdRenderPassSharedPtr _pass;
    HdRenderPassStateSharedPtr _passState;
    TfTokenVector _renderTags;
 
    // Optional internal render setup task, for params unpacking.
    HdxRenderSetupTaskSharedPtr _setupTask;
 
    // XXX: Storm specific API
    // Setup additional state that HdStRenderPassState requires.
    void _SetHdStRenderPassState(HdTaskContext *ctx,
                                 HdStRenderPassState *renderPassState);
 
    // Inspect the AOV bindings to determine if any of them need to be cleared.
    bool _NeedToClearAovs(HdRenderPassStateSharedPtr const &renderPassState)
        const;
 
    HdxRenderTask() = delete;
    HdxRenderTask(const HdxRenderTask &) = delete;
    HdxRenderTask &operator =(const HdxRenderTask &) = delete;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif //PXR_IMAGING_HDX_RENDER_TASK_H