diff options
Diffstat (limited to 'docs/_source/ext_tkserialization.txt')
| -rw-r--r-- | docs/_source/ext_tkserialization.txt | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/_source/ext_tkserialization.txt b/docs/_source/ext_tkserialization.txt new file mode 100644 index 0000000..3addaae --- /dev/null +++ b/docs/_source/ext_tkserialization.txt @@ -0,0 +1,45 @@ +/*! \page pageexttkserialization BlastTk Serialization (NvBlastExtTkSerialization) + +This extension contains serializers which can be loaded into the ExtSerialization manager defined in \ref pageextserialization. + +To use this extension, you must also load the ExtSerialization extension and create a serialization manager as described in \ref pageextserialization. + +We repeat this here (again, assuming we're in the Nv::Blast namespace): + +\code +ExtSerialization* ser = NvBlastExtSerializationCreate(); +\endcode + +Then, call the function NvBlastExtTkSerializerLoadSet, declared in <b>NvBlastExtTkSerialization.h</b>, passing in your TkFramework: + +\code +TkFramework* framework = ... // We must have created a TkFramework + +NvBlastExtTkSerializerLoadSet(*framework, *ser); +\endcode + +Now your serialization manager will have the serializers provided by this extension. Currently only TkAsset serializers exist, with object type ID +given by + +<br> +<b>TkObjectTypeID::Asset</b> +<br> + +As with low-level assets, you can serialize using the serialization manager directly: + +\code +const TkAsset* asset = ... // Given pointer to an Nv::Blast::TkAsset + +void* buffer; +uint64_t size = ser->serializeIntoBuffer(buffer, asset, TkObjectTypeID::Asset); +\endcode + +or use the wrapper function defined in <b>NvBlastExtTkSerialization.h</b>: + +/code +void* buffer; +uint64_t size = NvBlastExtSerializationSerializeTkAssetIntoBuffer(buffer, *ser, asset); +/endcode + +<br> +*/ |