ShaderEffect クラス

定義

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

継承

Object

DispatcherObject

DependencyObject

Freezable

Animatable

Effect

ShaderEffect

例

次のコード例は、 クラスから派生する方法を 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 つのピクセル シェーダーに基づいてカスタム効果を実装します。

次の手順では、カスタム効果を作成する方法を示します。

1. プリコンパイル済みの高レベル シェーディング言語 (HLSL) バイトコードから を PixelShader 読み込みます。

2. 効果とベースのサーフェス入力のパラメーターを表す依存関係プロパティを Brush定義します。 いずれかのオーバーロードを RegisterPixelShaderSamplerProperty 使用して、これらの入力を HLSL バイトコードで参照されるレジスタ番号に関連付けます。

サンプラーの数は 4 に制限されています。

PS 3.0 シェーダーを使用する場合は、次の制限が適用されます。

• PS 3.0 シェーダーが割り当てられると、サンプラーの数が 8 に増えます。 他のシェーダーの前に PS 3.0 シェーダーを割り当てて、8 つのサンプラーの登録を有効にします。

• float に対するシェーダー定数レジスタの上限である 224 が使用されます。 詳細については、「 ps_3_0」を参照してください。

• 次のデータ型は、PS 3.0 シェーダーでのみサポートされています。 これらが下位のシェーダー バージョンで使用されている場合は、例外がスローされます。

  • intおよび 型はuint、、、byte、、longsbyteulongshort、 ushortにint変換可能です。char

  • bool

• PS 3.0 のハードウェア サポートがないコンピューターに有効な PS 3.0 シェーダーが読み込まれている場合、シェーダーは無視されます。 シェーダーが無効な場合、例外はスローされません。

• コンピューターに複数のビデオ カードがある場合、動作は最も能力の低いビデオ カードによって定義されます。 たとえば、コンピューターに 2 つのビデオ カードがあり、そのうちの 1 つが PS 3.0 をサポートし、そのうちの 1 つがサポートされていない場合、動作はコンピューターが PS 3.0 をサポートしていない場合と同じです。

• コンピューターがハードウェアでの PS 3.0 のレンダリングをサポートしているが、無効な PS 3.0 シェーダーが割り当てられている場合、 InvalidPixelShaderEncountered イベントが発生します。 無効な PS 3.0 シェーダーの例は、 フラグを使用して ps_3_sw コンパイルされたシェーダーです。 クラスは ShaderEffect 、fxc.exeに渡されたフラグで ps_3_0 コンパイルされた PS 3.0 シェーダーのみを受け入れます。 詳細については、「 効果コンパイラ ツール」を参照してください。

コンストラクター

フィールド

プロパティ

メソッド

イベント

適用対象

こちらもご覧ください

• Effect
• PixelShader