dispatchBuffer.h

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_IMAGING_HD_ST_DISPATCH_BUFFER_H
#define PXR_IMAGING_HD_ST_DISPATCH_BUFFER_H

#include "pxr/pxr.h"
#include "pxr/imaging/hd/version.h"
#include "pxr/imaging/hd/bufferArray.h"
#include "pxr/imaging/hd/bufferSpec.h"
#include "pxr/imaging/hdSt/api.h"
#include "pxr/imaging/hdSt/bufferArrayRange.h"
#include "pxr/imaging/hdSt/bufferResource.h"

#include <memory>

PXR_NAMESPACE_OPEN_SCOPE

class HdStResourceRegistry;

using HdStDispatchBufferSharedPtr = std::shared_ptr<class HdStDispatchBuffer>;

class HdStDispatchBuffer : public HdBufferArray
{
public:
    HDST_API
    HdStDispatchBuffer(HdStResourceRegistry* resourceRegistry,
                       TfToken const &role,
                       int count,
                       unsigned int commandNumUints);

    HDST_API
    ~HdStDispatchBuffer() override;

    HDST_API
    void CopyData(std::vector<uint32_t> const &data);

    HDST_API
    void AddBufferResourceView(TfToken const &name,
                               HdTupleType tupleType, int offset);

    int GetCount() const { return _count; }

    unsigned int GetCommandNumUints() const { return _commandNumUints; }

    HdStBufferArrayRangeSharedPtr GetBufferArrayRange() const {
        return _bar;
    }

    HdStBufferResourceSharedPtr GetEntireResource() const {
        return _entireResource;
    }

    // HdBufferArray overrides. they are not supported in this class.
    HDST_API
    bool GarbageCollect() override;
    HDST_API
    void Reallocate(
        std::vector<HdBufferArrayRangeSharedPtr> const &,
        HdBufferArraySharedPtr const &) override;

    HDST_API
    void DebugDump(std::ostream &out) const override;

    HDST_API
    HdStBufferResourceSharedPtr GetResource() const;

    HDST_API
    HdStBufferResourceSharedPtr GetResource(TfToken const& name);

    HdStBufferResourceNamedList const& GetResources() const {return _resourceList;}

protected:
    HDST_API
    HdStBufferResourceSharedPtr _AddResource(TfToken const& name,
                                               HdTupleType tupleType,
                                               int offset,
                                               int stride);

private:
    HdStResourceRegistry *_resourceRegistry;
    int _count;
    unsigned int _commandNumUints;
    HdStBufferResourceNamedList _resourceList;
    HdStBufferResourceSharedPtr _entireResource;
    HdStBufferArrayRangeSharedPtr _bar;  // Alternative to range list in base class
};


PXR_NAMESPACE_CLOSE_SCOPE

#endif  // PXR_IMAGING_HD_ST_DISPATCH_BUFFER_H