/
SKPictureRecorder.xml
197 lines (194 loc) · 9.38 KB
/
SKPictureRecorder.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
<Type Name="SKPictureRecorder" FullName="SkiaSharp.SKPictureRecorder">
<TypeSignature Language="C#" Value="public class SKPictureRecorder : SkiaSharp.SKObject" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SKPictureRecorder extends SkiaSharp.SKObject" />
<TypeSignature Language="DocId" Value="T:SkiaSharp.SKPictureRecorder" />
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>SkiaSharp.SKObject</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>The picture recorder is used to record drawing operations made to a <see cref="T:SkiaSharp.SKCanvas" /> and stored in a <see cref="T:SkiaSharp.SKPicture" />.</summary>
<remarks></remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SKPictureRecorder ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPictureRecorder.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Creates a new instance of the <see cref="T:SkiaSharp.SKPictureRecorder" />.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BeginRecording">
<MemberSignature Language="C#" Value="public SkiaSharp.SKCanvas BeginRecording (SkiaSharp.SKRect cullRect);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class SkiaSharp.SKCanvas BeginRecording(valuetype SkiaSharp.SKRect cullRect) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPictureRecorder.BeginRecording(SkiaSharp.SKRect)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKCanvas</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cullRect" Type="SkiaSharp.SKRect" />
</Parameters>
<Docs>
<param name="cullRect">The culling rectangle for the new picture.</param>
<summary>Start the recording process and return the recording canvas.</summary>
<returns>Returns the current recording canvas. The same can be retrieved using <see cref="P:SkiaSharp.SKPictureRecorder.RecordingCanvas" />.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPictureRecorder.Dispose(System.Boolean)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPictureRecorder" /> and optionally releases the managed resources.</summary>
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPictureRecorder" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
</Docs>
</Member>
<Member MemberName="DisposeNative">
<MemberSignature Language="C#" Value="protected override void DisposeNative ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void DisposeNative() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPictureRecorder.DisposeNative" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="EndRecording">
<MemberSignature Language="C#" Value="public SkiaSharp.SKPicture EndRecording ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class SkiaSharp.SKPicture EndRecording() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPictureRecorder.EndRecording" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKPicture</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Signal that the caller is done recording.</summary>
<returns>Returns the <see cref="T:SkiaSharp.SKPicture" /> containing the recorded content.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This invalidates the canvas returned by
<xref:SkiaSharp.SKPictureRecorder.BeginRecording%2A> and
<xref:SkiaSharp.SKPictureRecorder.RecordingCanvas>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="EndRecordingAsDrawable">
<MemberSignature Language="C#" Value="public SkiaSharp.SKDrawable EndRecordingAsDrawable ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class SkiaSharp.SKDrawable EndRecordingAsDrawable() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPictureRecorder.EndRecordingAsDrawable" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKDrawable</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Signal that the caller is done recording.</summary>
<returns>Returns the <see cref="T:SkiaSharp.SKDrawable" /> containing the recorded content.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This invalidates the canvas returned by
<xref:SkiaSharp.SKPictureRecorder.BeginRecording%2A> and
<xref:SkiaSharp.SKPictureRecorder.RecordingCanvas>.
Unlike <xref:SkiaSharp.SKPictureRecorder.EndRecording%2A>, which returns an
immutable picture, the returned drawable may contain live references to other
drawables (if they were added to the recording canvas) and therefore this
drawable will reflect the current state of those nested drawables anytime it
is drawn or a new picture is snapped from it (by calling
<xref:SkiaSharp.SKDrawable.Snapshot%2A>).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="RecordingCanvas">
<MemberSignature Language="C#" Value="public SkiaSharp.SKCanvas RecordingCanvas { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class SkiaSharp.SKCanvas RecordingCanvas" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.SKPictureRecorder.RecordingCanvas" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKCanvas</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current recording canvas.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>