-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
RenderTargetBitmap.xml
290 lines (287 loc) · 17.7 KB
/
RenderTargetBitmap.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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
<Type Name="RenderTargetBitmap" FullName="System.Windows.Media.Imaging.RenderTargetBitmap">
<TypeSignature Language="C#" Value="public sealed class RenderTargetBitmap : System.Windows.Media.Imaging.BitmapSource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RenderTargetBitmap extends System.Windows.Media.Imaging.BitmapSource" />
<TypeSignature Language="DocId" Value="T:System.Windows.Media.Imaging.RenderTargetBitmap" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class RenderTargetBitmap
Inherits BitmapSource" />
<TypeSignature Language="F#" Value="type RenderTargetBitmap = class
 inherit BitmapSource" />
<TypeSignature Language="C++ CLI" Value="public ref class RenderTargetBitmap sealed : System::Windows::Media::Imaging::BitmapSource" />
<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.Imaging.BitmapSource</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Converts a <see cref="T:System.Windows.Media.Visual" /> object into a bitmap.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to use <xref:System.Windows.Media.Imaging.RenderTargetBitmap> to render text as an image.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Media/PixelFormat/Overview/RenderTargetBitmapExample.cs" id="Snippetrendertargetbitmapcodeexamplewholepage":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/ImagingSnippetGallery_procedural_snip/VB/RenderTargetBitmapExample.vb" id="Snippetrendertargetbitmapcodeexamplewholepage":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RenderTargetBitmap (int pixelWidth, int pixelHeight, double dpiX, double dpiY, System.Windows.Media.PixelFormat pixelFormat);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 pixelWidth, int32 pixelHeight, float64 dpiX, float64 dpiY, valuetype System.Windows.Media.PixelFormat pixelFormat) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.RenderTargetBitmap.#ctor(System.Int32,System.Int32,System.Double,System.Double,System.Windows.Media.PixelFormat)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (pixelWidth As Integer, pixelHeight As Integer, dpiX As Double, dpiY As Double, pixelFormat As PixelFormat)" />
<MemberSignature Language="F#" Value="new System.Windows.Media.Imaging.RenderTargetBitmap : int * int * double * double * System.Windows.Media.PixelFormat -> System.Windows.Media.Imaging.RenderTargetBitmap" Usage="new System.Windows.Media.Imaging.RenderTargetBitmap (pixelWidth, pixelHeight, dpiX, dpiY, pixelFormat)" />
<MemberSignature Language="C++ CLI" Value="public:
 RenderTargetBitmap(int pixelWidth, int pixelHeight, double dpiX, double dpiY, System::Windows::Media::PixelFormat pixelFormat);" />
<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-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">
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="pixelWidth" Type="System.Int32" />
<Parameter Name="pixelHeight" Type="System.Int32" />
<Parameter Name="dpiX" Type="System.Double" />
<Parameter Name="dpiY" Type="System.Double" />
<Parameter Name="pixelFormat" Type="System.Windows.Media.PixelFormat" />
</Parameters>
<Docs>
<param name="pixelWidth">The width of the bitmap.</param>
<param name="pixelHeight">The height of the bitmap.</param>
<param name="dpiX">The horizontal DPI of the bitmap.</param>
<param name="dpiY">The vertical DPI of the bitmap.</param>
<param name="pixelFormat">The format of the bitmap.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Imaging.RenderTargetBitmap" /> class that has the specified parameters.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Clear">
<MemberSignature Language="C#" Value="public void Clear ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Clear() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.RenderTargetBitmap.Clear" />
<MemberSignature Language="VB.NET" Value="Public Sub Clear ()" />
<MemberSignature Language="F#" Value="member this.Clear : unit -> unit" Usage="renderTargetBitmap.Clear " />
<MemberSignature Language="C++ CLI" Value="public:
 void Clear();" />
