BLI_array_store.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once

 
#include "BLI_sys_types.h"
 
typedef struct BArrayState BArrayState;
typedef struct BArrayStore BArrayStore;

BArrayStore *BLI_array_store_create(unsigned int stride, unsigned int chunk_count);
void BLI_array_store_destroy(BArrayStore *bs);
void BLI_array_store_clear(BArrayStore *bs);

size_t BLI_array_store_calc_size_expanded_get(const BArrayStore *bs);
size_t BLI_array_store_calc_size_compacted_get(const BArrayStore *bs);

BArrayState *BLI_array_store_state_add(BArrayStore *bs,
                                       const void *data,
                                       size_t data_len,
                                       const BArrayState *state_reference);
void BLI_array_store_state_remove(BArrayStore *bs, BArrayState *state);

size_t BLI_array_store_state_size_get(const BArrayState *state);
void BLI_array_store_state_data_get(const BArrayState *state, void *data);
void *BLI_array_store_state_data_get_alloc(const BArrayState *state, size_t *r_data_len);

bool BLI_array_store_is_valid(BArrayStore *bs);
 
/* `array_store_rle.cc` */

uint8_t *BLI_array_store_rle_encode(const uint8_t *data_dec,
                                    size_t data_dec_len,
                                    size_t data_enc_extra_size,
                                    size_t *r_data_enc_len);
void BLI_array_store_rle_decode(const uint8_t *data_enc,
                                const size_t data_enc_len,
                                void *data_dec_v,
                                const size_t data_dec_len);