aboutsummaryrefslogtreecommitdiff
path: root/NvBlast/docs/_source/data_converter.txt
diff options
context:
space:
mode:
Diffstat (limited to 'NvBlast/docs/_source/data_converter.txt')
-rw-r--r--NvBlast/docs/_source/data_converter.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/NvBlast/docs/_source/data_converter.txt b/NvBlast/docs/_source/data_converter.txt
new file mode 100644
index 0000000..a197483
--- /dev/null
+++ b/NvBlast/docs/_source/data_converter.txt
@@ -0,0 +1,42 @@
+/*! \page pageconverter DataConverter
+
+\verbatim
+
+USAGE:
+
+ DataConverter -i <infile> -o <outfile> [-v <outversion>] [--]
+ [--version] [-h]
+
+Where:
+
+ -i <infile>, --infile <infile>
+ (required) Input binary file.
+
+ -o <outfile>, --outfile <outfile>
+ (required) Output binary file.
+
+ -v <outversion>, --outversion <outversion>
+ Output binary block version. Pass -1 or ignore this parameter to
+ convert to latest version.
+
+ --, --ignore_rest
+ Ignores the rest of the labeled arguments following this flag.
+
+ --version
+ Displays version information and exits.
+
+ -h, --help
+ Displays usage information and exits.
+
+\endverbatim
+
+Blast&tm; low-level and Tk libraries will only load data in the most current format. If your data is in an older format, you may use the \ref pageextconverterll API to convert to the current format.
+
+DataConverter.exe is a utility to convert Blast&tm; data from an older format into the current format. The data must be stored in a binary-format file
+with filename given as the <infile> parameter. It uses the \ref pageextconverterll API to perform the conversion.
+
+Currently, DataConverter only works on the low-level data formats for an asset (NvBlastAsset) and family (NvBlastFamily). The .blast files used by
+SampleAssetViewer (see \ref pagesamples) may be converted using this tool.
+
+<br>
+*/