<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>
<Attributes>
<Attribute 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">
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Clears the render target and sets all pixels to transparent black.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CloneCore">
<MemberSignature Language="C#" Value="protected override void CloneCore (System.Windows.Freezable sourceFreezable);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void CloneCore(class System.Windows.Freezable sourceFreezable) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.RenderTargetBitmap.CloneCore(System.Windows.Freezable)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub CloneCore (sourceFreezable As Freezable)" />
<MemberSignature Language="F#" Value="override this.CloneCore : System.Windows.Freezable -> unit" Usage="renderTargetBitmap.CloneCore sourceFreezable" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void CloneCore(System::Windows::Freezable ^ sourceFreezable);" />
<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.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceFreezable" Type="System.Windows.Freezable" />
</Parameters>
<Docs>
<param name="sourceFreezable">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CloneCurrentValueCore">
<MemberSignature Language="C#" Value="protected override void CloneCurrentValueCore (System.Windows.Freezable sourceFreezable);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void CloneCurrentValueCore(class System.Windows.Freezable sourceFreezable) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.RenderTargetBitmap.CloneCurrentValueCore(System.Windows.Freezable)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub CloneCurrentValueCore (sourceFreezable As Freezable)" />
<MemberSignature Language="F#" Value="override this.CloneCurrentValueCore : System.Windows.Freezable -> unit" Usage="renderTargetBitmap.CloneCurrentValueCore sourceFreezable" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void CloneCurrentValueCore(System::Windows::Freezable ^ sourceFreezable);" />
<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.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceFreezable" Type="System.Windows.Freezable" />
</Parameters>
<Docs>
<param name="sourceFreezable">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateInstanceCore">
<MemberSignature Language="C#" Value="protected override System.Windows.Freezable CreateInstanceCore ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.Windows.Freezable CreateInstanceCore() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.RenderTargetBitmap.CreateInstanceCore" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function CreateInstanceCore () As Freezable" />
<MemberSignature Language="F#" Value="override this.CreateInstanceCore : unit -> System.Windows.Freezable" Usage="renderTargetBitmap.CreateInstanceCore " />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::Windows::Freezable ^ CreateInstanceCore();" />
<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.Freezable</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAsFrozenCore">
<MemberSignature Language="C#" Value="protected override void GetAsFrozenCore (System.Windows.Freezable sourceFreezable);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void GetAsFrozenCore(class System.Windows.Freezable sourceFreezable) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.RenderTargetBitmap.GetAsFrozenCore(System.Windows.Freezable)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub GetAsFrozenCore (sourceFreezable As Freezable)" />
<MemberSignature Language="F#" Value="override this.GetAsFrozenCore : System.Windows.Freezable -> unit" Usage="renderTargetBitmap.GetAsFrozenCore sourceFreezable" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void GetAsFrozenCore(System::Windows::Freezable ^ sourceFreezable);" />
<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.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceFreezable" Type="System.Windows.Freezable" />
</Parameters>
<Docs>
<param name="sourceFreezable">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetCurrentValueAsFrozenCore">
<MemberSignature Language="C#" Value="protected override void GetCurrentValueAsFrozenCore (System.Windows.Freezable sourceFreezable);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void GetCurrentValueAsFrozenCore(class System.Windows.Freezable sourceFreezable) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.RenderTargetBitmap.GetCurrentValueAsFrozenCore(System.Windows.Freezable)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub GetCurrentValueAsFrozenCore (sourceFreezable As Freezable)" />
<MemberSignature Language="F#" Value="override this.GetCurrentValueAsFrozenCore : System.Windows.Freezable -> unit" Usage="renderTargetBitmap.GetCurrentValueAsFrozenCore sourceFreezable" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void GetCurrentValueAsFrozenCore(System::Windows::Freezable ^ sourceFreezable);" />
<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.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceFreezable" Type="System.Windows.Freezable" />
</Parameters>
<Docs>
<param name="sourceFreezable">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Render">
<MemberSignature Language="C#" Value="public void Render (System.Windows.Media.Visual visual);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Render(class System.Windows.Media.Visual visual) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.RenderTargetBitmap.Render(System.Windows.Media.Visual)" />
<MemberSignature Language="VB.NET" Value="Public Sub Render (visual As Visual)" />
<MemberSignature Language="F#" Value="member this.Render : System.Windows.Media.Visual -> unit" Usage="renderTargetBitmap.Render visual" />
<MemberSignature Language="C++ CLI" Value="public:
 void Render(System::Windows::Media::Visual ^ visual);" />
<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.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="visual" Type="System.Windows.Media.Visual" />
</Parameters>
<Docs>
<param name="visual">The <see cref="T:System.Windows.Media.Visual" /> object to be used as a bitmap.</param>
<summary>Renders the <see cref="T:System.Windows.Media.Visual" /> object.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>