Creates a new SSAOPlugin instance.
Data type for the SSAO buffer (default: UnsignedByteType)
Size multiplier for the render target (default: 1.0)
Whether the plugin is initially enabled (default: true)
SSAO data packing mode (default: 1)
Protected
_Protected
Optional
_Protected
Optional
_Protected
_Readonly
bufferBuffer data type for the SSAO render target. Cannot be changed after plugin creation.
Internal
dependenciesPlugin dependencies - automatically adds GBufferPlugin for depth and normal data
Readonly
packingSSAO data packing mode for the render target. Cannot be changed after plugin creation.
Readonly
passReadonly
sizeRender target size multiplier relative to the main canvas size. Cannot be changed after plugin creation.
Optional
targetThe render target containing SSAO data
Optional
textureDebug texture preview of the SSAO buffer (read-only)
Optional
uiStatic
Readonly
OldStatic
Readonly
Pluginuse target instead
Protected
_This function is called every frame before composer render, if this pass is being used in the pipeline
Optional
_: IScene<ISceneEventMap>Optional
_1: ICamera<ICameraEventMap>Optional
_2: IRenderManager<IRenderManagerEventMap>Protected
_Protected
_Protected
_Protected
_Protected
_Optional
prefix: stringOptional
meta: anyOptional
meta: SerializationMetaType
Screen Space Ambient Occlusion (SSAO) Plugin for enhanced lighting and depth perception in 3D scenes.
SSAO is a real-time ambient occlusion technique that approximates the soft shadows that occur in creases, holes, and surfaces that are close to each other. This plugin adds a pre-render pass that calculates ambient occlusion data which is then used by materials during the main render pass.
Key Features
Dependencies
This plugin automatically adds GBufferPlugin as a dependency for efficient depth and normal data.
Usage Scenarios
Performance Considerations
sizeMultiplier
values (0.5-0.75) for better performance on mobile devicesTemporalAAPlugin
for temporal accumulationExample: Basic Usage
Example: Per-Material Control
Example: High Performance Setup