BottomLevelAS.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 "../../../Primitives/interface/Object.h"
#include "../../../Primitives/interface/FlagEnum.h"
#include "GraphicsTypes.h"
#include "Constants.h"
#include "Buffer.h"
 
DILIGENT_BEGIN_NAMESPACE(Diligent)
 
// {E56F5755-FE5E-496C-BFA7-BCD535360FF7}
static const INTERFACE_ID IID_BottomLevelAS =
    {0xe56f5755, 0xfe5e, 0x496c, {0xbf, 0xa7, 0xbc, 0xd5, 0x35, 0x36, 0xf, 0xf7}};
 
// clang-format off
 
static const Uint32 INVALID_INDEX = ~0u;
 
 
 
struct BLASTriangleDesc
{
    const char*               GeometryName          DEFAULT_INITIALIZER(nullptr);
 
    Uint32                    MaxVertexCount        DEFAULT_INITIALIZER(0);
 
    VALUE_TYPE                VertexValueType       DEFAULT_INITIALIZER(VT_UNDEFINED);
 
    Uint8                     VertexComponentCount  DEFAULT_INITIALIZER(0);
 
    Uint32                    MaxPrimitiveCount     DEFAULT_INITIALIZER(0);
 
    VALUE_TYPE                IndexType             DEFAULT_INITIALIZER(VT_UNDEFINED);
 
    Bool                      AllowsTransforms      DEFAULT_INITIALIZER(False);
    
#if DILIGENT_CPP_INTERFACE
    BLASTriangleDesc() noexcept {}
#endif
};
typedef struct BLASTriangleDesc BLASTriangleDesc;
 
 
 
struct BLASBoundingBoxDesc
{
    const char*               GeometryName  DEFAULT_INITIALIZER(nullptr);
    
    Uint32                    MaxBoxCount   DEFAULT_INITIALIZER(0);
    
#if DILIGENT_CPP_INTERFACE
    BLASBoundingBoxDesc() noexcept {}
#endif
};
typedef struct BLASBoundingBoxDesc BLASBoundingBoxDesc;
 
 
DILIGENT_TYPED_ENUM(RAYTRACING_BUILD_AS_FLAGS, Uint8)
{
    RAYTRACING_BUILD_AS_NONE              = 0,
 
    RAYTRACING_BUILD_AS_ALLOW_UPDATE      = 0x01,
 
    RAYTRACING_BUILD_AS_ALLOW_COMPACTION  = 0x02,
 
    RAYTRACING_BUILD_AS_PREFER_FAST_TRACE = 0x04,
 
    RAYTRACING_BUILD_AS_PREFER_FAST_BUILD = 0x08,
 
    RAYTRACING_BUILD_AS_LOW_MEMORY        = 0x10,
 
    RAYTRACING_BUILD_AS_FLAGS_LAST        = RAYTRACING_BUILD_AS_LOW_MEMORY
};
DEFINE_FLAG_ENUM_OPERATORS(RAYTRACING_BUILD_AS_FLAGS)
 
 
struct BottomLevelASDesc DILIGENT_DERIVE(DeviceObjectAttribs)
 
    const BLASTriangleDesc*    pTriangles       DEFAULT_INITIALIZER(nullptr);
 
    Uint32                     TriangleCount    DEFAULT_INITIALIZER(0);
 
    const BLASBoundingBoxDesc* pBoxes           DEFAULT_INITIALIZER(nullptr);
 
    Uint32                     BoxCount         DEFAULT_INITIALIZER(0);
    
    RAYTRACING_BUILD_AS_FLAGS  Flags            DEFAULT_INITIALIZER(RAYTRACING_BUILD_AS_NONE);
 
    Uint32                     CompactedSize    DEFAULT_INITIALIZER(0);
    
    Uint64                     CommandQueueMask DEFAULT_INITIALIZER(1);
 
#if DILIGENT_CPP_INTERFACE
    BottomLevelASDesc() noexcept {}
#endif
};
typedef struct BottomLevelASDesc BottomLevelASDesc;
 
 
struct ScratchBufferSizes
{
    Uint32 Build  DEFAULT_INITIALIZER(0);
    
    Uint32 Update DEFAULT_INITIALIZER(0);
    
#if DILIGENT_CPP_INTERFACE
    ScratchBufferSizes() noexcept {}
#endif
};
typedef struct ScratchBufferSizes ScratchBufferSizes;
 
 
#define DILIGENT_INTERFACE_NAME IBottomLevelAS
#include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
 
#define IBottomLevelASInclusiveMethods     \
    IDeviceObjectInclusiveMethods;         \
    IBottomLevelASMethods BottomLevelAS
 
 
DILIGENT_BEGIN_INTERFACE(IBottomLevelAS, IDeviceObject)
{
#if DILIGENT_CPP_INTERFACE
    virtual const BottomLevelASDesc& DILIGENT_CALL_TYPE GetDesc() const override = 0;
#endif
 
 
    VIRTUAL Uint32 METHOD(GetGeometryDescIndex)(THIS_
                                                const char* Name) CONST PURE;
 
 
    
    VIRTUAL Uint32 METHOD(GetGeometryIndex)(THIS_
                                            const char* Name) CONST PURE;
 
 
 
    VIRTUAL Uint32 METHOD(GetActualGeometryCount)(THIS) CONST PURE;
 
 
    
    VIRTUAL ScratchBufferSizes METHOD(GetScratchBufferSizes)(THIS) CONST PURE;
 
 
 
    VIRTUAL void* METHOD(GetNativeHandle)(THIS) PURE;
 
 
 
    VIRTUAL void METHOD(SetState)(THIS_
                                  RESOURCE_STATE State) PURE;
 
 
    VIRTUAL RESOURCE_STATE METHOD(GetState)(THIS) CONST PURE;
};
DILIGENT_END_INTERFACE
 
#include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
 
#if DILIGENT_C_INTERFACE
 
// clang-format off
 
#    define IBottomLevelAS_GetGeometryDescIndex(This, ...)  CALL_IFACE_METHOD(BottomLevelAS, GetGeometryDescIndex,   This, __VA_ARGS__)
#    define IBottomLevelAS_GetGeometryIndex(This, ...)      CALL_IFACE_METHOD(BottomLevelAS, GetGeometryIndex,       This, __VA_ARGS__)
#    define IBottomLevelAS_GetActualGeometryCount(This)     CALL_IFACE_METHOD(BottomLevelAS, GetActualGeometryCount, This)
#    define IBottomLevelAS_GetScratchBufferSizes(This)      CALL_IFACE_METHOD(BottomLevelAS, GetScratchBufferSizes,  This)
#    define IBottomLevelAS_GetNativeHandle(This)            CALL_IFACE_METHOD(BottomLevelAS, GetNativeHandle,        This)
#    define IBottomLevelAS_SetState(This, ...)              CALL_IFACE_METHOD(BottomLevelAS, SetState,               This, __VA_ARGS__)
#    define IBottomLevelAS_GetState(This)                   CALL_IFACE_METHOD(BottomLevelAS, GetState,               This)
 
// clang-format on
 
#endif
 
DILIGENT_END_NAMESPACE // namespace Diligent