diff options
| author | George Marques <george@gmarqu.es> | 2017-06-19 16:52:01 -0300 |
|---|---|---|
| committer | George Marques <george@gmarqu.es> | 2017-06-19 16:52:01 -0300 |
| commit | 34b6922caafe0138668859864adda19c4b803946 (patch) | |
| tree | 672fd167be2a77ecead53afae88679e728353573 /doc | |
| parent | 5c779c574a472d5c70316d7bbdef04e21f00b9be (diff) | |
Add documentation to compression functions
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/base/classes.xml | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 2331d49c1f..09ddb769b6 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -15299,6 +15299,19 @@ Open the file for writing or reading, depending on the flags. </description> </method> + <method name="open_compressed"> + <return type="int"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="mode_flags" type="int"> + </argument> + <argument index="2" name="compression_mode" type="int" default="0"> + </argument> + <description> + Open a compressed file for reading or writing. The compression_mode can be set as one of the COMPRESSION_* constants. + </description> + </method> <method name="open_encrypted"> <return type="int"> </return> @@ -15445,6 +15458,15 @@ <constant name="WRITE_READ" value="7"> Open the file for reading and writing. Create it if the file not exists and truncate if it exists. </constant> + <constant name="COMPRESSION_FASTLZ" value="0"> + Use the FastLZ compression method. + </constant> + <constant name="COMPRESSION_DEFLATE" value="1"> + Use the Deflate compression method. + </constant> + <constant name="COMPRESSION_ZSTD" value="2"> + Use the Zstd compression method. + </constant> </constants> </class> <class name="FileDialog" inherits="ConfirmationDialog" category="Core"> @@ -33733,6 +33755,26 @@ Append an [PoolByteArray] at the end of this array. </description> </method> + <method name="compress"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="compression_mode" type="int" default="0"> + </argument> + <description> + Returns a new [PoolByteArray] with the data compressed. The compression mode can be set using one of the COMPRESS_* constants of [File]. + </description> + </method> + <method name="decompress"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="buffer_size" type="int"> + </argument> + <argument index="1" name="compression_mode" type="int" default="0"> + </argument> + <description> + Returns a new [PoolByteArray] with the data decompressed. The buffer_size should be set as the size of the uncompressed data. The compression mode can be set using one of the COMPRESS_* constants of [File]. + </description> + </method> <method name="get_string_from_ascii"> <return type="String"> </return> |