lowlevel/NvBlast.h

In directory: lowlevel

Source file: lowlevel/NvBlast.h

Defines the API for the low-level blast library.

Macros

• NvBlastActorIsBoundToWorld

Functions

• NvBlastActorApplyFracture(NvBlastFractureBuffers *eventBuffers, NvBlastActor *actor, const NvBlastFractureBuffers *commands, NvBlastLog logFn, NvBlastTimers *timers): Applies the direct fracture and breaks graph bonds/edges as necessary.

• NvBlastActorCacheBondHeath(const NvBlastActor *actor, uint32_t bondIndex, NvBlastLog logFn): Tell the system to cache the bond health for the given bond index.

• NvBlastActorCanFracture(const NvBlastActor *actor, NvBlastLog logFn): Determines if the actor can fracture further.

• NvBlastActorDeactivate(NvBlastActor *actor, NvBlastLog logFn): Deactivate an actor within its family.

• NvBlastActorGenerateFracture(NvBlastFractureBuffers *commandBuffers, const NvBlastActor *actor, const NvBlastDamageProgram program, const void *programParams, NvBlastLog logFn, NvBlastTimers *timers): Creates fracture commands for the actor using a damage program and program parameters (material and damage descriptions).

• NvBlastActorGetBondHealths(const NvBlastActor *actor, NvBlastLog logFn): Access the bond health data for an actor.

• NvBlastActorGetCachedBondHeaths(const NvBlastActor *actor, NvBlastLog logFn): Access the cached bond health data for an actor.

• NvBlastActorGetFamily(const NvBlastActor *actor, NvBlastLog logFn): Access to an actor's family.

• NvBlastActorGetGraphNodeCount(const NvBlastActor *actor, NvBlastLog logFn): Get the number of graph nodes for this actor.

• NvBlastActorGetGraphNodeIndices(uint32_t *graphNodeIndices, uint32_t graphNodeIndicesSize, const NvBlastActor *actor, NvBlastLog logFn): Retrieve a list of graph node indices for the actor into the given array.

• NvBlastActorGetIndex(const NvBlastActor *actor, NvBlastLog logFn): Access to an actor's internal index.

• NvBlastActorGetMaxActorCountForSplit(const NvBlastActor *actor, NvBlastLog logFn): Returns the upper-bound number of actors which can be created by calling NvBlastActorSplit with that actor, this value can't exceed chunk count.

• NvBlastActorGetRequiredScratchForSplit(const NvBlastActor *actor, NvBlastLog logFn): Returns the number of bytes of scratch memory that the user must supply to NvBlastActorSplit, based upon the actor that will be passed into that function.

• NvBlastActorGetSerializationSize(const NvBlastActor *actor, NvBlastLog logFn): The buffer size needed to serialize a single actor.

• NvBlastActorGetVisibleChunkCount(const NvBlastActor *actor, NvBlastLog logFn): Get the number of visible chunks for this actor.

• NvBlastActorGetVisibleChunkIndices(uint32_t *visibleChunkIndices, uint32_t visibleChunkIndicesSize, const NvBlastActor *actor, NvBlastLog logFn): Retrieve a list of visible chunk indices for the actor into the given array.

• NvBlastActorHasExternalBonds(const NvBlastActor *actor, NvBlastLog logFn)

• NvBlastActorIsSplitRequired(const NvBlastActor *actor, NvBlastLog logFn): Determines if the actor is damaged (was fractured) and split call is required.

• NvBlastActorSerialize(void *buffer, uint32_t bufferSize, const NvBlastActor *actor, NvBlastLog logFn): Serialize a single actor to a buffer.

• NvBlastActorSplit(NvBlastActorSplitEvent *result, NvBlastActor *actor, uint32_t newActorsMaxCount, void *scratch, NvBlastLog logFn, NvBlastTimers *timers): Releases the oldActor and creates its children newActors if necessary.

