bufferResource.h

//
// Copyright 2017 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_ST_BUFFER_RESOURCE_H
#define PXR_IMAGING_HD_ST_BUFFER_RESOURCE_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hdSt/api.h"
 
#include "pxr/imaging/hd/types.h"
 
#include "pxr/imaging/hgi/buffer.h"
 
#include "pxr/base/tf/token.h"
 
#include <memory>
#include <utility>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
using HdStBufferResourceSharedPtr =
    std::shared_ptr<class HdStBufferResource>;
 
using HdStBufferResourceNamedPair =
    std::pair<TfToken, HdStBufferResourceSharedPtr>;
using HdStBufferResourceNamedList =
    std::vector<HdStBufferResourceNamedPair>;
 
class HdStBufferResource final
{
public:
    HDST_API
    HdStBufferResource(TfToken const &role,
                       HdTupleType tupleType,
                       int offset,
                       int stride);
 
    HDST_API
    ~HdStBufferResource();
 
    TfToken const &GetRole() const { return _role; }
 
    size_t GetSize() const { return _size; }
 
    HdTupleType GetTupleType() const { return _tupleType; }
 
    int GetOffset() const { return _offset; }
 
    int GetStride() const { return _stride; }
 
    HDST_API
    void SetAllocation(HgiBufferHandle const &handle, size_t size);
 
    HgiBufferHandle &GetHandle() { return _handle; }
 
private:
    HdStBufferResource(const HdStBufferResource &) = delete;
    HdStBufferResource &operator=(const HdStBufferResource &) = delete;
 
    HgiBufferHandle _handle;
    size_t _size;
 
    TfToken const _role;
    HdTupleType const _tupleType;
    int const _offset;
    int const _stride;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_HD_ST_BUFFER_RESOURCE_H