24#ifndef PXR_IMAGING_HD_BUFFER_ARRAY_RANGE_H
25#define PXR_IMAGING_HD_BUFFER_ARRAY_RANGE_H
28#include "pxr/imaging/hd/api.h"
29#include "pxr/imaging/hd/version.h"
31#include "pxr/base/vt/value.h"
32#include "pxr/imaging/hd/bufferArray.h"
36PXR_NAMESPACE_OPEN_SCOPE
39using HdBufferSpecVector = std::vector<struct HdBufferSpec>;
40using HdBufferArrayRangeSharedPtr = std::shared_ptr<class HdBufferArrayRange>;
41using HdBufferSourceSharedPtr = std::shared_ptr<class HdBufferSource>;
80 virtual bool Resize(
int numElements) = 0;
83 virtual void CopyData(HdBufferSourceSharedPtr
const &bufferSource) = 0;
137std::ostream &operator <<(std::ostream &out,
153 void Set(
int index, HdBufferArrayRangeSharedPtr
const &range);
158 HdBufferArrayRangeSharedPtr
const &
Get(
int index)
const;
166 std::vector<HdBufferArrayRangeSharedPtr> _ranges;
170PXR_NAMESPACE_CLOSE_SCOPE
Similar to a VAO, this object is a bundle of coherent buffers.
A resizable container of HdBufferArrayRanges.
HD_API void Set(int index, HdBufferArrayRangeSharedPtr const &range)
Set range into the container at index.
HdBufferArrayRangeContainer(int size)
Constructor.
HD_API void Resize(int size)
Resize the buffer array range container to size size.
HD_API HdBufferArrayRangeSharedPtr const & Get(int index) const
Returns the bar at index.
Interface class for representing range (subset) locator of HdBufferArray.
virtual bool IsAssigned() const =0
Returns true is the range has been assigned to a buffer.
virtual const void * _GetAggregation() const =0
Returns the aggregation container to be used in IsAggregatedWith()
virtual int GetElementOffset() const =0
Returns the offset at which this range begins in the underlying buffer array in terms of elements.
virtual void DebugDump(std::ostream &out) const =0
Debug output.
virtual size_t GetNumElements() const =0
Returns the number of elements.
virtual int GetByteOffset(TfToken const &resourceName) const =0
Returns the byte offset at which this range begins in the underlying buffer array for the given resou...
virtual VtValue ReadData(TfToken const &name) const =0
Read back the buffer content.
virtual HD_API ~HdBufferArrayRange()
Destructor (do nothing).
virtual bool RequiresStaging() const =0
Returns true if this needs a staging buffer for CPU to GPU copies.
bool IsAggregatedWith(HdBufferArrayRangeSharedPtr const &other) const
Returns true if the underlying buffer array is aggregated to other's.
virtual HdBufferArrayUsageHint GetUsageHint() const =0
Gets the usage hint on the underlying buffer array.
virtual size_t GetMaxNumElements() const =0
Returns the max number of elements.
virtual bool IsImmutable() const =0
Returns true if this range is marked as immutable.
virtual void GetBufferSpecs(HdBufferSpecVector *bufferSpecs) const =0
Gets the bufferSpecs for all resources.
virtual bool Resize(int numElements)=0
Resize memory area for this range.
virtual void IncrementVersion()=0
Increment the version of the buffer array.
virtual void SetBufferArray(HdBufferArray *bufferArray)=0
Sets the buffer array associated with this buffer;.
virtual void CopyData(HdBufferSourceSharedPtr const &bufferSource)=0
Copy source data into buffer.
virtual bool IsValid() const =0
Returns true if this range is valid.
virtual size_t GetVersion() const =0
Returns the version of the buffer array.
Token for efficient comparison, assignment, and hashing of known strings.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...