Struct Abgr32

Namespace

SixLabors.ImageSharp.PixelFormats

Assembly

SixLabors.ImageSharp.dll

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).

Ranges from [0, 0, 0, 0] to [1, 1, 1, 1] in vector form.

public struct Abgr32 : IPixel<Abgr32>, IEquatable<Abgr32>, IPackedVector<uint>, IPixel

Implements

IPixel<Abgr32>

IEquatable<Abgr32>

IPackedVector<uint>

IPixel

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

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.

Constructors

Abgr32(byte, byte, byte)

Initializes a new instance of the Abgr32 struct.

public Abgr32(byte r, byte g, byte b)

Parameters

r byte

The red component.

g byte

The green component.

b byte

The blue component.

Abgr32(byte, byte, byte, byte)

Initializes a new instance of the Abgr32 struct.

public Abgr32(byte r, byte g, byte b, byte a)

Parameters

r byte

The red component.

g byte

The green component.

b byte

The blue component.

a byte

The alpha component.

Abgr32(Vector3)

Initializes a new instance of the Abgr32 struct.

public Abgr32(Vector3 vector)

Parameters

vector Vector3

The vector containing the components for the packed vector.

Abgr32(Vector4)

Initializes a new instance of the Abgr32 struct.

public Abgr32(Vector4 vector)

Parameters

vector Vector4

The vector containing the components for the packed vector.

Abgr32(float, float, float, float)

Initializes a new instance of the Abgr32 struct.

public Abgr32(float r, float g, float b, float a = 1)

Parameters

r float

The red component.

g float

The green component.

b float

The blue component.

a float

The alpha component.

Abgr32(uint)

Initializes a new instance of the Abgr32 struct.

public Abgr32(uint packed)

Parameters

packed uint

The packed value.

Fields

A

Gets or sets the alpha component.

public byte A

Field Value

byte

B

Gets or sets the blue component.

public byte B

Field Value

byte

G

Gets or sets the green component.

public byte G

Field Value

byte

R

Gets or sets the red component.

public byte R

Field Value

byte

Properties

Abgr

Gets or sets the packed representation of the Abgrb32 struct.

public uint Abgr { readonly get; set; }

Property Value

uint

PackedValue

Gets or sets the packed representation of the value.

public uint PackedValue { readonly get; set; }

Property Value

uint

Methods

CreatePixelOperations()

Creates a PixelOperations<TPixel> instance for this pixel type. This method is not intended to be consumed directly. Use Instance instead.

public readonly PixelOperations<Abgr32> CreatePixelOperations()

Returns

PixelOperations<Abgr32>

The PixelOperations<TPixel> instance.

Equals(Abgr32)

public readonly bool Equals(Abgr32 other)

Parameters

other Abgr32

Returns

bool

Equals(object?)

public override readonly bool Equals(object? obj)

Parameters

obj object

Returns

bool

FromAbgr32(Abgr32)

Initializes the pixel instance from an Abgr32 value.

public void FromAbgr32(Abgr32 source)

Parameters

source Abgr32

The Abgr32 value.

FromArgb32(Argb32)

Initializes the pixel instance from an Argb32 value.

public void FromArgb32(Argb32 source)

Parameters

source Argb32

The Argb32 value.

FromBgr24(Bgr24)

Initializes the pixel instance from an Bgr24 value.

public void FromBgr24(Bgr24 source)

Parameters

source Bgr24

The Bgr24 value.

FromBgra32(Bgra32)

Initializes the pixel instance from an Bgra32 value.

public void FromBgra32(Bgra32 source)

Parameters

source Bgra32

The Bgra32 value.

FromBgra5551(Bgra5551)

Initializes the pixel instance from an Bgra5551 value.

public void FromBgra5551(Bgra5551 source)

Parameters

source Bgra5551

The Bgra5551 value.

FromL16(L16)

Initializes the pixel instance from an L16 value.

public void FromL16(L16 source)

Parameters

source L16

The L16 value.

FromL8(L8)

Initializes the pixel instance from an L8 value.

public void FromL8(L8 source)

Parameters

source L8

The L8 value.

FromLa16(La16)

Initializes the pixel instance from an La16 value.

public void FromLa16(La16 source)

Parameters

source La16

The La16 value.

FromLa32(La32)

Initializes the pixel instance from an La32 value.

public void FromLa32(La32 source)

Parameters

source La32

The La32 value.

FromRgb24(Rgb24)

Initializes the pixel instance from an Rgb24 value.

public void FromRgb24(Rgb24 source)

Parameters

source Rgb24

The Rgb24 value.

FromRgb48(Rgb48)

Initializes the pixel instance from an Rgb48 value.

public void FromRgb48(Rgb48 source)

Parameters

source Rgb48

The Rgb48 value.

FromRgba32(Rgba32)

Initializes the pixel instance from an Rgba32 value.

public void FromRgba32(Rgba32 source)

Parameters

source Rgba32

The Rgba32 value.

FromRgba64(Rgba64)

Initializes the pixel instance from an Rgba64 value.

public void FromRgba64(Rgba64 source)

Parameters

source Rgba64

The Rgba64 value.

FromScaledVector4(Vector4)

Initializes the pixel instance from a generic ("scaled") Vector4.

public void FromScaledVector4(Vector4 vector)

Parameters

vector Vector4

The vector to load the pixel from.

FromVector4(Vector4)

Initializes the pixel instance from a Vector4 which is specific to the current pixel type.

public void FromVector4(Vector4 vector)

Parameters

vector Vector4

The vector to load the pixel from.

GetHashCode()

public override readonly int GetHashCode()

Returns

int

ToRgba32(ref Rgba32)

Convert the pixel instance into Rgba32 representation.

public void ToRgba32(ref Rgba32 dest)

Parameters

dest Rgba32

The reference to the destination Rgba32 pixel

ToScaledVector4()

Expands the pixel into a generic ("scaled") Vector4 representation with values scaled and clamped between 0 and 1. The vector components are typically expanded in least to greatest significance order.

public readonly Vector4 ToScaledVector4()

Returns

Vector4

The Vector4.

ToString()

Gets a string representation of the packed vector.

public override readonly string ToString()

Returns

string

A string representation of the packed vector.

ToVector4()

Expands the pixel into a Vector4 which is specific to the current pixel type. The vector components are typically expanded in least to greatest significance order.

public readonly Vector4 ToVector4()

Returns

Vector4

The Vector4.

Operators

operator ==(Abgr32, Abgr32)

Compares two Argb32 objects for equality.

public static bool operator ==(Abgr32 left, Abgr32 right)

Parameters

left Abgr32

The Abgr32 on the left side of the operand.

right Abgr32

The Abgr32 on the right side of the operand.

Returns

bool

True if the left parameter is equal to the right parameter; otherwise, false.

implicit operator Abgr32(Color)

Converts a Color to Abgr32.

public static implicit operator Abgr32(Color color)

Parameters

color Color

The Color.

Returns

Abgr32

The Abgr32.

implicit operator Color(Abgr32)

Converts an Abgr32 to Color.

public static implicit operator Color(Abgr32 source)

Parameters

source Abgr32

The Abgr32.

Returns

Color

The Color.

operator !=(Abgr32, Abgr32)

Compares two Abgr32 objects for equality.

public static bool operator !=(Abgr32 left, Abgr32 right)

Parameters

left Abgr32

The Abgr32 on the left side of the operand.

right Abgr32

The Abgr32 on the right side of the operand.

Returns

bool

True if the left parameter is not equal to the right parameter; otherwise, false.