Browse Source

Fix pixel xml docs to add ranges and remove duplication

af/merge-core
James Jackson-South 9 years ago
parent
commit
ba2e3e1a15
  1. 3
      src/ImageSharp/PixelFormats/Alpha8.cs
  2. 1
      src/ImageSharp/PixelFormats/Argb32.cs
  3. 1
      src/ImageSharp/PixelFormats/Bgr565.cs
  4. 1
      src/ImageSharp/PixelFormats/Bgra4444.cs
  5. 1
      src/ImageSharp/PixelFormats/Byte4.cs
  6. 1
      src/ImageSharp/PixelFormats/HalfSingle.cs
  7. 1
      src/ImageSharp/PixelFormats/HalfVector2.cs
  8. 1
      src/ImageSharp/PixelFormats/HalfVector4.cs
  9. 1
      src/ImageSharp/PixelFormats/NormalizedByte2.cs
  10. 1
      src/ImageSharp/PixelFormats/NormalizedByte4.cs
  11. 1
      src/ImageSharp/PixelFormats/NormalizedShort2.cs
  12. 1
      src/ImageSharp/PixelFormats/NormalizedShort4.cs
  13. 1
      src/ImageSharp/PixelFormats/Rg32.cs
  14. 1
      src/ImageSharp/PixelFormats/Rgba1010102.cs
  15. 11
      src/ImageSharp/PixelFormats/Rgba32.BulkOperations.cs
  16. 11
      src/ImageSharp/PixelFormats/Rgba32.ColorspaceTransforms.cs
  17. 11
      src/ImageSharp/PixelFormats/Rgba32.Definitions.cs
  18. 11
      src/ImageSharp/PixelFormats/Rgba32.Transforms.cs
  19. 1
      src/ImageSharp/PixelFormats/Rgba32.cs
  20. 1
      src/ImageSharp/PixelFormats/Rgba64.cs
  21. 11
      src/ImageSharp/PixelFormats/RgbaVector.BulkOperations.cs
  22. 11
      src/ImageSharp/PixelFormats/RgbaVector.Definitions.cs
  23. 11
      src/ImageSharp/PixelFormats/RgbaVector.Transforms.cs
  24. 1
      src/ImageSharp/PixelFormats/RgbaVector.cs
  25. 1
      src/ImageSharp/PixelFormats/Short2.cs
  26. 1
      src/ImageSharp/PixelFormats/Short4.cs
  27. 2
      src/ImageSharp/PixelFormats/Vector4BlendTransforms.cs

3
src/ImageSharp/PixelFormats/Alpha8.cs

