diff options
| author | Bryan Galdrikian <[email protected]> | 2018-05-31 11:36:08 -0700 |
|---|---|---|
| committer | Bryan Galdrikian <[email protected]> | 2018-05-31 11:36:08 -0700 |
| commit | 7115f60b91b5717d90f643fd692010905c7004db (patch) | |
| tree | effd68c6978751c517d54c2f2bb5bb6e7dc93e18 /docs/_source/ext_tkserialization.txt | |
| parent | Updating BlastTool zip (diff) | |
| download | blast-1.1.3_rc1.tar.xz blast-1.1.3_rc1.zip | |
Blast 1.1.3. See docs/release_notes.txt.v1.1.3_rc1
Diffstat (limited to 'docs/_source/ext_tkserialization.txt')
| -rwxr-xr-x[-rw-r--r--] | docs/_source/ext_tkserialization.txt | 90 |
1 files changed, 45 insertions, 45 deletions
diff --git a/docs/_source/ext_tkserialization.txt b/docs/_source/ext_tkserialization.txt index 6dbd4f5..a1c9f22 100644..100755 --- a/docs/_source/ext_tkserialization.txt +++ b/docs/_source/ext_tkserialization.txt @@ -1,45 +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 are 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> -*/ +/*! \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 are 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>
+*/
|