API Reference

The HTrace Ambient Occlusion runtime API lets scripts read and change the active AO profile, switch the occlusion mode, tune quality and denoising, and enable or disable the pipeline-specific HTrace component.

The API is split between general settings and pipeline-specific integration types.

Runtime Assemblies and Namespaces

Namespace	Public API	Purpose
IPGames.HTraceAO.Runtime.Data.Public	HTraceAOSettings, GeneralSettings, SSAOSettings, GTAOSettings, RTAOSettings	Reads and changes the settings used by the renderer.
IPGames.HTraceAO.Runtime.Data.Profile	HTraceAOProfile	Stores a complete HTrace AO configuration as a ScriptableObject.
IPGames.HTraceAO.Runtime.Globals	AO mode, quality, denoising, tracing, and debug enums	Provides strongly typed values used by the settings classes.

Pipeline-specific namespaces and types are documented only on the corresponding URP, HDRP, and Built-in Render Pipeline reference pages.

Choose the Correct Entry Point

Pipeline and workflow	Settings source	API to use
URP, Use Volumes disabled	HTraceAOProfile assigned to the scene component	HTraceAOSettings.ActiveProfile
URP, Use Volumes enabled	The active HTraceAOVolume stack	HTraceAOVolume
HDRP	HTraceAOProfile assigned to the scene component	HTraceAOSettings.ActiveProfile
Built-in Render Pipeline	HTraceAOProfile assigned to the camera component	HTraceAOSettings.ActiveProfile

HTraceAOSettings.ActiveProfile is a global reference and can be null before the HTrace component is enabled. Always check it before reading or writing settings.

Reference Pages

• Runtime API describes profiles, settings classes, enums, value ranges, and the global active profile.
• Universal Render Pipeline covers the profile and Volume workflows.
• High Definition Render Pipeline covers profile control and the HDRP resource patch.
• Built-in Render Pipeline covers camera integration and motion-vector registration.