RV_Query.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:        RV_Query.h ( RV Library, C++)
 *
 * COMMENTS:
 *      Higher level Class to handle Vulkan Queries
 */

#ifndef RV_Query_h
#define RV_Query_h

#include "RV_API.h"

#include <SYS/SYS_Types.h>
#include <UT/UT_UniquePtr.h>

class RV_Render;
class RV_VKBuffer;
class RV_VKQuery;

enum RV_OcclusionResult
{
    RV_OCCLUSION_BOOLEAN,
    RV_OCCLUSION_NUM_SAMPLES
};

/// Occlusion query object
class RV_API RV_OcclusionQuery 
{
public:
    /// Initialize the query (create it)
    void init(RV_Render* r);
    /// Start the query
    bool begin(RV_Render* r);
    /// End the query
    void end(RV_Render* r);

protected:
    UT_UniquePtr<RV_VKQuery> myQuery;
    bool myIsBoolean;
    bool myIsGPUOnly;

    RV_OcclusionQuery(RV_OcclusionResult t, bool gpu_exclusive);
    virtual ~RV_OcclusionQuery();
};

// RV_OcclusionQueryCPU
// Intenally uses RV_VKQuery
//

/// Query to get occlusion results on the CPU -- useful for Debugging
/// more performant code should use the GPU version (RV_OcclusionQueryGPU)
/// and use conditional rendering in the command buffer
class RV_API RV_OcclusionQueryCPU : public RV_OcclusionQuery 
{
public:

    RV_OcclusionQueryCPU(RV_OcclusionResult t = RV_OCCLUSION_NUM_SAMPLES);
    ~RV_OcclusionQueryCPU() override;

    /// Return true if the query has finished and the result is available
    bool isResultAvailable(RV_Render* r);
    /// Return true if any samples were drawn
    bool getAnySamplesDrawn(RV_Render* r);
    /// Return the exact number of samples drawn
    int64  getNumSamples(RV_Render* r);
};

// RV_OcclusionQueryGPU
// Intenally uses RV_VKQuery
// 
/// Query to get occlusion results on the CPU results are written
/// to a buffer owned by the class instead of CPU memory.
class RV_API RV_OcclusionQueryGPU : public RV_OcclusionQuery 
{
public:
    RV_OcclusionQueryGPU(RV_OcclusionResult t = RV_OCCLUSION_NUM_SAMPLES);
    ~RV_OcclusionQueryGPU() override;

    /// Read the query results into a buffer.
    bool getResults(
            RV_Render* r,
            RV_VKBuffer* buffer,
            bool wait = true);

};
#if 0
/// A query that returns the elapsed time between begin and end in nanoseconds
class RV_API RV_TimerQuery 
{
public:
    RV_TimerQuery();
    
    /// Create the query
    void init(RV_Render* r);
    /// Create the query
    void init(RV_Render* inst);
    /// Begin the timer query
    bool begin(RV_VKCommandBuffer *cb);
    /// Begin end timer query
    void end(RV_VKCommandBuffer* cb);

    /// REturn the elapsed time in nanoseconds (10^-9 seconds)
    int64 getTimeNS();

    void writeResult(RV_VKCommandBuffer* cb, RV_VKBuffer* buf);
private:
    UT_UniquePtr<RV_VKQuery> myQuery;
};

#endif

#endif