Skip to content

Commit 60e931e

Browse files
mattleibowmattleibow
committed
Blazor docs
1 parent 4b4b192 commit 60e931e

7 files changed

Lines changed: 152 additions & 146 deletions

File tree

‎SkiaSharpAPI/SkiaSharp.Views.Blazor.Internal/ActionHelper.xml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
</Attribute>
1919
</Attributes>
2020
<Docs>
21-
<summary>To be added.</summary>
22-
<remarks>To be added.</remarks>
21+
<summary>Internal helper class for JavaScript interop callbacks. This class is not intended for public use.</summary>
22+
<remarks>This class wraps an <see cref="T:System.Action" /> delegate to make it invokable from JavaScript.</remarks>
2323
</Docs>
2424
<Members>
2525
<Member MemberName=".ctor">
@@ -37,9 +37,9 @@
3737
<Parameter Name="action" Type="System.Action" />
3838
</Parameters>
3939
<Docs>
40-
<param name="action">To be added.</param>
41-
<summary>To be added.</summary>
42-
<remarks>To be added.</remarks>
40+
<param name="action">The action to wrap.</param>
41+
<summary>Initializes a new instance of the <see cref="T:SkiaSharp.Views.Blazor.Internal.ActionHelper" /> class.</summary>
42+
<remarks />
4343
</Docs>
4444
</Member>
4545
<Member MemberName="Invoke">
@@ -63,8 +63,8 @@
6363
</ReturnValue>
6464
<Parameters />
6565
<Docs>
66-
<summary>To be added.</summary>
67-
<remarks>To be added.</remarks>
66+
<summary>Invokes the wrapped action. Called from JavaScript.</summary>
67+
<remarks />
6868
</Docs>
6969
</Member>
7070
</Members>

‎SkiaSharpAPI/SkiaSharp.Views.Blazor.Internal/FloatFloatActionHelper.xml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
</Attribute>
1919
</Attributes>
2020
<Docs>
21-
<summary>To be added.</summary>
22-
<remarks>To be added.</remarks>
21+
<summary>Internal helper class for JavaScript interop callbacks with two float parameters. This class is not intended for public use.</summary>
22+
<remarks>This class wraps an <see cref="T:System.Action`2" /> delegate to make it invokable from JavaScript for size change notifications.</remarks>
2323
</Docs>
2424
<Members>
2525
<Member MemberName=".ctor">
@@ -37,9 +37,9 @@
3737
<Parameter Name="action" Type="System.Action&lt;System.Single,System.Single&gt;" />
3838
</Parameters>
3939
<Docs>
40-
<param name="action">To be added.</param>
41-
<summary>To be added.</summary>
42-
<remarks>To be added.</remarks>
40+
<param name="action">The action to wrap.</param>
41+
<summary>Initializes a new instance of the <see cref="T:SkiaSharp.Views.Blazor.Internal.FloatFloatActionHelper" /> class.</summary>
42+
<remarks />
4343
</Docs>
4444
</Member>
4545
<Member MemberName="Invoke">
@@ -66,10 +66,10 @@
6666
<Parameter Name="height" Type="System.Single" />
6767
</Parameters>
6868
<Docs>
69-
<param name="width">To be added.</param>
70-
<param name="height">To be added.</param>
71-
<summary>To be added.</summary>
72-
<remarks>To be added.</remarks>
69+
<param name="width">The width value.</param>
70+
<param name="height">The height value.</param>
71+
<summary>Invokes the wrapped action with the specified dimensions. Called from JavaScript.</summary>
72+
<remarks />
7373
</Docs>
7474
</Member>
7575
</Members>

‎SkiaSharpAPI/SkiaSharp.Views.Blazor/SKCanvasView.xml‎

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
</Attribute>
2323
</Attributes>
2424
<Docs>
25-
<summary>To be added.</summary>
26-
<remarks>To be added.</remarks>
25+
<summary>A Blazor component that provides a SkiaSharp drawing surface using software rendering.</summary>
26+
<remarks>This component renders to an HTML canvas element using WebAssembly. The drawing surface is CPU-based and renders each frame by transferring pixel data to the browser canvas. For GPU-accelerated rendering, use <see cref="T:SkiaSharp.Views.Blazor.SKGLView" /> instead.</remarks>
2727
</Docs>
2828
<Members>
2929
<Member MemberName=".ctor">
@@ -39,8 +39,8 @@
3939
</AssemblyInfo>
4040
<Parameters />
4141
<Docs>
42-
<summary>To be added.</summary>
43-
<remarks>To be added.</remarks>
42+
<summary>Initializes a new instance of the <see cref="T:SkiaSharp.Views.Blazor.SKCanvasView" /> class.</summary>
43+
<remarks />
4444
</Docs>
4545
</Member>
4646
<Member MemberName="AdditionalAttributes">
@@ -63,9 +63,9 @@
6363
<ReturnType>System.Collections.Generic.IReadOnlyDictionary&lt;System.String,System.Object&gt;</ReturnType>
6464
</ReturnValue>
6565
<Docs>
66-
<summary>To be added.</summary>
67-
<value>To be added.</value>
68-
<remarks>To be added.</remarks>
66+
<summary>Gets or sets additional HTML attributes to apply to the canvas element.</summary>
67+
<value>A dictionary of attribute names and values, or <see langword="null" />.</value>
68+
<remarks>Use this property to add CSS classes, styles, or other HTML attributes to the underlying canvas element.</remarks>
6969
</Docs>
7070
</Member>
7171
<Member MemberName="BuildRenderTree">
@@ -86,9 +86,9 @@
8686
<Parameter Name="__builder" Type="Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder" />
8787
</Parameters>
8888
<Docs>
89-
<param name="__builder">To be added.</param>
90-
<summary>To be added.</summary>
91-
<remarks>To be added.</remarks>
89+
<param name="__builder">The render tree builder.</param>
90+
<summary>Renders the component to the render tree.</summary>
91+
<remarks />
9292
</Docs>
9393
</Member>
9494
<Member MemberName="Dispose">
@@ -110,8 +110,8 @@
110110
</ReturnValue>
111111
<Parameters />
112112
<Docs>
113-
<summary>To be added.</summary>
114-
<remarks>To be added.</remarks>
113+
<summary>Releases all resources used by this component.</summary>
114+
<remarks>Call this method when the component is no longer needed to free the underlying pixel buffer and JavaScript interop resources.</remarks>
115115
</Docs>
116116
</Member>
117117
<Member MemberName="Dpi">
@@ -128,9 +128,9 @@
128128
<ReturnType>System.Double</ReturnType>
129129
</ReturnValue>
130130
<Docs>
131-
<summary>To be added.</summary>
132-
<value>To be added.</value>
133-
<remarks>To be added.</remarks>
131+
<summary>Gets the current device pixel ratio (DPI scaling factor).</summary>
132+
<value>The device pixel ratio, typically 1.0 for standard displays and 2.0 or higher for high-DPI displays.</value>
133+
<remarks>This value is automatically updated when the browser's DPI changes, such as when moving windows between monitors with different scaling.</remarks>
134134
</Docs>
135135
</Member>
136136
<Member MemberName="EnableRenderLoop">
@@ -153,9 +153,10 @@
153153
<ReturnType>System.Boolean</ReturnType>
154154
</ReturnValue>
155155
<Docs>
156-
<summary>To be added.</summary>
157-
<value>To be added.</value>
158-
<remarks>To be added.</remarks>
156+
<summary>Gets or sets a value indicating whether continuous rendering is enabled.</summary>
157+
<value>
158+
<see langword="true" /> to render continuously using requestAnimationFrame; <see langword="false" /> to render only when <see cref="M:SkiaSharp.Views.Blazor.SKCanvasView.Invalidate" /> is called.</value>
159+
<remarks>Enable this for animations that need to update every frame. Disable for static content to conserve resources.</remarks>
159160
</Docs>
160161
</Member>
161162
<Member MemberName="IgnorePixelScaling">
@@ -178,9 +179,10 @@
178179
<ReturnType>System.Boolean</ReturnType>
179180
</ReturnValue>
180181
<Docs>
181-
<summary>To be added.</summary>
182-
<value>To be added.</value>
183-
<remarks>To be added.</remarks>
182+
<summary>Gets or sets a value indicating whether the canvas should ignore the device pixel ratio.</summary>
183+
<value>
184+
<see langword="true" /> to use logical pixels matching the CSS size; <see langword="false" /> to use physical pixels scaled by the DPI.</value>
185+
<remarks>When <see langword="false" /> (the default), the canvas is scaled to match the physical pixel density, resulting in sharper rendering on high-DPI displays. When <see langword="true" />, drawing coordinates match the CSS pixel size.</remarks>
184186
</Docs>
185187
</Member>
186188
<Member MemberName="Invalidate">
@@ -199,8 +201,8 @@
199201
</ReturnValue>
200202
<Parameters />
201203
<Docs>
202-
<summary>To be added.</summary>
203-
<remarks>To be added.</remarks>
204+
<summary>Requests a redraw of the canvas.</summary>
205+
<remarks>This method schedules a repaint using the browser's requestAnimationFrame API. The <see cref="P:SkiaSharp.Views.Blazor.SKCanvasView.OnPaintSurface" /> callback will be invoked on the next animation frame.</remarks>
204206
</Docs>
205207
</Member>
206208
<Member MemberName="OnAfterRenderAsync">
@@ -221,10 +223,11 @@
221223
<Parameter Name="firstRender" Type="System.Boolean" />
222224
</Parameters>
223225
<Docs>
224-
<param name="firstRender">To be added.</param>
225-
<summary>To be added.</summary>
226-
<returns>To be added.</returns>
227-
<remarks>To be added.</remarks>
226+
<param name="firstRender">
227+
<see langword="true" /> if this is the first time the component has been rendered; otherwise, <see langword="false" />.</param>
228+
<summary>Called after the component has rendered.</summary>
229+
<returns>A task representing the asynchronous operation.</returns>
230+
<remarks>On first render, this method initializes the JavaScript interop for the HTML canvas and sets up DPI and size change watchers.</remarks>
228231
</Docs>
229232
</Member>
230233
<Member MemberName="OnPaintSurface">
@@ -247,9 +250,9 @@
247250
<ReturnType>System.Action&lt;SkiaSharp.Views.Blazor.SKPaintSurfaceEventArgs&gt;</ReturnType>
248251
</ReturnValue>
249252
<Docs>
250-
<summary>To be added.</summary>
251-
<value>To be added.</value>
252-
<remarks>To be added.</remarks>
253+
<summary>Gets or sets the callback invoked when the canvas needs to be painted.</summary>
254+
<value>An action that receives <see cref="T:SkiaSharp.Views.Blazor.SKPaintSurfaceEventArgs" /> containing the surface and canvas information.</value>
255+
<remarks>Use this callback to perform your drawing operations. The callback is invoked when <see cref="M:SkiaSharp.Views.Blazor.SKCanvasView.Invalidate" /> is called or continuously when <see cref="P:SkiaSharp.Views.Blazor.SKCanvasView.EnableRenderLoop" /> is <see langword="true" />.</remarks>
253256
</Docs>
254257
</Member>
255258
</Members>

