blitCmds.h

//
// Copyright 2019 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HGI_BLIT_CMDS_H
#define PXR_IMAGING_HGI_BLIT_CMDS_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hgi/api.h"
#include "pxr/imaging/hgi/buffer.h"
#include "pxr/imaging/hgi/cmds.h"
#include "pxr/imaging/hgi/texture.h"
#include <memory>
 
PXR_NAMESPACE_OPEN_SCOPE
 
struct HgiTextureGpuToCpuOp;
struct HgiTextureCpuToGpuOp;
struct HgiBufferGpuToGpuOp;
struct HgiBufferCpuToGpuOp;
struct HgiBufferGpuToCpuOp;
struct HgiTextureToBufferOp;
struct HgiBufferToTextureOp;
struct HgiResolveImageOp;
 
using HgiBlitCmdsUniquePtr = std::unique_ptr<class HgiBlitCmds>;
 
 
class HgiBlitCmds : public HgiCmds
{
public:
    HGI_API
    ~HgiBlitCmds() override;
 
    HGI_API
    virtual void PushDebugGroup(const char* label,
        const GfVec4f& color = s_blitDebugColor) = 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 CopyTextureGpuToCpu(HgiTextureGpuToCpuOp const& copyOp) = 0;
 
    HGI_API
    virtual void CopyTextureCpuToGpu(HgiTextureCpuToGpuOp const& copyOp) = 0;
 
    HGI_API
    virtual void CopyBufferGpuToGpu(HgiBufferGpuToGpuOp const& copyOp) = 0;
 
    HGI_API
    virtual void CopyBufferCpuToGpu(HgiBufferCpuToGpuOp const& copyOp) = 0;
 
    HGI_API
    virtual void CopyBufferGpuToCpu(HgiBufferGpuToCpuOp const& copyOp) = 0;
 
    HGI_API
    virtual void CopyTextureToBuffer(HgiTextureToBufferOp const& copyOp) = 0;
 
    HGI_API
    virtual void CopyBufferToTexture(HgiBufferToTextureOp const& copyOp) = 0;
 
    HGI_API
    virtual void GenerateMipMaps(HgiTextureHandle const& texture) = 0;
    
    HGI_API
    virtual void FillBuffer(HgiBufferHandle const& buffer, uint8_t value) = 0;
 
    HGI_API
    virtual void InsertMemoryBarrier(HgiMemoryBarrier barrier) = 0;
 
protected:
    HGI_API
    HgiBlitCmds();
 
private:
    HgiBlitCmds & operator=(const HgiBlitCmds&) = delete;
    HgiBlitCmds(const HgiBlitCmds&) = delete;
};
 
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif