wieslawsoltes
/
SkiaSharp
зеркало из
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Docs

This commit is contained in:
Matthew Leibowitz 2016-10-21 16:43:43 +02:00
Родитель 983ed403b3
Коммит 73360d8eac
8 изменённых файлов: 163 добавлений и 59 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

2
docs/en/SkiaSharp.Views.Desktop/Extensions.xml
Просмотреть файл

@ -12,7 +12,7 @@
<Docs>
<summary>Various extension methods to convert between SkiaSharp types and System.Drawing types.</summary>
<remarks>
<para />
<para></para>
</remarks>
</Docs>
<Members>

64
docs/en/SkiaSharp.Views.Desktop/SKControl.xml
Просмотреть файл

@ -10,8 +10,10 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>A control that can be drawn on using SkiaSharp drawing commands.</summary>
<remarks>
<para></para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
@ -23,8 +25,10 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Creates a new instance of the <see cref="T:SkiaSharp.Views.Desktop.SKControl" /> view.</summary>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
@ -60,9 +64,11 @@
<Parameter Name="e" Type="System.Windows.Forms.PaintEventArgs" />
</Parameters>
<Docs>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="e">A PaintEventArgs that contains the event data.</param>
<summary>Raises the Paint event.</summary>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
<Member MemberName="OnPaintSurface">
@ -79,9 +85,27 @@
<Parameter Name="e" Type="SkiaSharp.Views.Desktop.SKPaintSurfaceEventArgs" />
</Parameters>
<Docs>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="e">The event arguments that contain the drawing surface and information.</param>
<summary>Implement this to draw on the canvas.</summary>
<remarks>
<para>There are two ways to draw on this surface: by overriding the <see cref="M:SkiaSharp.Views.Desktop.SKControl.OnPaintSurface" /> method, or by attaching a handler to the  <see cref="E:SkiaSharp.Views.Desktop.SKControl.PaintSurface" /> event. If the method is overriden, then the base must be called.</para>
<para></para>
<example>
<code lang="C#"><![CDATA[protected override void OnPaintSurface (SKPaintSurfaceEventArgs e)
{
// call the base method
base.OnPaintSurface (e);
var surface = e.Surface;
var surfaceWidth = e.Info.Width;
var surfaceHeight = e.Info.Height;
var canvas = surface.Canvas;
// draw on the canvas
canvas.Flush ();
}]]></code>
</example>
</remarks>
</Docs>
</Member>
<Member MemberName="PaintSurface">
@ -95,8 +119,24 @@
<ReturnType>System.EventHandler&lt;SkiaSharp.Views.Desktop.SKPaintSurfaceEventArgs&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Occurs when the the canvas needs to be re-drawn.</summary>
<remarks>
<para>There are two ways to draw on this surface: by overriding the <see cref="M:SkiaSharp.Views.Desktop.SKControl.OnPaintSurface" /> method, or by attaching a handler to the  <see cref="E:SkiaSharp.Views.Desktop.SKControl.PaintSurface" /> event.</para>
<para></para>
<example>
<code lang="C#"><![CDATA[SKControl myView = ...;
myView.PaintSurface += (sender, e) => {
var surface = e.Surface;
var surfaceWidth = e.Info.Width;
var surfaceHeight = e.Info.Height;
var canvas = surface.Canvas;
// draw on the canvas
canvas.Flush ();
};]]></code>
</example>
</remarks>
</Docs>
</Member>
</Members>

64
docs/en/SkiaSharp.Views.Desktop/SKGLControl.xml
Просмотреть файл

@ -10,8 +10,10 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>A hardware-accelerated control that can be drawn on using SkiaSharp drawing commands.</summary>
<remarks>
<para></para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
@ -23,8 +25,10 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Creates a new instance of the <see cref="T:SkiaSharp.Views.Desktop.SKGLControl" /> view.</summary>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
@ -60,9 +64,11 @@
<Parameter Name="e" Type="System.Windows.Forms.PaintEventArgs" />
</Parameters>
<Docs>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="e">A PaintEventArgs that contains the event data.</param>
<summary>Raises the Paint event.</summary>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
<Member MemberName="OnPaintSurface">
@ -79,9 +85,27 @@
<Parameter Name="e" Type="SkiaSharp.Views.Desktop.SKPaintGLSurfaceEventArgs" />
</Parameters>
<Docs>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="e">The event arguments that contain the drawing surface and information.</param>
<summary>Implement this to draw on the canvas.</summary>
<remarks>
<para>There are two ways to draw on this surface: by overriding the <see cref="M:SkiaSharp.Views.Desktop.SKGLControl.OnPaintSurface" /> method, or by attaching a handler to the <see cref="E:SkiaSharp.Views.Desktop.SKGLControl.PaintSurface" /> event. If the method is overriden, then the base must be called.</para>
<para></para>
<example>
<code lang="C#"><![CDATA[protected override void OnPaintSurface (SKPaintGLSurfaceEventArgs e)
{
// call the base method
base.OnPaintSurface (e);
var surface = e.Surface;
var surfaceWidth = e.RenderTarget.Width;
var surfaceHeight = e.RenderTarget.Height;
var canvas = surface.Canvas;
// draw on the canvas
canvas.Flush ();
}]]></code>
</example>
</remarks>
</Docs>
</Member>
<Member MemberName="PaintSurface">
@ -95,8 +119,24 @@
<ReturnType>System.EventHandler&lt;SkiaSharp.Views.Desktop.SKPaintGLSurfaceEventArgs&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Occurs when the surface needs to be re-drawn.</summary>
<remarks>
<para>There are two ways to draw on this surface: by overriding the <see cref="M:SkiaSharp.Views.Desktop.SKGLControl.OnPaintSurface" /> method, or by attaching a handler to the <see cref="E:SkiaSharp.Views.Desktop.SKGLControl.PaintSurface" /> event.</para>
<para></para>
<example>
<code lang="C#"><![CDATA[SKGLControl myView = ...;
myView.PaintSurface += (sender, e) => {
var surface = e.Surface;
var surfaceWidth = e.RenderTarget.Width;
var surfaceHeight = e.RenderTarget.Height;
var canvas = surface.Canvas;
// draw on the canvas
canvas.Flush ();
};]]></code>
</example>
</remarks>
</Docs>
</Member>
</Members>

36
docs/en/SkiaSharp.Views.Desktop/SKPaintGLSurfaceEventArgs.xml
Просмотреть файл

@ -10,8 +10,10 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Provides data for the <see cref="E:SkiaSharp.Views.Desktop.SKGLControl.PaintSurface" /> event.</summary>
<remarks>
<para></para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
@ -26,10 +28,12 @@
<Parameter Name="renderTarget" Type="SkiaSharp.GRBackendRenderTargetDesc" />
</Parameters>
<Docs>
<param name="surface">To be added.</param>
<param name="renderTarget">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="surface">The surface that is being drawn on.</param>
<param name="renderTarget">The render target that is currently being drawn.</param>
<summary>Creates a new instance of the <see cref="T:SkiaSharp.Views.Desktop.SKPaintGLSurfaceEventArgs" /> event arguments.</summary>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
<Member MemberName="RenderTarget">
@ -43,9 +47,13 @@
<ReturnType>SkiaSharp.GRBackendRenderTargetDesc</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the render target that is currently being drawn.</summary>
<value>
<para></para>
</value>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Surface">
@ -59,9 +67,13 @@
<ReturnType>SkiaSharp.SKSurface</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the surface that is currently being drawn on.</summary>
<value>
<para></para>
</value>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
</Members>

36
docs/en/SkiaSharp.Views.Desktop/SKPaintSurfaceEventArgs.xml
Просмотреть файл

@ -10,8 +10,10 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Provides data for the <see cref="E:SkiaSharp.Views.Desktop.SKControl.PaintSurface" /> event.</summary>
<remarks>
<para></para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
@ -26,10 +28,12 @@
<Parameter Name="info" Type="SkiaSharp.SKImageInfo" />
</Parameters>
<Docs>
<param name="surface">To be added.</param>
<param name="info">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="surface">The surface that is being drawn on.</param>
<param name="info">The information about the surface.</param>
<summary>Creates a new instance of the <see cref="T:SkiaSharp.Views.Desktop.SKPaintSurfaceEventArgs" /> event arguments.</summary>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Info">
@ -43,9 +47,13 @@
<ReturnType>SkiaSharp.SKImageInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the information about the surface that is currently being drawn.</summary>
<value>
<para></para>
</value>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Surface">
@ -59,9 +67,13 @@
<ReturnType>SkiaSharp.SKSurface</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the surface that is currently being drawn on.</summary>
<value>
<para></para>
</value>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
</Members>

4
docs/en/SkiaSharp.Views.Forms/SKCanvasView.xml
Просмотреть файл

@ -78,8 +78,8 @@
base.OnPaintSurface (e);
var surface = e.Surface;
var surfaceWidth = e.RenderTarget.Width;
var surfaceHeight = e.RenderTarget.Height;
var surfaceWidth = e.Info.Width;
var surfaceHeight = e.Info.Height;
var canvas = surface.Canvas;
// draw on the canvas

2
docs/en/SkiaSharp.Views.Forms/SKGLView.xml
Просмотреть файл

@ -138,7 +138,7 @@
<ReturnType>System.EventHandler&lt;SkiaSharp.Views.Forms.SKPaintGLSurfaceEventArgs&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the the surface needs to be re-drawn.</summary>
<summary>Occurs when the surface needs to be re-drawn.</summary>
<remarks>
<para>There are two ways to draw on this surface: by overriding the <see cref="M:SkiaSharp.Views.Forms.SKGLView.OnPaintSurface" /> method, or by attaching a handler to the <see cref="E:SkiaSharp.Views.Forms.SKGLView.PaintSurface" /> event.</para>
<para></para>

14
docs/en/SkiaSharp/SKAutoCanvasRestore.xml
Просмотреть файл

@ -23,9 +23,9 @@
<summary>Convenience class used to restore the canvas state in a using statement.</summary>
<remarks>
<para>This class can be used in a using statement to save the state of the canvas (matrix, clip and draw filter) allowing you to change these components and have them automatically undone by virtue of having the <see cref="M:SkiaSharp.SKAutoCanvasRestore.Dispose" /> method restore the canvas state to the state it was when this instance was created.</para>
<para></para>
<example>
<code lang="C#"><![CDATA[SKCanvas canvas = ...;
<para></para>
<example>
<code lang="C#"><![CDATA[SKCanvas canvas = ...;
using (new SKAutoCanvasRestore(canvas, true)) {
// perform some transform
@ -37,8 +37,8 @@ using (new SKAutoCanvasRestore(canvas, true)) {
// automatically restore to original transform
}]]></code>
</example>
<para></para>
</example>
<para></para>
</remarks>
</Docs>
<Members>
@ -62,7 +62,7 @@ using (new SKAutoCanvasRestore(canvas, true)) {
<Docs>
<param name="canvas">The canvas whose state will be preserved</param>
<param name="doSave">Determines whether you want the <see cref="M:SkiaSharp.SKCanvas.Save" /> method to be invoked on your behalf at this point.</param>
<summary>Creates a canvas restore point</summary>
<summary>Creates a canvas restore point.</summary>
<remarks>
<para></para>
</remarks>
@ -86,7 +86,7 @@ using (new SKAutoCanvasRestore(canvas, true)) {
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the canvas restore point, restoring the state of the canvas (matrix, clip and draw filter) to the state it was when the object was creatd.  This operation will not do anything if you had previously manually called the <see cref="M:SkiaSharp.SKAutoCanvasRestore.Restore" /> method.</summary>
<summary>Disposes the canvas restore point, restoring the state of the canvas (matrix, clip and draw filter) to the state it was when the object was created.  This operation will not do anything if you had previously manually called the <see cref="M:SkiaSharp.SKAutoCanvasRestore.Restore" /> method.</summary>
<remarks>
<para></para>
</remarks>