NvBlastTypes.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and related documentation and
// any modifications thereto. Any use, reproduction, disclosure, or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA Corporation is strictly prohibited.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2016-2020 NVIDIA Corporation. All rights reserved.


#ifndef NVBLASTTYPES_H
#define NVBLASTTYPES_H


#include "NvBlastPreprocessor.h"
#include <stdint.h>


//  NvBlast common types

struct NvBlastMessage
{
    enum Type
    {
        Error,      
        Warning,    
        Info,       
        Debug       
    };
};


typedef void(*NvBlastLog)(int type, const char* msg, const char* file, int line);


struct NvBlastID
{
    char data[16];
};


struct NvBlastTimers
{
    int64_t  material;      
    int64_t  fracture;      
    int64_t  island;        
    int64_t  partition;     
    int64_t  visibility;    
};


struct NvBlastDataBlock
{
    enum Type
    {
        AssetDataBlock,
        FamilyDataBlock,

        Count
    };


    uint32_t    dataType;

    uint32_t    formatVersion;

    uint32_t    size;

    uint32_t    reserved;
};



//  NvBlastAsset related types

struct NvBlastChunk
{
    float       centroid[3];

    float       volume;

    uint32_t    parentChunkIndex;

    uint32_t    firstChildIndex;

    uint32_t    childIndexStop;

    uint32_t    userData;
};


struct NvBlastBond
{
    float       normal[3];

    float       area;

    float       centroid[3];

    uint32_t    userData;
};


struct NvBlastSupportGraph
{
    uint32_t    nodeCount;

    uint32_t*   chunkIndices;

    uint32_t*   adjacencyPartition;

    uint32_t*   adjacentNodeIndices;

    uint32_t*   adjacentBondIndices;
};


struct NvBlastAsset {};


struct NvBlastChunkDesc
{
    enum Flags
    {
        NoFlags = 0,

        SupportFlag = (1 << 0)
    };

    float       centroid[3];

    float       volume;

    uint32_t    parentChunkIndex;

    uint32_t    flags;

    uint32_t    userData;
};


struct NvBlastBondDesc
{
    NvBlastBond bond;

    uint32_t    chunkIndices[2];
};


struct NvBlastAssetDesc
{
    uint32_t                chunkCount;

    const NvBlastChunkDesc* chunkDescs;

    uint32_t                bondCount;

    const NvBlastBondDesc*  bondDescs;
};



//  NvBlastActor related types

struct NvBlastFamily {};


struct NvBlastActor {};


struct NvBlastActorDesc
{
    float           uniformInitialBondHealth;

    const float*    initialBondHealths;

    float           uniformInitialLowerSupportChunkHealth;

    const float*    initialSupportChunkHealths;
};



//  Types used for damage and fracturing


struct NvBlastChunkFractureData
{
    uint32_t    userdata;   
    uint32_t    chunkIndex; 
    float       health;     
};


struct NvBlastBondFractureData
{
    uint32_t    userdata;   
    uint32_t    nodeIndex0; 
    uint32_t    nodeIndex1; 
    float       health;     
};


struct NvBlastFractureBuffers
{
    uint32_t                    bondFractureCount;      
    uint32_t                    chunkFractureCount;     
    NvBlastBondFractureData*    bondFractures;          
    NvBlastChunkFractureData*   chunkFractures;         
};


struct NvBlastActorSplitEvent
{
    NvBlastActor*   deletedActor;   
    NvBlastActor**  newActors;      
};


struct NvBlastGraphShaderActor
{
    uint32_t            actorIndex;             
    uint32_t            graphNodeCount;         
    uint32_t            assetNodeCount;         
    uint32_t            firstGraphNodeIndex;    
    const uint32_t*     graphNodeIndexLinks;    
    const uint32_t*     chunkIndices;           
    const uint32_t*     adjacencyPartition;     
    const uint32_t*     adjacentNodeIndices;    
    const uint32_t*     adjacentBondIndices;    
    const NvBlastBond*  assetBonds;             
    const NvBlastChunk* assetChunks;            
    const float*        familyBondHealths;      
    const float*        supportChunkHealths;    
    const uint32_t*     nodeActorIndices;       
};


struct NvBlastSubgraphShaderActor
{
    uint32_t            chunkIndex;     
    const NvBlastChunk* assetChunks;    
};


typedef void(*NvBlastGraphShaderFunction)(NvBlastFractureBuffers* commandBuffers, const NvBlastGraphShaderActor* actor, const void* programParams);


typedef void(*NvBlastSubgraphShaderFunction)(NvBlastFractureBuffers* commandBuffers, const NvBlastSubgraphShaderActor* actor, const void* programParams);


struct NvBlastDamageProgram
{
    NvBlastGraphShaderFunction      graphShaderFunction;
    NvBlastSubgraphShaderFunction   subgraphShaderFunction;
};




#endif // ifndef NVBLASTTYPES_H