-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
Effect.xml
238 lines (221 loc) · 16.3 KB
/
Effect.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<Type Name="Effect" FullName="System.Windows.Media.Effects.Effect">
<TypeSignature Language="C#" Value="public abstract class Effect : System.Windows.Media.Animation.Animatable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract Effect extends System.Windows.Media.Animation.Animatable" FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<TypeSignature Language="DocId" Value="T:System.Windows.Media.Effects.Effect" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class Effect
Inherits Animatable" />
<TypeSignature Language="F#" Value="type Effect = class
 inherit Animatable
 interface DUCE.IResource" FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<TypeSignature Language="C++ CLI" Value="public ref class Effect abstract : System::Windows::Media::Animation::Animatable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Effect extends System.Windows.Media.Animation.Animatable" FrameworkAlternate="windowsdesktop-3.0;windowsdesktop-3.1;windowsdesktop-5.0;windowsdesktop-6.0;windowsdesktop-7.0;windowsdesktop-8.0;windowsdesktop-9.0" />
<TypeSignature Language="F#" Value="type Effect = class
 inherit Animatable" FrameworkAlternate="windowsdesktop-3.0;windowsdesktop-3.1;windowsdesktop-5.0;windowsdesktop-6.0;windowsdesktop-7.0;windowsdesktop-8.0;windowsdesktop-9.0" />
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Windows.Media.Animation.Animatable</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides a custom bitmap effect.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Derive from the <xref:System.Windows.Media.Effects.Effect> class to implement a custom bitmap effect. In most cases, you will derive from <xref:System.Windows.Media.Effects.ShaderEffect>.
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Effects.ShaderEffect" />
<altmember cref="T:System.Windows.Media.Effects.PixelShader" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Effect ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Effects.Effect.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 Effect();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Effects.Effect" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public System.Windows.Media.Effects.Effect Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Media.Effects.Effect Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Effects.Effect.Clone" />
<MemberSignature Language="VB.NET" Value="Public Function Clone () As Effect" />
<MemberSignature Language="F#" Value="override this.Clone : unit -> System.Windows.Media.Effects.Effect" Usage="effect.Clone " />
<MemberSignature Language="C++ CLI" Value="public:
 System::Windows::Media::Effects::Effect ^ Clone();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.Effects.Effect</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a modifiable clone of this <see cref="T:System.Windows.Media.Effects.Effect" /> 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.</summary>
<returns>A modifiable clone of this instance. The returned clone is effectively a deep copy of the current object. The clone's <see cref="P:System.Windows.Freezable.IsFrozen" /> property is <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Windows.Media.Effects.Effect.Clone%2A> method can be used to produce modifiable copies of frozen <xref:System.Windows.Freezable> objects. For convenience, this method shadows the inherited <xref:System.Windows.Freezable.Clone%2A> method to provide a strongly typed implementation.
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Effects.ShaderEffect" />
<altmember cref="M:System.Windows.Freezable.Clone" />
</Docs>
</Member>
<Member MemberName="CloneCurrentValue">
<MemberSignature Language="C#" Value="public System.Windows.Media.Effects.Effect CloneCurrentValue ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Media.Effects.Effect CloneCurrentValue() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Effects.Effect.CloneCurrentValue" />
<MemberSignature Language="VB.NET" Value="Public Function CloneCurrentValue () As Effect" />
<MemberSignature Language="F#" Value="override this.CloneCurrentValue : unit -> System.Windows.Media.Effects.Effect" Usage="effect.CloneCurrentValue " />
<MemberSignature Language="C++ CLI" Value="public:
 System::Windows::Media::Effects::Effect ^ CloneCurrentValue();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.Effects.Effect</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a modifiable clone of this <see cref="T:System.Windows.Media.Effects.Effect" /> 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.</summary>
