Up to date
This page is up to date for Godot 4.1.
If you still find outdated information, please open an issue.
PackedByteArray¶
A packed array of bytes.
Description¶
An array specifically designed to hold bytes. Packs data tightly, so it saves memory for large array sizes.
PackedByteArray also provides methods to encode/decode various types to/from bytes. The way values are encoded is an implementation detail and shouldn't be relied upon when interacting with external apps.
Constructors¶
PackedByteArray ( ) |
|
PackedByteArray ( PackedByteArray from ) |
|
PackedByteArray ( Array from ) |
Methods¶
void |
append_array ( PackedByteArray array ) |
void |
clear ( ) |
decode_double ( int byte_offset ) const |
|
decode_float ( int byte_offset ) const |
|
decode_half ( int byte_offset ) const |
|
decode_s16 ( int byte_offset ) const |
|
decode_s32 ( int byte_offset ) const |
|
decode_s64 ( int byte_offset ) const |
|
decode_u16 ( int byte_offset ) const |
|
decode_u32 ( int byte_offset ) const |
|
decode_u64 ( int byte_offset ) const |
|
decode_var ( int byte_offset, bool allow_objects=false ) const |
|
decode_var_size ( int byte_offset, bool allow_objects=false ) const |
|
decompress ( int buffer_size, int compression_mode=0 ) const |
|
decompress_dynamic ( int max_output_size, int compression_mode=0 ) const |
|
duplicate ( ) |
|
void |
encode_double ( int byte_offset, float value ) |
void |
encode_float ( int byte_offset, float value ) |
void |
encode_half ( int byte_offset, float value ) |
void |
|
void |
encode_s16 ( int byte_offset, int value ) |
void |
encode_s32 ( int byte_offset, int value ) |
void |
encode_s64 ( int byte_offset, int value ) |
void |
|
void |
encode_u16 ( int byte_offset, int value ) |
void |
encode_u32 ( int byte_offset, int value ) |
void |
encode_u64 ( int byte_offset, int value ) |
encode_var ( int byte_offset, Variant value, bool allow_objects=false ) |
|
void |
|
get_string_from_ascii ( ) const |
|
get_string_from_utf8 ( ) const |
|
get_string_from_utf16 ( ) const |
|
get_string_from_utf32 ( ) const |
|
get_string_from_wchar ( ) const |
|
has_encoded_var ( int byte_offset, bool allow_objects=false ) const |
|
hex_encode ( ) const |
|
is_empty ( ) const |
|
void |
|
void |
reverse ( ) |
void |
|
size ( ) const |
|
void |
sort ( ) |
to_float32_array ( ) const |
|
to_float64_array ( ) const |
|
to_int32_array ( ) const |
|
to_int64_array ( ) const |
Operators¶
operator != ( PackedByteArray right ) |
|
operator + ( PackedByteArray right ) |
|
operator == ( PackedByteArray right ) |
|
operator [] ( int index ) |
Constructor Descriptions¶
PackedByteArray PackedByteArray ( )
Constructs an empty PackedByteArray.
PackedByteArray PackedByteArray ( PackedByteArray from )
Constructs a PackedByteArray as a copy of the given PackedByteArray.
PackedByteArray PackedByteArray ( Array from )
Constructs a new PackedByteArray. Optionally, you can pass in a generic Array that will be converted.
Method Descriptions¶
Appends an element at the end of the array (alias of push_back).
void append_array ( PackedByteArray array )
Appends a PackedByteArray at the end of this array.
int bsearch ( int value, bool before=true )
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array.
Note: Calling bsearch on an unsorted array results in unexpected behavior.
void clear ( )
Clears the array. This is equivalent to using resize with a size of 0.
PackedByteArray compress ( int compression_mode=0 ) const
Returns a new PackedByteArray with the data compressed. Set the compression mode using one of CompressionMode's constants.
Returns the number of times an element is in the array.
float decode_double ( int byte_offset ) const
Decodes a 64-bit floating point number from the bytes starting at byte_offset. Fails if the byte count is insufficient. Returns 0.0 if a valid number can't be decoded.