bsa::fo4::file::read_params struct final

#include <bsa/fo4.hpp>

Common parameters to configure how files are read.

// Read and compress a file for FO4/FO76, general format
bsa::fo4::file::read_params{
    .format_ = bsa::fo4::format::general,
    .compression_format_ = bsa::fo4::compression_format::zip,
    .compression_level_ = bsa::fo4::compression_level::fo4,
    .compression_type_ = bsa::compression_type::compressed,
};

// Read and compress a file for FO4/FO76, directx format
bsa::fo4::file::read_params{
    .format_ = bsa::fo4::format::directx,
    .compression_format_ = bsa::fo4::compression_format::zip,
    .compression_level_ = bsa::fo4::compression_level::fo4,
    .compression_type_ = bsa::compression_type::compressed,
};

// Read and compress a file for FO4 on the xbox, general format
bsa::fo4::file::read_params{
    .format_ = bsa::fo4::format::general,
    .compression_format_ = bsa::fo4::compression_format::zip,
    .compression_level_ = bsa::fo4::compression_level::fo4_xbox,
    .compression_type_ = bsa::compression_type::compressed,
};

// Read and compress a file for FO4 on the xbox, directx format
bsa::fo4::file::read_params{
    .format_ = bsa::fo4::format::directx,
    .compression_format_ = bsa::fo4::compression_format::zip,
    .compression_level_ = bsa::fo4::compression_level::fo4_xbox,
    .compression_type_ = bsa::compression_type::compressed,
};

// Read and compress a file for SF, general format
bsa::fo4::file::read_params{
    .format_ = bsa::fo4::format::general,
    .compression_format_ = bsa::fo4::compression_format::zip,
    .compression_level_ = bsa::fo4::compression_level::sf,
    .compression_type_ = bsa::compression_type::compressed,
};

// Read and compress a file for SF, directx format
bsa::fo4::file::read_params{
    .format_ = bsa::fo4::format::directx,
    .compression_format_ = bsa::fo4::compression_format::lz4,
    .compression_type_ = bsa::compression_type::compressed,
};

Public variables

format format_

The format to read the file as.

std::size_t mip_chunk_width

The maxiumum width to restrict a single mip chunk to.

std::size_t mip_chunk_height

The maxiumum height to restrict a single mip chunk to.

compression_format compression_format_

The format the file should be compressed in.

compression_level compression_level_

The level to compress the file at.

compression_type compression_type_

The resulting compression of the file read.