TopLevelAS.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"
#include "BottomLevelAS.h"
 
DILIGENT_BEGIN_NAMESPACE(Diligent)
 
// {16561861-294B-4804-96FA-1717333F769A}
static const INTERFACE_ID IID_TopLevelAS =
    {0x16561861, 0x294b, 0x4804, {0x96, 0xfa, 0x17, 0x17, 0x33, 0x3f, 0x76, 0x9a}};
 
// clang-format off
 
struct TopLevelASDesc DILIGENT_DERIVE(DeviceObjectAttribs)
 
    Uint32                    MaxInstanceCount 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
    TopLevelASDesc() noexcept {}
#endif
};
typedef struct TopLevelASDesc TopLevelASDesc;
 
 
DILIGENT_TYPED_ENUM(HIT_GROUP_BINDING_MODE, Uint8)
{
    HIT_GROUP_BINDING_MODE_PER_GEOMETRY = 0,
 
    HIT_GROUP_BINDING_MODE_PER_INSTANCE,
 
    HIT_GROUP_BINDING_MODE_PER_TLAS,
 
    HIT_GROUP_BINDING_MODE_USER_DEFINED,
 
    HIT_GROUP_BINDING_MODE_LAST = HIT_GROUP_BINDING_MODE_USER_DEFINED,
};
 
 
struct TLASBuildInfo
{
    Uint32                 InstanceCount                    DEFAULT_INITIALIZER(0);
    
    Uint32                 HitGroupStride                   DEFAULT_INITIALIZER(0);
    
    HIT_GROUP_BINDING_MODE BindingMode                      DEFAULT_INITIALIZER(HIT_GROUP_BINDING_MODE_PER_GEOMETRY);
 
    Uint32                 FirstContributionToHitGroupIndex DEFAULT_INITIALIZER(0);
 
    Uint32                 LastContributionToHitGroupIndex  DEFAULT_INITIALIZER(0);
};
typedef struct TLASBuildInfo TLASBuildInfo;
 
 
struct TLASInstanceDesc
{
    Uint32          ContributionToHitGroupIndex DEFAULT_INITIALIZER(0);
    
    Uint32          InstanceIndex               DEFAULT_INITIALIZER(0);
 
    IBottomLevelAS* pBLAS                       DEFAULT_INITIALIZER(nullptr);
    
#if DILIGENT_CPP_INTERFACE
    TLASInstanceDesc() noexcept {}
#endif
};
typedef struct TLASInstanceDesc TLASInstanceDesc;
 
 
#define DILIGENT_INTERFACE_NAME ITopLevelAS
#include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
 
#define ITopLevelASInclusiveMethods        \
    IDeviceObjectInclusiveMethods;         \
    ITopLevelASMethods TopLevelAS
 
 
DILIGENT_BEGIN_INTERFACE(ITopLevelAS, IDeviceObject)
{
#if DILIGENT_CPP_INTERFACE
    virtual const TopLevelASDesc& DILIGENT_CALL_TYPE GetDesc() const override = 0;
#endif
    
    
    VIRTUAL TLASInstanceDesc METHOD(GetInstanceDesc)(THIS_
                                                     const char* Name) CONST PURE;
    
 
    
    VIRTUAL TLASBuildInfo METHOD(GetBuildInfo)(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 ITopLevelAS_GetInstanceDesc(This, ...)  CALL_IFACE_METHOD(TopLevelAS, GetInstanceDesc,       This, __VA_ARGS__)
#    define ITopLevelAS_GetBuildInfo(This)          CALL_IFACE_METHOD(TopLevelAS, GetBuildInfo,          This)
#    define ITopLevelAS_GetScratchBufferSizes(This) CALL_IFACE_METHOD(TopLevelAS, GetScratchBufferSizes, This)
#    define ITopLevelAS_GetNativeHandle(This)       CALL_IFACE_METHOD(TopLevelAS, GetNativeHandle,       This)
#    define ITopLevelAS_SetState(This, ...)         CALL_IFACE_METHOD(TopLevelAS, SetState,              This, __VA_ARGS__)
#    define ITopLevelAS_GetState(This)              CALL_IFACE_METHOD(TopLevelAS, GetState,              This)
 
// clang-format on
 
#endif
 
DILIGENT_END_NAMESPACE // namespace Diligent