ShaderEffect 类

定义

通过使用 PixelShader 提供自定义位图效果。

public ref class ShaderEffect abstract : System::Windows::Media::Effects::Effect
public abstract class ShaderEffect : System.Windows.Media.Effects.Effect
type ShaderEffect = class
    inherit Effect
Public MustInherit Class ShaderEffect
Inherits Effect
继承

示例

下面的代码示例演示如何从 ShaderEffect 类派生。

using System;
using System.Windows;
using System.Windows.Media;
using System.Windows.Media.Effects;
using System.Reflection;

namespace ShaderEffectDemo
{

    public class ThresholdEffect : ShaderEffect
    {
        private static PixelShader _pixelShader =
            new PixelShader() { UriSource = MakePackUri("ThresholdEffect.fx.ps") };

        public ThresholdEffect()
        {
            PixelShader = _pixelShader;

            UpdateShaderValue(InputProperty);
            UpdateShaderValue(ThresholdProperty);
            UpdateShaderValue(BlankColorProperty);
        }

        // MakePackUri is a utility method for computing a pack uri
        // for the given resource. 
        public static Uri MakePackUri(string relativeFile)
        {
            Assembly a = typeof(ThresholdEffect).Assembly;

            // Extract the short name.
            string assemblyShortName = a.ToString().Split(',')[0];

            string uriString = "pack://application:,,,/" +
                assemblyShortName +
                ";component/" +
                relativeFile;

            return new Uri(uriString);
        }

        ///////////////////////////////////////////////////////////////////////
        #region Input dependency property

        public Brush Input
        {
            get { return (Brush)GetValue(InputProperty); }
            set { SetValue(InputProperty, value); }
        }

        public static readonly DependencyProperty InputProperty =
            ShaderEffect.RegisterPixelShaderSamplerProperty("Input", typeof(ThresholdEffect), 0);

        #endregion

        ///////////////////////////////////////////////////////////////////////
        #region Threshold dependency property

        public double Threshold
        {
            get { return (double)GetValue(ThresholdProperty); }
            set { SetValue(ThresholdProperty, value); }
        }

        public static readonly DependencyProperty ThresholdProperty =
            DependencyProperty.Register("Threshold", typeof(double), typeof(ThresholdEffect),
                    new UIPropertyMetadata(0.5, PixelShaderConstantCallback(0)));

        #endregion

        ///////////////////////////////////////////////////////////////////////
        #region BlankColor dependency property

        public Color BlankColor
        {
            get { return (Color)GetValue(BlankColorProperty); }
            set { SetValue(BlankColorProperty, value); }
        }

        public static readonly DependencyProperty BlankColorProperty =
            DependencyProperty.Register("BlankColor", typeof(Color), typeof(ThresholdEffect),
                    new UIPropertyMetadata(Colors.Transparent, PixelShaderConstantCallback(1)));

        #endregion
    }
}

下面的代码示例演示与上 ShaderEffect 一个类对应的着色器。

// Threshold shader 

// Object Declarations

sampler2D implicitInput : register(s0);
float threshold : register(c0);
float4 blankColor : register(c1);

//--------------------------------------------------------------------------------------
// Pixel Shader
//--------------------------------------------------------------------------------------
float4 main(float2 uv : TEXCOORD) : COLOR
{
    float4 color = tex2D(implicitInput, uv);
    float intensity = (color.r + color.g + color.b) / 3;
    
    float4 result;
    if (intensity > threshold)
    {
        result = color;
    }
    else
    {
        result = blankColor;
    }
    
    return result;
}

以下 XAML 演示如何使用自定义着色器效果。

<Window x:Class="ShaderEffectDemo.Window1"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="clr-namespace:ShaderEffectDemo"
    Title="Window1" Height="300" Width="300">
    <Window.Resources>
        <local:ThresholdEffect x:Key="thresholdEffect" Threshold="0.25" BlankColor="Orange" />
    </Window.Resources>
    
    <Grid Effect="{StaticResource thresholdEffect}">

    </Grid>
</Window>

注解

ShaderEffect 类派生,以基于单个像素着色器实现自定义效果。

以下步骤演示如何创建自定义效果。

  1. PixelShader从预编译的高级着色语言 (HLSL) 字节代码加载 。

  2. 定义表示效果参数和基于表面输入的 Brush依赖属性。 使用其中 RegisterPixelShaderSamplerProperty 一个重载将这些输入与 HLSL 字节码中引用的寄存器号相关联。

采样器的数量限制为 4 个。

