Merge branch 'refs/heads/pr/33'

9 years ago · c3a7777aaa
4 changed files with 377 additions and 0 deletions
--- a/.editorconfig
+++ b/.editorconfig
@ -0,0 +1,3 @@
+[*.cs]
+indent_style = space
+indent_size = 4
--- a/README.md
+++ b/README.md
@ -58,6 +58,7 @@ git clone https://github.com/JimBobSquarePants/ImageSharp
 - [x] YCbCr
 - IPackedPixel\<TPacked\> representations of color models. Compatible with Microsoft XNA Game Studio and MonoGame.
 - [x] Alpha8 
+ - [x] Argb 
 - [x] Bgr565 
 - [x] Bgra444 
 - [x] Bgra565 
--- a/src/ImageSharp/Colors/PackedPixel/Argb.cs
+++ b/src/ImageSharp/Colors/PackedPixel/Argb.cs
@ -0,0 +1,328 @@
+// <copyright file="Argb.cs" company="James Jackson-South">
+// Copyright (c) James Jackson-South and contributors.
+// Licensed under the Apache License, Version 2.0.
+// </copyright>
+
+namespace ImageSharp
+{
+    using System;
+    using System.Numerics;
+
+    /// <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.
+    /// </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>
+    public struct Argb : IPackedPixel<uint>, IEquatable<Argb>
+    {
+        /// <summary>
+        /// The shift count for the blue component
+        /// </summary>
+        private const int BlueShift = 0;
+
+        /// <summary>
+        /// The shift count for the green component
+        /// </summary>
+        private const int GreenShift = 8;
+
+        /// <summary>
+        /// The shift count for the red component
+        /// </summary>
+        private const int RedShift = 16;
+
+        /// <summary>
+        /// The shift count for the alpha component
+        /// </summary>
+        private const int AlphaShift = 24;
+
+        /// <summary>
+        /// The maximum byte value.
+        /// </summary>
+        private static readonly Vector4 MaxBytes = new Vector4(255);
+
+        /// <summary>
+        /// The half vector value.
+        /// </summary>
+        private static readonly Vector4 Half = new Vector4(0.5F);
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Argb"/> struct.
+        /// </summary>
+        /// <param name="r">The red component.</param>
+        /// <param name="g">The green component.</param>
+        /// <param name="b">The blue component.</param>
+        /// <param name="a">The alpha component.</param>
+        public Argb(byte r, byte g, byte b, byte a = 255)
+        {
+            this.PackedValue = Pack(r, g, b, a);
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Argb"/> struct.
+        /// </summary>
+        /// <param name="r">The red component.</param>
+        /// <param name="g">The green component.</param>
+        /// <param name="b">The blue component.</param>
+        /// <param name="a">The alpha component.</param>
+        public Argb(float r, float g, float b, float a = 1)
+        {
+            this.PackedValue = Pack(r, g, b, a);
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Argb"/> struct.
+        /// </summary>
+        /// <param name="vector">
+        /// The vector containing the components for the packed vector.
+        /// </param>
+        public Argb(Vector3 vector)
+        {
+            this.PackedValue = Pack(ref vector);
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Argb"/> struct.
+        /// </summary>
+        /// <param name="vector">
+        /// The vector containing the components for the packed vector.
+        /// </param>
+        public Argb(Vector4 vector)
+        {
+            this.PackedValue = Pack(ref vector);
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Argb"/> struct.
+        /// </summary>
+        /// <param name="packed">
+        /// The packed value.
+        /// </param>
+        public Argb(uint packed = 0)
+        {
+            this.PackedValue = packed;
+        }
+
+        /// <inheritdoc/>
+        public uint PackedValue { get; set; }
+
+        /// <summary>
+        /// Gets or sets the red component.
+        /// </summary>
+        public byte R
+        {
+            get
+            {
+                return (byte)(this.PackedValue >> RedShift);
+            }
+
+            set
+            {
+                this.PackedValue = this.PackedValue & 0xFF00FFFF | (uint)value << RedShift;
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the green component.
+        /// </summary>
+        public byte G
+        {
+            get
+            {
+                return (byte)(this.PackedValue >> GreenShift);
+            }
+
+            set
+            {
+                this.PackedValue = this.PackedValue & 0xFFFF00FF | (uint)value << GreenShift;
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the blue component.
+        /// </summary>
+        public byte B
+        {
+            get
+            {
+                return (byte)(this.PackedValue >> BlueShift);
+            }
+
+            set
+            {
+                this.PackedValue = this.PackedValue & 0xFFFFFF00 | (uint)value << BlueShift;
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the alpha component.
+        /// </summary>
+        public byte A
+        {
+            get
+            {
+                return (byte)(this.PackedValue >> AlphaShift);
+            }
+
+            set
+            {
+                this.PackedValue = this.PackedValue & 0x00FFFFFF | (uint)value << AlphaShift;
+            }
+        }
+
+        /// <summary>
+        /// Compares two <see cref="Argb"/> objects for equality.
+        /// </summary>
+        /// <param name="left">
+        /// The <see cref="Argb"/> on the left side of the operand.
+        /// </param>
+        /// <param name="right">
+        /// The <see cref="Argb"/> on the right side of the operand.
+        /// </param>
+        /// <returns>
+        /// True if the <paramref name="left"/> parameter is equal to the <paramref name="right"/> parameter; otherwise, false.
+        /// </returns>
+        public static bool operator ==(Argb left, Argb right)
+        {
+            return left.PackedValue == right.PackedValue;
+        }
+
+        /// <summary>
+        /// Compares two <see cref="Argb"/> objects for equality.
+        /// </summary>
+        /// <param name="left">The <see cref="Argb"/> on the left side of the operand.</param>
+        /// <param name="right">The <see cref="Argb"/> on the right side of the operand.</param>
+        /// <returns>
+        /// True if the <paramref name="left"/> parameter is not equal to the <paramref name="right"/> parameter; otherwise, false.
+        /// </returns>
+        public static bool operator !=(Argb left, Argb right)
+        {
+            return left.PackedValue != right.PackedValue;
+        }
+
+        /// <inheritdoc/>
+        public void PackFromVector4(Vector4 vector)
+        {
+            this.PackedValue = Pack(ref vector);
+        }
+
+        /// <inheritdoc/>
+        public Vector4 ToVector4()
+        {
+            return new Vector4(this.R, this.G, this.B, this.A) / MaxBytes;
+        }
+
+        /// <inheritdoc/>
+        public void PackFromBytes(byte x, byte y, byte z, byte w)
+        {
+            this.PackedValue = Pack(x, y, z, w);
+        }
+
+        /// <inheritdoc/>
+        public void ToBytes(byte[] bytes, int startIndex, ComponentOrder componentOrder)
+        {
+            switch (componentOrder)
+            {
+                case ComponentOrder.ZYX:
+                    bytes[startIndex] = this.B;
+                    bytes[startIndex + 1] = this.G;
+                    bytes[startIndex + 2] = this.R;
+                    break;
+                case ComponentOrder.ZYXW:
+                    bytes[startIndex] = this.B;
+                    bytes[startIndex + 1] = this.G;
+                    bytes[startIndex + 2] = this.R;
+                    bytes[startIndex + 3] = this.A;
+                    break;
+                case ComponentOrder.XYZ:
+                    bytes[startIndex] = this.R;
+                    bytes[startIndex + 1] = this.G;
+                    bytes[startIndex + 2] = this.B;
+                    break;
+                case ComponentOrder.XYZW:
+                    bytes[startIndex] = this.R;
+                    bytes[startIndex + 1] = this.G;
+                    bytes[startIndex + 2] = this.B;
+                    bytes[startIndex + 3] = this.A;
+                    break;
+                default:
+                    throw new NotSupportedException();
+            }
+        }
+
+        /// <inheritdoc/>
+        public override bool Equals(object obj)
+        {
+            return obj is Argb && this.Equals((Argb)obj);
+        }
+
+        /// <inheritdoc/>
+        public bool Equals(Argb other)
+        {
+            return this.PackedValue == other.PackedValue;
+        }
+
+        /// <inheritdoc/>
+        public override int GetHashCode()
+        {
+            // ReSharper disable once NonReadonlyMemberInGetHashCode
+            return this.PackedValue.GetHashCode();
+        }
+
+        /// <summary>
+        /// Packs the four floats into a <see cref="uint"/>.
+        /// </summary>
+        /// <param name="x">The x-component</param>
+        /// <param name="y">The y-component</param>
+        /// <param name="z">The z-component</param>
+        /// <param name="w">The w-component</param>
+        /// <returns>The <see cref="uint"/></returns>
+        private static uint Pack(float x, float y, float z, float w)
+        {
+            var value = new Vector4(x, y, z, w);
+            return Pack(ref value);
+        }
+
+        /// <summary>
+        /// Packs the four floats into a <see cref="uint"/>.
+        /// </summary>
+        /// <param name="x">The x-component</param>
+        /// <param name="y">The y-component</param>
+        /// <param name="z">The z-component</param>
+        /// <param name="w">The w-component</param>
+        /// <returns>The <see cref="uint"/></returns>
+        private static uint Pack(byte x, byte y, byte z, byte w)
+        {
+            return (uint)(x << RedShift | y << GreenShift | z << BlueShift | w << AlphaShift);
+        }
+
+        /// <summary>
+        /// Packs a <see cref="Vector3"/> into a uint.
+        /// </summary>
+        /// <param name="vector">The vector containing the values to pack.</param>
+        /// <returns>The <see cref="uint"/> containing the packed values.</returns>
+        private static uint Pack(ref Vector3 vector)
+        {
+            var value = new Vector4(vector, 1);
+            return Pack(ref value);
+        }
+
+        /// <summary>
+        /// Packs a <see cref="Vector4"/> into a uint.
+        /// </summary>
+        /// <param name="vector">The vector containing the values to pack.</param>
+        /// <returns>The <see cref="uint"/> containing the packed values.</returns>
+        private static uint Pack(ref Vector4 vector)
+        {
+            vector = Vector4.Clamp(vector, Vector4.Zero, Vector4.One);
+            vector *= MaxBytes;
+            vector += Half;
+            return (uint)(((byte)vector.X << RedShift)
+                        | ((byte)vector.Y << GreenShift)
+                        | ((byte)vector.Z << BlueShift)
+                        | (byte)vector.W << AlphaShift);
+        }
+    }
+}
--- a/tests/ImageSharp.Tests/Colors/PackedPixelTests.cs
+++ b/tests/ImageSharp.Tests/Colors/PackedPixelTests.cs
@ -56,6 +56,51 @@ namespace ImageSharp.Tests.Colors
            Assert.Equal(bgra, new byte[] { 0, 0, 0, 128 });
        }

+        [Fact]
+        public void Argb()
+        {
+            // Test the limits.
+            Assert.Equal((uint)0x0, new Argb(Vector4.Zero).PackedValue);
+            Assert.Equal(0xFFFFFFFF, new Argb(Vector4.One).PackedValue);
+
+            // Test ToVector4.
+            Assert.True(Equal(Vector4.One, new Argb(Vector4.One).ToVector4()));
+            Assert.True(Equal(Vector4.Zero, new Argb(Vector4.Zero).ToVector4()));
+            Assert.True(Equal(Vector4.UnitX, new Argb(Vector4.UnitX).ToVector4()));
+            Assert.True(Equal(Vector4.UnitY, new Argb(Vector4.UnitY).ToVector4()));
+            Assert.True(Equal(Vector4.UnitZ, new Argb(Vector4.UnitZ).ToVector4()));
+            Assert.True(Equal(Vector4.UnitW, new Argb(Vector4.UnitW).ToVector4()));
+
+            // Test clamping.
+            Assert.True(Equal(Vector4.Zero, new Argb(Vector4.One * -1234.0f).ToVector4()));
+            Assert.True(Equal(Vector4.One, new Argb(Vector4.One * +1234.0f).ToVector4()));
+
+            float x = +0.1f;
+            float y = -0.3f;
+            float z = +0.5f;
+            float w = -0.7f;
+            Argb argb = new Argb(x, y, z, w);
+            Assert.Equal(0x001a0080u, argb.PackedValue);
+
+            // Test ordering
+            byte[] rgb = new byte[3];
+            byte[] rgba = new byte[4];
+            byte[] bgr = new byte[3];
+            byte[] bgra = new byte[4];
+
+            argb.ToBytes(rgb, 0, ComponentOrder.XYZ);
+            Assert.Equal(rgb, new byte[] { 0x1a, 0, 0x80 });
+
+            argb.ToBytes(rgba, 0, ComponentOrder.XYZW);
+            Assert.Equal(rgba, new byte[] { 0x1a, 0, 0x80, 0 });
+
+            argb.ToBytes(bgr, 0, ComponentOrder.ZYX);
+            Assert.Equal(bgr, new byte[] { 0x80, 0, 0x1a });
+
+            argb.ToBytes(bgra, 0, ComponentOrder.ZYXW);
+            Assert.Equal(bgra, new byte[] { 0x80, 0, 0x1a, 0 });
+        }
+
        [Fact]
        public void Bgr565()
        {