Add Rgba64

src/ImageSharp/Colors/PackedPixel/Rgba64.cs

@@ -0,0 +1,170 @@
+// <copyright file="Rgba64.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 16-bit unsigned normalized values ranging from 0 to 1.
+    /// </summary>
+    public struct Rgba64 : IPackedPixel<ulong>, IEquatable<Rgba64>, IPackedVector
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Rgba64"/> struct. 
+        /// </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>
+        public Rgba64(float x, float y, float z, float w)
+        {
+            this.PackedValue = Pack(x, y, z, w);
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Rgba64"/> struct. 
+        /// </summary>
+        /// <param name="vector">The vector containing the components values.</param>
+        public Rgba64(Vector4 vector)
+        {
+            this.PackedValue = Pack(vector.X, vector.Y, vector.Z, vector.W);
+        }
+
+        /// <inheritdoc />
+        public ulong PackedValue { get; set; }
+
+        /// <summary>
+        /// Compares two <see cref="Rgba64"/> objects for equality.
+        /// </summary>
+        /// <param name="left">
+        /// The <see cref="Rgba64"/> on the left side of the operand.
+        /// </param>
+        /// <param name="right">
+        /// The <see cref="Rgba64"/> 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 ==(Rgba64 left, Rgba64 right)
+        {
+            return left.PackedValue == right.PackedValue;
+        }
+
+        /// <summary>
+        /// Compares two <see cref="Rgba64"/> objects for equality.
+        /// </summary>
+        /// <param name="left">
+        /// The <see cref="Rgba64"/> on the left side of the operand.
+        /// </param>
+        /// <param name="right">
+        /// The <see cref="Rgba64"/> 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 !=(Rgba64 left, Rgba64 right)
+        {
+            return left.PackedValue != right.PackedValue;
+        }
+
+        /// <inheritdoc />
+        public Vector4 ToVector4()
+        {
+            return new Vector4(
+                (this.PackedValue & 0xFFFF) / 65535F,
+                ((this.PackedValue >> 16) & 0xFFFF) / 65535F,
+                ((this.PackedValue >> 32) & 0xFFFF) / 65535F,
+                ((this.PackedValue >> 48) & 0xFFFF) / 65535F);
+        }
+
+        /// <inheritdoc />
+        public void PackFromVector4(Vector4 vector)
+        {
+            this.PackedValue = Pack(vector.X, vector.Y, vector.Z, vector.W);
+        }
+
+        /// <inheritdoc />
+        public void PackFromBytes(byte x, byte y, byte z, byte w)
+        {
+            this.PackFromVector4(new Vector4(x, y, z, w) / 255F);
+        }
+
+        /// <inheritdoc />
+        public void ToBytes(byte[] bytes, int startIndex, ComponentOrder componentOrder)
+        {
+            Vector4 vector = this.ToVector4() * 255F;
+
+            switch (componentOrder)
+            {
+                case ComponentOrder.ZYX:
+                    bytes[startIndex] = (byte)(float)Math.Round(vector.Z);
+                    bytes[startIndex + 1] = (byte)(float)Math.Round(vector.Y);
+                    bytes[startIndex + 2] = (byte)(float)Math.Round(vector.X);
+                    break;
+                case ComponentOrder.ZYXW:
+                    bytes[startIndex] = (byte)(float)Math.Round(vector.Z);
+                    bytes[startIndex + 1] = (byte)(float)Math.Round(vector.Y);
+                    bytes[startIndex + 2] = (byte)(float)Math.Round(vector.X);
+                    bytes[startIndex + 3] = (byte)(float)Math.Round(vector.W);
+                    break;
+                case ComponentOrder.XYZ:
+                    bytes[startIndex] = (byte)(float)Math.Round(vector.X);
+                    bytes[startIndex + 1] = (byte)(float)Math.Round(vector.Y);
+                    bytes[startIndex + 2] = (byte)(float)Math.Round(vector.Z);
+                    break;
+                case ComponentOrder.XYZW:
+                    bytes[startIndex] = (byte)(float)Math.Round(vector.X);
+                    bytes[startIndex + 1] = (byte)(float)Math.Round(vector.Y);
+                    bytes[startIndex + 2] = (byte)(float)Math.Round(vector.Z);
+                    bytes[startIndex + 3] = (byte)(float)Math.Round(vector.W);
+                    break;
+                default:
+                    throw new NotSupportedException();
+            }
+        }
+
+        /// <inheritdoc />
+        public override bool Equals(object obj)
+        {
+            return (obj is Rgba64) && this.Equals((Rgba64)obj);
+        }
+
+        /// <inheritdoc />
+        public bool Equals(Rgba64 other)
+        {
+            return this.PackedValue == other.PackedValue;
+        }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return this.ToVector4().ToString();
+        }
+
+        /// <inheritdoc />
+        public override int GetHashCode()
+        {
+            return this.PackedValue.GetHashCode();
+        }
+
+        /// <summary>
+        /// Packs the <see cref="float"/> components into a <see cref="ulong"/>.
+        /// </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="ulong"/> containing the packed values.</returns>
+        private static ulong Pack(float x, float y, float z, float w)
+        {
+            return (ulong)Math.Round(x.Clamp(0, 1) * 65535F) |
+                   ((ulong)Math.Round(y.Clamp(0, 1) * 65535F) << 16) |
+                   ((ulong)Math.Round(z.Clamp(0, 1) * 65535F) << 32) |
+                   ((ulong)Math.Round(w.Clamp(0, 1) * 65535F) << 48);
+        }
+    }
+}

