Skip to content

feat: capture mipmap generation options in writer metadata params #1238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
walcht wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: capture mipmap generation options in writer metadata params #1238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ee91f3
feat: capture mipmap generation options in writer metadata params
walcht Aug 5, 2026
a9f95c1
reorder mipmap generation options
walcht Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tests/cts
Open in desktop
Submodule cts updated 864 files
36 changes: 31 additions & 5 deletions tools/ktx/command_create.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ struct OptionsCreate {
std::optional<basisu::Resampler::Boundary_Op> mipmapWrap;
basisu::Resampler::Boundary_Op defaultMipmapWrap =
basisu::Resampler::Boundary_Op::BOUNDARY_CLAMP;
std::string mipmapGenerationOptions{}; /// Capture mipmap generation options

std::optional<std::string> swizzle; /// Sets KTXswizzle
std::optional<std::string> swizzleInput; /// Used to swizzle the input image data

Expand Down Expand Up @@ -443,6 +445,17 @@ struct OptionsCreate {
return result;
}

void captureMipmapGenerationOption(const char* name) {
mipmapGenerationOptions += fmt::format(" --{}", name);
}

template <typename T>
T captureMipmapGenerationOption(cxxopts::ParseResult& args, const char* name) {
const T value = args[name].as<T>();
mipmapGenerationOptions += fmt::format(" --{} {}", name, value);
return value;
}

void process(cxxopts::Options&, cxxopts::ParseResult& args, Reporter& report) {
_1d = args[k1D].as<bool>();
cubemap = args[kCubemap].as<bool>();
Expand All @@ -460,7 +473,11 @@ struct OptionsCreate {
levels = args[kLevels].as<uint32_t>();

mipmapRuntime = args[kRuntimeMipmap].as<bool>();
mipmapGenerate = args[kGenerateMipmap].as<bool>();

if (args[kGenerateMipmap].count()) {
mipmapGenerate = true;
captureMipmapGenerationOption(kGenerateMipmap);
}

if (args[kMipmapFilter].count()) {
static const std::unordered_set<std::string> filter_table{
Expand All @@ -482,13 +499,13 @@ struct OptionsCreate {
"quadratic_mix",
};

mipmapFilter = to_lower_copy(args[kMipmapFilter].as<std::string>());
mipmapFilter = to_lower_copy(captureMipmapGenerationOption<std::string>(args, kMipmapFilter));
if (filter_table.count(*mipmapFilter) == 0)
report.fatal_usage("Invalid or unsupported mipmap filter specified as --mipmap-filter argument: \"{}\".", *mipmapFilter);
}

if (args[kMipmapFilterScale].count())
mipmapFilterScale = args[kMipmapFilterScale].as<float>();
mipmapFilterScale = captureMipmapGenerationOption<float>(args, kMipmapFilterScale);

if (args[kMipmapWrap].count()) {
static const std::unordered_map<std::string, basisu::Resampler::Boundary_Op> wrap_table{
Expand All @@ -497,7 +514,7 @@ struct OptionsCreate {
{ "reflect", basisu::Resampler::Boundary_Op::BOUNDARY_REFLECT },
};

const auto wrapStr = to_lower_copy(args[kMipmapWrap].as<std::string>());
const auto wrapStr = to_lower_copy(captureMipmapGenerationOption<std::string>(args, kMipmapWrap));
const auto it = wrap_table.find(wrapStr);
if (it == wrap_table.end())
report.fatal_usage("Invalid or unsupported mipmap wrap mode specified as --mipmap-wrap argument: \"{}\".", wrapStr);
Expand Down Expand Up @@ -2040,7 +2057,16 @@ void CommandCreate::executeCreate() {
compress(texture, options);

// Add KTXwriterScParams metadata if ASTC encoding, BasisU encoding, or other supercompression was used
const auto writerScParams = fmt::format("{}{}{}{}", options.astcOptions, options.codecOptions, options.commonOptions, options.compressOptions);
// Note:
// We don't want to capture mipmap generation options if mipmap generation
// is not activated (because looking at kv metadata might give the wrong
// impression that mipmaps were generated). This is the same for ASTC.
const auto writerScParams = fmt::format("{}{}{}{}{}",
options.encodeASTC ? options.astcOptions : "",
options.codecOptions,
options.commonOptions,
options.mipmapGenerate ? options.mipmapGenerationOptions : "",
options.compressOptions);
if (writerScParams.size() > 0) {
// Options always contain a leading space
assert(writerScParams[0] == ' ');
Expand Down
Loading