diff options
Diffstat (limited to 'docs/_source/ext_pxserialization.txt')
| -rwxr-xr-x[-rw-r--r--] | docs/_source/ext_pxserialization.txt | 96 |
1 files changed, 48 insertions, 48 deletions
diff --git a/docs/_source/ext_pxserialization.txt b/docs/_source/ext_pxserialization.txt index a8f4ea0..5638ee2 100644..100755 --- a/docs/_source/ext_pxserialization.txt +++ b/docs/_source/ext_pxserialization.txt @@ -1,48 +1,48 @@ -/*! \page pageextpxserialization ExtPhysX Serialization (NvBlastExtPxSerialization) - -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 NvBlastExtPxSerializerLoadSet, declared in <b>NvBlastExtPxSerialization.h</b>, passing in your TkFramework (required by ExtPhysX), along with -your physx::PxPhysics and physx::PxCooking pointers: - -\code -TkFramework* framework = ... // We must have created a TkFramework -physx::PxPhysics* physics = ... // and PxPhysics -physx::PxCooking* cooking = ... // and PxCooking - -NvBlastExtPxSerializerLoadSet(*framework, *physics, *cooking *ser); -\endcode - -Now your serialization manager will have the serializers provided by this extension. Currently only ExtPxAsset serializers exist, with object type ID -given by - -<br> -<b>ExtPxObjectTypeID::Asset</b> -<br> - -As with low-level assets, you can serialize using the serialization manager directly: - -\code -const ExtPxAsset* asset = ... // Given pointer to an Nv::Blast::ExtPxAsset - -void* buffer; -uint64_t size = ser->serializeIntoBuffer(buffer, asset, ExtPxObjectTypeID::Asset); -\endcode - -or use the wrapper function defined in <b>NvBlastExtPxSerialization.h</b>: - -\code -void* buffer; -uint64_t size = NvBlastExtSerializationSerializeExtPxAssetIntoBuffer(buffer, *ser, asset); -\endcode - -<br> -*/ +/*! \page pageextpxserialization ExtPhysX Serialization (NvBlastExtPxSerialization)
+
+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 NvBlastExtPxSerializerLoadSet, declared in <b>NvBlastExtPxSerialization.h</b>, passing in your TkFramework (required by ExtPhysX), along with
+your physx::PxPhysics and physx::PxCooking pointers:
+
+\code
+TkFramework* framework = ... // We must have created a TkFramework
+physx::PxPhysics* physics = ... // and PxPhysics
+physx::PxCooking* cooking = ... // and PxCooking
+
+NvBlastExtPxSerializerLoadSet(*framework, *physics, *cooking *ser);
+\endcode
+
+Now your serialization manager will have the serializers provided by this extension. Currently only ExtPxAsset serializers exist, with object type ID
+given by
+
+<br>
+<b>ExtPxObjectTypeID::Asset</b>
+<br>
+
+As with low-level assets, you can serialize using the serialization manager directly:
+
+\code
+const ExtPxAsset* asset = ... // Given pointer to an Nv::Blast::ExtPxAsset
+
+void* buffer;
+uint64_t size = ser->serializeIntoBuffer(buffer, asset, ExtPxObjectTypeID::Asset);
+\endcode
+
+or use the wrapper function defined in <b>NvBlastExtPxSerialization.h</b>:
+
+\code
+void* buffer;
+uint64_t size = NvBlastExtSerializationSerializeExtPxAssetIntoBuffer(buffer, *ser, asset);
+\endcode
+
+<br>
+*/
|