<returns>A modifiable clone of the current object. The cloned object's <see cref="P:System.Windows.Freezable.IsFrozen" /> property will be <see langword="false" /> even if the source's <see cref="P:System.Windows.Freezable.IsFrozen" /> property was <see langword="true" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is used to produce modifiable copies of frozen <xref:System.Windows.Freezable> objects (or any <xref:System.Windows.Freezable> object). For convenience, this method shadows the inherited version with a strongly typed implementation.
For more information, see <xref:System.Windows.Freezable.CloneCurrentValue%2A?displayProperty=nameWithType>.
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Effects.ShaderEffect" />
</Docs>
</Member>
<Member MemberName="EffectMapping">
<MemberSignature Language="C#" Value="protected internal virtual System.Windows.Media.GeneralTransform EffectMapping { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Windows.Media.GeneralTransform EffectMapping" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Effects.Effect.EffectMapping" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overridable ReadOnly Property EffectMapping As GeneralTransform" />
<MemberSignature Language="F#" Value="member this.EffectMapping : System.Windows.Media.GeneralTransform" Usage="System.Windows.Media.Effects.Effect.EffectMapping" />
<MemberSignature Language="C++ CLI" Value="protected public:
 virtual property System::Windows::Media::GeneralTransform ^ EffectMapping { System::Windows::Media::GeneralTransform ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.GeneralTransform</ReturnType>
</ReturnValue>
<Docs>
<summary>When overridden in a derived class, transforms mouse input and coordinate systems through the effect.</summary>
<value>The transform to apply. The default is the identity transform.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Override the <xref:System.Windows.Media.Effects.Effect.EffectMapping%2A> property to assign a transform that differs from the default identity transform.
Input is transformed through the inverse of this transform. The <xref:System.Windows.Media.Visual.TransformToAncestor%2A> and <xref:System.Windows.Media.Visual.TransformToDescendant%2A> methods also have the <xref:System.Windows.Media.Effects.Effect.EffectMapping%2A> transform applied.
Incoming points must be in the [0-1] range, and outgoing points must map to the [0-1] range. The <xref:System.Windows.Media.GeneralTransform.Inverse%2A> property must return a <xref:System.Windows.Media.GeneralTransform> that computes the inverse mapping.
The inverse transform maps a point from after the effect is applied to the point that it came from before the effect. The non-inverse transform maps a point from before the effect is applied to after the effect is applied.
Note that the transform does not include information about the physical pixel size being used, and it just operates in the unit range.
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Effects.ShaderEffect" />
<altmember cref="T:System.Windows.Media.Effects.PixelShader" />
</Docs>
</Member>
<Member MemberName="ImplicitInput">
<MemberSignature Language="C#" Value="public static System.Windows.Media.Brush ImplicitInput { get; }" />
<MemberSignature Language="ILAsm" Value=".property class System.Windows.Media.Brush ImplicitInput" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Effects.Effect.ImplicitInput" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property ImplicitInput As Brush" />
<MemberSignature Language="F#" Value="static member ImplicitInput : System.Windows.Media.Brush" Usage="System.Windows.Media.Effects.Effect.ImplicitInput" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::Windows::Media::Brush ^ ImplicitInput { System::Windows::Media::Brush ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;windowsdesktop-3.0;windowsdesktop-3.1;windowsdesktop-5.0;windowsdesktop-6.0;windowsdesktop-7.0;windowsdesktop-8.0;windowsdesktop-9.0">
<AttributeName Language="C#">[System.ComponentModel.Browsable(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Browsable(false)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.Media.Brush</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see cref="T:System.Windows.Media.Brush" /> that, when it is used as an input for an <see cref="T:System.Windows.Media.Effects.Effect" />, causes the bitmap of the <see cref="T:System.Windows.UIElement" /> that the <see cref="T:System.Windows.Media.Effects.Effect" /> is applied to be that input.</summary>
<value>The <see cref="T:System.Windows.Media.Brush" /> that acts as the input.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Windows.Media.Effects.Effect.ImplicitInput%2A> property as the value to a Brush-valued input to a <xref:System.Windows.Media.Effects.ShaderEffect>.
The <xref:System.Windows.Media.Effects.Effect.ImplicitInput%2A> property represents the shader input that comes from the rendering of the <xref:System.Windows.UIElement> that the <xref:System.Windows.Media.Effects.Effect> is applied to.
> [!NOTE]
> The behavior is undefined when <xref:System.Windows.Media.Effects.Effect.ImplicitInput%2A> is used as a Brush in other WPF classes.
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Effects.ShaderEffect" />
<altmember cref="T:System.Windows.Media.Effects.PixelShader" />
</Docs>
</Member>
</Members>
</Type>