resourceBindings.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_RESOURCEBINDINGS_H
#define PXR_IMAGING_HGI_RESOURCEBINDINGS_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hgi/api.h"
#include "pxr/imaging/hgi/buffer.h"
#include "pxr/imaging/hgi/enums.h"
#include "pxr/imaging/hgi/handle.h"
#include "pxr/imaging/hgi/sampler.h"
#include "pxr/imaging/hgi/texture.h"
#include "pxr/imaging/hgi/types.h"
 
#include <string>
#include <vector>
 
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
 
 
 
struct HgiBufferBindDesc
{
    HGI_API
    HgiBufferBindDesc();
 
    HgiBufferHandleVector buffers;
    std::vector<uint32_t> offsets;
    std::vector<uint32_t> sizes;
    HgiBindResourceType resourceType;
    uint32_t bindingIndex;
    HgiShaderStage stageUsage;
    bool writable;
};
using HgiBufferBindDescVector = std::vector<HgiBufferBindDesc>;
 
HGI_API
bool operator==(
    const HgiBufferBindDesc& lhs,
    const HgiBufferBindDesc& rhs);
 
HGI_API
bool operator!=(
    const HgiBufferBindDesc& lhs,
    const HgiBufferBindDesc& rhs);
 
struct HgiTextureBindDesc
{
    HGI_API
    HgiTextureBindDesc();
 
    HgiTextureHandleVector textures;
    HgiSamplerHandleVector samplers;
    HgiBindResourceType resourceType;
    uint32_t bindingIndex;
    HgiShaderStage stageUsage;
    bool writable;
};
using HgiTextureBindDescVector = std::vector<HgiTextureBindDesc>;
 
HGI_API
bool operator==(
    const HgiTextureBindDesc& lhs,
    const HgiTextureBindDesc& rhs);
 
HGI_API
bool operator!=(
    const HgiTextureBindDesc& lhs,
    const HgiTextureBindDesc& rhs);
 
struct HgiResourceBindingsDesc
{
    HGI_API
    HgiResourceBindingsDesc();
 
    std::string debugName;
    HgiBufferBindDescVector buffers;
    HgiTextureBindDescVector textures;
};
 
HGI_API
bool operator==(
    const HgiResourceBindingsDesc& lhs,
    const HgiResourceBindingsDesc& rhs);
 
HGI_API
bool operator!=(
    const HgiResourceBindingsDesc& lhs,
    const HgiResourceBindingsDesc& rhs);
 
 
class HgiResourceBindings
{
public:
    HGI_API
    virtual ~HgiResourceBindings();
 
    HGI_API
    HgiResourceBindingsDesc const& GetDescriptor() const;
 
protected:
    HGI_API
    HgiResourceBindings(HgiResourceBindingsDesc const& desc);
 
    HgiResourceBindingsDesc _descriptor;
 
private:
    HgiResourceBindings() = delete;
    HgiResourceBindings & operator=(const HgiResourceBindings&) = delete;
    HgiResourceBindings(const HgiResourceBindings&) = delete;
};
 
using HgiResourceBindingsHandle = HgiHandle<HgiResourceBindings>;
using HgiResourceBindingsHandleVector = std::vector<HgiResourceBindingsHandle>;
 
struct HgiVertexBufferBinding
{
    HGI_API
    HgiVertexBufferBinding(HgiBufferHandle const &buffer,
                           uint32_t byteOffset,
                           uint32_t index)
        : buffer(buffer)
        , byteOffset(byteOffset)
        , index(index)
    {
    }
 
    HgiBufferHandle buffer;
    uint32_t byteOffset;
    uint32_t index;
};
 
using HgiVertexBufferBindingVector = std::vector<HgiVertexBufferBinding>;
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif