ops.h

//
// Copyright 2020 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HGIGL_OPS_H
#define PXR_IMAGING_HGIGL_OPS_H

#include "pxr/pxr.h"
#include "pxr/base/gf/vec4i.h"

#include "pxr/imaging/hgi/buffer.h"
#include "pxr/imaging/hgi/blitCmdsOps.h"
#include "pxr/imaging/hgi/graphicsCmdsDesc.h"
#include "pxr/imaging/hgi/graphicsPipeline.h"
#include "pxr/imaging/hgi/resourceBindings.h"

#include "pxr/imaging/hgiGL/api.h"
#include "pxr/imaging/hgiGL/device.h"

#include <cstdint>
#include <functional>
#include <vector>

PXR_NAMESPACE_OPEN_SCOPE

using HgiGLOpsFn = std::function<void(void)>;

class HgiGLOps
{
public:
    HGIGL_API
    static HgiGLOpsFn PushDebugGroup(const char* label,
        const GfVec4f& color = GfVec4f(0.0));

    HGIGL_API
    static HgiGLOpsFn PopDebugGroup();

    HGIGL_API
    static HgiGLOpsFn InsertDebugMarker(const char* label);

    HGIGL_API
    static HgiGLOpsFn CopyTextureGpuToCpu(HgiTextureGpuToCpuOp const& copyOp);

    HGIGL_API
    static HgiGLOpsFn CopyTextureCpuToGpu(HgiTextureCpuToGpuOp const& copyOp);

    HGIGL_API
    static HgiGLOpsFn CopyBufferGpuToGpu(HgiBufferGpuToGpuOp const& copyOp);

    HGIGL_API
    static HgiGLOpsFn CopyBufferCpuToGpu(HgiBufferCpuToGpuOp const& copyOp);

    HGIGL_API
    static HgiGLOpsFn CopyBufferGpuToCpu(HgiBufferGpuToCpuOp const& copyOp);

    HGIGL_API
    static HgiGLOpsFn CopyTextureToBuffer(HgiTextureToBufferOp const& copyOp);

    HGIGL_API
    static HgiGLOpsFn CopyBufferToTexture(HgiBufferToTextureOp const& copyOp);

    HGIGL_API
    static HgiGLOpsFn ResolveFramebuffer(
        HgiGLDevice* device,
        HgiGraphicsCmdsDesc const &graphicsCmds);
    
    HGIGL_API
    static HgiGLOpsFn SetViewport(GfVec4i const& vp);

    HGIGL_API
    static HgiGLOpsFn SetScissor(GfVec4i const& sc);

    HGIGL_API
    static HgiGLOpsFn BindPipeline(HgiGraphicsPipelineHandle pipeline);

    HGIGL_API
    static HgiGLOpsFn BindPipeline(HgiComputePipelineHandle pipeline);

    HGIGL_API
    static HgiGLOpsFn BindResources(HgiResourceBindingsHandle resources);

    HGIGL_API
    static HgiGLOpsFn SetConstantValues(
        HgiGraphicsPipelineHandle pipeline,
        HgiShaderStage stages,
        uint32_t bindIndex,
        uint32_t byteSize,
        const void* data);

    HGIGL_API
    static HgiGLOpsFn SetConstantValues(
        HgiComputePipelineHandle pipeline,
        uint32_t bindIndex,
        uint32_t byteSize,
        const void* data);

    HGIGL_API
    static HgiGLOpsFn BindVertexBuffers(
        HgiVertexBufferBindingVector const &bindings);

    HGIGL_API
    static HgiGLOpsFn Draw(
        HgiPrimitiveType primitiveType,
        uint32_t primitiveIndexSize,
        uint32_t vertexCount,
        uint32_t baseVertex,
        uint32_t instanceCount,
        uint32_t baseInstance);

    HGIGL_API
    static HgiGLOpsFn DrawIndirect(
        HgiPrimitiveType primitiveType,
        uint32_t primitiveIndexSize,
        HgiBufferHandle const& drawParameterBuffer,
        uint32_t drawBufferByteOffset,
        uint32_t drawCount,
        uint32_t stride);

    HGIGL_API
    static HgiGLOpsFn DrawIndexed(
        HgiPrimitiveType primitiveType,
        uint32_t primitiveIndexSize,
        HgiBufferHandle const& indexBuffer,
        uint32_t indexCount,
        uint32_t indexBufferByteOffset,
        uint32_t baseVertex,
        uint32_t instanceCount,
        uint32_t baseInstance);

    HGIGL_API
    static HgiGLOpsFn DrawIndexedIndirect(
        HgiPrimitiveType primitiveType,
        uint32_t primitiveIndexSize,
        HgiBufferHandle const& indexBuffer,
        HgiBufferHandle const& drawParameterBuffer,
        uint32_t drawBufferByteOffset,
        uint32_t drawCount,
        uint32_t stride);

    HGIGL_API
    static HgiGLOpsFn BindFramebufferOp(
        HgiGLDevice* device,
        HgiGraphicsCmdsDesc const& desc);

    HGIGL_API
    static HgiGLOpsFn Dispatch(int dimX, int dimY);

    HGIGL_API
    static HgiGLOpsFn FillBuffer(HgiBufferHandle const& buffer, uint8_t value);

    HGIGL_API
    static HgiGLOpsFn GenerateMipMaps(HgiTextureHandle const& texture);

    HGIGL_API
    static HgiGLOpsFn InsertMemoryBarrier(HgiMemoryBarrier barrier);

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif