tizen

Author: mattleibow

source/SkiaSharp.Views.Maui/SkiaSharp.Views.Maui.Controls/SKImageSource.cs

@@ -6,7 +6,7 @@
 namespace SkiaSharp.Views.Maui.Controls
 {
 /// <summary>
-/// Represents a <see cref="T:SkiaSharp.SKImage" /> image source.
+/// Represents a <see cref="SKImage" /> image source.
 /// </summary>
 public sealed partial class SKImageImageSource : ImageSource, ISKImageImageSource
 {
@@ -16,7 +16,7 @@ public sealed partial class SKImageImageSource : ImageSource, ISKImageImageSourc
 public static readonly BindableProperty ImageProperty = BindableProperty.Create(nameof(Image), typeof(SKImage), typeof(SKImageImageSource), default(SKImage));
 
 /// <summary>
-/// Gets or sets the underlying <see cref="T:SkiaSharp.SKImage" /> of the image source.
+/// Gets or sets the underlying <see cref="SKImage" /> of the image source.
 /// </summary>
 public SKImage Image
 {
@@ -34,7 +34,7 @@ public override Task<bool> Cancel()
 }
 
 /// <summary>
-/// Allows implicit casting from a <see cref="T:SkiaSharp.SKImage" />.
+/// Allows implicit casting from a <see cref="SKImage" />.
 /// </summary>
 /// <param name="image">The image to use when creating the ImageSource.</param>
 /// <returns>Returns a new instance of <see cref="SKImageImageSource" /> with the <see cref="SKImageImageSource.Image" /> property set to the image.</returns>
@@ -47,10 +47,10 @@ public static implicit operator SKImageImageSource(SKImage image)
 }
 
 /// <summary>
-/// Allows implicit casting to a <see cref="T:SkiaSharp.SKImage" />.
+/// Allows implicit casting to a <see cref="SKImage" />.
 /// </summary>
 /// <param name="source">The ImageSource to retrieve the image from.</param>
-/// <returns>Returns the underlying <see cref="T:SkiaSharp.SKImage" /> of the ImageSource.</returns>
+/// <returns>Returns the underlying <see cref="SKImage" /> of the ImageSource.</returns>
 public static implicit operator SKImage(SKImageImageSource source)
 {
 return source?.Image;
@@ -65,7 +65,7 @@ protected override void OnPropertyChanged(string propertyName = null)
 }
 
 /// <summary>
-/// Represents a <see cref="T:SkiaSharp.SKBitmap" /> image source.
+/// Represents a <see cref="SKBitmap" /> image source.
 /// </summary>
 public sealed partial class SKBitmapImageSource : ImageSource, ISKBitmapImageSource
 {
@@ -75,7 +75,7 @@ public sealed partial class SKBitmapImageSource : ImageSource, ISKBitmapImageSou
 public static readonly BindableProperty BitmapProperty = BindableProperty.Create(nameof(Bitmap), typeof(SKBitmap), typeof(SKBitmapImageSource), default(SKBitmap));
 
 /// <summary>
-/// Gets or sets the underlying <see cref="T:SkiaSharp.SKBitmap" /> of the image source.
+/// Gets or sets the underlying <see cref="SKBitmap" /> of the image source.
 /// </summary>
 public SKBitmap Bitmap
 {
@@ -93,7 +93,7 @@ public override Task<bool> Cancel()
 }
 
 /// <summary>
-/// Allows implicit casting from a <see cref="T:SkiaSharp.SKBitmap" />.
+/// Allows implicit casting from a <see cref="SKBitmap" />.
 /// </summary>
 /// <param name="bitmap">The bitmap to use when creating the ImageSource.</param>
 /// <returns>Returns a new instance of <see cref="SKBitmapImageSource" /> with the <see cref="SKBitmapImageSource.Bitmap" /> property set to the bitmap.</returns>
@@ -106,10 +106,10 @@ public static implicit operator SKBitmapImageSource(SKBitmap bitmap)
 }
 
 /// <summary>
-/// Allows implicit casting to a <see cref="T:SkiaSharp.SKBitmap" />.
+/// Allows implicit casting to a <see cref="SKBitmap" />.
 /// </summary>
 /// <param name="source">The ImageSource to retrieve the bitmap from.</param>
-/// <returns>Returns the underlying <see cref="T:SkiaSharp.SKBitmap" /> of the ImageSource.</returns>
+/// <returns>Returns the underlying <see cref="SKBitmap" /> of the ImageSource.</returns>
 public static implicit operator SKBitmap(SKBitmapImageSource source)
 {
 return source?.Bitmap;
@@ -124,7 +124,7 @@ protected override void OnPropertyChanged(string propertyName = null)
 }
 
 /// <summary>
-/// Represents a <see cref="T:SkiaSharp.SKPixmap" /> image source.
+/// Represents a <see cref="SKPixmap" /> image source.
 /// </summary>
 public sealed partial class SKPixmapImageSource : ImageSource, ISKPixmapImageSource
 {
@@ -134,7 +134,7 @@ public sealed partial class SKPixmapImageSource : ImageSource, ISKPixmapImageSou
 public static readonly BindableProperty PixmapProperty = BindableProperty.Create(nameof(Pixmap), typeof(SKPixmap), typeof(SKPixmapImageSource), default(SKPixmap));
 
 /// <summary>
-/// Gets or sets the underlying <see cref="T:SkiaSharp.SKPixmap" /> of the image source.
+/// Gets or sets the underlying <see cref="SKPixmap" /> of the image source.
 /// </summary>
 public SKPixmap Pixmap
 {
@@ -152,7 +152,7 @@ public override Task<bool> Cancel()
 }
 
 /// <summary>
-/// Allows implicit casting from a <see cref="T:SkiaSharp.SKPixmap" />.
+/// Allows implicit casting from a <see cref="SKPixmap" />.
 /// </summary>
 /// <param name="pixmap">The pixmap to use when creating the ImageSource.</param>
 /// <returns>Returns a new instance of <see cref="SKPixmapImageSource" /> with the <see cref="SKPixmapImageSource.Pixmap" /> property set to the bitmap.</returns>
@@ -165,10 +165,10 @@ public static implicit operator SKPixmapImageSource(SKPixmap pixmap)
 }
 
 /// <summary>
-/// Allows implicit casting to a <see cref="T:SkiaSharp.SKPixmap" />.
+/// Allows implicit casting to a <see cref="SKPixmap" />.
 /// </summary>
 /// <param name="source">The ImageSource to retrieve the pixmap from.</param>
-/// <returns>Returns the underlying <see cref="T:SkiaSharp.SKPixmap" /> of the ImageSource.</returns>
+/// <returns>Returns the underlying <see cref="SKPixmap" /> of the ImageSource.</returns>
 public static implicit operator SKPixmap(SKPixmapImageSource source)
 {
 return source?.Pixmap;
@@ -183,7 +183,7 @@ protected override void OnPropertyChanged(string propertyName = null)
 }
 
 /// <summary>
-/// Represents a <see cref="T:SkiaSharp.SKPicture" /> image source.
+/// Represents a <see cref="SKPicture" /> image source.
 /// </summary>
 public sealed partial class SKPictureImageSource : ImageSource, ISKPictureImageSource
 {
@@ -198,7 +198,7 @@ public sealed partial class SKPictureImageSource : ImageSource, ISKPictureImageS
 public static readonly BindableProperty DimensionsProperty = BindableProperty.Create(nameof(Dimensions), typeof(SKSizeI), typeof(SKPictureImageSource), default(SKSizeI));
 
 /// <summary>
-/// Gets or sets the underlying <see cref="T:SkiaSharp.SKImage" /> of the image source.
+/// Gets or sets the underlying <see cref="SKImage" /> of the image source.
 /// </summary>
 public SKPicture Picture
 {
@@ -225,10 +225,10 @@ public override Task<bool> Cancel()
 }
 
 /// <summary>
-/// Allows explicit casting to a <see cref="T:SkiaSharp.SKPicture" />.
+/// Allows explicit casting to a <see cref="SKPicture" />.
 /// </summary>
 /// <param name="source">The ImageSource to retrieve the picture from.</param>
-/// <returns>Returns the underlying <see cref="T:SkiaSharp.SKPicture" /> of the ImageSource.</returns>
+/// <returns>Returns the underlying <see cref="SKPicture" /> of the ImageSource.</returns>
 public static explicit operator SKPicture(SKPictureImageSource source)
 {
 return source?.Picture;

source/SkiaSharp.Views/SkiaSharp.Views/Platform/Tizen/CustomRenderingView.cs

@@ -4,6 +4,9 @@
 
 namespace SkiaSharp.Views.Tizen
 {
+/// <summary>
+/// An abstract view that can be inherited from to allow drawing on using SkiaSharp drawing commands.
+/// </summary>
 public abstract class CustomRenderingView : Widget
 {
 private readonly Evas.ImagePixelsSetCallback redrawCallback;
@@ -20,8 +23,15 @@ public CustomRenderingView(EvasObject parent)
 redrawCallback = (d, o) => OnDrawFrame();
 }
 
+/// <summary>
+/// Gets the current canvas size.
+/// </summary>
+/// <remarks>The canvas size may be different to the view size as a result of the current device's pixel density.</remarks>
 public SKSize CanvasSize => GetSurfaceSize();
 
+/// <summary>
+/// Gets or sets the rendering mode.
+/// </summary>
 public RenderingMode RenderingMode
 {
 get { return renderingMode; }
@@ -39,6 +49,9 @@ public RenderingMode RenderingMode
 }
 }
 
+/// <summary>
+/// Invalidates the entire surface of the control and causes the control to be redrawn.
+/// </summary>
 public void Invalidate()
 {
 if (RenderingMode == RenderingMode.WhenDirty)

source/SkiaSharp.Views/SkiaSharp.Views/Platform/Tizen/RenderingMode.cs

@@ -1,8 +1,17 @@
 namespace SkiaSharp.Views.Tizen
 {
+/// <summary>
+/// Various options for rendering a view.
+/// </summary>
 public enum RenderingMode
 {
+/// <summary>
+/// The view is repainted continuously.
+/// </summary>
 Continuously,
+/// <summary>
+/// The view only redraws the surface when the it is created, resized, or when <see cref="M:SkiaSharp.Views.Tizen.CustomRenderingView.Invalidate" /> is called.
+/// </summary>
 WhenDirty,
 }
 }

source/SkiaSharp.Views/SkiaSharp.Views/Platform/Tizen/SKCanvasView.cs

@@ -4,6 +4,9 @@
 
 namespace SkiaSharp.Views.Tizen
 {
+/// <summary>
+/// A view that can be drawn on using SkiaSharp drawing commands.
+/// </summary>
 public class SKCanvasView : CustomRenderingView
 {
 private bool ignorePixelScaling;
@@ -16,6 +19,10 @@ public SKCanvasView(EvasObject parent)
 info = new SKImageInfo(0, 0, SKImageInfo.PlatformColorType, SKAlphaType.Premul);
 }
 
+/// <summary>
+/// Gets or sets a value indicating whether the drawing canvas should be resized on high resolution displays.
+/// </summary>
+/// <remarks>By default, when <see langword="false" />, the canvas is resized to 1 canvas pixel per display pixel. When <see langword="true" />, the canvas is resized to device independent pixels, and then stretched to fill the view. Although performance is improved and all objects are the same size on different display densities, blurring and pixelation may occur.</remarks>
 public bool IgnorePixelScaling
 {
 get => ignorePixelScaling;
@@ -30,6 +37,25 @@ public bool IgnorePixelScaling
 }
 }
 
+/// <summary>
+/// Occurs when the surface needs to be redrawn.
+/// </summary>
+/// <remarks>There are two ways to draw on this surface: by overriding the
+/// <see cref="SkiaSharp.Views.Tizen.SKCanvasView.OnDrawFrame(SkiaSharp.Views.Tizen.SKPaintSurfaceEventArgs)" />
+/// method, or by attaching a handler to the
+/// <see cref="SkiaSharp.Views.Tizen.SKCanvasView.PaintSurface" />
+/// event.
+/// ## Examples
+/// ```csharp
+/// 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 ();
+/// };
+/// ```</remarks>
 public event EventHandler<SKPaintSurfaceEventArgs> PaintSurface;
 
 protected override SKSizeI GetSurfaceSize() => canvasSize;

source/SkiaSharp.Views/SkiaSharp.Views/Platform/Tizen/SKGLSurfaceView.cs

@@ -7,6 +7,9 @@
 
 namespace SkiaSharp.Views.Tizen
 {
+/// <summary>
+/// A hardware-accelerated view that can be drawn on using SkiaSharp drawing commands.
+/// </summary>
 public class SKGLSurfaceView : CustomRenderingView
 {
 private const GRSurfaceOrigin surfaceOrigin = GRSurfaceOrigin.BottomLeft;
@@ -40,8 +43,30 @@ public SKGLSurfaceView(EvasObject parent)
 };
 }
 
+/// <summary>
+/// Occurs when the surface needs to be redrawn.
+/// </summary>
+/// <remarks>There are two ways to draw on this surface: by overriding the
+/// <see cref="SkiaSharp.Views.Tizen.SKGLSurfaceView.OnDrawFrame(SkiaSharp.Views.Tizen.SKPaintGLSurfaceEventArgs)" />
+/// method, or by attaching a handler to the
+/// <see cref="SkiaSharp.Views.Tizen.SKGLSurfaceView.PaintSurface" />
+/// event.
+/// ## Examples
+/// ```csharp
+/// myView.PaintSurface += (sender, e) => {
+/// var surface = e.Surface;
+/// var surfaceWidth = e.BackendRenderTarget.Width;
+/// var surfaceHeight = e.BackendRenderTarget.Height;
+/// var canvas = surface.Canvas;
+/// // draw on the canvas
+/// canvas.Flush ();
+/// };
+/// ```</remarks>
 public event EventHandler<SKPaintGLSurfaceEventArgs> PaintSurface;
 
+/// <summary>
+/// Gets the current GPU context.
+/// </summary>
 public GRContext GRContext => context;
 
 protected override SKSizeI GetSurfaceSize() => surfaceSize;

source/SkiaSharp.Views/SkiaSharp.Views/Platform/Tizen/ScalingInfo.cs

@@ -4,6 +4,9 @@
 
 namespace SkiaSharp.Views.Tizen
 {
+/// <summary>
+/// A utility class that can be used to determine screen densities.
+/// </summary>
 public static class ScalingInfo
 {
 private static readonly Lazy<string> profile = new Lazy<string>(() => Elementary.GetProfile());
@@ -25,16 +28,36 @@ public static class ScalingInfo
 
 private static double? scalingFactorOverride;
 
+/// <summary>
+/// Gets the device profile.
+/// </summary>
 public static string Profile => profile.Value;
 
+/// <summary>
+/// Gets the DPI of the screen.
+/// </summary>
 public static int Dpi => dpi.Value;
 
+/// <summary>
+/// The scaling factor to convert between raw pixels and device-independent pixels.
+/// </summary>
 public static double ScalingFactor => scalingFactorOverride ?? scalingFactor.Value;
 
+/// <summary>
+/// Convert from raw pixels into device-independent pixels.
+/// </summary>
+/// <param name="v">The raw pixel dimension.</param>
+/// <returns>Returns the device-independent pixel dimension.</returns>
 public static double FromPixel(double v) => v / ScalingFactor;
 
+/// <summary>
+/// Convert from device-independent pixels into raw pixels.
+/// </summary>
+/// <param name="v">The device-independent pixel dimension.</param>
+/// <returns>Returns the raw pixel dimension.</returns>
 public static double ToPixel(double v) => v * ScalingFactor;
 
+/// <param name="scalingFactor"></param>
 public static void SetScalingFactor(double? scalingFactor)
 {
 scalingFactorOverride = scalingFactor;