computeCmds.h

//
// Copyright 2020 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HGI_COMPUTE_CMDS_H
#define PXR_IMAGING_HGI_COMPUTE_CMDS_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hgi/api.h"
#include "pxr/imaging/hgi/computePipeline.h"
#include "pxr/imaging/hgi/resourceBindings.h"
#include "pxr/imaging/hgi/cmds.h"
#include <memory>
 
PXR_NAMESPACE_OPEN_SCOPE
 
using HgiComputeCmdsUniquePtr = std::unique_ptr<class HgiComputeCmds>;
 
 
class HgiComputeCmds : public HgiCmds
{
public:
    HGI_API
    ~HgiComputeCmds() override;
 
    HGI_API
    virtual void PushDebugGroup(const char* label,
        const GfVec4f& color = s_computeDebugColor) = 0;
 
    HGI_API
    virtual void PopDebugGroup() = 0;
 
    HGI_API
    virtual void InsertDebugMarker(
        const char* label,
        const GfVec4f& color = s_markerDebugColor) = 0;
 
    HGI_API
    virtual void BindPipeline(HgiComputePipelineHandle pipeline) = 0;
 
    HGI_API
    virtual void BindResources(HgiResourceBindingsHandle resources) = 0;
 
    HGI_API
    virtual void SetConstantValues(
        HgiComputePipelineHandle pipeline,
        uint32_t bindIndex,
        uint32_t byteSize,
        const void* data) = 0;
 
    HGI_API
    virtual void Dispatch(int dimX, int dimY) = 0;
 
    HGI_API
    virtual void InsertMemoryBarrier(HgiMemoryBarrier barrier) = 0;
 
    HGI_API
    virtual HgiComputeDispatch GetDispatchMethod() const = 0;
 
protected:
    HGI_API
    HgiComputeCmds();
 
private:
    HgiComputeCmds & operator=(const HgiComputeCmds&) = delete;
    HgiComputeCmds(const HgiComputeCmds&) = delete;
};
 
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif