HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
bufferArrayRange.h
Go to the documentation of this file.
1 //
2 // Copyright 2017 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_IMAGING_HD_ST_BUFFER_ARRAY_RANGE_H
25 #define PXR_IMAGING_HD_ST_BUFFER_ARRAY_RANGE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/base/tf/token.h"
32 
33 #include <memory>
34 
36 
37 
38 class HdBufferArrayGL;
40 
42  std::shared_ptr<class HdStBufferArrayRange>;
43 
44 class HdStBufferResource;
45 
47  std::shared_ptr<class HdStBufferResource>;
49  std::vector< std::pair<TfToken, HdStBufferResourceSharedPtr> >;
50 
51 /// \class HdStBufferArrayRange
52 ///
53 /// Interface class for representing range (subset) locator of HdBufferArray.
54 ///
55 /// Each memory management strategy defines a specialized range class which is
56 /// inherited of this interface so that client (drawItem) can be agnostic about
57 /// the implementation detail of aggregation.
58 ///
60 {
61 public:
62  HdStBufferArrayRange(HdStResourceRegistry* resourceRegistry);
63 
64  /// Destructor (do nothing).
65  /// The specialized range class may want to do something for garbage
66  /// collection in its destructor. However, be careful not do any
67  /// substantial work here (obviously including any kind of GL calls),
68  /// since the destructor gets called frequently on various contexts.
69  HDST_API
70  virtual ~HdStBufferArrayRange();
71 
72  /// Returns the GPU resource. If the buffer array contains more than one
73  /// resource, this method raises a coding error.
74  virtual HdStBufferResourceSharedPtr GetResource() const = 0;
75 
76  /// Returns the named GPU resource.
78 
79  /// Returns the list of all named GPU resources for this bufferArrayRange.
80  virtual HdStBufferResourceNamedList const& GetResources() const = 0;
81 
82  /// Sets the bufferSpecs for all resources.
83  HDST_API
84  virtual void GetBufferSpecs(HdBufferSpecVector *bufferSpecs) const override;
85 
86 protected:
88 
89 private:
90  HdStResourceRegistry* _resourceRegistry;
91 };
92 
94 std::ostream &operator <<(std::ostream &out,
95  const HdStBufferArrayRange &self);
96 
97 /// \class HdStBufferArrayRangeContainer
98 ///
99 /// A resizable container of HdBufferArrayRanges.
100 ///
102 {
103 public:
104  /// Constructor
105  HdStBufferArrayRangeContainer(int size) : _ranges(size) { }
106 
107  /// Set \p range into the container at \p index.
108  /// If the size of container is smaller than index, resize it.
109  HDST_API
110  void Set(int index, HdStBufferArrayRangeSharedPtr const &range);
111 
112  /// Returns the bar at \p index. returns null if either the index
113  // is out of range or not yet set.
114  HDST_API
115  HdStBufferArrayRangeSharedPtr const &Get(int index) const;
116 
117 private:
118  std::vector<HdStBufferArrayRangeSharedPtr> _ranges;
119 };
120 
121 
123 
124 #endif // HD_BUFFER_ARRAY_RANGE_GL_H
std::shared_ptr< class HdStBufferArrayRange > HdStBufferArrayRangeSharedPtr
virtual HDST_API void GetBufferSpecs(HdBufferSpecVector *bufferSpecs) const override
Sets the bufferSpecs for all resources.
std::vector< std::pair< TfToken, HdStBufferResourceSharedPtr > > HdStBufferResourceNamedList
GLuint const GLchar * name
Definition: glcorearb.h:785
GLsizeiptr size
Definition: glcorearb.h:663
Definition: token.h:87
HdStBufferArrayRange(HdStResourceRegistry *resourceRegistry)
std::vector< struct HdBufferSpec > HdBufferSpecVector
std::shared_ptr< class HdStBufferResource > HdStBufferResourceSharedPtr
HDST_API HdStBufferArrayRangeSharedPtr const & Get(int index) const
Returns the bar at index. returns null if either the index.
HDST_API void Set(int index, HdStBufferArrayRangeSharedPtr const &range)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define HDST_API
Definition: api.h:40
GLuint index
Definition: glcorearb.h:785
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HdStResourceRegistry * GetResourceRegistry()
HD_API std::ostream & operator<<(std::ostream &out, const HdBufferArrayRange &self)
HdStBufferArrayRangeContainer(int size)
Constructor.
GLenum GLint * range
Definition: glcorearb.h:1924
virtual HdStBufferResourceNamedList const & GetResources() const =0
Returns the list of all named GPU resources for this bufferArrayRange.
virtual HdStBufferResourceSharedPtr GetResource() const =0
virtual HDST_API ~HdStBufferArrayRange()