shading library

The shading family of post-processing: screen-space ambient occlusion and contact shadows.

Each effect is a plugin — AmbientOcclusionAddon and ContactShadowsAddon, both in shadingAddons — and each is the switch of its own render step. The settings an application configures the family with are flutter3d_core's, which flutter3d re-exports by name; this library does not.

Each plugin adds the slots of the settings its steps read — SettingsSlot.ambientOcclusion and the rest — so renderer.renderSteps.settings lists the family's while it is installed, and settings.extension(SettingsSlot.ambientOcclusion) reads them the way a third-party addon's own are read. The types themselves are still defined in flutter3d_core: the kernel's passes read them as fields of RenderSettings, and a field typed by a class of this package's would make the kernel depend on its own addon. So they are imported from where they are declared, and this library is where the family's documentation sends a reader. An addon outside this repository defines its settings in its own package and carries them in RenderSettings.extensions; see SettingsSlot.

Classes

AmbientOcclusionAddon
The ambient occlusion and its blur, whichever method — RenderSettings.ambientOcclusion.
ContactShadowsAddon
The short march towards the sun at every pixel, and its resolve — RenderSettings.contactShadows.

Constants

shadingAddons → const List<RenderStepAddon>
Every effect of the shading family.