ShaderEffect Classe

Riferimento

Definizione

Spazio dei nomi:: System.Windows.Media.Effects

Assembly:: PresentationCore.dll

Importante

Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.

Genera un effetto bitmap personalizzato usando 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

Ereditarietà: Object

DispatcherObject

DependencyObject

Freezable

Animatable

Effect
ShaderEffect

Esempio

Nell'esempio di codice seguente viene illustrato come derivare dalla ShaderEffect classe .

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
    }
}

Nell'esempio di codice seguente viene illustrato uno shader che corrisponde alla classe precedente 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;
}

Il codice XAML seguente illustra come usare l'effetto shader personalizzato.

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

Commenti

Derivare dalla ShaderEffect classe per implementare un effetto personalizzato in base a un singolo pixel shader.

La procedura seguente illustra come creare un effetto personalizzato.

Caricare un PixelShader bytecode da bytecode HLSL (High Level Shading Language) precompilato.
Definire le proprietà di dipendenza che rappresentano i parametri dell'effetto e Brushgli input della superficie basata su base. Usare uno degli RegisterPixelShaderSamplerProperty overload per associare questi input ai numeri di registrazione a cui si fa riferimento nel bytecode HLSL.

Il numero di campionatori è limitato a 4.

Quando si usa uno shader PS 3.0, si applicano le restrizioni seguenti.

Quando viene assegnato uno shader PS 3.0, il numero di campionatori aumenta a 8. Assegnare lo shader PS 3.0 prima di altri shader per abilitare la registrazione di 8 campionatori.
Viene usato il limite di registrazione costante completo dello shader pari a 224 per i valori float. Per altre informazioni, vedere ps_3_0.
I tipi di dati seguenti sono supportati solo negli shader ps 3.0. Viene generata un'eccezione se vengono usate nelle versioni di shader inferiori.
- inte tipi convertibili in int: uint, byte, sbyte, long, ulong, short, , ushortchar
- bool
Se uno shader PS 3.0 valido viene caricato in un computer che non dispone del supporto hardware per PS 3.0, lo shader viene ignorato. Se lo shader non è valido, non viene generata alcuna eccezione.
Se un computer ha più di una scheda video, il comportamento viene definito dalla scheda video meno idonea. Ad esempio, se il computer ha due schede video, una delle quali supporta PS 3.0 e una delle quali non, il comportamento è uguale a se il computer non supporta PS 3.0.
Se un computer supporta il rendering di PS 3.0 nell'hardware, ma viene assegnato uno shader PS 3.0 non valido, viene generato l'evento InvalidPixelShaderEncountered . Un esempio di shader PS 3.0 non valido è uno compilato con il ps_3_sw flag . La ShaderEffect classe accetta solo shader PS 3.0 compilati con il ps_3_0 flag passato a fxc.exe. Per altre informazioni, vedere Strumento del compilatore di effetti.

Nota

Gli shader PS 2.0 vengono eseguiti durante il rendering nel software. Tuttavia, anche se PS 3.0 è supportato dall'hardware del sistema, gli shader PS 3.0 non vengono eseguiti durante il rendering software.

Costruttori

ShaderEffect()

Inizializza una nuova istanza della classe ShaderEffect.

Campi

PixelShaderProperty

Identifica la proprietà di dipendenza PixelShader.

Proprietà

CanFreeze	Ottiene un valore che indica se l'oggetto può essere impostato come non modificabile. (Ereditato da Freezable)
DdxUvDdyUvRegisterIndex	Ottiene o imposta un valore che indica il registro dello shader da usare per la derivazione parziale delle coordinate della trama rispetto alle dimensioni dello schermo.
DependencyObjectType	Ottiene l'oggetto DependencyObjectType che esegue il wrapping del tipo CLR di questa istanza. (Ereditato da DependencyObject)
Dispatcher	Ottiene l'oggetto Dispatcher associato a DispatcherObject. (Ereditato da DispatcherObject)
EffectMapping	Quando se ne effettua l'override in una classe derivata, l'input del mouse e i sistemi di coordinate verranno trasformati tramite l'effetto. (Ereditato da Effect)
HasAnimatedProperties	Ottiene un valore che indica se uno o più oggetti AnimationClock sono associati a una qualsiasi delle proprietà di dipendenza di questo oggetto. (Ereditato da Animatable)
IsFrozen	Ottiene un valore che indica se l'oggetto è attualmente modificabile. (Ereditato da Freezable)
IsSealed	Ottiene un valore che indica se l'istanza è attualmente sealed (di sola lettura). (Ereditato da DependencyObject)
PaddingBottom	Ottiene o imposta un valore che indica che la trama generata dall'effetto è più ampia della rispettiva trama immessa lungo il bordo inferiore.
PaddingLeft	Ottiene o imposta un valore che indica che la trama generata dall'effetto è più ampia della rispettiva trama immessa lungo il bordo sinistro.
PaddingRight	Ottiene o imposta un valore che indica che la trama generata dall'effetto è più ampia della rispettiva trama immessa lungo il bordo destro.
PaddingTop	Ottiene o imposta un valore che indica che la trama generata dall'effetto è più ampia della rispettiva trama immessa lungo il bordo superiore.
PixelShader	Ottiene o imposta l'oggetto PixelShader da usare per l'effetto.

