Files
solvecraft/docs/render-cpu-advanced-integration.md
selune 9e6e0b8df1 Render workspace: complete experimental ribbon, resources and effects integration (#5493) (#5494)
* wip(render): reconcile completed material and image pipeline source with 0.20 (#5493)

Source-only integration reference for staged review, not a merge-ready aggregate.
Donor: 0xlillith/solidcraft@aea20b0115.
Upstream: 858e5995d6.

Retain original CPU/material contracts and explicit GPU donor provenance in
docs/render-materials-lab.md (#2067, #2191, #2780, #3306). Preserve released
format migrations and current navigation/startup/shell behavior. New saved
records use pending descriptors. The physical-card descriptor follows the
maintainer's material-engineering-cards naming request, with a legacy-lab
format-29 regression. Replace raw new panel hosts with shared containers.

Repository checks, complete workspace/all-target Clippy, and the independent
physical/resource authoring checks pass for this source. The fresh full local
CI invocation has reached test compilation and is not yet complete. Do not
transfer donor native output or prior test totals to this integration.

Generated review screenshots, video, package ZIP and machine logs remain at
the immutable personal evidence pin. Uncommitted geometric displacement is
backed up separately, not silently included. No kernel/vendor change, direct
main write, release or independent contributor-branch rewrite.

Co-authored-by: Christian Svensson <blue@cmd.nu>

* test(cli): pin the Compact camera-sample admission diagnostic (#5493)

The bounded request still refuses 1024x1024x64 samples before host initialization and writes no output. Update only the stale expected diagnostic to the existing Compact budget wording; production limits and code are unchanged. Exact-tree CLI regression suite: 14 passed, 0 failed. The full repository gate has been invoked separately and is not yet complete.

* Normalize UI container violation paths across platforms

Report repository-relative paths with forward slashes so diagnostics and the existing nested-package regression assertions agree on Windows and Unix. Keep the container detection rules unchanged.

Validation: official ui-containers gate and all seven focused xtask tests passed; rustfmt and diff checks passed. Only xtask/dependencies were compiled; no application build or heavy tests.
(cherry picked from commit 44b58d8e10)

* fix(render): preserve camera contracts and correct acceptance regressions (#5493)

Preserve Design view.apply semantics with a separate strict Render camera command. Retain existing translations when English-only aliases collide; add material-axis entries and camera-specific pitch labels. Compare complete validated engineering cards and retain job handles before cancellation.

Focused and native acceptance is pinned to tree f8a423b21f. Full CI has been invoked separately and is not claimed green. Landing follows the render integration policy in #5493.

* fix(render): resolve showcase licence and upstream resource hygiene (#5493)

Record SychPL's explicit MIT OR Apache-2.0 grant, retaining source/model bytes and the Ubuntu lettering notice. Remove 80 absent attribution rows, personal fork records, dead delivery attributes and three fork/resource-only workflows. Existing xtask assets now performs bounded offline hash checks and rejects orphan render attribution; no parallel draft CI or package installation. Original authoring reproduction remains explicit. Scoped xtask tests, assets, Clippy, formatting and prepared SELENE validation pass; no application or renderer-wide result is inferred.

* fix(render): align saved bounds and progressive sample resolution (#5493)

Address review r4364211669/r4364211677/r4364211681/r4364211691/r4364211695. Persisted light/frame domains respect the existing 1e9 document bound; related LED/rectangle/direction cases use the same bound. Workstation primary resolve shares the 4096 admission cap and film counters use checked conversions. Exact candidate: 485 CPU render tests, 21 render document tests and strict scoped Clippy pass, including positive boundary round trips and 2048/4096 end-to-end checkpoints. No released format/migration edits, relaxed test limits or full-stack acceptance claim.

* wip(render): isolate optional resources and harden sample handling (#5493)

Review work in progress: opt-in encoded render library with reproducible runtime catalog exports; native-only robust dependency through the workspace; checked bloom slices; per-sample point-light diagnostics; independent area-light spatial/film keys. Resource-module binaries in both configurations, generation, Cargo production feature graphs and attribution checks pass. Full engine/render regression and combined acceptance are pending: do not merge this donor as a constituent or treat scoped resource proof as runtime acceptance.

* fix(gpu): preserve donor allocations through the scope-safety repair (#5722)

Port the native-validated #5723 scope-cleanup correction into the experimental donor, retaining its adaptive, volume, aging, photographic and bloom allocations. Same reverse-drain helper and regression cases; the donor combination still needs its own compile/test gate and is not covered retroactively by render-base results.

* claim: #1369

* Reject unknown pending concepts after format folding (#1369)

* test(render): close bounded sampling and bloom review regressions (#5493)

Validate the optional-resource/lighting/dependency donor at its exact tree. Required Vulkan GPU 127/0/3; CPU renderer 487/0; engine Render 72/0; document render 21/0; lean library 7/0; strict scoped Clippy, assets/layers/lists/containers and lean-engine WASM pass. Preserve original failed controller/typing attempts. This is the draft donor/disposition source, not a replacement for constituent render PRs or final main acceptance.

* wip(render): preserve stable aging target validation candidate

Exact staged source from prior review work on donor 3b892eab5e. This is a recovery/review checkpoint, NOT accepted delivery. An actual command-path regression currently fails because the selected executor refuses ordered surface aging. No assertion, capability or admission limit is weakened. Native/UI/full combination acceptance remains pending. Saved/runtime split adds one pending descriptor and retains original file scope; no main/render branch is changed.

* test(render): preserve numeric setup intent at the admitted coordinate bound

Follow up jyviko review on #5494 without weakening the corrected saved-coordinate contract. The positive clicked fixture uses 1e9 instead of inadmissible 2e9; explicit out-of-range cases still refuse, and the full saved setup round-trips through JSON and the native container. Exact-source Render workspace 95/0 and strict all-target UI Clippy pass. This does not incorporate the separately failing stable-aging candidate or claim full current-render acceptance.

* test(render): use the real GPU executor for saved aging

Move successful native cold-reopen Check/Start coverage from the CPU-backed protocol fixture into the production GPU executor tests. Verify capture-index changes preserve the stable target and that enabling aging changes both PNG and raw EXR output. Retain explicit, allocation-free refusal coverage for executors without aging support. Production capabilities and admission checks are unchanged.

* fix(render): persist stable identities for targeted aging (#5493)

Separate saved RenderBodyTarget identities from captured mesh ordinals. Reject legacy ambiguous targets, resolve Check/Start after visibility changes and preserve native reopening, copies and undo. Unsupported executors still refuse; real AMD Vulkan regression completes saved aging after reordered capture.

Source tree 6b84c8ad passes document 23, engine Render 75, GPU effects 5 and Render UI 95 with no failures; scoped strict Clippy, WASM and repository gates pass. Fresh CLI/native reopen and clean/aged GPU exports pass with identical physical totals and inspected actual images. Whole current-render integration is separate.

* fix(render): reconcile combined CPU/GPU contracts on current upstream

Unify captured resources/status and CPU-vs-GPU request schemas after the real two-parent integration; remove obsolete duplicate Vulkan selector and retain combined platform-filter regression. Deduplicate only identical or superseded test definitions, retaining the stronger card metadata and reserved-executor assertions. No assertions, admission limits or feature refusals are weakened.

All targets of render dependencies, GPU, engine, UI, CLI and native app pass cargo check with raytrace-cpu and bundled-render-library at tree c70d00d1. Native executable tests and full current-source acceptance remain pending. This is a private integration rehearsal for subsequent constituent PRs, not an aggregate official render/main merge.

* test(render): retain one complete host lifetime regression set

Deduplicate byte-identical DropProbe/task-lifetime tests and retain the adapted environment/texture ownership regressions with every assertion and complete memory estimate. Keep the registered-geometry admission regression once; only struct field order differed. Replace a one-element diagnostic loop with its equivalent block, preserving all wrap/width assertions.

Test-only integration repair. Formatting and diff checks pass; refreshed executable validation is required. No production behavior, limits, assertions or ignores changed.

* fix(doc): recognize the proven format-29 card descriptor alias

Normalize only the historical format-29 physical-material-cards spelling, and only when material-engineering-cards is registered. Admission and migration de-duplication use the same identity. Unknown concepts, wrong versions and incapable readers still refuse before mutation. Six controlled-history Rust regressions and actual CLI migration/no-clobber acceptance pass. No version, released migration or CI changes. Refs #5793, #1369, #5493.

* test(render): preserve grounding refusal before explicit instance moves

Update the two Render binding fixtures for upstream first-occurrence grounding. Verify grounded movement refuses without changing document/history, then explicitly unground through the public command before the intended move. Retain every target, resource, copy and persistence assertion. Refs #5493.

---------

Co-authored-by: Christian Svensson <blue@cmd.nu>
Co-authored-by: Victor Santos Oliveira <56417388+Vittuu@users.noreply.github.com>
Co-authored-by: cfaulkingham <colin.faulkingham@gmail.com>
2026-10-24 14:21:59 +00:00

7.4 KiB

Advanced CPU recovery on the rendering branch

This document records the recovered local CPU port onto the personal branch's CPU/GPU2 snapshot. That recovery did not merge an upstream branch or change the document format. Subsequent numerical persistence and progressive publication are described below and in CPU progressive sampling. The recovery baseline is source tree 338535736593a8e49d9a6d1ccff8509dff618721, with Git HEAD 93a2922c5ee272fb605703ae84c05825b4a74607.

The recovery input is the 34-path local patch against original base 64339aedbc5e2f0d46e89dd915724deb06d5702d; its SHA-256 is 746f4e18b75ae9e6e4095e7c40812bad92c20078275979e2ccef7b3605924b77. It contains the project's original CPU prototypes and follow-ups associated with 0xlillith's prior work. This integration adds no third-party assets, code, rendering library or dependency. The source identity is provenance, not proof that its old tests passed on this new combination.

Connected capabilities

Area Actual consumer in this revision Limits
GGX visible-normal sampling (VNDF) CPU ImageTask rough reflections and the certified anisotropic adapter The original single-scattering Schlick/GGX/separable-Smith model; no layered coat transport, transmission proposal or diffuse GI.
Fixed primary AA Existing CPU image job and visible 1/4/16 sample controls Reuse only for completed, nonselected primary hits within one fixed spatial sample. Not a progressive sample prefix.
Surface emission Primary and reflected hits add visible linear radiance through current throughput No mesh-light sampling, illumination of neighbors, emissive GI or calibrated watts.
Surface effects The shared CPU hit surface feeds existing direct lights, HDR and opaque reflections Bounded periodic roughness/bump fields in world millimetres; no geometry displacement, texture lookup or physical-material change.
Dielectric preview Existing CPU image job branches bounded reflected/transmitted paths Only certified thin sheets and outward, axis-aligned 12-triangle boxes; no general closed mesh, nested/touching volumes, colored transmission shadows, caustics or GI.
Recovered film component Public FilmAccumulator API, with a complete-pass view and FilmPngTask encoder This statistical component remains independent. The subsequent native progressive image path uses film::primary::PrimaryFilm and the shared image host.

The runtime API accepts new CPU options under raytrace: emissions, surface_effects, dielectrics and environment. The last is constant secondary radiance, separate from the captured HDR input at the top level. The subsequent CPU workspace panel exposes body reflections, constant secondary radiance, captured HDR input, directional lights and point lights. Area lights, area sampling/seed and spot cones have no dedicated panel editors, but complete saved numerical setups retain their values and pass them to engine validation. Emission, surface effects, glass and anisotropic face bindings remain runtime API inputs, outside portable setup persistence. Existing CPU primary AA, exposure, shadow and studio preset controls remain in place. The GPU material editor owns a different runtime schema selected explicitly with top-level progressive: true. CPU progressive sampling instead uses raytrace.progressive and rejects area lights, dielectric and anisotropic overrides in its initial bounded contract; the fixed CPU route retains those capabilities.

See VNDF, primary AA, emission, surface effects and dielectrics for request and numerical bounds.

Film and exact PNG contract

FilmAccumulator keeps per-pixel sample counts, linear means and Welford variance. Each checked update contains at most 256 consecutive pixels. Work and input checks precede its bounded commit, and cancellation is checked before commit. complete_pass refuses zero samples or unequal pixel counts and returns a borrowed immutable view. No partially completed pass is publishable through that API.

FilmPngTask resolves the complete linear mean with exposure, the existing Reinhard mapping and one sRGB transfer. It reuses the CPU PNG encoder, including the sRGB chunk, rather than introducing another codec. Its maximum output is 4096 pixels per dimension and four million pixels in total. A step resolves at most 256 pixels and writes at most four encoding rows. The encoded result owns its host reservation and exposes bytes by borrow.

The subsequent CPU progressive image path connects its camera-specific PrimaryFilm to sampler passes, the same cancellation token and cumulative work counter, generation checks under the host's publication lock, and retained immutable checkpoints. Only the final PNG is exportable. It does not call the statistical FilmAccumulator/FilmPngTask API described above. That independent API still expects an existing caller-owned film lease, held for the entire film lifetime; its component tests alone do not qualify the integrated progressive path.

CPU/GPU compatibility and resources

The builtin CPU image limit stays 384 MiB per job; registered GPU jobs keep their 512 MiB limit. Film snapshots use the existing host pool, reject a registered executor, and account for both borrowed film and encoding capacities before allocation. Completed PNGs retain the remaining lease. New emission, surface and dielectric option capacities are included in task and retained-request accounting. No new process, background worker, device registry or pool is introduced.

The shared OpaqueSurface type can contain GPU2's clear coat. Applying a CPU roughness field preserves that layer for direct BRDF evaluation. A coated body or face selected for CPU reflections, anisotropy or dielectrics is explicitly refused because the recovered transport estimator has no coat lobe. GPU2's own coat and dielectric path remains unchanged. Captured GPU transmission data is not reinterpreted as CPU dielectric options.

CPU admission still certifies immutable captured body identities, retains opaque alpha requirements, checks finite inputs and bounded capacities, and rejects unsupported intersections between optical, emission and surface selections. Geometry, document history, physical mass properties and saved materials are not modified by these runtime inputs.

Validation status and next acceptance gate

The recovery handoff was a source-only port. At that handoff, its author ran Rust formatting, a whitespace check and a reproducible patch replay; the author did not run a Cargo build, test, Clippy, wasm check, application launch or native image acceptance for that isolated port. Existing recovered tests are retained, with new integration regressions for preservation of clear coat, refusal of unmatched coat transport and exclusion of registered executors from CPU film reservations.

The integrator must compile and execute the exact combined revision, including CPU feature on/off and the current ImageTask layout bound. Render/engine/UI contracts, cancellation and lease tests, hostile inputs, wasm and project CI remain gates. Real equal-camera CPU output and exported PNGs are still needed to assess the visible results. Historical results from earlier source snapshots do not qualify this revision.