NvBlastActorSerializationBlock.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 NVBLASTACTORSERIALIZATIONBLOCK_H
#define NVBLASTACTORSERIALIZATIONBLOCK_H


#include "NvBlastFixedBoolArray.h"


namespace Nv
{
namespace Blast
{

struct ActorSerializationFormat
{
    enum Version
    {
        Initial,

        //  New formats must come before Count.  They should be given descriptive names with more information in comments.

        Count,

        Current = Count - 1
    };
};


struct ActorSerializationHeader
{
    uint32_t    m_formatVersion;

    uint32_t    m_size;

    uint32_t    m_index;

    uint32_t    m_visibleChunkCount;

    uint32_t    m_graphNodeCount;

    uint32_t    m_leafChunkCount;

    NvBlastBlockArrayData(uint32_t, m_visibleChunkIndicesOffset, getVisibleChunkIndices, m_visibleChunkCount);

    NvBlastBlockArrayData(uint32_t, m_graphNodeIndicesOffset, getGraphNodeIndices, m_graphNodeCount);

    NvBlastBlockData(float, m_lowerSupportChunkHealthsOffset, getLowerSupportChunkHealths);

    NvBlastBlockData(float, m_bondHealthsOffset, getBondHealths);

    NvBlastBlockArrayData(uint32_t, m_fastRouteOffset, getFastRoute, m_graphNodeCount);

    NvBlastBlockArrayData(uint32_t, m_hopCountsOffset, getHopCounts, m_graphNodeCount);

    NvBlastBlockData(FixedBoolArray, m_edgeRemovedArrayOffset, getEdgeRemovedArray);
};



NV_INLINE size_t getActorSerializationSize(uint32_t visibleChunkCount, uint32_t lowerSupportChunkCount, uint32_t graphNodeCount, uint32_t bondCount)
{
    // Family offsets
    const size_t visibleChunkIndicesOffset = align16(sizeof(ActorSerializationHeader));                             // size = visibleChunkCount*sizeof(uint32_t)
    const size_t graphNodeIndicesOffset = align16(visibleChunkIndicesOffset + visibleChunkCount*sizeof(uint32_t));  // size = graphNodeCount*sizeof(uint32_t)
    const size_t lowerSupportHealthsOffset = align16(graphNodeIndicesOffset + graphNodeCount*sizeof(uint32_t));     // size = lowerSupportChunkCount*sizeof(float)
    const size_t bondHealthsOffset = align16(lowerSupportHealthsOffset + lowerSupportChunkCount*sizeof(float));     // size = bondCount*sizeof(float)
    const size_t fastRouteOffset = align16(bondHealthsOffset + bondCount*sizeof(float));                            // size = graphNodeCount*sizeof(uint32_t)
    const size_t hopCountsOffset = align16(fastRouteOffset + graphNodeCount*sizeof(uint32_t));                      // size = graphNodeCount*sizeof(uint32_t)
    const size_t edgeRemovedArrayOffset = align16(hopCountsOffset + graphNodeCount*sizeof(uint32_t));               // size = 0 or FixedBoolArray::requiredMemorySize(bondCount)
    return align16(edgeRemovedArrayOffset + (bondCount == 0 ? 0 : FixedBoolArray::requiredMemorySize(bondCount)));
}

} // namespace Blast
} // namespace Nv


#endif // ifndef NVBLASTACTORSERIALIZATIONBLOCK_H