A pooled Array of bytes.
An Array specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory.
Note: This type is passed by value and not by reference.
PoolByteArray | PoolByteArray ( Array from ) |
void | append ( int byte ) |
void | append_array ( PoolByteArray array ) |
PoolByteArray | compress ( int compression_mode=0 ) |
PoolByteArray | decompress ( int buffer_size, int compression_mode=0 ) |
bool | empty ( ) |
String | get_string_from_ascii ( ) |
String | get_string_from_utf8 ( ) |
String | hex_encode ( ) |
int | insert ( int idx, int byte ) |
void | invert ( ) |
void | push_back ( int byte ) |
void | remove ( int idx ) |
void | resize ( int idx ) |
void | set ( int idx, int byte ) |
int | size ( ) |
PoolByteArray | subarray ( int from, int to ) |
Constructs a new PoolByteArray
. Optionally, you can pass in a generic Array that will be converted.
Appends an element at the end of the array (alias of push_back).
Appends a PoolByteArray
at the end of this array.
Returns a new PoolByteArray
with the data compressed. Set the compression mode using one of CompressionMode's constants.
Returns a new PoolByteArray
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 true
if the array is empty.
Returns a copy of the array's contents as String. Fast alternative to get_string_from_utf8 if the content is ASCII-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.
Returns a copy of the array's contents as 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 a hexadecimal representation of this array as a String.
var array = PoolByteArray([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()
).
Reverses the order of the elements in the array.
Appends an element at the end of the array.
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.
Changes the byte at the given index.
Returns the size of the array.
Returns the slice of the PoolByteArray
between indices (inclusive) as a new PoolByteArray
. Any negative index is considered to be from the end of the array.
© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/3.2/classes/class_poolbytearray.html