使用 PS 3.0 着色器时,以下限制适用。

  • 分配 PS 3.0 着色器时,采样器数将增加到 8。 在其他着色器之前分配 PS 3.0 着色器,以启用注册 8 个采样器。

  • 使用浮点数的完整着色器常量寄存器限制为 224。 有关详细信息,请参阅 ps_3_0

  • 以下数据类型仅在 PS 3.0 着色器中受支持。 如果在较低的着色器版本中使用它们,则会引发异常。

    • int和 类型可转换为 intuint、、bytelongsbyteulongshortushortchar

    • bool

  • 如果在没有硬件支持 PS 3.0 的计算机上加载了有效的 PS 3.0 着色器,则忽略该着色器。 如果着色器无效,则不会引发异常。

  • 如果计算机有多个视频卡,则行为由最低支持的视频卡定义。 例如,如果计算机有两个视频卡,其中一个支持 PS 3.0,其中一个不支持,则行为与计算机不支持 PS 3.0 时的行为相同。

  • 如果计算机支持在硬件中呈现 PS 3.0,但分配了无效的 PS 3.0 着色器, InvalidPixelShaderEncountered 则会引发 事件。 无效 PS 3.0 着色器的示例是使用 标志编译的 ps_3_sw 着色器。 类 ShaderEffect 仅接受使用 ps_3_0 传递给 fxc.exe 的标志编译的 PS 3.0 着色器。 有关详细信息,请参阅 效果编译器工具

注意

PS 2.0 着色器在软件中呈现时运行。 但是,即使系统硬件支持 PS 3.0,PS 3.0 着色器也不会在软件呈现期间运行。

构造函数

ShaderEffect()

初始化 ShaderEffect 类的新实例。

字段

PixelShaderProperty

标识 PixelShader 依赖项属性。

属性

CanFreeze

获取一个值,该值指示是否可将对象变为不可修改。

(继承自 Freezable)
DdxUvDdyUvRegisterIndex

获取或设置一个值,该值指示要用于纹理坐标对屏幕空间的偏导数的着色器寄存器。

DependencyObjectType

DependencyObjectType获取包装此实例的 CLR 类型的 。

(继承自 DependencyObject)
Dispatcher

获取与此 Dispatcher 关联的 DispatcherObject

(继承自 DispatcherObject)
EffectMapping

当在派生类中重写时,通过效果转换鼠标输入和坐标系。

(继承自 Effect)
HasAnimatedProperties

获取一个值,该值指示一个或多个 AnimationClock 对象是否与此对象的任何依赖项属性相关联。

(继承自 Animatable)
IsFrozen

获取一个值,该值指示对象当前是否可修改。

(继承自 Freezable)
IsSealed

获取一个值,该值指示此实例当前是否为密封的(只读)。

(继承自 DependencyObject)
PaddingBottom

获取或设置一个值,该值指示沿下边缘方向效果的输出纹理大于其输入纹理。

PaddingLeft

获取或设置一个值,该值指示沿左边缘方向效果的输出纹理大于其输入纹理。

PaddingRight

获取或设置一个值,该值指示沿右边缘方向效果的输出纹理大于其输入纹理。

PaddingTop

获取或设置一个值,该值指示沿上边缘方向效果的输出纹理大于其输入纹理。

PixelShader

获取或设置要用于该效果的 PixelShader

方法

ApplyAnimationClock(DependencyProperty, AnimationClock)

AnimationClock 应用到指定的 DependencyProperty。 如果该属性已进行动画处理,则使用 SnapshotAndReplace 切换行为。

(继承自 Animatable)
ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)

AnimationClock 应用到指定的 DependencyProperty。 如果该属性已进行动画处理,则使用指定的 HandoffBehavior

(继承自 Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline)

将动画应用于指定 DependencyProperty。 动画会在呈现下一帧时启动。 如果指定属性已进行动画处理,则使用 SnapshotAndReplace 切换行为。

(继承自 Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)

将动画应用于指定 DependencyProperty。 动画会在呈现下一帧时启动。 如果指定的属性已进行动画处理,则使用指定的 HandoffBehavior

(继承自 Animatable)
CheckAccess()

确定调用线程是否可以访问此 DispatcherObject

(继承自 DispatcherObject)
ClearValue(DependencyProperty)

清除属性的本地值。 要清除的属性由 DependencyProperty 标识符指定。

(继承自 DependencyObject)
ClearValue(DependencyPropertyKey)

清除只读属性的本地值。 要清除的属性由 DependencyPropertyKey 指定。

(继承自 DependencyObject)
Clone()

创建此 ShaderEffect 对象的可修改复本,从而深度复制此对象的值。 在复制此对象的依赖项属性时,此方法复制资源引用和数据绑定(可能不再解析),但不复制动画或其当前值。

CloneCore(Freezable)

使用基(未经过动画处理的)属性值使该实例成为指定 Freezable 的克隆(深层复制)。

CloneCurrentValue()

创建此 ShaderEffect 对象的可修改复本,从而深度复制此对象的当前值。 不复制资源引用、数据绑定和动画,而是复制其当前值。

CloneCurrentValueCore(Freezable)

使用当前属性值使该实例成为指定 Freezable 的可修改克隆(深层复制)。

CoerceValue(DependencyProperty)

对指定依赖属性的值进行强制。 通过对调用方 DependencyObject 上存在的依赖属性的属性元数据中所指定的任何 CoerceValueCallback 函数进行调用来完成此操作。

(继承自 DependencyObject)
CreateInstance()

初始化 Freezable 类的新实例。

(继承自 Freezable)
CreateInstanceCore()

创建 Freezable 派生类的新实例。

Equals(Object)

确定提供的 DependencyObject 是否等效于当前 DependencyObject

