CE_VDBGrid.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME: CE_VDBGrid.h ( CE Library, C++)
 *
 * COMMENTS: Compute Engine Grid.
 */

#ifndef __CE_VDBGrid__
#define __CE_VDBGrid__

#include "CE_API.h"

#include <UT/UT_Array.h>
#include <UT/UT_NonCopyable.h>
#include <UT/UT_VectorTypes.h>

#include <SYS/SYS_Types.h>

#include <openvdb/Platform.h>
#include <openvdb/openvdb.h>

class CE_API CE_VDBGrid
{
public:
    CE_VDBGrid() {}
    ~CE_VDBGrid() 
    { 
        releaseBuffer(); 
        releaseTileStarts(); 
    };

    UT_NON_COPYABLE(CE_VDBGrid)

    /// Return the underlying OpenCL buffer that can be used in kernel
    /// invocations.
    const cl::Buffer &buffer() const { return myBuffer; }
    exint             bufferSize() const { return myBufSize; }

    const cl::Buffer &tileStarts() const { return myTileStartsBuffer; }
    exint             numTiles() const { return myTileStartsCount; }

    /// If the current OpenCL buffer is valid.
    bool hasBuffer() const { return (myBuffer() != 0);}
    bool hasTileStarts() const { return (myTileStartsBuffer() != 0); }

    /// Initialize the CE_VDBGrid from the supplied VDB grid.
    void  initFromVDB(const openvdb::GridBase &grid);

    /// Initialize the CE_VDBGrid from the supplied buffers of a nanovdb.
    void initFromDeviceBuffers(cl::Buffer gridbuffer, exint gridsize, cl::Buffer tilestartbuffer, exint tilestartcount);

    /// Build the tile start buffer from the provided grid, this will
    /// be one tile per dense leaf node
    void  buildTileStarts(const openvdb::GridBase &grid);

    /// Create a VDB grid from the CE VDB grid
    openvdb::GridBase::Ptr createVDB() const;

protected:

    void releaseBuffer();
    void releaseTileStarts();

    cl::Buffer  myBuffer;
    exint       myBufSize = -1;

    UT_Array<UT_Vector3i>       myTileStarts;
    cl::Buffer  myTileStartsBuffer;
    exint myTileStartsCount = -1;
};

#endif