Browse Source

Revert Rgba32 specificity on docs.

af/merge-core
James Jackson-South 6 years ago
parent
commit
2bcba77d5f
  1. 2
      src/ImageSharp/Formats/IImageDecoder.cs
  2. 22
      src/ImageSharp/Image.FromBytes.cs
  3. 8
      src/ImageSharp/Image.FromFile.cs
  4. 6
      src/ImageSharp/Image.FromStream.cs

2
src/ImageSharp/Formats/IImageDecoder.cs

@ -26,7 +26,7 @@ namespace SixLabors.ImageSharp.Formats
/// </summary>
/// <param name="configuration">The configuration for the image.</param>
/// <param name="stream">The <see cref="Stream"/> containing image data.</param>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
Image Decode(Configuration configuration, Stream stream);
}
}

22
src/ImageSharp/Image.FromBytes.cs

@ -270,7 +270,7 @@ namespace SixLabors.ImageSharp
/// </summary>
/// <param name="data">The byte array containing image data.</param>
/// <param name="format">The detected format.</param>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(byte[] data, out IImageFormat format) =>
Load(Configuration.Default, data, out format);
@ -279,7 +279,7 @@ namespace SixLabors.ImageSharp
/// </summary>
/// <param name="data">The byte array containing encoded image data.</param>
/// <param name="decoder">The decoder.</param>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(byte[] data, IImageDecoder decoder) => Load(Configuration.Default, data, decoder);
/// <summary>
@ -287,7 +287,7 @@ namespace SixLabors.ImageSharp
/// </summary>
/// <param name="config">The config for the decoder.</param>
/// <param name="data">The byte array containing encoded image data.</param>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(Configuration config, byte[] data) => Load(config, data, out _);
/// <summary>
@ -296,7 +296,7 @@ namespace SixLabors.ImageSharp
/// <param name="config">The config for the decoder.</param>
/// <param name="data">The byte array containing image data.</param>
/// <param name="decoder">The decoder.</param>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(Configuration config, byte[] data, IImageDecoder decoder)
{
using (var stream = new MemoryStream(data))
@ -311,7 +311,7 @@ namespace SixLabors.ImageSharp
/// <param name="config">The config for the decoder.</param>
/// <param name="data">The byte array containing image data.</param>
/// <param name="format">The mime type of the decoded image.</param>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(Configuration config, byte[] data, out IImageFormat format)
{
using (var stream = new MemoryStream(data))
@ -324,7 +324,7 @@ namespace SixLabors.ImageSharp
/// Load a new instance of <see cref="Image"/> from the given encoded byte span.
/// </summary>
/// <param name="data">The byte span containing image data.</param>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(ReadOnlySpan<byte> data) => Load(Configuration.Default, data);
/// <summary>
@ -332,7 +332,7 @@ namespace SixLabors.ImageSharp
/// </summary>
/// <param name="data">The byte span containing image data.</param>
/// <param name="decoder">The decoder.</param>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(ReadOnlySpan<byte> data, IImageDecoder decoder) =>
Load(Configuration.Default, data, decoder);
@ -341,7 +341,7 @@ namespace SixLabors.ImageSharp
/// </summary>
/// <param name="data">The byte span containing image data.</param>
/// <param name="format">The detected format.</param>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(ReadOnlySpan<byte> data, out IImageFormat format) =>
Load(Configuration.Default, data, out format);
@ -350,7 +350,7 @@ namespace SixLabors.ImageSharp
/// </summary>
/// <param name="config">The configuration options.</param>
/// <param name="data">The byte span containing image data.</param>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(Configuration config, ReadOnlySpan<byte> data) => Load(config, data, out _);
/// <summary>
@ -359,7 +359,7 @@ namespace SixLabors.ImageSharp
/// <param name="config">The Configuration.</param>
/// <param name="data">The byte span containing image data.</param>
/// <param name="decoder">The decoder.</param>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static unsafe Image Load(
Configuration config,
ReadOnlySpan<byte> data,
@ -380,7 +380,7 @@ namespace SixLabors.ImageSharp
/// <param name="config">The configuration options.</param>
/// <param name="data">The byte span containing image data.</param>
/// <param name="format">The <see cref="IImageFormat"/> of the decoded image.</param>>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static unsafe Image Load(
Configuration config,
ReadOnlySpan<byte> data,

8
src/ImageSharp/Image.FromFile.cs

@ -45,7 +45,7 @@ namespace SixLabors.ImageSharp
/// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable.
/// </exception>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(string path) => Load(Configuration.Default, path);
/// <summary>
@ -67,7 +67,7 @@ namespace SixLabors.ImageSharp
/// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable.
/// </exception>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(Configuration config, string path) => Load(config, path, out _);
/// <summary>
@ -79,7 +79,7 @@ namespace SixLabors.ImageSharp
/// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable.
/// </exception>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(Configuration config, string path, IImageDecoder decoder)
{
using (Stream stream = config.FileSystem.OpenRead(path))
@ -96,7 +96,7 @@ namespace SixLabors.ImageSharp
/// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable.
/// </exception>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(string path, IImageDecoder decoder) => Load(Configuration.Default, path, decoder);
/// <summary>

6
src/ImageSharp/Image.FromStream.cs

@ -80,7 +80,7 @@ namespace SixLabors.ImageSharp
/// <param name="format">The format type of the decoded image.</param>
/// <exception cref="NotSupportedException">Thrown if the stream is not readable.</exception>
/// <exception cref="UnknownImageFormatException">Image cannot be loaded.</exception>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(Stream stream, out IImageFormat format) => Load(Configuration.Default, stream, out format);
/// <summary>
@ -90,7 +90,7 @@ namespace SixLabors.ImageSharp
/// <param name="stream">The stream containing image information.</param>
/// <exception cref="NotSupportedException">Thrown if the stream is not readable.</exception>
/// <exception cref="UnknownImageFormatException">Image cannot be loaded.</exception>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(Stream stream) => Load(Configuration.Default, stream);
/// <summary>
@ -101,7 +101,7 @@ namespace SixLabors.ImageSharp
/// <param name="decoder">The decoder.</param>
/// <exception cref="NotSupportedException">Thrown if the stream is not readable.</exception>
/// <exception cref="UnknownImageFormatException">Image cannot be loaded.</exception>
/// <returns>The <see cref="Image"/> in <see cref="Rgba32"/> pixel format.</returns>
/// <returns>The <see cref="Image"/>.</returns>
public static Image Load(Stream stream, IImageDecoder decoder) => Load(Configuration.Default, stream, decoder);
/// <summary>

Loading…
Cancel
Save