• NvBlastApplyAssetDescChunkReorderMap(NvBlastChunkDesc *reorderedChunkDescs, const NvBlastChunkDesc *chunkDescs, uint32_t chunkCount, NvBlastBondDesc *bondDescs, uint32_t bondCount, const uint32_t *chunkReorderMap, bool keepBondNormalChunkOrder, NvBlastLog logFn): Apply chunk reorder map.

• NvBlastApplyAssetDescChunkReorderMapInPlace(NvBlastChunkDesc *chunkDescs, uint32_t chunkCount, NvBlastBondDesc *bondDescs, uint32_t bondCount, const uint32_t *chunkReorderMap, bool keepBondNormalChunkOrder, void *scratch, NvBlastLog logFn): Apply chunk reorder map.

• NvBlastAssetCreateFamily(void *mem, const NvBlastAsset *asset, NvBlastLog logFn): Family-building function.

• NvBlastAssetCreateFamilyFromSizeData(void *mem, const NvBlastAssetMemSizeData &sizeData, NvBlastLog logFn): Family-building function.

• NvBlastAssetGetActorSerializationSizeUpperBound(const NvBlastAsset *asset, NvBlastLog logFn): A buffer size sufficient to serialize an actor instanced from a given asset.

• NvBlastAssetGetBondCount(const NvBlastAsset *asset, NvBlastLog logFn): Get the number of bonds in the given asset.

• NvBlastAssetGetBonds(const NvBlastAsset *asset, NvBlastLog logFn): Access an array of bonds of the given asset.

• NvBlastAssetGetChunkCount(const NvBlastAsset *asset, NvBlastLog logFn): Get the number of chunks in the given asset.

• NvBlastAssetGetChunkToGraphNodeMap(const NvBlastAsset *asset, NvBlastLog logFn): Access a map from chunk index to graph node index.

• NvBlastAssetGetChunks(const NvBlastAsset *asset, NvBlastLog logFn): Access an array of chunks of the given asset.

• NvBlastAssetGetFamilyMemorySize(const NvBlastAsset *asset, NvBlastLog logFn): Calculates the memory requirements for a family based upon an asset.

• NvBlastAssetGetFamilyMemorySizeFromSizeData(const NvBlastAssetMemSizeData &sizeData, NvBlastLog logFn): Calculates the memory requirements for a family based upon supplied sized data.

• NvBlastAssetGetFirstSubsupportChunkIndex(const NvBlastAsset *asset, NvBlastLog logFn): Get the first subsupport chunk index in the given asset.

• NvBlastAssetGetFormatVersion(const NvBlastAsset *asset, NvBlastLog logFn): Retrieve the data format version for the given asset.

• NvBlastAssetGetID(const NvBlastAsset *asset, NvBlastLog logFn): Retrieve the asset ID.

• NvBlastAssetGetLeafChunkCount(const NvBlastAsset *asset, NvBlastLog logFn): Get the number of leaf chunks in the given asset.

• NvBlastAssetGetSize(const NvBlastAsset *asset, NvBlastLog logFn): Retrieve the memory size (in bytes) of the given data asset.

• NvBlastAssetGetSupportChunkCount(const NvBlastAsset *asset, NvBlastLog logFn): Get the number of support chunks in the given asset.

• NvBlastAssetGetSupportGraph(const NvBlastAsset *asset, NvBlastLog logFn): Access the support graph for the given asset.

• NvBlastAssetMemSizeDataFromAsset(const NvBlastAsset *asset): Fill out the size data from the provided asset.

• NvBlastAssetSetID(NvBlastAsset *asset, const NvBlastID *id, NvBlastLog logFn): Set an asset's ID.

• NvBlastBuildAssetDescChunkReorderMap(uint32_t *chunkReorderMap, const NvBlastChunkDesc *chunkDescs, uint32_t chunkCount, void *scratch, NvBlastLog logFn): Build chunk reorder map.