(继承自 DependencyObject)
Freeze()

使当前对象不可修改,并且将其 IsFrozen 属性设置为 true

(继承自 Freezable)
FreezeCore(Boolean)

使此 Animatable 对象成为不可修改的对象,或确定是否可使其成为不可修改的对象。

(继承自 Animatable)
GetAnimationBaseValue(DependencyProperty)

返回指定的 DependencyProperty 的未经过动画处理的值。

(继承自 Animatable)
GetAsFrozen()

使用基(未经过动画处理的)属性值创建 Freezable 的冻结副本。 由于副本已冻结,因此将通过引用复制任何冻结的子对象。

(继承自 Freezable)
GetAsFrozenCore(Freezable)

让该实例成为指定的 Freezable 的冻结克隆,前者使用基(非动画的)属性值。

GetCurrentValueAsFrozen()

使用当前属性值创建 Freezable 的冻结副本。 由于副本已冻结,因此将通过引用复制任何冻结的子对象。

(继承自 Freezable)
GetCurrentValueAsFrozenCore(Freezable)

使当前实例成为指定 Freezable 的冻结克隆。 如果对象具有动画依赖属性,则复制其当前的动画值。

GetHashCode()

获取此 DependencyObject 的哈希代码。

(继承自 DependencyObject)
GetLocalValueEnumerator()

创建一个专用的枚举数,用于确定哪些依赖项属性在此 DependencyObject 上具有以本地方式设置的值。

(继承自 DependencyObject)
GetType()

获取当前实例的 Type

(继承自 Object)
GetValue(DependencyProperty)

DependencyObject 的此实例返回依赖属性的当前有效值。

(继承自 DependencyObject)
InvalidateProperty(DependencyProperty)

重新评估指定依赖属性的有效值。

(继承自 DependencyObject)
MemberwiseClone()

创建当前 Object 的浅表副本。

(继承自 Object)
OnChanged()

修改当前 Freezable 对象时调用。

(继承自 Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject)

确保为刚刚设置的 DependencyObjectType 数据成员建立适当的上下文指针。

(继承自 Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)

此成员支持Windows Presentation Foundation (WPF) 基础结构,不应直接从代码使用。

(继承自 Freezable)
OnPropertyChanged(DependencyPropertyChangedEventArgs)

重写 OnPropertyChanged(DependencyPropertyChangedEventArgs)DependencyObject 实现,以同时调用任何响应类型 Freezable 不断变化的依赖属性的 Changed 处理程序。

(继承自 Freezable)
PixelShaderConstantCallback(Int32)

将依赖项属性值与像素着色器的浮点常量寄存器相关联。

PixelShaderSamplerCallback(Int32)

将依赖项属性值与像素着色器的采样器寄存器相关联。

PixelShaderSamplerCallback(Int32, SamplingMode)

将依赖项属性值与像素着色器的采样器寄存器以及 SamplingMode 相关联。

ReadLocalValue(DependencyProperty)

如果存在,则返回依赖属性的本地值。

(继承自 DependencyObject)
ReadPreamble()

确保正在从有效的线程访问 FreezableFreezable 的继承者必须在任何 API 一开始读取不属于依赖项对象的数据成员时调用此方法。

(继承自 Freezable)
RegisterPixelShaderSamplerProperty(String, Type, Int32)

将依赖项属性与着色器的采样器寄存器相关联。

RegisterPixelShaderSamplerProperty(String, Type, Int32, SamplingMode)

将依赖项属性与着色器的采样器寄存器以及 SamplingMode 相关联。

SetCurrentValue(DependencyProperty, Object)

设置依赖属性的值而不更改其值源。

(继承自 DependencyObject)
SetValue(DependencyProperty, Object)

设置依赖属性的本地值,该值由其依赖属性标识符指定。

(继承自 DependencyObject)
SetValue(DependencyPropertyKey, Object)

设置一个只读依赖属性的本地值,该值由依赖属性的 DependencyPropertyKey 标识符指定。

(继承自 DependencyObject)
ShouldSerializeProperty(DependencyProperty)

返回一个值,该值指示序列化进程是否应序列化所提供的依赖属性的值。

(继承自 DependencyObject)
ToString()

返回表示当前对象的字符串。

(继承自 Object)
UpdateShaderValue(DependencyProperty)

通知效果应当更新与指定依赖项属性对应的着色器常量或采样器。

VerifyAccess()

强制调用线程具有此 DispatcherObject 的访问权限。

(继承自 DispatcherObject)
WritePostscript()

引发 FreezableChanged 事件并调用其 OnChanged() 方法。 从 Freezable 派生的类应在修改的类成员不存储为依赖属性的任何 API 的末尾调用此方法。

(继承自 Freezable)
WritePreamble()

验证 Freezable 是否未被冻结,并且是否正在从有效的线程上下文中访问它。 Freezable 的继承项应当在任何 API 一开始写入不属于依赖项属性的数据成员时调用此方法。

(继承自 Freezable)

事件

Changed

在修改 Freezable 或其包含的对象时发生。

(继承自 Freezable)

适用于

另请参阅