aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/Drawing
diff options
context:
space:
mode:
authorMark Monteiro <mark.monteiro23@gmail.com>2019-12-13 20:57:23 +0100
committerMark Monteiro <mark.monteiro23@gmail.com>2019-12-13 20:57:23 +0100
commit88928118eb51b121aed0348494ef7456c1c55379 (patch)
treee0bc5e5372c4606c11cf464c862e9b9b870a3a3e /MediaBrowser.Controller/Drawing
parent54dbdc695a1c4d3b987f9fd91be55ff109975a43 (diff)
Add missing documentation in Jellyfun.Drawing.Skia
Diffstat (limited to 'MediaBrowser.Controller/Drawing')
-rw-r--r--MediaBrowser.Controller/Drawing/IImageEncoder.cs16
1 files changed, 11 insertions, 5 deletions
diff --git a/MediaBrowser.Controller/Drawing/IImageEncoder.cs b/MediaBrowser.Controller/Drawing/IImageEncoder.cs
index a0f9ae46e..88e67b648 100644
--- a/MediaBrowser.Controller/Drawing/IImageEncoder.cs
+++ b/MediaBrowser.Controller/Drawing/IImageEncoder.cs
@@ -11,6 +11,7 @@ namespace MediaBrowser.Controller.Drawing
/// </summary>
/// <value>The supported input formats.</value>
IReadOnlyCollection<string> SupportedInputFormats { get; }
+
/// <summary>
/// Gets the supported output formats.
/// </summary>
@@ -18,9 +19,9 @@ namespace MediaBrowser.Controller.Drawing
IReadOnlyCollection<ImageFormat> SupportedOutputFormats { get; }
/// <summary>
- /// Gets the name.
+ /// Gets the display name for the encoder.
/// </summary>
- /// <value>The name.</value>
+ /// <value>The display name.</value>
string Name { get; }
/// <summary>
@@ -35,17 +36,22 @@ namespace MediaBrowser.Controller.Drawing
/// <value><c>true</c> if [supports image encoding]; otherwise, <c>false</c>.</value>
bool SupportsImageEncoding { get; }
+ /// <summary>
+ /// Get the dimensions of an image from the filesystem.
+ /// </summary>
+ /// <param name="path">The filepath of the image.</param>
+ /// <returns>The image dimensions.</returns>
ImageDimensions GetImageSize(string path);
/// <summary>
- /// Encodes the image.
+ /// Encode an image.
/// </summary>
string EncodeImage(string inputPath, DateTime dateModified, string outputPath, bool autoOrient, ImageOrientation? orientation, int quality, ImageProcessingOptions options, ImageFormat outputFormat);
/// <summary>
- /// Creates the image collage.
+ /// Create an image collage.
/// </summary>
- /// <param name="options">The options.</param>
+ /// <param name="options">The options to use when creating the collage.</param>
void CreateImageCollage(ImageCollageOptions options);
}
}