Edited wiki page through web user interface.

17 years ago · 42859ead47
parent d27fddaf94
commit 42859ead47
1 changed files with 3 additions and 1 deletions
--- a/wiki/ApiDocumentation.wiki
+++ b/wiki/ApiDocumentation.wiki
@ -19,12 +19,14 @@ All the members of the API are in the `nvtt` namespace. Members outside of the `

 As new features are added to NVTT, binary compatibility will always be preserved. That should allow upgrading to new versions without even having to recompile the application code.

-
+The most important function of the API is the following:

 {{{
 nvtt::compress(const InputOptions &, const OutputOptions &, const CompressionOptions &);
 }}}

+It takes the texture defined by `InputOptions`, compresses it according to the `CompressionOptions` and outputs it according to the `OutputOptions`. These classes are documented in detail in the following sections.
+
 == Input Options ==

 The input options class describe the images that compose the texture to be generated, and several preprocessing operations that could be applied to it.