OpenVDB: nanovdb/GridHandle.h Source File

OpenVDB 12.0.0 |

Loading...
Searching...
No Matches
GridHandle.h
Go to the documentation of this file.
1// Copyright Contributors to the OpenVDB Project
2// SPDX-License-Identifier: Apache-2.0
3
4/*!
5 \file nanovdb/GridHandle.h
6
7 \author Ken Museth
8
9 \date January 8, 2020
10
11 \brief Defines GridHandle, which manages a host, and possibly a device,
12 memory buffer containing one or more NanoVDB grids.
13*/
14
15#ifndef NANOVDB_GRID_HANDLE_H_HAS_BEEN_INCLUDED
16#define NANOVDB_GRID_HANDLE_H_HAS_BEEN_INCLUDED
17
18#include <fstream> // for std::ifstream
19#include <iostream> // for std::cerr/cout
20#include <vector>
21#include <initializer_list>
22
23#include <nanovdb/NanoVDB.h>// for toGridType
24#include <nanovdb/HostBuffer.h>
25#include <nanovdb/tools/GridChecksum.h>// for updateGridCount
26
27 namespace nanovdb {
28
29// --------------------------> GridHandle <------------------------------------
30
31 struct GridHandleMetaData {uint64_t offset, size; GridType gridType;};
32
33/// @brief This class serves to manage a buffer containing one or more NanoVDB Grids.
34///
35/// @note It is important to note that this class does NOT depend on OpenVDB.
36template<typename BufferT = HostBuffer>
37 class GridHandle
38{
39 std::vector<GridHandleMetaData> mMetaData;
40 BufferT mBuffer;
41
42 template <typename T>
43 static T* no_const(const T* ptr) { return const_cast<T*>(ptr); }
44
45public:
46 using BufferType = BufferT;
47
48 /// @brief Move constructor from a host buffer
49 /// @param buffer buffer containing one or more NanoGrids that will be moved into this GridHandle
50 /// @throw Will throw and error with the buffer does not contain a valid NanoGrid!
51 template<typename T = BufferT, typename util::enable_if<BufferTraits<T>::hasDeviceDual, int>::type = 0>
52 GridHandle(T&& buffer);
53
54 /// @brief Move constructor from a dual host-device buffer
55 /// @param buffer buffer containing one or more NanoGrids that will be moved into this GridHandle
56 /// @throw Will throw and error with the buffer does not contain a valid NanoGrid!
57 template<typename T = BufferT, typename util::disable_if<BufferTraits<T>::hasDeviceDual, int>::type = 0>
58 GridHandle(T&& buffer);
59
60 /// @brief Constructs an empty GridHandle
61 GridHandle() = default;
62
63 /// @brief Disallow copy-construction
64 GridHandle(const GridHandle&) = delete;
65
66 /// @brief Move copy-constructor
67 GridHandle(GridHandle&& other) noexcept {
68 mBuffer = std::move(other.mBuffer);
69 mMetaData = std::move(other.mMetaData);
70 }
71
72 /// @brief clear this GridHandle to an empty handle
73 void reset() {
74 mBuffer.clear();
75 mMetaData.clear();
76 }
77
78 /// @brief Disallow copy assignment operation
79 GridHandle& operator=(const GridHandle&) = delete;
80
81 /// @brief Move copy assignment operation
82 GridHandle& operator=(GridHandle&& other) noexcept {
83 mBuffer = std::move(other.mBuffer);
84 mMetaData = std::move(other.mMetaData);
85 return *this;
86 }
87
88 /// @brief Performs a deep copy of the GridHandle, possibly templated on a different buffer type
89 /// @tparam OtherBufferT Buffer type of the deep copy
90 /// @param buffer optional buffer used for allocation
91 /// @return A new handle of the specified buffer type that contains a deep copy of the current handle
92 template <typename OtherBufferT = HostBuffer>
93 GridHandle<OtherBufferT> copy(const OtherBufferT& buffer = OtherBufferT()) const;
94
95 /// @brief Return a reference to the buffer
96 BufferT& buffer() { return mBuffer; }
97
98 /// @brief Return a const reference to the buffer
99 const BufferT& buffer() const { return mBuffer; }
100
101 /// @brief Returns a non-const pointer to the data.
102 /// @warning Note that the return pointer can be NULL if the GridHandle was not initialized
103 void* data() { return mBuffer.data(); }
104
105 /// @brief Returns a const pointer to the data.
106 /// @warning Note that the return pointer can be NULL if the GridHandle was not initialized
107 const void* data() const { return mBuffer.data(); }
108
109 template<typename U = BufferT>
110 typename util::enable_if<BufferTraits<U>::hasDeviceDual, const void*>::type
111 deviceData() const { return mBuffer.deviceData(); }
112 template<typename U = BufferT>
113 typename util::enable_if<BufferTraits<U>::hasDeviceDual, void*>::type
114 deviceData() { return mBuffer.deviceData(); }
115
116 /// @brief Returns the size in bytes of the raw memory buffer managed by this GridHandle.
117 uint64_t size() const { return mBuffer.size(); }
118
119 //@{
120 /// @brief Return true if this handle is empty, i.e. has no allocated memory
121 bool empty() const { return this->size() == 0; }
122 bool isEmpty() const { return this->size() == 0; }
123 //@}
124
125 /// @brief Return true if this handle contains any grids
126 operator bool() const { return !this->empty(); }
127
128 /// @brief Returns a const host pointer to the @a n'th NanoVDB grid encoded in this GridHandle.
129 /// @tparam ValueT Value type of the grid point to be returned
130 /// @param n Index of the (host) grid pointer to be returned
131 /// @warning Note that the return pointer can be NULL if the GridHandle no host grid, @a n is invalid
132 /// or if the template parameter does not match the specified grid!
133 template<typename ValueT>
134 const NanoGrid<ValueT>* grid(uint32_t n = 0) const;
135
136 /// @brief Returns a host pointer to the @a n'th NanoVDB grid encoded in this GridHandle.
137 /// @tparam ValueT Value type of the grid point to be returned
138 /// @param n Index of the (host) grid pointer to be returned
139 /// @warning Note that the return pointer can be NULL if the GridHandle no host grid, @a n is invalid
140 /// or if the template parameter does not match the specified grid!
141 template<typename ValueT>
142 NanoGrid<ValueT>* grid(uint32_t n = 0) {return const_cast<NanoGrid<ValueT>*>(static_cast<const GridHandle*>(this)->template grid<ValueT>(n));}
143
144 /// @brief Return a const pointer to the @a n'th grid encoded in this GridHandle on the device, e.g. GPU
145 /// @tparam ValueT Value type of the grid point to be returned
146 /// @param n Index of the (device) grid pointer to be returned
147 /// @warning Note that the return pointer can be NULL if the GridHandle has no device grid, @a n is invalid,
148 /// or if the template parameter does not match the specified grid.
149 template<typename ValueT, typename U = BufferT>
150 typename util::enable_if<BufferTraits<U>::hasDeviceDual, const NanoGrid<ValueT>*>::type
151 deviceGrid(uint32_t n=0) const;
152
153 /// @brief Return a const pointer to the @a n'th grid encoded in this GridHandle on the device, e.g. GPU
154 /// @tparam ValueT Value type of the grid point to be returned
155 /// @param n Index if of the grid pointer to be returned
156 /// @param verbose if non-zero error messages will be printed in case something failed
157 /// @warning Note that the return pointer can be NULL if the GridHandle was not initialized, @a n is invalid,
158 /// or if the template parameter does not match the specified grid.
159 template<typename ValueT, typename U = BufferT>
160 typename util::enable_if<BufferTraits<U>::hasDeviceDual, NanoGrid<ValueT>*>::type
161 deviceGrid(uint32_t n=0){return const_cast<NanoGrid<ValueT>*>(static_cast<const GridHandle*>(this)->template deviceGrid<ValueT>(n));}
162
163 /// @brief Upload the grid to the device, e.g. from CPU to GPU
164 /// @note This method is only available if the buffer supports devices
165 template<typename U = BufferT>
166 typename util::enable_if<BufferTraits<U>::hasDeviceDual, void>::type
167 deviceUpload(void* stream = nullptr, bool sync = true) { mBuffer.deviceUpload(stream, sync); }
168
169 /// @brief Download the grid to from the device, e.g. from GPU to CPU
170 /// @note This method is only available if the buffer supports devices
171 template<typename U = BufferT>
172 typename util::enable_if<BufferTraits<U>::hasDeviceDual, void>::type
173 deviceDownload(void* stream = nullptr, bool sync = true) { mBuffer.deviceDownload(stream, sync); }
174
175 /// @brief Check if the buffer is this handle has any padding, i.e. if the buffer is larger than the combined size of all its grids
176 /// @return true is the combined size of all grid is smaller than the buffer size
177 bool isPadded() const {return mMetaData.empty() ? false : mMetaData.back().offset + mMetaData.back().size != mBuffer.size();}
178
179 /// @brief Return the total number of grids contained in this buffer
180 uint32_t gridCount() const {return static_cast<uint32_t>(mMetaData.size());}
181
182 /// @brief Return the grid size of the @a n'th grid in this GridHandle
183 /// @param n index of the grid (assumed to be less than gridCount())
184 /// @return Return the byte size of the specified grid
185 uint64_t gridSize(uint32_t n = 0) const {return mMetaData[n].size; }
186
187 /// @brief Return the GridType of the @a n'th grid in this GridHandle
188 /// @param n index of the grid (assumed to be less than gridCount())
189 /// @return Return the GridType of the specified grid
190 GridType gridType(uint32_t n = 0) const {return mMetaData[n].gridType; }
191
192 /// @brief Access to the GridData of the n'th grid in the current handle
193 /// @param n zero-based ID of the grid
194 /// @return Const pointer to the n'th GridData in the current handle
195 const GridData* gridData(uint32_t n = 0) const;
196
197 /// @brief Returns a const point to the @a n'th grid meta data
198 /// @param n zero-based ID of the grid
199 /// @warning Note that the return pointer can be NULL if the GridHandle was not initialized
200 const GridMetaData* gridMetaData(uint32_t n = 0) const;
201
202 /// @brief Write a specific grid in this buffer to an output stream
203 /// @param os output stream that the buffer will be written to
204 /// @param n zero-based index of the grid to be written to stream
205 void write(std::ostream& os, uint32_t n) const {
206 if (const GridData* data = this->gridData(n)) {
207 os.write((const char*)data, data->mGridSize);
208 } else {
209 throw std::runtime_error("GridHandle does not contain a #" + std::to_string(n) + " grid");
210 }
211 }
212
213 /// @brief Write the entire grid buffer to an output stream
214 /// @param os output stream that the buffer will be written to
215 void write(std::ostream& os) const {
216 for (uint32_t n=0; n<this->gridCount(); ++n) this->write(os, n);
217 }
218
219 /// @brief Write this entire grid buffer to a file
220 /// @param fileName string name of the output file
221 void write(const std::string &fileName) const {
222 std::ofstream os(fileName, std::ios::out | std::ios::binary | std::ios::trunc);
223 if (!os.is_open()) throw std::ios_base::failure("Unable to open file named \"" + fileName + "\" for output");
224 this->write(os);
225 }
226
227 /// @brief Write a specific grid to file
228 /// @param fileName string name of the output file
229 /// @param n zero-based index of the grid to be written to file
230 void write(const std::string &fileName, uint32_t n) const {
231 std::ofstream os(fileName, std::ios::out | std::ios::binary | std::ios::trunc);
232 if (!os.is_open()) throw std::ios_base::failure("Unable to open file named \"" + fileName + "\" for output");
233 this->write(os, n);
234 }
235
236 /// @brief Read an entire raw grid buffer from an input stream
237 /// @param is input stream containing a raw grid buffer
238 /// @param pool optional pool from which to allocate the new grid buffer
239 /// @throw Will throw a std::logic_error if the stream does not contain a valid raw grid
240 void read(std::istream& is, const BufferT& pool = BufferT());
241
242 /// @brief Read a specific grid from an input stream containing a raw grid buffer
243 /// @param is input stream containing a raw grid buffer
244 /// @param n zero-based index of the grid to be read
245 /// @param pool optional pool from which to allocate the new grid buffer
246 /// @throw Will throw a std::logic_error if the stream does not contain a valid raw grid
247 void read(std::istream& is, uint32_t n, const BufferT& pool = BufferT());
248
249 /// @brief Read a specific grid from an input stream containing a raw grid buffer
250 /// @param is input stream containing a raw grid buffer
251 /// @param gridName string name of the grid to be read
252 /// @param pool optional pool from which to allocate the new grid buffer
253 /// @throw Will throw a std::logic_error if the stream does not contain a valid raw grid with the speficied name
254 void read(std::istream& is, const std::string &gridName, const BufferT& pool = BufferT());
255
256 /// @brief Read a raw grid buffer from a file
257 /// @param filename string name of the input file containing a raw grid buffer
258 /// @param pool optional pool from which to allocate the new grid buffe
259 void read(const std::string &fileName, const BufferT& pool = BufferT()) {
260 std::ifstream is(fileName, std::ios::in | std::ios::binary);
261 if (!is.is_open()) throw std::ios_base::failure("Unable to open file named \"" + fileName + "\" for input");
262 this->read(is, pool);
263 }
264
265 /// @brief Read a specific grid from a file containing a raw grid buffer
266 /// @param filename string name of the input file containing a raw grid buffer
267 /// @param n zero-based index of the grid to be read
268 /// @param pool optional pool from which to allocate the new grid buffer
269 /// @throw Will throw a std::ios_base::failure if the file does not exist and a
270 /// std::logic_error if the files does not contain a valid raw grid
271 void read(const std::string &fileName, uint32_t n, const BufferT& pool = BufferT()) {
272 std::ifstream is(fileName, std::ios::in | std::ios::binary);
273 if (!is.is_open()) throw std::ios_base::failure("Unable to open file named \"" + fileName + "\" for input");
274 this->read(is, n, pool);
275 }
276
277 /// @brief Read a specific grid from a file containing a raw grid buffer
278 /// @param filename string name of the input file containing a raw grid buffer
279 /// @param gridName string name of the grid to be read
280 /// @param pool optional pool from which to allocate the new grid buffer
281 /// @throw Will throw a std::ios_base::failure if the file does not exist and a
282 /// std::logic_error if the files does not contain a valid raw grid withe the specified name
283 void read(const std::string &fileName, const std::string &gridName, const BufferT& pool = BufferT()) {
284 std::ifstream is(fileName, std::ios::in | std::ios::binary);
285 if (!is.is_open()) throw std::ios_base::failure("Unable to open file named \"" + fileName + "\" for input");
286 this->read(is, gridName, pool);
287 }
288}; // GridHandle
289
290// --------------------------> Implementation of private methods in GridHandle <------------------------------------
291
292template<typename BufferT>
293 inline const GridData* GridHandle<BufferT>::gridData(uint32_t n) const
294{
295 const void *data = this->data();
296 if (data == nullptr || n >= mMetaData.size()) return nullptr;
297 return util::PtrAdd<GridData>(data, mMetaData[n].offset);
298}// const GridData* GridHandle<BufferT>::gridData(uint32_t n) const
299
300template<typename BufferT>
301 inline const GridMetaData* GridHandle<BufferT>::gridMetaData(uint32_t n) const
302{
303 const auto *data = this->data();
304 if (data == nullptr || n >= mMetaData.size()) return nullptr;
305 return util::PtrAdd<GridMetaData>(data, mMetaData[n].offset);
306}// const GridMetaData* GridHandle<BufferT>::gridMetaData(uint32_t n) const
307
308 inline __hostdev__ void cpyGridHandleMeta(const GridData *data, GridHandleMetaData *meta)
309{
310 uint64_t offset = 0;
311 for (auto *p=meta, *q=p+data->mGridCount; p!=q; ++p) {
312 *p = {offset, data->mGridSize, data->mGridType};
313 offset += p->size;
314 data = util::PtrAdd<GridData>(data, p->size);
315 }
316}// void cpyGridHandleMeta(const GridData *data, GridHandleMetaData *meta)
317
318template<typename BufferT>
319template<typename T, typename util::disable_if<BufferTraits<T>::hasDeviceDual, int>::type>
320 GridHandle<BufferT>::GridHandle(T&& buffer)
321{
322 static_assert(util::is_same<T,BufferT>::value, "Expected U==BufferT");
323 mBuffer = std::move(buffer);
324 if (auto *data = reinterpret_cast<const GridData*>(mBuffer.data())) {
325 if (!data->isValid()) throw std::runtime_error("GridHandle was constructed with an invalid host buffer");
326 mMetaData.resize(data->mGridCount);
327 cpyGridHandleMeta(data, mMetaData.data());
328 }
329}// GridHandle<BufferT>::GridHandle(T&& buffer)
330
331template<typename BufferT>
332template <typename OtherBufferT>
333 inline GridHandle<OtherBufferT> GridHandle<BufferT>::copy(const OtherBufferT& other) const
334{
335 if (mBuffer.isEmpty()) return GridHandle<OtherBufferT>();// return an empty handle
336 auto buffer = OtherBufferT::create(mBuffer.size(), &other);
337 std::memcpy(buffer.data(), mBuffer.data(), mBuffer.size());// deep copy of buffer
338 return GridHandle<OtherBufferT>(std::move(buffer));
339}// GridHandle<OtherBufferT> GridHandle<BufferT>::copy(const OtherBufferT& other) const
340
341template<typename BufferT>
342template<typename ValueT>
343 inline const NanoGrid<ValueT>* GridHandle<BufferT>::grid(uint32_t n) const
344{
345 const void *data = mBuffer.data();
346 if (data == nullptr || n >= mMetaData.size() || mMetaData[n].gridType != toGridType<ValueT>()) return nullptr;
347 return util::PtrAdd<NanoGrid<ValueT>>(data, mMetaData[n].offset);
348}// const NanoGrid<ValueT>* GridHandle<BufferT>::grid(uint32_t n) const
349
350template<typename BufferT>
351template<typename ValueT, typename U>
352inline typename util::enable_if<BufferTraits<U>::hasDeviceDual, const NanoGrid<ValueT>*>::type
353GridHandle<BufferT>::deviceGrid(uint32_t n) const
354{
355 const void *data = mBuffer.deviceData();
356 if (data == nullptr || n >= mMetaData.size() || mMetaData[n].gridType != toGridType<ValueT>()) return nullptr;
357 return util::PtrAdd<NanoGrid<ValueT>>(data, mMetaData[n].offset);
358}// GridHandle<BufferT>::deviceGrid(uint32_t n) cons
359
360template<typename BufferT>
361 void GridHandle<BufferT>::read(std::istream& is, const BufferT& pool)
362{
363 GridData data;
364 is.read((char*)&data, sizeof(GridData));
365 if (data.isValid()) {
366 uint64_t size = data.mGridSize, sum = 0u;
367 while(data.mGridIndex + 1u < data.mGridCount) {// loop over remaining raw grids in stream
368 is.seekg(data.mGridSize - sizeof(GridData), std::ios::cur);// skip grid
369 is.read((char*)&data, sizeof(GridData));
370 sum += data.mGridSize;
371 }
372 auto buffer = BufferT::create(size + sum, &pool);
373 is.seekg(-int64_t(sum + sizeof(GridData)), std::ios::cur);// rewind to start
374 is.read((char*)(buffer.data()), buffer.size());
375 *this = GridHandle(std::move(buffer));
376 } else {
377 is.seekg(-sizeof(GridData), std::ios::cur);// rewind
378 throw std::logic_error("This stream does not contain a valid raw grid buffer");
379 }
380}// void GridHandle<BufferT>::read(std::istream& is, const BufferT& pool)
381
382template<typename BufferT>
383 void GridHandle<BufferT>::read(std::istream& is, uint32_t n, const BufferT& pool)
384{
385 GridData data;
386 is.read((char*)&data, sizeof(GridData));
387 if (data.isValid()) {
388 if (n>=data.mGridCount) throw std::runtime_error("stream does not contain a #" + std::to_string(n) + " grid");
389 while(data.mGridIndex != n) {
390 is.seekg(data.mGridSize - sizeof(GridData), std::ios::cur);// skip grid
391 is.read((char*)&data, sizeof(GridData));
392 }
393 auto buffer = BufferT::create(data.mGridSize, &pool);
394 is.seekg(-sizeof(GridData), std::ios::cur);// rewind
395 is.read((char*)(buffer.data()), data.mGridSize);
396 tools::updateGridCount((GridData*)buffer.data(), 0u, 1u);
397 *this = GridHandle(std::move(buffer));
398 } else {
399 is.seekg(-sizeof(GridData), std::ios::cur);// rewind sizeof(GridData) bytes to undo initial read
400 throw std::logic_error("This file does not contain a valid raw buffer");
401 }
402}// void GridHandle<BufferT>::read(std::istream& is, uint32_t n, const BufferT& pool)
403
404template<typename BufferT>
405 void GridHandle<BufferT>::read(std::istream& is, const std::string &gridName, const BufferT& pool)
406{
407 static const std::streamsize byteSize = sizeof(GridData);
408 GridData data;
409 is.read((char*)&data, byteSize);
410 is.seekg(-byteSize, std::ios::cur);// rewind
411 if (data.isValid()) {
412 uint32_t n = 0;
413 while(data.mGridName != gridName && n++ < data.mGridCount) {
414 is.seekg(data.mGridSize, std::ios::cur);// skip grid
415 is.read((char*)&data, byteSize);// read sizeof(GridData) bytes
416 is.seekg(-byteSize, std::ios::cur);// rewind
417 }
418 if (n>data.mGridCount) throw std::runtime_error("No raw grid named \""+gridName+"\"");
419 auto buffer = BufferT::create(data.mGridSize, &pool);
420 is.read((char*)(buffer.data()), data.mGridSize);
421 tools::updateGridCount((GridData*)buffer.data(), 0u, 1u);
422 *this = GridHandle(std::move(buffer));
423 } else {
424 throw std::logic_error("This file does not contain a valid raw buffer");
425 }
426}// void GridHandle<BufferT>::read(std::istream& is, const std::string &gridName n, const BufferT& pool)
427
428// --------------------------> free-standing functions <------------------------------------
429
430/// @brief Split all grids in a single GridHandle into a vector of multiple GridHandles each with a single grid
431/// @tparam BufferT Type of the input and output grid buffers
432/// @param handle GridHandle with grids that will be slip into individual GridHandles
433/// @param pool optional pool used for allocation of output GridHandle
434/// @return Vector of GridHandles each containing a single grid
435template<typename BufferT, template <class, class...> class VectorT = std::vector>
436inline VectorT<GridHandle<BufferT>>
437splitGrids(const GridHandle<BufferT> &handle, const BufferT* other = nullptr)
438{
439 using HandleT = GridHandle<BufferT>;
440 const void *ptr = handle.data();
441 if (ptr == nullptr) return VectorT<HandleT>();
442 VectorT<HandleT> handles(handle.gridCount());
443 for (auto &h : handles) {
444 const GridData *src = reinterpret_cast<const GridData*>(ptr);
445 NANOVDB_ASSERT(src->isValid());
446 auto buffer = BufferT::create(src->mGridSize, other);
447 GridData *dst = reinterpret_cast<GridData*>(buffer.data());
448 std::memcpy(dst, src, src->mGridSize);
449 tools::updateGridCount(dst, 0u, 1u);
450 h = HandleT(std::move(buffer));
451 ptr = util::PtrAdd(ptr, src->mGridSize);
452 }
453 return std::move(handles);
454}// splitGrids
455
456/// @brief Combines (or merges) multiple GridHandles into a single GridHandle containing all grids
457/// @tparam BufferT Type of the input and output grid buffers
458/// @param handles Vector of GridHandles to be combined
459/// @param pool optional pool used for allocation of output GridHandle
460/// @return single GridHandle containing all input grids
461template<typename BufferT, template <class, class...> class VectorT>
462inline GridHandle<BufferT>
463mergeGrids(const VectorT<GridHandle<BufferT>> &handles, const BufferT* pool = nullptr)
464{
465 uint64_t size = 0u;
466 uint32_t counter = 0u, gridCount = 0u;
467 for (auto &h : handles) {
468 gridCount += h.gridCount();
469 for (uint32_t n=0; n<h.gridCount(); ++n) size += h.gridSize(n);
470 }
471 auto buffer = BufferT::create(size, pool);
472 void *dst = buffer.data();
473 for (auto &h : handles) {
474 const void *src = h.data();
475 for (uint32_t n=0; n<h.gridCount(); ++n) {
476 std::memcpy(dst, src, h.gridSize(n));
477 GridData *data = reinterpret_cast<GridData*>(dst);
478 NANOVDB_ASSERT(data->isValid());
479 tools::updateGridCount(data, counter++, gridCount);
480 dst = util::PtrAdd(dst, data->mGridSize);
481 src = util::PtrAdd(src, data->mGridSize);
482 }
483 }
484 return GridHandle<BufferT>(std::move(buffer));
485}// mergeGrids
486
487} // namespace nanovdb
488
489#if defined(__CUDACC__)
490#include <nanovdb/cuda/GridHandle.cuh>
491#endif// defined(__CUDACC__)
492
493#endif // NANOVDB_GRID_HANDLE_H_HAS_BEEN_INCLUDED
HostBuffer.h
HostBuffer - a buffer that contains a shared or private bump pool to either externally or internally ...
NanoVDB.h
Implements a light-weight self-contained VDB data-structure in a single file! In other words,...
nanovdb::GridHandle
This class serves to manage a buffer containing one or more NanoVDB Grids.
Definition GridHandle.h:38
nanovdb::GridHandle::data
void * data()
Returns a non-const pointer to the data.
Definition GridHandle.h:103
nanovdb::GridHandle::operator=
GridHandle & operator=(const GridHandle &)=delete
Disallow copy assignment operation.
nanovdb::GridHandle::grid
NanoGrid< ValueT > * grid(uint32_t n=0)
Returns a host pointer to the n'th NanoVDB grid encoded in this GridHandle.
Definition GridHandle.h:142
nanovdb::GridHandle::buffer
BufferT & buffer()
Return a reference to the buffer.
Definition GridHandle.h:96
nanovdb::GridHandle::gridData
const GridData * gridData(uint32_t n=0) const
Access to the GridData of the n'th grid in the current handle.
Definition GridHandle.h:293
nanovdb::GridHandle::deviceUpload
util::enable_if< BufferTraits< U >::hasDeviceDual, void >::type deviceUpload(void *stream=nullptr, bool sync=true)
Upload the grid to the device, e.g. from CPU to GPU.
Definition GridHandle.h:167
nanovdb::GridHandle::data
const void * data() const
Returns a const pointer to the data.
Definition GridHandle.h:107
nanovdb::GridHandle::write
void write(std::ostream &os) const
Write the entire grid buffer to an output stream.
Definition GridHandle.h:215
nanovdb::GridHandle::GridHandle
GridHandle(const GridHandle &)=delete
Disallow copy-construction.
nanovdb::GridHandle::operator=
GridHandle & operator=(GridHandle &&other) noexcept
Move copy assignment operation.
Definition GridHandle.h:82
nanovdb::GridHandle::deviceDownload
util::enable_if< BufferTraits< U >::hasDeviceDual, void >::type deviceDownload(void *stream=nullptr, bool sync=true)
Download the grid to from the device, e.g. from GPU to CPU.
Definition GridHandle.h:173
nanovdb::GridHandle::grid
const NanoGrid< ValueT > * grid(uint32_t n=0) const
Returns a const host pointer to the n'th NanoVDB grid encoded in this GridHandle.
Definition GridHandle.h:343
nanovdb::GridHandle::read
void read(const std::string &fileName, const std::string &gridName, const BufferT &pool=BufferT())
Read a specific grid from a file containing a raw grid buffer.
Definition GridHandle.h:283
nanovdb::GridHandle::empty
bool empty() const
Return true if this handle is empty, i.e. has no allocated memory.
Definition GridHandle.h:121
nanovdb::GridHandle::deviceGrid
util::enable_if< BufferTraits< U >::hasDeviceDual, constNanoGrid< ValueT > * >::type deviceGrid(uint32_t n=0) const
Return a const pointer to the n'th grid encoded in this GridHandle on the device, e....
Definition GridHandle.h:353
nanovdb::GridHandle::size
uint64_t size() const
Returns the size in bytes of the raw memory buffer managed by this GridHandle.
Definition GridHandle.h:117
nanovdb::GridHandle::deviceGrid
util::enable_if< BufferTraits< U >::hasDeviceDual, NanoGrid< ValueT > * >::type deviceGrid(uint32_t n=0)
Return a const pointer to the n'th grid encoded in this GridHandle on the device, e....
Definition GridHandle.h:161
nanovdb::GridHandle::buffer
const BufferT & buffer() const
Return a const reference to the buffer.
Definition GridHandle.h:99
nanovdb::GridHandle::GridHandle
GridHandle(GridHandle &&other) noexcept
Move copy-constructor.
Definition GridHandle.h:67
nanovdb::GridHandle::deviceData
util::enable_if< BufferTraits< U >::hasDeviceDual, constvoid * >::type deviceData() const
Definition GridHandle.h:111
nanovdb::GridHandle::gridMetaData
const GridMetaData * gridMetaData(uint32_t n=0) const
Returns a const point to the n'th grid meta data.
Definition GridHandle.h:301
nanovdb::GridHandle::gridSize
uint64_t gridSize(uint32_t n=0) const
Return the grid size of the n'th grid in this GridHandle.
Definition GridHandle.h:185
nanovdb::GridHandle::gridType
GridType gridType(uint32_t n=0) const
Return the GridType of the n'th grid in this GridHandle.
Definition GridHandle.h:190
nanovdb::GridHandle::read
void read(const std::string &fileName, uint32_t n, const BufferT &pool=BufferT())
Read a specific grid from a file containing a raw grid buffer.
Definition GridHandle.h:271
nanovdb::GridHandle::write
void write(const std::string &fileName) const
Write this entire grid buffer to a file.
Definition GridHandle.h:221
nanovdb::GridHandle::isPadded
bool isPadded() const
Check if the buffer is this handle has any padding, i.e. if the buffer is larger than the combined si...
Definition GridHandle.h:177
nanovdb::GridHandle::BufferType
BufferT BufferType
Definition GridHandle.h:46
nanovdb::GridHandle::copy
GridHandle< OtherBufferT > copy(const OtherBufferT &buffer=OtherBufferT()) const
Performs a deep copy of the GridHandle, possibly templated on a different buffer type.
Definition GridHandle.h:333
nanovdb::GridHandle::gridCount
uint32_t gridCount() const
Return the total number of grids contained in this buffer.
Definition GridHandle.h:180
nanovdb::GridHandle::isEmpty
bool isEmpty() const
Definition GridHandle.h:122
nanovdb::GridHandle::reset
void reset()
clear this GridHandle to an empty handle
Definition GridHandle.h:73
nanovdb::GridHandle::GridHandle
GridHandle(T &&buffer)
Move constructor from a host buffer.
Definition GridHandle.h:320
nanovdb::GridHandle::deviceData
util::enable_if< BufferTraits< U >::hasDeviceDual, void * >::type deviceData()
Definition GridHandle.h:114
nanovdb::GridHandle::read
void read(const std::string &fileName, const BufferT &pool=BufferT())
Read a raw grid buffer from a file.
Definition GridHandle.h:259
nanovdb::GridHandle::write
void write(const std::string &fileName, uint32_t n) const
Write a specific grid to file.
Definition GridHandle.h:230
nanovdb::GridHandle::read
void read(std::istream &is, const BufferT &pool=BufferT())
Read an entire raw grid buffer from an input stream.
Definition GridHandle.h:361
nanovdb::GridHandle::write
void write(std::ostream &os, uint32_t n) const
Write a specific grid in this buffer to an output stream.
Definition GridHandle.h:205
nanovdb::GridHandle::GridHandle
GridHandle()=default
Constructs an empty GridHandle.
nanovdb::GridMetaData
This is a convenient class that allows for access to grid meta-data that are independent of the value...
Definition NanoVDB.h:5895
nanovdb::util::PtrAdd
static DstT * PtrAdd(void *p, int64_t offset)
Adds a byte offset to a non-const pointer to produce another non-const pointer.
Definition Util.h:478
nanovdb
Definition GridHandle.h:27
nanovdb::cpyGridHandleMeta
void cpyGridHandleMeta(const GridData *data, GridHandleMetaData *meta)
Definition GridHandle.h:308
nanovdb::mergeGrids
GridHandle< BufferT > mergeGrids(const VectorT< GridHandle< BufferT > > &handles, const BufferT *pool=nullptr)
Combines (or merges) multiple GridHandles into a single GridHandle containing all grids.
Definition GridHandle.h:463
nanovdb::NanoGrid
Grid< NanoTree< BuildT > > NanoGrid
Definition NanoVDB.h:4750
nanovdb::toGridType
__hostdev__ GridType toGridType()
Maps from a templated build type to a GridType enum.
Definition NanoVDB.h:812
nanovdb::splitGrids
VectorT< GridHandle< BufferT > > splitGrids(const GridHandle< BufferT > &handle, const BufferT *other=nullptr)
Split all grids in a single GridHandle into a vector of multiple GridHandles each with a single grid.
Definition GridHandle.h:437
nanovdb::GridType
GridType
List of types that are currently supported by NanoVDB.
Definition NanoVDB.h:219
__hostdev__
#define __hostdev__
Definition Util.h:73
NANOVDB_ASSERT
#define NANOVDB_ASSERT(x)
Definition Util.h:50
nanovdb::GridData
Struct with all the member data of the Grid (useful during serialization of an openvdb grid)
Definition NanoVDB.h:1811
nanovdb::GridData::mGridType
GridType mGridType
Definition NanoVDB.h:1825
nanovdb::GridData::mGridSize
uint64_t mGridSize
Definition NanoVDB.h:1819
nanovdb::GridData::isValid
__hostdev__ bool isValid() const
return true if the magic number and the version are both valid
Definition NanoVDB.h:1864
nanovdb::GridData::mGridCount
uint32_t mGridCount
Definition NanoVDB.h:1818
nanovdb::GridHandleMetaData
Definition GridHandle.h:31
nanovdb::GridHandleMetaData::offset
uint64_t offset
Definition GridHandle.h:31
nanovdb::GridHandleMetaData::gridType
GridType gridType
Definition GridHandle.h:31
nanovdb::GridHandleMetaData::size
uint64_t size
Definition GridHandle.h:31
nanovdb::util::enable_if
C++11 implementation of std::enable_if.
Definition Util.h:335
nanovdb::util::is_same::value
static constexpr bool value
Definition Util.h:316