Metodi

ApplyAnimationClock(DependencyProperty, AnimationClock)	Applica un oggetto AnimationClock all'oggetto DependencyProperty specificato. Se la proprietà è già animata, viene usato il comportamento di continuità di SnapshotAndReplace. (Ereditato da Animatable)
ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)	Applica un oggetto AnimationClock all'oggetto DependencyProperty specificato. Se alla proprietà è già stata aggiunta un'animazione, viene utilizzato l'oggetto HandoffBehavior specificato. (Ereditato da Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline)	Applica un'animazione all'oggetto DependencyProperty specificato. L'animazione viene avviata quando viene eseguito il rendering del fotogramma successivo. Se alla proprietà specificata è già applicata un'animazione, viene usato il comportamento di continuità di SnapshotAndReplace. (Ereditato da Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)	Applica un'animazione all'oggetto DependencyProperty specificato. L'animazione viene avviata quando viene eseguito il rendering del fotogramma successivo. Se alla proprietà specificata è già stata aggiunta un'animazione, viene utilizzato l'oggetto HandoffBehavior specificato. (Ereditato da Animatable)
CheckAccess()	Determina se il thread chiamante ha accesso a DispatcherObject. (Ereditato da DispatcherObject)
ClearValue(DependencyProperty)	Cancella il valore locale di una proprietà. La proprietà da cancellare è specificata da un identificatore DependencyProperty. (Ereditato da DependencyObject)
ClearValue(DependencyPropertyKey)	Cancella il valore locale di una proprietà di sola lettura. La proprietà da cancellare è specificata da un oggetto DependencyPropertyKey. (Ereditato da DependencyObject)
Clone()	Crea un clone modificabile dell'oggetto ShaderEffect, eseguendo copie complete dei valori di tale oggetto. Durante la copia delle proprietà di dipendenza di questo oggetto, questo metodo copia i riferimenti alle risorse e i data binding (che potrebbero non essere più risolti), ma non le animazioni né i relativi valori correnti.
CloneCore(Freezable)	Rende l'istanza un clone (copia completa) dell'oggetto Freezable specificato usando i valori di proprietà di base (non animati).
CloneCurrentValue()	Crea un clone modificabile dell'oggetto ShaderEffect, eseguendo copie complete dei valori correnti di tale oggetto. I riferimenti alle risorse, i data binding e le animazioni non vengono copiati, mentre vengono copiati i relativi valori correnti.
CloneCurrentValueCore(Freezable)	Rende l'istanza un clone (copia completa) modificabile dell'oggetto Freezable specificato usando i valori di proprietà correnti.
CoerceValue(DependencyProperty)	Assegna forzatamente il valore della proprietà di dipendenza specificata. Questa operazione viene eseguita richiamando qualsiasi funzione CoerceValueCallback specificata nei metadati della proprietà di dipendenza esistente nell'oggetto DependencyObject chiamante. (Ereditato da DependencyObject)
CreateInstance()	Inizializza una nuova istanza della classe Freezable. (Ereditato da Freezable)
CreateInstanceCore()	Crea una nuova istanza della classe derivata da Freezable.
Equals(Object)	Determina se l'oggetto DependencyObject specificato equivale all'oggetto DependencyObject corrente. (Ereditato da DependencyObject)
Freeze()	Rende non modificabile l'oggetto corrente e ne imposta la proprietà IsFrozen su `true`. (Ereditato da Freezable)
FreezeCore(Boolean)	Rende immodificabile questo oggetto Animatable o determina se l'oggetto può essere reso immodificabile. (Ereditato da Animatable)
GetAnimationBaseValue(DependencyProperty)	Restituisce il valore non animato dell'oggetto DependencyProperty specificato. (Ereditato da Animatable)
GetAsFrozen()	Crea una copia bloccata di Freezable, utilizzando valori delle proprietà di base (non-animati). Dato che la copia è bloccata, gli oggetti secondari bloccati sono copiati dal riferimento. (Ereditato da Freezable)
GetAsFrozenCore(Freezable)	Rende l'istanza un clone bloccato dell'oggetto Freezable specificato usando i valori di proprietà di base (non animati).
GetCurrentValueAsFrozen()	Crea una copia bloccata di Freezable utilizzando valori della proprietà correnti. Dato che la copia è bloccata, gli oggetti secondari bloccati sono copiati dal riferimento. (Ereditato da Freezable)
GetCurrentValueAsFrozenCore(Freezable)	Rende l'istanza corrente un clone bloccato dell'oggetto Freezable specificato. Se l'oggetto ha proprietà di dipendenza animate, i valori animati correnti vengono copiati.
GetHashCode()	Ottiene un codice hash per l'oggetto DependencyObject. (Ereditato da DependencyObject)
GetLocalValueEnumerator()	Crea un enumeratore specializzato per determinare le proprietà di dipendenza che presentano valori impostati localmente nell'oggetto DependencyObject. (Ereditato da DependencyObject)
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
GetValue(DependencyProperty)	Restituisce il valore effettivo corrente di una proprietà di dipendenza in questa istanza di DependencyObject. (Ereditato da DependencyObject)
InvalidateProperty(DependencyProperty)	Valuta di nuovo il valore effettivo della proprietà di dipendenza specificata. (Ereditato da DependencyObject)
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
OnChanged()	Chiamato quando viene modificato l'oggetto Freezable corrente. (Ereditato da Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject)	Assicura che adatti puntatori del contesto siano stabiliti per un membro dati DependencyObjectType che è appena stato impostato. (Ereditato da Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)	Questo membro supporta l'infrastruttura Windows Presentation Foundation (WPF) e non deve essere usata direttamente dal codice. (Ereditato da Freezable)
OnPropertyChanged(DependencyPropertyChangedEventArgs)	Esegue l'override dell'implementazione di DependencyObject di OnPropertyChanged(DependencyPropertyChangedEventArgs) per richiamare anche eventuali gestori Changed in risposta alla modifica di una proprietà di dipendenza di tipo Freezable. (Ereditato da Freezable)
PixelShaderConstantCallback(Int32)	Associa il valore di una proprietà di dipendenza a un registro costante float di un pixel shader.
PixelShaderSamplerCallback(Int32)	Associa il valore di una proprietà di dipendenza a un registro del campionatore di un pixel shader.
PixelShaderSamplerCallback(Int32, SamplingMode)	Associa il valore di una proprietà di dipendenza al registro del campionatore di un pixel shader e a SamplingMode.
ReadLocalValue(DependencyProperty)	Restituisce il valore locale di una proprietà di dipendenza, se esistente. (Ereditato da DependencyObject)
ReadPreamble()	Assicura che l’accesso di Freezable sia stato eseguito da un thread valido. Gli eredi di Freezable devono chiamare questo metodo all'inizio di qualsiasi API che legge i membri dei dati che non sono proprietà della dipendenza. (Ereditato da Freezable)
RegisterPixelShaderSamplerProperty(String, Type, Int32)	Associa una proprietà di dipendenza a un registro del campionatore dello shader.
RegisterPixelShaderSamplerProperty(String, Type, Int32, SamplingMode)	Associa una proprietà di dipendenza a un registro del campionatore dello shader e a SamplingMode.
SetCurrentValue(DependencyProperty, Object)	Imposta il valore di una proprietà di dipendenza senza modificare l'origine del valore. (Ereditato da DependencyObject)
SetValue(DependencyProperty, Object)	Imposta il valore locale di una proprietà di dipendenza, specificato dal relativo identificatore della proprietà di dipendenza. (Ereditato da DependencyObject)
SetValue(DependencyPropertyKey, Object)	Imposta il valore locale di una proprietà di dipendenza di sola lettura, specificato dall'identificatore DependencyPropertyKey della proprietà di dipendenza. (Ereditato da DependencyObject)
ShouldSerializeProperty(DependencyProperty)	Restituisce un valore che indica se i processi di serializzazione devono serializzare il valore della proprietà di dipendenza specificata. (Ereditato da DependencyObject)
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)
UpdateShaderValue(DependencyProperty)	Notifica all'effetto che la costante o il campionatore dello shader, corrispondente alla proprietà di dipendenza specificata, deve essere aggiornato.
VerifyAccess()	Impone che il thread chiamante abbia accesso a DispatcherObject. (Ereditato da DispatcherObject)
WritePostscript()	Genera l'evento Changed per Freezable e richiama il metodo OnChanged(). Le classi che derivano da Freezable devono chiamare questo metodo alla fine di qualsiasi API che modifica i membri di classe che non sono archiviati come proprietà di dipendenza. (Ereditato da Freezable)
WritePreamble()	Verifica che l'oggetto Freezable non sia bloccato e che l'accesso sia eseguito da un contesto di threading valido. Gli eredi di Freezable devono chiamare questo metodo all'inizio di qualsiasi API che scrive sui membri dei dati che non sono proprietà della dipendenza. (Ereditato da Freezable)

Eventi

Changed

Si verifica quando Freezable o un oggetto che contiene è modificato.

(Ereditato da Freezable)

Si applica a