mirror of https://github.com/SixLabors/ImageSharp
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
340 lines
12 KiB
340 lines
12 KiB
// Copyright (c) Six Labors and contributors.
|
|
// Licensed under the Apache License, Version 2.0.
|
|
|
|
using System.Numerics;
|
|
using System.Runtime.CompilerServices;
|
|
using System.Runtime.InteropServices;
|
|
|
|
namespace SixLabors.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 (least significant to most significant byte).
|
|
/// <para>
|
|
/// Ranges from [0, 0, 0, 0] to [1, 1, 1, 1] in vector form.
|
|
/// </para>
|
|
/// </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>
|
|
[StructLayout(LayoutKind.Sequential)]
|
|
public partial struct Argb32 : IPixel<Argb32>, IPackedVector<uint>
|
|
{
|
|
/// <summary>
|
|
/// Gets or sets the alpha component.
|
|
/// </summary>
|
|
public byte A;
|
|
|
|
/// <summary>
|
|
/// Gets or sets the red component.
|
|
/// </summary>
|
|
public byte R;
|
|
|
|
/// <summary>
|
|
/// Gets or sets the green component.
|
|
/// </summary>
|
|
public byte G;
|
|
|
|
/// <summary>
|
|
/// Gets or sets the blue component.
|
|
/// </summary>
|
|
public byte B;
|
|
|
|
/// <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="Argb32"/> struct.
|
|
/// </summary>
|
|
/// <param name="r">The red component.</param>
|
|
/// <param name="g">The green component.</param>
|
|
/// <param name="b">The blue component.</param>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public Argb32(byte r, byte g, byte b)
|
|
{
|
|
this.R = r;
|
|
this.G = g;
|
|
this.B = b;
|
|
this.A = byte.MaxValue;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="Argb32"/> 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>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public Argb32(byte r, byte g, byte b, byte a)
|
|
{
|
|
this.R = r;
|
|
this.G = g;
|
|
this.B = b;
|
|
this.A = a;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="Argb32"/> 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>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public Argb32(float r, float g, float b, float a = 1)
|
|
: this() => this.Pack(r, g, b, a);
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="Argb32"/> struct.
|
|
/// </summary>
|
|
/// <param name="vector">
|
|
/// The vector containing the components for the packed vector.
|
|
/// </param>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public Argb32(Vector3 vector)
|
|
: this() => this.Pack(ref vector);
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="Argb32"/> struct.
|
|
/// </summary>
|
|
/// <param name="vector">
|
|
/// The vector containing the components for the packed vector.
|
|
/// </param>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public Argb32(Vector4 vector)
|
|
: this() => this.Pack(ref vector);
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="Argb32"/> struct.
|
|
/// </summary>
|
|
/// <param name="packed">
|
|
/// The packed value.
|
|
/// </param>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public Argb32(uint packed)
|
|
: this() => this.Argb = packed;
|
|
|
|
/// <summary>
|
|
/// Gets or sets the packed representation of the Argb32 struct.
|
|
/// </summary>
|
|
public uint Argb
|
|
{
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
get => Unsafe.As<Argb32, uint>(ref this);
|
|
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
set => Unsafe.As<Argb32, uint>(ref this) = value;
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public uint PackedValue
|
|
{
|
|
get => this.Argb;
|
|
set => this.Argb = value;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Compares two <see cref="Argb32"/> objects for equality.
|
|
/// </summary>
|
|
/// <param name="left">The <see cref="Argb32"/> on the left side of the operand.</param>
|
|
/// <param name="right">The <see cref="Argb32"/> 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>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public static bool operator ==(Argb32 left, Argb32 right) => left.Equals(right);
|
|
|
|
/// <summary>
|
|
/// Compares two <see cref="Argb32"/> objects for equality.
|
|
/// </summary>
|
|
/// <param name="left">The <see cref="Argb32"/> on the left side of the operand.</param>
|
|
/// <param name="right">The <see cref="Argb32"/> 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>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public static bool operator !=(Argb32 left, Argb32 right) => !left.Equals(right);
|
|
|
|
/// <inheritdoc />
|
|
public PixelOperations<Argb32> CreatePixelOperations() => new PixelOperations();
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public void FromScaledVector4(Vector4 vector) => this.FromVector4(vector);
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public Vector4 ToScaledVector4() => this.ToVector4();
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public void FromVector4(Vector4 vector) => this.Pack(ref vector);
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public Vector4 ToVector4() => new Vector4(this.R, this.G, this.B, this.A) / MaxBytes;
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public void FromArgb32(Argb32 source) => this.PackedValue = source.PackedValue;
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public void FromBgr24(Bgr24 source)
|
|
{
|
|
this.R = source.R;
|
|
this.G = source.G;
|
|
this.B = source.B;
|
|
this.A = byte.MaxValue;
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public void FromBgra32(Bgra32 source)
|
|
{
|
|
this.R = source.R;
|
|
this.G = source.G;
|
|
this.B = source.B;
|
|
this.A = source.A;
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public void FromGray8(Gray8 source)
|
|
{
|
|
this.R = source.PackedValue;
|
|
this.G = source.PackedValue;
|
|
this.B = source.PackedValue;
|
|
this.A = byte.MaxValue;
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public void FromGray16(Gray16 source)
|
|
{
|
|
byte rgb = ImageMaths.DownScaleFrom16BitTo8Bit(source.PackedValue);
|
|
this.R = rgb;
|
|
this.G = rgb;
|
|
this.B = rgb;
|
|
this.A = byte.MaxValue;
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public void FromRgb24(Rgb24 source)
|
|
{
|
|
this.R = source.R;
|
|
this.G = source.G;
|
|
this.B = source.B;
|
|
this.A = byte.MaxValue;
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public void FromRgba32(Rgba32 source)
|
|
{
|
|
this.R = source.R;
|
|
this.G = source.G;
|
|
this.B = source.B;
|
|
this.A = source.A;
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public void ToRgba32(ref Rgba32 dest)
|
|
{
|
|
dest.R = this.R;
|
|
dest.G = this.G;
|
|
dest.B = this.B;
|
|
dest.A = this.A;
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public void FromRgb48(Rgb48 source)
|
|
{
|
|
this.R = ImageMaths.DownScaleFrom16BitTo8Bit(source.R);
|
|
this.G = ImageMaths.DownScaleFrom16BitTo8Bit(source.G);
|
|
this.B = ImageMaths.DownScaleFrom16BitTo8Bit(source.B);
|
|
this.A = byte.MaxValue;
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public void FromRgba64(Rgba64 source)
|
|
{
|
|
this.R = ImageMaths.DownScaleFrom16BitTo8Bit(source.R);
|
|
this.G = ImageMaths.DownScaleFrom16BitTo8Bit(source.G);
|
|
this.B = ImageMaths.DownScaleFrom16BitTo8Bit(source.B);
|
|
this.A = ImageMaths.DownScaleFrom16BitTo8Bit(source.A);
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public override bool Equals(object obj) => obj is Argb32 argb32 && this.Equals(argb32);
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public bool Equals(Argb32 other) => this.Argb == other.Argb;
|
|
|
|
/// <summary>
|
|
/// Gets a string representation of the packed vector.
|
|
/// </summary>
|
|
/// <returns>A string representation of the packed vector.</returns>
|
|
public override string ToString() => $"Argb({this.A}, {this.R}, {this.G}, {this.B})";
|
|
|
|
/// <inheritdoc/>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
public override int GetHashCode() => this.Argb.GetHashCode();
|
|
|
|
/// <summary>
|
|
/// Packs the four floats into a color.
|
|
/// </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>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
private void Pack(float x, float y, float z, float w)
|
|
{
|
|
var value = new Vector4(x, y, z, w);
|
|
this.Pack(ref value);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Packs a <see cref="Vector3"/> into a uint.
|
|
/// </summary>
|
|
/// <param name="vector">The vector containing the values to pack.</param>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
private void Pack(ref Vector3 vector)
|
|
{
|
|
var value = new Vector4(vector, 1);
|
|
this.Pack(ref value);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Packs a <see cref="Vector4"/> into a color.
|
|
/// </summary>
|
|
/// <param name="vector">The vector containing the values to pack.</param>
|
|
[MethodImpl(InliningOptions.ShortMethod)]
|
|
private void Pack(ref Vector4 vector)
|
|
{
|
|
vector *= MaxBytes;
|
|
vector += Half;
|
|
vector = Vector4.Clamp(vector, Vector4.Zero, MaxBytes);
|
|
|
|
this.R = (byte)vector.X;
|
|
this.G = (byte)vector.Y;
|
|
this.B = (byte)vector.Z;
|
|
this.A = (byte)vector.W;
|
|
}
|
|
}
|
|
}
|