PixelShader Class

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Provides a managed wrapper around a High Level Shading Language (HLSL) pixel shader.

Namespace: System.Windows.Media.Effects
Assembly: PresentationCore (in PresentationCore.dll)

Inheritance Hierarchy

System.Object
System.Windows.Threading.DispatcherObject
System.Windows.DependencyObject
System.Windows.Freezable
System.Windows.Media.Animation.Animatable
System.Windows.Media.Effects.PixelShader

Syntax

C++

public sealed class PixelShader : Animatable

Constructors

	Name	Description
	PixelShader()	Initializes a new instance of the PixelShader class.

Properties

	Name	Description
	CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
	DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)
	Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
	HasAnimatedProperties	Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.(Inherited from Animatable.)
	IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
	IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)
	ShaderRenderMode	Gets or sets a value indicating whether to use hardware or software rendering.
	UriSource	Gets or sets a Pack URI reference to HLSL bytecode in the assembly.

Methods

	Name	Description
	ApplyAnimationClock(DependencyProperty, AnimationClock)	Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)
	ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)	Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.(Inherited from Animatable.)
	BeginAnimation(DependencyProperty, AnimationTimeline)	Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)
	BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)	Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
	CheckAccess()	Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)
	ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
	ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
	Clone()	Creates a modifiable clone of this PixelShader object, making deep copies of this object's values. When copying this object's dependency properties, this method copies resource references and data bindings (which may no longer resolve), but not animations or their current values.
	CloneCurrentValue()	Creates a modifiable clone of this PixelShader object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are copied.
	CoerceValue(DependencyProperty)	Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.(Inherited from DependencyObject.)
	Equals(Object)	Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)
	Freeze()	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
	GetAnimationBaseValue(DependencyProperty)	Returns the non-animated value of the specified DependencyProperty.(Inherited from Animatable.)
	GetAsFrozen()	Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetCurrentValueAsFrozen()	Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.(Inherited from Freezable.)
	GetHashCode()	Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)
	GetLocalValueEnumerator()	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	GetValue(DependencyProperty)	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
	InvalidateProperty(DependencyProperty)	Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)
	ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
	SetCurrentValue(DependencyProperty, Object)	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
	SetStreamSource(Stream)	Assigns the Stream to use as the source of HLSL bytecode.
	SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
	SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
	ShouldSerializeProperty(DependencyProperty)	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	VerifyAccess()	Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

Fields

	Name	Description
	ShaderRenderModeProperty	Identifies the ShaderRenderMode dependency property.
	UriSourceProperty	Identifies the UriSource dependency property.

Events

	Name	Description
	Changed	Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
	InvalidPixelShaderEncountered	Occurs when the render thread cannot process the pixel shader.

Remarks

Use the PixelShader class to access pre-compiled HLSL bytecode in a Windows Presentation Foundation (WPF) application. You can create a PixelShader from a Pack URI reference or from a Stream.

Set the UriSource property or call the SetStreamSource method to load the shader bytecode.

To create a custom effect, assign the PixelShader to the PixelShader property of a ShaderEffect.

Version Information

.NET Framework
Available since 3.0
Silverlight
Available since 3.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.