tests/ImageSharp.Tests/Colors/PackedPixelTests.cs

@@ -657,6 +657,54 @@ namespace ImageSharp.Tests.Colors
             Assert.Equal(rgba, new byte[] { 25, 0, 128, 0 });
         }
 
+        [Fact]
+        public void Rgba64()
+        {
+            // Test the limits.
+            Assert.Equal((ulong)0x0, new Rgba64(Vector4.Zero).PackedValue);
+            Assert.Equal(0xFFFFFFFFFFFFFFFF, new Rgba64(Vector4.One).PackedValue);
+
+            // Test ToVector4
+            Assert.True(Equal(Vector4.Zero, new Rgba64(Vector4.Zero).ToVector4()));
+            Assert.True(Equal(Vector4.One, new Rgba64(Vector4.One).ToVector4()));
+
+            // Test clamping.
+            Assert.True(Equal(Vector4.Zero, new Rgba64(Vector4.One * -1234.0f).ToVector4()));
+            Assert.True(Equal(Vector4.One, new Rgba64(Vector4.One * 1234.0f).ToVector4()));
+
+            // Test data ordering
+            Assert.Equal(0xC7AD8F5C570A1EB8, new Rgba64(((float)0x1EB8) / 0xffff, ((float)0x570A) / 0xffff, ((float)0x8F5C) / 0xffff, ((float)0xC7AD) / 0xffff).PackedValue);
+            Assert.Equal(0xC7AD8F5C570A1EB8, new Rgba64(0.12f, 0.34f, 0.56f, 0.78f).PackedValue);
+
+            float x = 0.08f;
+            float y = 0.15f;
+            float z = 0.30f;
+            float w = 0.45f;
+            Assert.Equal((ulong)0x73334CCC2666147B, new Rgba64(x, y, z, w).PackedValue);
+
+            byte[] rgb = new byte[3];
+            byte[] rgba = new byte[4];
+            byte[] bgr = new byte[3];
+            byte[] bgra = new byte[4];
+
+            new Rgba64(x, y, z, w).ToBytes(rgb, 0, ComponentOrder.XYZ);
+            Assert.Equal(rgb, new byte[] { 20, 38, 76 });
+
+            new Rgba64(x, y, z, w).ToBytes(rgba, 0, ComponentOrder.XYZW);
+            Assert.Equal(rgba, new byte[] { 20, 38, 76, 115 });
+
+            new Rgba64(x, y, z, w).ToBytes(bgr, 0, ComponentOrder.ZYX);
+            Assert.Equal(bgr, new byte[] { 76, 38, 20 });
+
+            new Rgba64(x, y, z, w).ToBytes(bgra, 0, ComponentOrder.ZYXW);
+            Assert.Equal(bgra, new byte[] { 76, 38, 20, 115 });
+
+            Rgba64 r = new Rgba64();
+            r.PackFromBytes(20, 38, 76, 115);
+            r.ToBytes(rgba, 0, ComponentOrder.XYZW);
+            Assert.Equal(rgba, new byte[] { 20, 38, 76, 115 });
+        }
+
         // Comparison helpers with small tolerance to allow for floating point rounding during computations.
         public static bool Equal(float a, float b)
         {

tests/ImageSharp.Tests/Formats/GeneralFormatTests.cs

@@ -63,6 +63,7 @@ namespace ImageSharp.Tests
                 // Image<HalfVector4, ulong> image = file.CreateImage().To<HalfVector4, ulong>();
                 // Image<Rg32, uint> image = file.CreateImage().To<Rg32, uint>();
                 // Image<Rgba1010102, uint> image = file.CreateImage().To<Rgba1010102, uint>();
+                // Image<Rgba64, ulong> image = file.CreateImage().To<Rgba64, ulong>();
 
                 // TODO: Conversion between types who's vector ranges are different are not possible without scaling function, Make static version of known ones.
                 // Image<NormalizedByte2, ushort> image = file.CreateImage().To<NormalizedByte2, ushort>(v => (2F * v) - Vector4.One);