SsaoFilter Class

SsaoFilter Class

Creates a Screen-Space Ambient Occlusion (SSAO) effect to approximate ambient occlusion in real-time.

Inheritance Hierarchy

SystemObject
DigitalRune.Graphics.PostProcessingPostProcessor
DigitalRune.Graphics.PostProcessingSsaoFilter

Namespace: DigitalRune.Graphics.PostProcessing
Assembly: DigitalRune.Graphics (in DigitalRune.Graphics.dll) Version: 1.2.0.0 (1.2.1.14562)

Syntax

C++

Copy

public class SsaoFilter : PostProcessor

Public Class SsaoFilter
	Inherits PostProcessor

public ref class SsaoFilter : public PostProcessor

type SsaoFilter =  
    class
        inherit PostProcessor
    end

The SsaoFilter type exposes the following members.

Constructors

	Name	Description
	SsaoFilter	Initializes a new instance of the SsaoFilter class.

Top

Methods

	Name	Description
	Dispose	Releases all resources used by an instance of the PostProcessor class. (Inherited from PostProcessor.)
	Dispose(Boolean)	Releases the unmanaged resources used by an instance of the PostProcessor class and optionally releases the managed resources. (Inherited from PostProcessor.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnDisable	Called when this post-processor is disabled. (Inherited from PostProcessor.)
	OnEnable	Called when this post-processor is enabled. (Inherited from PostProcessor.)
	OnProcess	Called when the post-processor should perform the post-processing. (Overrides PostProcessorOnProcess(RenderContext).)
	Process	Performs the post-processing using the SourceTexture and the RenderTarget specified in the render context. (Inherited from PostProcessor.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	CombineWithSource	Gets or sets a value indicating whether the ambient occlusion should be applied to the source image - or if a black-white AO image is produced, ignoring the source image.
	DefaultTargetFormat	Gets or sets the default target format. (This property is used by the PostProcessorChain). (Inherited from PostProcessor.)
	DownsampleFactor	Gets or sets the downsample factor.
	Enabled	Gets or sets a value indicating whether this post-processor is enabled. (Inherited from PostProcessor.)
	GraphicsService	Gets the graphics service. (Inherited from PostProcessor.)
	IsDisposed	Gets a value indicating whether this post-processor has been disposed of. (Inherited from PostProcessor.)
	MaxDistances	Gets or sets the max distances for ambient occlusion.
	Name	Gets or sets the name of the post-processor. (Inherited from PostProcessor.)
	NumberOfBlurPasses	Gets or sets the number of blur passes.
	Quality	Gets or sets the quality level.
	Radii	Gets or sets the inner and outer ambient occlusion radius.
	Scale	Gets or sets the scale factors.
	Strength	Gets or sets the strength of the ambient occlusion.
	UseEdgeAwareBlur	Gets or sets a value indicating whether the ambient occlusion should be blurred using an edge-aware blur.

Top

Remarks

The default values are suitable for typical scenes, where 1 world space unit = 1 meter. If the rendered scenes have a different scale, the property MaxDistances needs to be adjusted.

A different SSAO method with higher quality is implemented in the SaoFilter.

Reference

DigitalRune.Graphics.PostProcessing Namespace