diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2021-02-02 21:59:24 +0100 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2021-02-02 21:59:55 +0100 |
| commit | c5f0db45df6002258ee0b3f0158d1069f828455e (patch) | |
| tree | e3161137720c820a47f5ebc9b18e991f933cba36 /doc | |
| parent | 9e0bdeb5de323f5ec7c21511478a2b2524e70fc3 (diff) | |
Improve the `File.endian_swap` documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/File.xml | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 2f7ac551cf..ff03f44789 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -481,8 +481,9 @@ </methods> <members> <member name="endian_swap" type="bool" setter="set_endian_swap" getter="get_endian_swap" default="false"> - If [code]true[/code], the file's endianness is swapped. Use this if you're dealing with files written on big-endian machines. - [b]Note:[/b] This is about the file format, not CPU type. This is always reset to [code]false[/code] whenever you open the file. + If [code]true[/code], the file is read with big-endian [url=https://en.wikipedia.org/wiki/Endianness]endianness[/url]. If [code]false[/code], the file is read with little-endian endianness. If in doubt, leave this to [code]false[/code] as most files are written with little-endian endianness. + [b]Note:[/b] [member endian_swap] is only about the file format, not the CPU type. The CPU endianness doesn't affect the default endianness for files written. + [b]Note:[/b] This is always reset to [code]false[/code] whenever you open the file. Therefore, you must set [member endian_swap] [i]after[/i] opening the file, not before. </member> </members> <constants> |