SaturationFilter Class

Changes the saturation of the input texture.

Inheritance Hierarchy

SystemObject
DigitalRune.Graphics.PostProcessingPostProcessor
DigitalRune.Graphics.PostProcessingSaturationFilter

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

Syntax

public class SaturationFilter : PostProcessor

Public Class SaturationFilter
	Inherits PostProcessor

public ref class SaturationFilter : public PostProcessor

type SaturationFilter =  
    class
        inherit PostProcessor
    end

The SaturationFilter type exposes the following members.

Constructors

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

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.)

Properties

	Name	Description
	DefaultTargetFormat	Gets or sets the default target format. (This property is used by the PostProcessorChain). (Inherited from PostProcessor.)
	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.)
	Name	Gets or sets the name of the post-processor. (Inherited from PostProcessor.)
	Saturation	Gets or sets the saturation.

Remarks

This filter assumes that the saturation of the input texture is 1. The saturation of each pixel is changed to the given target Saturation.