‎SkiaSharpAPI/SkiaSharp.Views.Blazor/SKGLView.xml‎

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
</Attribute>
2323
</Attributes>
2424
<Docs>
25-
<summary>To be added.</summary>
26-
<remarks>To be added.</remarks>
25+
<summary>A Blazor component that provides a GPU-accelerated SkiaSharp drawing surface using WebGL.</summary>
26+
<remarks>This component renders to an HTML canvas element using WebGL for hardware-accelerated graphics. It provides better performance than <see cref="T:SkiaSharp.Views.Blazor.SKCanvasView" /> for complex scenes and animations, but requires WebGL support in the browser.</remarks>
2727
</Docs>
2828
<Members>
2929
<Member MemberName=".ctor">
@@ -39,8 +39,8 @@
3939
</AssemblyInfo>
4040
<Parameters />
4141
<Docs>
42-
<summary>To be added.</summary>
43-
<remarks>To be added.</remarks>
42+
<summary>Initializes a new instance of the <see cref="T:SkiaSharp.Views.Blazor.SKGLView" /> class.</summary>
43+
<remarks />
4444
</Docs>
4545
</Member>
4646
<Member MemberName="AdditionalAttributes">
@@ -63,9 +63,9 @@
6363
<ReturnType>System.Collections.Generic.IReadOnlyDictionary&lt;System.String,System.Object&gt;</ReturnType>
6464
</ReturnValue>
6565
<Docs>
66-
<summary>To be added.</summary>
67-
<value>To be added.</value>
68-
<remarks>To be added.</remarks>
66+
<summary>Gets or sets additional HTML attributes to apply to the canvas element.</summary>
67+
<value>A dictionary of attribute names and values, or <see langword="null" />.</value>
68+
<remarks>Use this property to add CSS classes, styles, or other HTML attributes to the underlying canvas element.</remarks>
6969
</Docs>
7070
</Member>
7171
<Member MemberName="BuildRenderTree">
@@ -86,9 +86,9 @@
8686
<Parameter Name="__builder" Type="Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder" />
8787
</Parameters>
8888
<Docs>
89-
<param name="__builder">To be added.</param>
90-
<summary>To be added.</summary>
91-
<remarks>To be added.</remarks>
89+
<param name="__builder">The render tree builder.</param>
90+
<summary>Renders the component to the render tree.</summary>
91+
<remarks />
9292
</Docs>
9393
</Member>
9494
<Member MemberName="Dispose">
@@ -110,8 +110,8 @@
110110
</ReturnValue>
111111
<Parameters />
112112
<Docs>
113-
<summary>To be added.</summary>
114-
<remarks>To be added.</remarks>
113+
<summary>Releases all resources used by this component.</summary>
114+
<remarks>Call this method when the component is no longer needed to free the GPU context, surface, and JavaScript interop resources.</remarks>
115115
</Docs>
116116
</Member>
117117
<Member MemberName="Dpi">
@@ -128,9 +128,9 @@
128128
<ReturnType>System.Double</ReturnType>
129129
</ReturnValue>
130130
<Docs>
131-
<summary>To be added.</summary>
132-
<value>To be added.</value>
133-
<remarks>To be added.</remarks>
131+
<summary>Gets the current device pixel ratio (DPI scaling factor).</summary>
132+
<value>The device pixel ratio, typically 1.0 for standard displays and 2.0 or higher for high-DPI displays.</value>
133+
<remarks>This value is automatically updated when the browser's DPI changes, such as when moving windows between monitors with different scaling.</remarks>
134134
</Docs>
135135
</Member>
136136
<Member MemberName="EnableRenderLoop">
@@ -153,9 +153,10 @@
153153
<ReturnType>System.Boolean</ReturnType>
154154
</ReturnValue>
155155
<Docs>
156-
<summary>To be added.</summary>
157-
<value>To be added.</value>
158-
<remarks>To be added.</remarks>
156+
<summary>Gets or sets a value indicating whether continuous rendering is enabled.</summary>
157+
<value>
158+
<see langword="true" /> to render continuously using requestAnimationFrame; <see langword="false" /> to render only when <see cref="M:SkiaSharp.Views.Blazor.SKGLView.Invalidate" /> is called.</value>
159+
<remarks>Enable this for animations that need to update every frame. Disable for static content to conserve GPU resources and battery.</remarks>
159160
</Docs>
160161
</Member>
161162
<Member MemberName="IgnorePixelScaling">
@@ -178,9 +179,10 @@
178179
<ReturnType>System.Boolean</ReturnType>
179180
</ReturnValue>
180181
<Docs>
181-
<summary>To be added.</summary>
182-
<value>To be added.</value>
183-
<remarks>To be added.</remarks>
182+
<summary>Gets or sets a value indicating whether the canvas should ignore the device pixel ratio.</summary>
183+
<value>
184+
<see langword="true" /> to use logical pixels matching the CSS size; <see langword="false" /> to use physical pixels scaled by the DPI.</value>
185+
<remarks>When <see langword="false" /> (the default), the canvas is scaled to match the physical pixel density, resulting in sharper rendering on high-DPI displays. When <see langword="true" />, drawing coordinates match the CSS pixel size.</remarks>
184186
</Docs>
185187
</Member>
186188
<Member MemberName="Invalidate">
@@ -199,8 +201,8 @@
199201
</ReturnValue>
200202
<Parameters />
201203
<Docs>
202-
<summary>To be added.</summary>
203-
<remarks>To be added.</remarks>
204+
<summary>Requests a redraw of the canvas.</summary>
205+
<remarks>This method schedules a repaint using the browser's requestAnimationFrame API. The <see cref="P:SkiaSharp.Views.Blazor.SKGLView.OnPaintSurface" /> callback will be invoked on the next animation frame.</remarks>
204206
</Docs>
205207
</Member>
206208
<Member MemberName="OnAfterRenderAsync">
@@ -221,10 +223,11 @@
221223
<Parameter Name="firstRender" Type="System.Boolean" />
222224
</Parameters>
223225
<Docs>
224-
<param name="firstRender">To be added.</param>
225-
<summary>To be added.</summary>
226-
<returns>To be added.</returns>
227-
<remarks>To be added.</remarks>
226+
<param name="firstRender">
227+
<see langword="true" /> if this is the first time the component has been rendered; otherwise, <see langword="false" />.</param>
228+
<summary>Called after the component has rendered.</summary>
229+
<returns>A task representing the asynchronous operation.</returns>
230+
<remarks>On first render, this method initializes the WebGL context, creates the GPU context and surface, and sets up DPI and size change watchers.</remarks>
228231
</Docs>
229232
</Member>
230233
<Member MemberName="OnPaintSurface">
@@ -247,9 +250,9 @@
247250
<ReturnType>System.Action&lt;SkiaSharp.Views.Blazor.SKPaintGLSurfaceEventArgs&gt;</ReturnType>
248251
</ReturnValue>
249252
<Docs>
250-
<summary>To be added.</summary>
251-
<value>To be added.</value>
252-
<remarks>To be added.</remarks>
253+
<summary>Gets or sets the callback invoked when the canvas needs to be painted.</summary>
254+
<value>An action that receives <see cref="T:SkiaSharp.Views.Blazor.SKPaintGLSurfaceEventArgs" /> containing the surface, canvas, and GPU context information.</value>
255+
<remarks>Use this callback to perform your drawing operations. The callback is invoked when <see cref="M:SkiaSharp.Views.Blazor.SKGLView.Invalidate" /> is called or continuously when <see cref="P:SkiaSharp.Views.Blazor.SKGLView.EnableRenderLoop" /> is <see langword="true" />.</remarks>
253256
</Docs>
254257
</Member>
255258
</Members>

0 commit comments

Comments
 (0)