ludus::content::scene_cook::BestEffortOptions¶
Ludus Wiki · API overview · Browse API
Struct
Options for the best-effort importers.
Declared in modules/content/scene_cook/include/ludus/content/scene_cook/best_effort_import.h
#include <ludus/content/scene_cook/best_effort_import.h>
struct ludus::content::scene_cook::BestEffortOptions final
Fields¶
IsDryRun¶
bool ludus::content::scene_cook::BestEffortOptions::IsDryRun = false
Parse and plan only: no image decoding and no bundle. The report is complete except for texture sizes, and BestEffortResult::Bundle stays empty.
Declared in modules/content/scene_cook/include/ludus/content/scene_cook/best_effort_import.h
JobsOrNull¶
foundation::threading::JobSystem* ludus::content::scene_cook::BestEffortOptions::JobsOrNull = nullptr
Optional caller-owned job system on which texture images are decoded in parallel; nullptr decodes them one at a time on the calling thread.
The importer reads every image file on the calling thread, then decodes batches of up to min(GetWorkerCount() + 1, 8) images in jobs while the caller helps in Wait, so it holds at most that many extra decoded images. Bundles, reports and input digests are byte-identical for every worker count, including zero and nullptr. The system must be initialized, must have no graph in flight for the duration of the import (a busy system makes the import decode serially), and is used from the calling thread only. Browser builds pass a zero-worker system or nullptr. Not owned.
Related types: foundation::threading::JobSystem
Declared in modules/content/scene_cook/include/ludus/content/scene_cook/best_effort_import.h
EnvironmentFile¶
std::string_view ludus::content::scene_cook::BestEffortOptions::EnvironmentFile
Optional latitude/longitude lighting image relative to the scene source directory. Empty preserves source lighting. An existing authored environment rejects this addition; analytic lights and emission are retained. The image must resolve inside the source root, including symlinks, and participates in source digests. The caller keeps this borrowed view alive for the duration of the call. Linear HDR energy is retained with a bounded texture and radiance multiplier; +Y is north, longitude zero is +X, increasing longitude turns toward +Z.
Declared in modules/content/scene_cook/include/ludus/content/scene_cook/best_effort_import.h