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.

Methods

bool

append ( int value )

void

append_array ( PackedByteArray array )

int

bsearch ( int value, bool before=true )

PackedByteArray

compress ( int compression_mode=0 ) const

float

decode_double ( int byte_offset ) const

float

decode_float ( int byte_offset ) const

float

decode_half ( int byte_offset ) const

int

decode_s16 ( int byte_offset ) const

int

decode_s32 ( int byte_offset ) const

int

decode_s64 ( int byte_offset ) const

int

decode_s8 ( int byte_offset ) const

int

decode_u16 ( int byte_offset ) const

int

decode_u32 ( int byte_offset ) const

int

decode_u64 ( int byte_offset ) const

int

decode_u8 ( int byte_offset ) const

Variant

decode_var ( int byte_offset, bool allow_objects=false ) const

int

decode_var_size ( int byte_offset, bool allow_objects=false ) const

PackedByteArray

decompress ( int buffer_size, int compression_mode=0 ) const

PackedByteArray

decompress_dynamic ( int max_output_size, int compression_mode=0 ) const

PackedByteArray

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

encode_s16 ( int byte_offset, int value )

void

encode_s32 ( int byte_offset, int value )

void

encode_s64 ( int byte_offset, int value )

void

encode_s8 ( int byte_offset, int value )

void

encode_u16 ( int byte_offset, int value )

void

encode_u32 ( int byte_offset, int value )

void

encode_u64 ( int byte_offset, int value )

void

encode_u8 ( int byte_offset, int value )

int

encode_var ( int byte_offset, Variant value, bool allow_objects=false )

void

fill ( int value )

String

get_string_from_ascii ( ) const

String

get_string_from_utf16 ( ) const

String

get_string_from_utf32 ( ) const

String

get_string_from_utf8 ( ) const

bool

has ( int value ) const

bool

has_encoded_var ( int byte_offset, bool allow_objects=false ) const

String

hex_encode ( ) const

int

insert ( int at_index, int value )

bool

is_empty ( ) const

bool

push_back ( int value )

void

remove ( int index )

int

resize ( int new_size )

void

reverse ( )

void

set ( int index, int value )

int

size ( ) const

void

sort ( )

PackedByteArray

subarray ( int from, int to ) const

PackedFloat32Array

to_float32_array ( ) const

PackedFloat64Array

to_float64_array ( ) const

PackedInt32Array

to_int32_array ( ) const

PackedInt64Array

to_int64_array ( ) const

Constructor Descriptions

Constructs an empty PackedByteArray.


Constructs a PackedByteArray as a copy of the given PackedByteArray.


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).


Appends a PackedByteArray at the end of this array.


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.


Returns a new PackedByteArray with the data compressed. Set the compression mode using one of CompressionMode's constants.


  • float decode_double ( int byte_offset ) const


  • float decode_float ( int byte_offset ) const


  • float decode_half ( int byte_offset ) const


  • int decode_s16 ( int byte_offset ) const


  • int decode_s32 ( int byte_offset ) const


  • int decode_s64 ( int byte_offset ) const


  • int decode_s8 ( int byte_offset ) const


  • int decode_u16 ( int byte_offset ) const


  • int decode_u32 ( int byte_offset ) const


  • int decode_u64 ( int byte_offset ) const


  • int decode_u8 ( int byte_offset ) const


  • Variant decode_var ( int byte_offset, bool allow_objects=false ) const


  • int decode_var_size ( int byte_offset, bool allow_objects=false ) const


Returns a new PackedByteArray with the data decompressed. Set buffer_size to the size of the uncompressed data. Set the compression mode using one of CompressionMode's constants.


Returns a new PackedByteArray with the data decompressed. Set the compression mode using one of CompressionMode's constants. This method only accepts gzip and deflate compression modes.

This method is potentially slower than decompress, as it may have to re-allocate its output buffer multiple times while decompressing, whereas decompress knows it's output buffer size from the beginning.

GZIP has a maximal compression ratio of 1032:1, meaning it's very possible for a small compressed payload to decompress to a potentially very large output. To guard against this, you may provide a maximum size this function is allowed to allocate in bytes via max_output_size. Passing -1 will allow for unbounded output. If any positive value is passed, and the decompression exceeds that amount in bytes, then an error will be returned.


Creates a copy of the array, and returns it.


  • 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 encode_s16 ( int byte_offset, int value )


  • void encode_s32 ( int byte_offset, int value )


  • void encode_s64 ( int byte_offset, int value )


  • void encode_s8 ( int byte_offset, int value )


  • void encode_u16 ( int byte_offset, int value )


  • void encode_u32 ( int byte_offset, int value )


  • void encode_u64 ( int byte_offset, int value )


  • void encode_u8 ( int byte_offset, int value )



  • void fill ( int value )

Assigns the given value to all elements in the array. This can typically be used together with resize to create an array with a given size and initialized elements.


  • String get_string_from_ascii ( ) const

Converts ASCII/Latin-1 encoded array to String. Fast alternative to get_string_from_utf8 if the content is ASCII/Latin-1 only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use get_string_from_utf8.


  • String get_string_from_utf16 ( ) const

Converts UTF-16 encoded array to String. If the BOM is missing, system endianness is assumed. Returns empty string if source array is not valid UTF-16 string.


  • String get_string_from_utf32 ( ) const

Converts UTF-32 encoded array to String. System endianness is assumed. Returns empty string if source array is not valid UTF-32 string.


  • String get_string_from_utf8 ( ) const

Converts UTF-8 encoded array to String. Slower than get_string_from_ascii but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. Returns empty string if source array is not valid UTF-8 string.


Returns true if the array contains value.


  • bool has_encoded_var ( int byte_offset, bool allow_objects=false ) const


Returns a hexadecimal representation of this array as a String.

var array = PackedByteArray([11, 46, 255])
print(array.hex_encode()) # Prints: 0b2eff

Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (idx == size()).


  • bool is_empty ( ) const

Returns true if the array is empty.


Appends an element at the end of the array.


  • void remove ( int index )

Removes an element from the array by index.


Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.


  • void reverse ( )

Reverses the order of the elements in the array.


  • void set ( int index, int value )

Changes the byte at the given index.


  • int size ( ) const

Returns the size of the array.


  • void sort ( )

Sorts the elements of the array in ascending order.


Returns the slice of the PackedByteArray between indices (inclusive) as a new PackedByteArray. Any negative index is considered to be from the end of the array.


Returns a copy of the data converted to a PackedFloat32Array, where each block of 4 bytes has been converted to a 32-bit float (C++ float).

The size of the new array will be byte_array.size() / 4.

If the original data can't be converted to 32-bit floats, the resulting data is undefined.


Returns a copy of the data converted to a PackedFloat64Array, where each block of 8 bytes has been converted to a 64-bit float (C++ double, Godot float).

The size of the new array will be byte_array.size() / 8.

If the original data can't be converted to 64-bit floats, the resulting data is undefined.


Returns a copy of the data converted to a PackedInt32Array, where each block of 4 bytes has been converted to a signed 32-bit integer (C++ int32_t).

The size of the new array will be byte_array.size() / 4.

If the original data can't be converted to signed 32-bit integers, the resulting data is undefined.


Returns a copy of the data converted to a PackedInt64Array, where each block of 4 bytes has been converted to a signed 64-bit integer (C++ int64_t, Godot int).

The size of the new array will be byte_array.size() / 8.

If the original data can't be converted to signed 64-bit integers, the resulting data is undefined.

Operator Descriptions

  • bool operator != ( )




  • bool operator == ( )



  • int operator [] ( int index )