Query.h

Go to the documentation of this file.

/*
 *  Copyright 2019-2021 Diligent Graphics LLC
 *  Copyright 2015-2019 Egor Yusov
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  
 *      http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  In no event and under no legal theory, whether in tort (including negligence), 
 *  contract, or otherwise, unless required by applicable law (such as deliberate 
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental, 
 *  or consequential damages of any character arising as a result of this License or 
 *  out of the use or inability to use the software (including but not limited to damages 
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
 *  all other commercial damages or losses), even if such Contributor has been advised 
 *  of the possibility of such damages.
 */
 
#pragma once
 
 
#include "DeviceObject.h"
#include "GraphicsTypes.h"
 
DILIGENT_BEGIN_NAMESPACE(Diligent)
 
// {70F2A88A-F8BE-4901-8F05-2F72FA695BA0}
static const INTERFACE_ID IID_Query =
    {0x70f2a88a, 0xf8be, 0x4901, {0x8f, 0x5, 0x2f, 0x72, 0xfa, 0x69, 0x5b, 0xa0}};
 
struct QueryDataOcclusion
{
    const enum QUERY_TYPE Type DEFAULT_INITIALIZER(QUERY_TYPE_OCCLUSION);
 
    Uint64 NumSamples DEFAULT_INITIALIZER(0);
};
typedef struct QueryDataOcclusion QueryDataOcclusion;
 
struct QueryDataBinaryOcclusion
{
    const enum QUERY_TYPE Type DEFAULT_INITIALIZER(QUERY_TYPE_BINARY_OCCLUSION);
 
    bool AnySamplePassed DEFAULT_INITIALIZER(0);
};
typedef struct QueryDataBinaryOcclusion QueryDataBinaryOcclusion;
 
struct QueryDataTimestamp
{
    const enum QUERY_TYPE Type DEFAULT_INITIALIZER(QUERY_TYPE_TIMESTAMP);
 
    Uint64 Counter DEFAULT_INITIALIZER(0);
 
    Uint64 Frequency DEFAULT_INITIALIZER(0);
};
typedef struct QueryDataTimestamp QueryDataTimestamp;
 
struct QueryDataPipelineStatistics
{
    const enum QUERY_TYPE Type DEFAULT_INITIALIZER(QUERY_TYPE_PIPELINE_STATISTICS);
 
    Uint64 InputVertices DEFAULT_INITIALIZER(0);
 
    Uint64 InputPrimitives DEFAULT_INITIALIZER(0);
 
    Uint64 GSPrimitives DEFAULT_INITIALIZER(0);
 
    Uint64 ClippingInvocations DEFAULT_INITIALIZER(0);
 
    Uint64 ClippingPrimitives DEFAULT_INITIALIZER(0);
 
    Uint64 VSInvocations DEFAULT_INITIALIZER(0);
 
    Uint64 GSInvocations DEFAULT_INITIALIZER(0);
 
    Uint64 PSInvocations DEFAULT_INITIALIZER(0);
 
    Uint64 HSInvocations DEFAULT_INITIALIZER(0);
 
    Uint64 DSInvocations DEFAULT_INITIALIZER(0);
 
    Uint64 CSInvocations DEFAULT_INITIALIZER(0);
};
typedef struct QueryDataPipelineStatistics QueryDataPipelineStatistics;
 
struct QueryDataDuration
{
    const enum QUERY_TYPE Type DEFAULT_INITIALIZER(QUERY_TYPE_DURATION);
 
    Uint64 Duration DEFAULT_INITIALIZER(0);
 
    Uint64 Frequency DEFAULT_INITIALIZER(0);
};
typedef struct QueryDataDuration QueryDataDuration;
 
// clang-format off
 
struct QueryDesc DILIGENT_DERIVE(DeviceObjectAttribs)
 
    enum QUERY_TYPE Type DEFAULT_INITIALIZER(QUERY_TYPE_UNDEFINED);
 
#if DILIGENT_CPP_INTERFACE
    QueryDesc() noexcept {};
 
    explicit QueryDesc(QUERY_TYPE _Type) noexcept :
        Type(_Type)
    {}
#endif
};
typedef struct QueryDesc QueryDesc;
 
#define DILIGENT_INTERFACE_NAME IQuery
#include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
 
#define IQueryInclusiveMethods     \
    IDeviceObjectInclusiveMethods; \
    IQueryMethods Query
 
// clang-format off
 
 
DILIGENT_BEGIN_INTERFACE(IQuery, IDeviceObject)
{
#if DILIGENT_CPP_INTERFACE
    virtual const QueryDesc& METHOD(GetDesc)() const override = 0;
#endif
 
 
    VIRTUAL bool METHOD(GetData)(THIS_
                                 void*   pData,
                                 Uint32  DataSize, 
                                 bool    AutoInvalidate DEFAULT_VALUE(true)) PURE;
 
    VIRTUAL void METHOD(Invalidate)(THIS) PURE;
};
DILIGENT_END_INTERFACE
 
#include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
 
#if DILIGENT_C_INTERFACE
 
// clang-format off
 
#    define IQuery_GetDesc(This) (const struct QueryDesc*)IDeviceObject_GetDesc(This)
 
#    define IQuery_GetData(This, ...) CALL_IFACE_METHOD(Query, GetData,    This, __VA_ARGS__)
#    define IQuery_Invalidate(This)   CALL_IFACE_METHOD(Query, Invalidate, This)
 
// clang-format on
 
#endif
 
DILIGENT_END_NAMESPACE // namespace Diligent