cee::vtfx::FileSettings Class Reference

File settings for VTFx files. More...

Public Attributes

bool binary
 true (default): use binary data files
false: use text data files (mainly for debugging) More...
 
bool createDigitalSignature
 true: a signature on the file contents will be created to detect changes made by third parties
false (default): no signature will be created More...
 
int compressionLevel
 0: no compression
1: low compression rate with fast decompression speed
...
5 (default): medium compression
...
9: maximum compression More...
 
Str vendorName
 Vendor name, usually the company name (single line of text) More...
 
Str applicationName
 Name of the application that exports the VTFx file (single line of text) More...
 
Str password
 Password for encrypted VTFx files (AES 256)
Empty string (default) to disable encryption.
Password must consist of 7 bit ASCII characters. More...
 

Detailed Description

File settings for VTFx files.

File settings are provided when creating VTFx files and when appending data to VTFx files.

Member Data Documentation

Str cee::vtfx::FileSettings::applicationName

Name of the application that exports the VTFx file (single line of text)

bool cee::vtfx::FileSettings::binary

true (default): use binary data files
false: use text data files (mainly for debugging)

int cee::vtfx::FileSettings::compressionLevel

0: no compression
1: low compression rate with fast decompression speed
...
5 (default): medium compression
...
9: maximum compression

bool cee::vtfx::FileSettings::createDigitalSignature

true: a signature on the file contents will be created to detect changes made by third parties
false (default): no signature will be created

Str cee::vtfx::FileSettings::password

Password for encrypted VTFx files (AES 256)
Empty string (default) to disable encryption.
Password must consist of 7 bit ASCII characters.

Str cee::vtfx::FileSettings::vendorName

Vendor name, usually the company name (single line of text)