bsa::fo4::chunk class final

#include <bsa/fo4.hpp>

Base classes

class bsa::components::compressed_byte_container

A byte storage container with compression support.

Public types

struct mips_t

Unique to format::directx.

Public variables

struct bsa::fo4::chunk::mips_t mips

Capacity

auto empty() const -> bool noexcept

Checks if the underlying byte container is empty.

auto size() const -> std::size_t noexcept

Returns the size of the underlying byte container.

Compression

void compress(compression_level a_level = compression_level::normal)

Compresses the file.

auto compress_bound() const -> std::size_t

Returns an upper bound on the storage size required to compress the file.

auto compress_into(std::span<std::byte> a_out, compression_level a_level = compression_level::normal) const -> std::size_t

Compresses the file into the given buffer.

Decompression

void decompress()

Decompresses the file.

void decompress_into(std::span<std::byte> a_out) const

Decompresses the file into the given buffer.

auto decompressed_size() const -> std::size_t noexcept

Retrieves the decompressed size of the compressed storage.

Element access

auto as_bytes() const -> std::span<const std::byte> noexcept

Retrieves an immutable view into the underlying bytes.

auto data() const -> const std::byte* noexcept

Retrieves an immutable pointer to the underlying bytes.

Modifiers

void clear() noexcept

Clears the data and mips of the chunk.

void set_data(std::span<const std::byte> a_data, std::optional<std::size_t> a_decompressedSize = std::nullopt) noexcept

Assigns the underlying container to be a non-owning view into the given data.

void set_data(std::vector<std::byte> a_data, std::optional<std::size_t> a_decompressedSize = std::nullopt) noexcept

Assigns the underlying container to be an owning view into the given data.

Observers

auto compressed() const -> bool noexcept

Checks if the underlying bytes are compressed.

Function documentation