• NvBlastCreateAsset(void *mem, const NvBlastAssetDesc *desc, void *scratch, NvBlastLog logFn): Asset-building function.

• NvBlastEnsureAssetExactSupportCoverage(NvBlastChunkDesc *chunkDescs, uint32_t chunkCount, void *scratch, NvBlastLog logFn): Function to ensure (check and update) support coverage of chunks.

• NvBlastFamilyCreateFirstActor(NvBlastFamily *family, const NvBlastActorDesc *desc, void *scratch, NvBlastLog logFn): Instance the family's asset into a new, unfractured actor.

• NvBlastFamilyDeserializeActor(NvBlastFamily *family, const void *buffer, NvBlastLog logFn): Deserialize a single Actor from a buffer into the given family.

• NvBlastFamilyGetActorByIndex(const NvBlastFamily *family, uint32_t actorIndex, NvBlastLog logFn): Retrieve the actor associated with the given actor index.

• NvBlastFamilyGetActorCount(const NvBlastFamily *family, NvBlastLog logFn): Retrieve the number of active actors associated with the given family.

• NvBlastFamilyGetActors(NvBlastActor **actors, uint32_t actorsSize, const NvBlastFamily *family, NvBlastLog logFn): Retrieve the active actors associated with the given family.

• NvBlastFamilyGetAsset(const NvBlastFamily *family, NvBlastLog logFn): Retrieve the asset of the given family.

• NvBlastFamilyGetAssetID(const NvBlastFamily *family, NvBlastLog logFn): Retrieve the asset ID of the given family.

• NvBlastFamilyGetChunkActor(const NvBlastFamily *family, uint32_t chunkIndex, NvBlastLog logFn): Retrieve the actor associated with the given chunk.

• NvBlastFamilyGetChunkActorIndices(const NvBlastFamily *family, NvBlastLog logFn): Retrieve the actor indices associated with chunks.

• NvBlastFamilyGetFormatVersion(const NvBlastFamily *family, NvBlastLog logFn): Retrieve the data format version for the given family.

• NvBlastFamilyGetMaxActorCount(const NvBlastFamily *family, NvBlastLog logFn): Retrieve the max active actor count family could have.

• NvBlastFamilyGetRequiredScratchForCreateFirstActor(const NvBlastFamily *family, NvBlastLog logFn): Returns the number of bytes of scratch memory that the user must supply to NvBlastFamilyCreateFirstActor.

• NvBlastFamilyGetSize(const NvBlastFamily *family, NvBlastLog logFn): Retrieve the size (in bytes) of the given family.

• NvBlastFamilySetAsset(NvBlastFamily *family, const NvBlastAsset *asset, NvBlastLog logFn): Set asset to the family.

• NvBlastGetAssetMemorySize(const NvBlastAssetDesc *desc, NvBlastLog logFn): Calculates the memory requirements for an asset based upon its descriptor.

• NvBlastGetAssetMemorySizeFromSizeData(const NvBlastAssetMemSizeData &sizeData, NvBlastLog logFn): Calculates the memory requirements for an asset based upon supplied sized data.

• NvBlastGetRequiredScratchForCreateAsset(const NvBlastAssetDesc *desc, NvBlastLog logFn): Returns the number of bytes of scratch memory that the user must supply to NvBlastCreateAsset, based upon the descriptor that will be passed into that function.

• NvBlastReorderAssetDescChunks(NvBlastChunkDesc *chunkDescs, uint32_t chunkCount, NvBlastBondDesc *bondDescs, uint32_t bondCount, uint32_t *chunkReorderMap, bool keepBondNormalChunkOrder, void *scratch, NvBlastLog logFn): Build and apply chunk reorder map.

• NvBlastTicksToSeconds(int64_t ticks): Convert a tick value from NvBlastTimers to seconds.

• NvBlastTimersReset(NvBlastTimers *timers): Resets all values in the given NvBlastTimers struct to zero.