@ -10,7 +10,8 @@ namespace ImageSharp.PixelFormats
using System.Runtime.CompilerServices;
/// <summary>
/// Packed pixel type containing a single 8 bit normalized W values ranging from 0 to 1.
/// Packed pixel type containing a single 8 bit normalized W values.
/// Ranges from &lt;0, 0, 0, 0&gt; to &lt;0, 0, 0, 1&gt; in vector form.
/// </summary>
public struct Alpha8 : IPixel<Alpha8>, IPackedVector<byte>
{

1
src/ImageSharp/PixelFormats/Argb32.cs

@ -11,6 +11,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing four 8-bit unsigned normalized values ranging from 0 to 255.
/// The color components are stored in alpha, red, green, and blue order.
/// Ranges from &lt;0, 0, 0, 0&gt; to &lt;1, 1, 1, 1&gt; in vector form.
/// </summary>
/// <remarks>
/// This struct is fully mutable. This is done (against the guidelines) for the sake of performance,

1
src/ImageSharp/PixelFormats/Bgr565.cs

@ -11,6 +11,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing unsigned normalized values ranging from 0 to 1. The x and z components use 5 bits, and the y component uses 6 bits.
/// Ranges from &lt;0, 0, 0, 1&gt; to &lt;1, 1, 1, 1&gt; in vector form.
/// </summary>
public struct Bgr565 : IPixel<Bgr565>, IPackedVector<ushort>
{

1
src/ImageSharp/PixelFormats/Bgra4444.cs

@ -11,6 +11,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing unsigned normalized values, ranging from 0 to 1, using 4 bits each for x, y, z, and w.
/// Ranges from &lt;0, 0, 0, 0&gt; to &lt;1, 1, 1, 1&gt; in vector form.
/// </summary>
public struct Bgra4444 : IPixel<Bgra4444>, IPackedVector<ushort>
{

1
src/ImageSharp/PixelFormats/Byte4.cs

@ -11,6 +11,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing four 8-bit unsigned integer values, ranging from 0 to 255.
/// Ranges from &lt;0, 0, 0, 0&gt; to &lt;1, 1, 1, 1&gt; in vector form.
/// </summary>
public struct Byte4 : IPixel<Byte4>, IPackedVector<uint>
{

1
src/ImageSharp/PixelFormats/HalfSingle.cs

@ -10,6 +10,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing a single 16 bit floating point value.
/// Ranges from &lt;0, 0, 0, 1&gt; to &lt;1, 0, 0, 1&gt; in vector form.
/// </summary>
public struct HalfSingle : IPixel<HalfSingle>, IPackedVector<ushort>
{

1
src/ImageSharp/PixelFormats/HalfVector2.cs

@ -10,6 +10,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing two 16-bit floating-point values.
/// Ranges from &lt;0, 0, 0, 1&gt; to &lt;1, 0, 0, 1&gt; in vector form.
/// </summary>
public struct HalfVector2 : IPixel<HalfVector2>, IPackedVector<uint>
{

1
src/ImageSharp/PixelFormats/HalfVector4.cs

@ -10,6 +10,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing four 16-bit floating-point values.
/// Ranges from &lt;0, 0, 0, 0&gt; to &lt;1, 1, 1, 1&gt; in vector form.
/// </summary>
public struct HalfVector4 : IPixel<HalfVector4>, IPackedVector<ulong>
{

1
src/ImageSharp/PixelFormats/NormalizedByte2.cs

@ -11,6 +11,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed packed pixel type containing two 8-bit signed normalized values, ranging from −1 to 1.
/// Ranges from &lt;-1, -1, 0, 1&gt; to &lt;1, 1, 0, 1&gt; in vector form.
/// </summary>
public struct NormalizedByte2 : IPixel<NormalizedByte2>, IPackedVector<ushort>
{

1
src/ImageSharp/PixelFormats/NormalizedByte4.cs

@ -11,6 +11,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing four 8-bit signed normalized values, ranging from −1 to 1.
/// Ranges from &lt;-1, -1, -1, -1&gt; to &lt;1, 1, 1, 1&gt; in vector form.
/// </summary>
public struct NormalizedByte4 : IPixel<NormalizedByte4>, IPackedVector<uint>
{

1
src/ImageSharp/PixelFormats/NormalizedShort2.cs

@ -10,6 +10,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing two 16-bit signed normalized values, ranging from −1 to 1.
/// Ranges from &lt;-1, -1, 0, 1&gt; to &lt;1, 1, 0, 1&gt; in vector form.
/// </summary>
public struct NormalizedShort2 : IPixel<NormalizedShort2>, IPackedVector<uint>
{

1
src/ImageSharp/PixelFormats/NormalizedShort4.cs

@ -10,6 +10,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing four 16-bit signed normalized values, ranging from −1 to 1.
/// Ranges from &lt;-1, -1, -1, -1&gt; to &lt;1, 1, 1, 1&gt; in vector form.
/// </summary>
public struct NormalizedShort4 : IPixel<NormalizedShort4>, IPackedVector<ulong>
{

1
src/ImageSharp/PixelFormats/Rg32.cs

@ -11,6 +11,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing two 16-bit unsigned normalized values ranging from 0 to 1.
/// Ranges from &lt;0, 0, 0, 1&gt; to &lt;1, 1, 0, 1&gt; in vector form.
/// </summary>
public struct Rg32 : IPixel<Rg32>, IPackedVector<uint>
{

1
src/ImageSharp/PixelFormats/Rgba1010102.cs

@ -12,6 +12,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed vector type containing unsigned normalized values ranging from 0 to 1.
/// The x, y and z components use 10 bits, and the w component uses 2 bits.
/// Ranges from &lt;0, 0, 0, 0&gt; to &lt;1, 1, 1, 1&gt; in vector form.
/// </summary>
public struct Rgba1010102 : IPixel<Rgba1010102>, IPackedVector<uint>
{

11
src/ImageSharp/PixelFormats/Rgba32.BulkOperations.cs

@ -10,14 +10,9 @@ namespace ImageSharp.PixelFormats
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
/// <summary>
/// Unpacked pixel type containing four 8-bit unsigned normalized values ranging from 0 to 255.
/// The color components are stored in red, green, blue, and alpha order.
/// </summary>
/// <remarks>
/// This struct is fully mutable. This is done (against the guidelines) for the sake of performance,
/// as it avoids the need to create new values for modification operations.
/// </remarks>
/// <content>
/// Provides optimized overrides for bulk operations.
/// </content>
public partial struct Rgba32
{
/// <summary>

11
src/ImageSharp/PixelFormats/Rgba32.ColorspaceTransforms.cs

@ -9,14 +9,9 @@ namespace ImageSharp.PixelFormats
using System.Numerics;
using Colors.Spaces;
/// <summary>
/// Packed pixel type containing four 8-bit unsigned normalized values ranging from 0 to 255.
/// The color components are stored in red, green, blue, and alpha order.
/// </summary>
/// <remarks>
/// This struct is fully mutable. This is done (against the guidelines) for the sake of performance,
/// as it avoids the need to create new values for modification operations.
/// </remarks>
/// <content>
/// Provides implicit colorspace transformation.
/// </content>
public partial struct Rgba32
{
/// <summary>

11
src/ImageSharp/PixelFormats/Rgba32.Definitions.cs

@ -5,14 +5,9 @@
namespace ImageSharp.PixelFormats
{
/// <summary>
/// Packed vector type containing four 8-bit unsigned normalized values ranging from 0 to 255.
/// The color components are stored in red, green, blue, and alpha order.
/// </summary>
/// <remarks>
/// This struct is fully mutable. This is done (against the guidelines) for the sake of performance,
/// as it avoids the need to create new values for modification operations.
/// </remarks>
/// <content>
/// Provides standardized deifinitions for named colors.
/// </content>
public partial struct Rgba32
{
/// <summary>

11
src/ImageSharp/PixelFormats/Rgba32.Transforms.cs

@ -8,14 +8,9 @@ namespace ImageSharp.PixelFormats
using System.Numerics;
using System.Runtime.CompilerServices;
/// <summary>
/// Packed pixel type containing four 8-bit unsigned normalized values ranging from 0 to 255.
/// The color components are stored in red, green, blue, and alpha order.
/// </summary>
/// <remarks>
/// This struct is fully mutable. This is done (against the guidelines) for the sake of performance,
/// as it avoids the need to create new values for modification operations.
/// </remarks>
/// <content>
/// Provides operators and composition algorithms.
/// </content>
public partial struct Rgba32
{
/// <summary>

1
src/ImageSharp/PixelFormats/Rgba32.cs

@ -12,6 +12,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing four 8-bit unsigned normalized values ranging from 0 to 255.
/// The color components are stored in red, green, blue, and alpha order.
/// Ranges from &lt;0, 0, 0, 0&gt; to &lt;1, 1, 1, 1&gt; in vector form.
/// </summary>
/// <remarks>
/// This struct is fully mutable. This is done (against the guidelines) for the sake of performance,

1
src/ImageSharp/PixelFormats/Rgba64.cs

@ -11,6 +11,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing four 16-bit unsigned normalized values ranging from 0 to 1.
/// Ranges from &lt;0, 0, 0, 0&gt; to &lt;1, 1, 1, 1&gt; in vector form.
/// </summary>
public struct Rgba64 : IPixel<Rgba64>, IPackedVector<ulong>
{

11
src/ImageSharp/PixelFormats/RgbaVector.BulkOperations.cs

@ -7,14 +7,9 @@ namespace ImageSharp.PixelFormats
{
using System.Numerics;
/// <summary>
/// Unpacked pixel type containing four 16-bit unsigned normalized values typically ranging from 0 to 1.
/// The color components are stored in red, green, blue, and alpha order.
/// </summary>
/// <remarks>
/// This struct is fully mutable. This is done (against the guidelines) for the sake of performance,
/// as it avoids the need to create new values for modification operations.
/// </remarks>
/// <content>
/// Provides optimized overrides for bulk operations.
/// </content>
public partial struct RgbaVector
{
/// <summary>

11
src/ImageSharp/PixelFormats/RgbaVector.Definitions.cs

@ -5,14 +5,9 @@
namespace ImageSharp.PixelFormats
{
/// <summary>
/// Unpacked pixel type containing four 16-bit floating-point values typically ranging from 0 to 1.
/// The color components are stored in red, green, blue, and alpha order.
/// </summary>
/// <remarks>
/// This struct is fully mutable. This is done (against the guidelines) for the sake of performance,
/// as it avoids the need to create new values for modification operations.
/// </remarks>
/// <content>
/// Provides operators and composition algorithms.
/// </content>
public partial struct RgbaVector
{
/// <summary>

11
src/ImageSharp/PixelFormats/RgbaVector.Transforms.cs

@ -8,14 +8,9 @@ namespace ImageSharp.PixelFormats
using System.Numerics;
using System.Runtime.CompilerServices;
/// <summary>
/// Unpacked pixel type containing four 16-bit floating-point values typically ranging from 0 to 1.
/// The color components are stored in red, green, blue, and alpha order.
/// </summary>
/// <remarks>
/// This struct is fully mutable. This is done (against the guidelines) for the sake of performance,
/// as it avoids the need to create new values for modification operations.
/// </remarks>
/// <content>
/// Provides operators and composition algorithms.
/// </content>
public partial struct RgbaVector
{
/// <summary>

1
src/ImageSharp/PixelFormats/RgbaVector.cs

@ -11,6 +11,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Unpacked pixel type containing four 16-bit floating-point values typically ranging from 0 to 1.
/// The color components are stored in red, green, blue, and alpha order.
/// Ranges from &lt;0, 0, 0, 0&gt; to &lt;1, 1, 1, 1&gt; in vector form.
/// </summary>
/// <remarks>
/// This struct is fully mutable. This is done (against the guidelines) for the sake of performance,

1
src/ImageSharp/PixelFormats/Short2.cs

@ -11,6 +11,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing two 16-bit signed integer values.
/// Ranges from &lt;-32767, -32767, 0, 1&gt; to &lt;32767, 32767, 0, 1&gt; in vector form.
/// </summary>
public struct Short2 : IPixel<Short2>, IPackedVector<uint>
{

1
src/ImageSharp/PixelFormats/Short4.cs

@ -11,6 +11,7 @@ namespace ImageSharp.PixelFormats
/// <summary>
/// Packed pixel type containing four 16-bit signed integer values.
/// Ranges from &lt;-37267, -37267, -37267, -37267&gt; to &lt;37267, 37267, 37267, 37267&gt; in vector form.
/// </summary>
public struct Short4 : IPixel<Short4>, IPackedVector<ulong>
{

2
src/ImageSharp/PixelFormats/Vector4BlendTransforms.cs

@ -289,4 +289,4 @@ namespace ImageSharp.PixelFormats
return b + s - (2F * b * s);
}
}
}
}
Loading…
Cancel
Save