tsai
/
ImageSharp
mirror of https://github.com/SixLabors/ImageSharp
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

fix parameter names

pull/143/head
Scott Williams 9 years ago
parent
a3185fd6e7
commit
04dd705664
2 changed files with 64 additions and 64 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 64
      src/ImageSharp/Image.FromBytes.cs
  2. 64
      src/ImageSharp/Image.FromFile.cs

64
src/ImageSharp/Image.FromBytes.cs
View File

@ -20,126 +20,126 @@ namespace ImageSharp
public sealed partial class Image public sealed partial class Image
{ {
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given byte array.
/// </summary> /// </summary>
/// <param name="stream">The stream containing image information.</param> /// <param name="data">The byte array containing image data.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image Load(byte[] stream) public static Image Load(byte[] data)
{ {
return Load(stream, null, null); return Load(data, null, null);
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given byte array.
/// </summary> /// </summary>
/// <param name="stream">The stream containing image information.</param> /// <param name="data">The byte array containing image data.</param>
/// <param name="options">The options for the decoder.</param> /// <param name="options">The options for the decoder.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image Load(byte[] stream, IDecoderOptions options) public static Image Load(byte[] data, IDecoderOptions options)
{ {
return Load(stream, options, null); return Load(data, options, null);
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given byte array.
/// </summary> /// </summary>
/// <param name="stream">The stream containing image information.</param> /// <param name="data">The byte array containing image data.</param>
/// <param name="config">The config for the decoder.</param> /// <param name="config">The config for the decoder.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image Load(byte[] stream, Configuration config) public static Image Load(byte[] data, Configuration config)
{ {
return Load(stream, null, config); return Load(data, null, config);
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given byte array.
/// </summary> /// </summary>
/// <param name="stream">The stream containing image information.</param> /// <param name="data">The byte array containing image data.</param>
/// <param name="options">The options for the decoder.</param> /// <param name="options">The options for the decoder.</param>
/// <param name="config">The configuration options.</param> /// <param name="config">The configuration options.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image Load(byte[] stream, IDecoderOptions options, Configuration config) public static Image Load(byte[] data, IDecoderOptions options, Configuration config)
{ {
using (MemoryStream ms = new MemoryStream(stream)) using (MemoryStream ms = new MemoryStream(data))
{ {
return Load(ms, options, config); return Load(ms, options, config);
} }
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given byte array.
/// </summary> /// </summary>
/// <typeparam name="TColor">The pixel format.</typeparam> /// <typeparam name="TColor">The pixel format.</typeparam>
/// <param name="stream">The stream containing image information.</param> /// <param name="data">The byte array containing image data.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image<TColor> Load<TColor>(byte[] stream) public static Image<TColor> Load<TColor>(byte[] data)
where TColor : struct, IPixel<TColor> where TColor : struct, IPixel<TColor>
{ {
return Load<TColor>(stream, null, null); return Load<TColor>(data, null, null);
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given byte array.
/// </summary> /// </summary>
/// <typeparam name="TColor">The pixel format.</typeparam> /// <typeparam name="TColor">The pixel format.</typeparam>
/// <param name="stream">The stream containing image information.</param> /// <param name="data">The byte array containing image data.</param>
/// <param name="options">The options for the decoder.</param> /// <param name="options">The options for the decoder.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image<TColor> Load<TColor>(byte[] stream, IDecoderOptions options) public static Image<TColor> Load<TColor>(byte[] data, IDecoderOptions options)
where TColor : struct, IPixel<TColor> where TColor : struct, IPixel<TColor>
{ {
return Load<TColor>(stream, options, null); return Load<TColor>(data, options, null);
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given byte array.
/// </summary> /// </summary>
/// <typeparam name="TColor">The pixel format.</typeparam> /// <typeparam name="TColor">The pixel format.</typeparam>
/// <param name="stream">The stream containing image information.</param> /// <param name="data">The byte array containing image data.</param>
/// <param name="config">The config for the decoder.</param> /// <param name="config">The config for the decoder.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image<TColor> Load<TColor>(byte[] stream, Configuration config) public static Image<TColor> Load<TColor>(byte[] data, Configuration config)
where TColor : struct, IPixel<TColor> where TColor : struct, IPixel<TColor>
{ {
return Load<TColor>(stream, null, config); return Load<TColor>(data, null, config);
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given byte array.
/// </summary> /// </summary>
/// <typeparam name="TColor">The pixel format.</typeparam> /// <typeparam name="TColor">The pixel format.</typeparam>
/// <param name="stream">The stream containing image information.</param> /// <param name="data">The byte array containing image data.</param>
/// <param name="options">The options for the decoder.</param> /// <param name="options">The options for the decoder.</param>
/// <param name="config">The configuration options.</param> /// <param name="config">The configuration options.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image<TColor> Load<TColor>(byte[] stream, IDecoderOptions options, Configuration config) public static Image<TColor> Load<TColor>(byte[] data, IDecoderOptions options, Configuration config)
where TColor : struct, IPixel<TColor> where TColor : struct, IPixel<TColor>
{ {
using (MemoryStream ms = new MemoryStream(stream)) using (MemoryStream ms = new MemoryStream(data))
{ {
return Load<TColor>(ms, options, config); return Load<TColor>(ms, options, config);
} }

64
src/ImageSharp/Image.FromFile.cs
View File

@ -21,124 +21,124 @@ namespace ImageSharp
public sealed partial class Image public sealed partial class Image
{ {
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given file.
/// </summary> /// </summary>
/// <param name="stream">The stream containing image information.</param> /// <param name="path">The file path to the image.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image Load(string stream) public static Image Load(string path)
{ {
return Load(stream, null, null); return Load(path, null, null);
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given file.
/// </summary> /// </summary>
/// <param name="stream">The stream containing image information.</param> /// <param name="path">The file path to the image.</param>
/// <param name="options">The options for the decoder.</param> /// <param name="options">The options for the decoder.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image Load(string stream, IDecoderOptions options) public static Image Load(string path, IDecoderOptions options)
{ {
return Load(stream, options, null); return Load(path, options, null);
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given file.
/// </summary> /// </summary>
/// <param name="stream">The stream containing image information.</param> /// <param name="path">The file path to the image.</param>
/// <param name="config">The config for the decoder.</param> /// <param name="config">The config for the decoder.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image Load(string stream, Configuration config) public static Image Load(string path, Configuration config)
{ {
return Load(stream, null, config); return Load(path, null, config);
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given file.
/// </summary> /// </summary>
/// <param name="stream">The stream containing image information.</param> /// <param name="path">The file path to the image.</param>
/// <param name="options">The options for the decoder.</param> /// <param name="options">The options for the decoder.</param>
/// <param name="config">The configuration options.</param> /// <param name="config">The configuration options.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image Load(string stream, IDecoderOptions options, Configuration config) public static Image Load(string path, IDecoderOptions options, Configuration config)
{ {
return new Image(Image.Load<Color>(stream, options, config)); return new Image(Load<Color>(path, options, config));
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given file.
/// </summary> /// </summary>
/// <typeparam name="TColor">The pixel format.</typeparam> /// <typeparam name="TColor">The pixel format.</typeparam>
/// <param name="stream">The stream containing image information.</param> /// <param name="path">The file path to the image.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image<TColor> Load<TColor>(string stream) public static Image<TColor> Load<TColor>(string path)
where TColor : struct, IPixel<TColor> where TColor : struct, IPixel<TColor>
{ {
return Load<TColor>(stream, null, null); return Load<TColor>(path, null, null);
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given file.
/// </summary> /// </summary>
/// <typeparam name="TColor">The pixel format.</typeparam> /// <typeparam name="TColor">The pixel format.</typeparam>
/// <param name="stream">The stream containing image information.</param> /// <param name="path">The file path to the image.</param>
/// <param name="options">The options for the decoder.</param> /// <param name="options">The options for the decoder.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image<TColor> Load<TColor>(string stream, IDecoderOptions options) public static Image<TColor> Load<TColor>(string path, IDecoderOptions options)
where TColor : struct, IPixel<TColor> where TColor : struct, IPixel<TColor>
{ {
return Load<TColor>(stream, options, null); return Load<TColor>(path, options, null);
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given file.
/// </summary> /// </summary>
/// <typeparam name="TColor">The pixel format.</typeparam> /// <typeparam name="TColor">The pixel format.</typeparam>
/// <param name="stream">The stream containing image information.</param> /// <param name="path">The file path to the image.</param>
/// <param name="config">The config for the decoder.</param> /// <param name="config">The config for the decoder.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image<TColor> Load<TColor>(string stream, Configuration config) public static Image<TColor> Load<TColor>(string path, Configuration config)
where TColor : struct, IPixel<TColor> where TColor : struct, IPixel<TColor>
{ {
return Load<TColor>(stream, null, config); return Load<TColor>(path, null, config);
} }
/// <summary> /// <summary>
/// Loads the image from the given stream. /// Loads the image from the given file.
/// </summary> /// </summary>
/// <typeparam name="TColor">The pixel format.</typeparam> /// <typeparam name="TColor">The pixel format.</typeparam>
/// <param name="stream">The stream containing image information.</param> /// <param name="path">The file path to the image.</param>
/// <param name="options">The options for the decoder.</param> /// <param name="options">The options for the decoder.</param>
/// <param name="config">The configuration options.</param> /// <param name="config">The configuration options.</param>
/// <exception cref="NotSupportedException"> /// <exception cref="NotSupportedException">
/// Thrown if the stream is not readable nor seekable. /// Thrown if the stream is not readable nor seekable.
/// </exception> /// </exception>
/// <returns>The image</returns> /// <returns>The image</returns>
public static Image<TColor> Load<TColor>(string stream, IDecoderOptions options, Configuration config) public static Image<TColor> Load<TColor>(string path, IDecoderOptions options, Configuration config)
where TColor : struct, IPixel<TColor> where TColor : struct, IPixel<TColor>
{ {
config = config ?? Configuration.Default; config = config ?? Configuration.Default;
using (Stream s = config.FileSystem.OpenRead(stream)) using (Stream s = config.FileSystem.OpenRead(path))
{ {
return Load<TColor>(s, options, config); return Load<TColor>(s, options, config);
} }

Write Preview
Loading…
Cancel
Save