bufferArrayRange.h

//
// Copyright 2017 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_BUFFER_ARRAY_RANGE_H
#define PXR_IMAGING_HD_ST_BUFFER_ARRAY_RANGE_H

#include "pxr/pxr.h"
#include "pxr/imaging/hdSt/api.h"
#include "pxr/imaging/hd/version.h"
#include "pxr/base/tf/token.h"
#include "pxr/imaging/hd/bufferArrayRange.h"

#include <memory>

PXR_NAMESPACE_OPEN_SCOPE


class HdBufferArrayGL;
class HdStResourceRegistry;

using HdStBufferArrayRangeSharedPtr = 
    std::shared_ptr<class HdStBufferArrayRange>;

class HdStBufferResource;

using HdStBufferResourceSharedPtr = 
    std::shared_ptr<class HdStBufferResource>;
using HdStBufferResourceNamedList =
    std::vector< std::pair<TfToken, HdStBufferResourceSharedPtr> >;

class HdStBufferArrayRange : public HdBufferArrayRange 
{
public:
    HdStBufferArrayRange(HdStResourceRegistry* resourceRegistry);

    HDST_API
    virtual ~HdStBufferArrayRange();

    virtual HdStBufferResourceSharedPtr GetResource() const = 0;

    virtual HdStBufferResourceSharedPtr GetResource(TfToken const& name) = 0;

    virtual HdStBufferResourceNamedList const& GetResources() const = 0;

    HDST_API
    virtual void GetBufferSpecs(HdBufferSpecVector *bufferSpecs) const override;
    
protected:
    HdStResourceRegistry* GetResourceRegistry();
    
private:
    HdStResourceRegistry* _resourceRegistry;
};

HDST_API
std::ostream &operator <<(std::ostream &out,
                          const HdStBufferArrayRange &self);

class HdStBufferArrayRangeContainer
{
public:
    HdStBufferArrayRangeContainer(int size) : _ranges(size) { }

    HDST_API
    void Set(int index, HdStBufferArrayRangeSharedPtr const &range);

    // is out of range or not yet set.
    HDST_API
    HdStBufferArrayRangeSharedPtr const &Get(int index) const;

private:
    std::vector<HdStBufferArrayRangeSharedPtr> _ranges;
};


PXR_NAMESPACE_CLOSE_SCOPE

#endif  // HD_BUFFER_ARRAY_RANGE_GL_H