Blur Class

Blur Class

Blurs the image using a convolution filter.

Inheritance Hierarchy

SystemObject
DigitalRune.Graphics.PostProcessingPostProcessor
DigitalRune.Graphics.PostProcessingBlur

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 Blur : PostProcessor

Public Class Blur
	Inherits PostProcessor

public ref class Blur : public PostProcessor

type Blur =  
    class
        inherit PostProcessor
    end

The Blur type exposes the following members.

Constructors

	Name	Description
	Blur	Initializes a new instance of the Blur 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.)
	InitializeBoxBlur	Computes sample offsets and weights for box blur filter kernel.
	InitializeGaussianBlur	Computes sample offsets and weights for Gaussian blur filter kernel.
	InitializePoissonBlur	Computes sample offsets and weights for a 13-tap Poisson disk filter kernel.
	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
	DefaultTargetFormat	Gets or sets the default target format. (This property is used by the PostProcessorChain). (Inherited from PostProcessor.)
	DepthScaling	Gets or sets a value that controls how scene depth influences the filter scale. (Only used by anisotropic or bilateral blurs.)
	EdgeSoftness	Gets or sets the edge softness for bilateral filtering.
	Enabled	Gets or sets a value indicating whether this post-processor is enabled. (Inherited from PostProcessor.)
	FilterInLogSpace	Gets or sets a value indicating whether log-space filtering is used.
	GraphicsService	Gets the graphics service. (Inherited from PostProcessor.)
	IsAnisotropic	Gets or sets a value indicating whether to use an anisotropic filter kernel.
	IsBilateral	Gets or sets a value indicating whether joint bilateral filtering (= edge-aware filtering) is enabled.
	IsDisposed	Gets a value indicating whether this post-processor has been disposed of. (Inherited from PostProcessor.)
	IsSeparable	Gets or sets a value indicating whether the configured blur filter is separable.
	MaxNumberOfSamples	Gets the maximum number of samples that are supported.
	Name	Gets or sets the name of the post-processor. (Inherited from PostProcessor.)
	NumberOfPasses	Gets or sets the number of blur passes.
	NumberOfSamples	Gets or sets the number of samples.
	Offsets	Gets the sample offsets.
	Scale	Gets or sets the scale that is applied to the offsets.
	Weights	Gets or sets the weights of the samples.

Top

Remarks

Per default, a box blur is performed. The type of blur can be changed using

InitializeBoxBlur(Int32, Boolean),
InitializeGaussianBlur(Int32, Single, Boolean),
InitializePoissonBlur,
or by changing the sample Offsets and sample Weights directly.

Many convolution blur filters are separable and can be performed in two passes (a horizontal blur and a vertical blur). If this is the case, IsSeparable can be set to and two passes will be performed. In the second pass, the x and y values in Offsets are switched internally.

Limitations:
Anisotropic or joint bilateral filtering in log-space is not supported. When FilterInLogSpace is set, the properties IsAnisotropic and IsBilateral are ignored.

Reference

DigitalRune.Graphics.PostProcessing Namespace