indirectCommandEncoder.h

//
// Copyright 2022 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HGI_INDIRECT_COMMAND_ENCODER_H
#define PXR_IMAGING_HGI_INDIRECT_COMMAND_ENCODER_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hgi/api.h"
#include "pxr/imaging/hgi/cmds.h"
#include "pxr/imaging/hgi/resourceBindings.h"
#include "pxr/imaging/hgi/graphicsPipeline.h"
 
#include <memory>
#include <stdint.h>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class Hgi;
class HgiComputeCmds;
class HgiGraphicsCmds;
 
struct HgiIndirectCommands
{
    HgiIndirectCommands(uint32_t drawCount,
                        HgiGraphicsPipelineHandle const &graphicsPipeline,
                        HgiResourceBindingsHandle const &resourceBindings)
        : drawCount(drawCount)
        , graphicsPipeline(graphicsPipeline)
        , resourceBindings(resourceBindings)
    {
    }
 
    virtual ~HgiIndirectCommands() = default;
 
    uint32_t drawCount;
    HgiGraphicsPipelineHandle graphicsPipeline;
    HgiResourceBindingsHandle resourceBindings;
};
 
using HgiIndirectCommandsUniquePtr = std::unique_ptr<HgiIndirectCommands>;
 
class HgiIndirectCommandEncoder : public HgiCmds
{
public:
    HGI_API
    ~HgiIndirectCommandEncoder() override;
    
    HGI_API
    virtual HgiIndirectCommandsUniquePtr EncodeDraw(
        HgiComputeCmds * computeCmds,
        HgiGraphicsPipelineHandle const& pipeline,
        HgiResourceBindingsHandle const& resourceBindings,
        HgiVertexBufferBindingVector const& vertexBindings,
        HgiBufferHandle const& drawParameterBuffer,
        uint32_t drawBufferByteOffset,
        uint32_t drawCount,
        uint32_t stride) = 0;
    
    HGI_API
    virtual HgiIndirectCommandsUniquePtr EncodeDrawIndexed(
        HgiComputeCmds * computeCmds,
        HgiGraphicsPipelineHandle const& pipeline,
        HgiResourceBindingsHandle const& resourceBindings,
        HgiVertexBufferBindingVector const& vertexBindings,
        HgiBufferHandle const& indexBuffer,
        HgiBufferHandle const& drawParameterBuffer,
        uint32_t drawBufferByteOffset,
        uint32_t drawCount,
        uint32_t stride,
        uint32_t patchBaseVertexByteOffset) = 0;
    
    HGI_API
    virtual void ExecuteDraw(
        HgiGraphicsCmds * gfxCmds,
        HgiIndirectCommands const* commands) = 0;
 
protected:
    HGI_API
    HgiIndirectCommandEncoder();
 
private:
    HgiIndirectCommandEncoder & operator=(const HgiIndirectCommandEncoder&) = delete;
    HgiIndirectCommandEncoder(const HgiIndirectCommandEncoder&) = delete;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif