Struct Argb32

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.

Implements

IPixel<Argb32>

IEquatable<Argb32>

IPackedVector<UInt32>

IPixel

Inherited Members

Object.Equals(Object, Object)

Object.GetType()

Object.ReferenceEquals(Object, Object)

Namespace: SixLabors.ImageSharp.PixelFormats

Assembly: SixLabors.ImageSharp.dll

Syntax

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

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

| Improve this Doc View Source

Argb32(Byte, Byte, Byte)

Initializes a new instance of the Argb32 struct.

Declaration

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

Parameters

Type	Name	Description
Byte	r	The red component.
Byte	g	The green component.
Byte	b	The blue component.

| Improve this Doc View Source

Argb32(Byte, Byte, Byte, Byte)

Initializes a new instance of the Argb32 struct.

Declaration

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

Parameters

Type	Name	Description
Byte	r	The red component.
Byte	g	The green component.
Byte	b	The blue component.
Byte	a	The alpha component.

| Improve this Doc View Source

Argb32(Vector3)

Initializes a new instance of the Argb32 struct.

Declaration

public Argb32(Vector3 vector)

Parameters

Type	Name	Description
Vector3	vector	The vector containing the components for the packed vector.

| Improve this Doc View Source

Argb32(Vector4)

Initializes a new instance of the Argb32 struct.

Declaration

public Argb32(Vector4 vector)

Parameters

Type	Name	Description
Vector4	vector	The vector containing the components for the packed vector.

| Improve this Doc View Source

Argb32(Single, Single, Single, Single)

Initializes a new instance of the Argb32 struct.

Declaration

public Argb32(float r, float g, float b, float a = 1F)

Parameters

Type	Name	Description
Single	r	The red component.
Single	g	The green component.
Single	b	The blue component.
Single	a	The alpha component.

| Improve this Doc View Source

Argb32(UInt32)

Initializes a new instance of the Argb32 struct.

Declaration

public Argb32(uint packed)

Parameters

Type	Name	Description
UInt32	packed	The packed value.

Fields

| Improve this Doc View Source

A

Gets or sets the alpha component.

Declaration

public byte A

Field Value

Type	Description
Byte

| Improve this Doc View Source

B

Gets or sets the blue component.

Declaration

public byte B

Field Value

Type	Description
Byte

| Improve this Doc View Source

G

Gets or sets the green component.

Declaration

public byte G

Field Value

Type	Description
Byte

| Improve this Doc View Source

R

Gets or sets the red component.

Declaration

public byte R

Field Value

Type	Description
Byte

Properties

| Improve this Doc View Source

Argb

Gets or sets the packed representation of the Argb32 struct.

Declaration

public uint Argb { readonly get; set; }

Property Value

Type	Description
UInt32

| Improve this Doc View Source

PackedValue

Gets or sets the packed representation of the value.

Declaration

public uint PackedValue { readonly get; set; }

Property Value

Type	Description
UInt32

Methods

| Improve this Doc View Source

CreatePixelOperations()

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

Declaration

public readonly PixelOperations<Argb32> CreatePixelOperations()

Returns

Type	Description
PixelOperations<Argb32>	The PixelOperations<TPixel> instance.

| Improve this Doc View Source

Equals(Argb32)

Declaration

public readonly bool Equals(Argb32 other)

Parameters

Type	Name	Description
Argb32	other

Returns

Type	Description
Boolean

| Improve this Doc View Source

Equals(Object)

Declaration

public override readonly bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

ValueType.Equals(Object)

| Improve this Doc View Source

FromAbgr32(Abgr32)

Initializes the pixel instance from an Abgr32 value.

Declaration

public void FromAbgr32(Abgr32 source)

Parameters

Type	Name	Description
Abgr32	source	The Abgr32 value.

| Improve this Doc View Source

FromArgb32(Argb32)

Initializes the pixel instance from an Argb32 value.

Declaration

public void FromArgb32(Argb32 source)

Parameters

Type	Name	Description
Argb32	source	The Argb32 value.

| Improve this Doc View Source

FromBgr24(Bgr24)

Initializes the pixel instance from an Bgr24 value.

Declaration

public void FromBgr24(Bgr24 source)

Parameters

Type	Name	Description
Bgr24	source	The Bgr24 value.

| Improve this Doc View Source

FromBgra32(Bgra32)

Initializes the pixel instance from an Bgra32 value.

Declaration

public void FromBgra32(Bgra32 source)

Parameters

Type	Name	Description
Bgra32	source	The Bgra32 value.

| Improve this Doc View Source

FromBgra5551(Bgra5551)

Initializes the pixel instance from an Bgra5551 value.

Declaration

public void FromBgra5551(Bgra5551 source)

Parameters

Type	Name	Description
Bgra5551	source	The Bgra5551 value.

| Improve this Doc View Source

FromL16(L16)

Initializes the pixel instance from an L16 value.

Declaration

public void FromL16(L16 source)

Parameters

Type	Name	Description
L16	source	The L16 value.

| Improve this Doc View Source

FromL8(L8)

Initializes the pixel instance from an L8 value.

Declaration

public void FromL8(L8 source)

Parameters

Type	Name	Description
L8	source	The L8 value.

| Improve this Doc View Source

FromLa16(La16)

Initializes the pixel instance from an La16 value.

Declaration

public void FromLa16(La16 source)

Parameters

Type	Name	Description
La16	source	The La16 value.

| Improve this Doc View Source

FromLa32(La32)

Initializes the pixel instance from an La32 value.

Declaration

public void FromLa32(La32 source)

Parameters

Type	Name	Description
La32	source	The La32 value.

| Improve this Doc View Source

FromRgb24(Rgb24)

Initializes the pixel instance from an Rgb24 value.

Declaration

public void FromRgb24(Rgb24 source)

Parameters

Type	Name	Description
Rgb24	source	The Rgb24 value.

| Improve this Doc View Source

FromRgb48(Rgb48)

Initializes the pixel instance from an Rgb48 value.

Declaration

public void FromRgb48(Rgb48 source)

Parameters

Type	Name	Description
Rgb48	source	The Rgb48 value.

| Improve this Doc View Source

FromRgba32(Rgba32)

Initializes the pixel instance from an Rgba32 value.

Declaration

public void FromRgba32(Rgba32 source)

Parameters

Type	Name	Description
Rgba32	source	The Rgba32 value.

| Improve this Doc View Source

FromRgba64(Rgba64)

Initializes the pixel instance from an Rgba64 value.

Declaration

public void FromRgba64(Rgba64 source)

Parameters

Type	Name	Description
Rgba64	source	The Rgba64 value.

| Improve this Doc View Source

FromScaledVector4(Vector4)

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

Declaration

public void FromScaledVector4(Vector4 vector)

Parameters

Type	Name	Description
Vector4	vector	The vector to load the pixel from.

| Improve this Doc View Source

FromVector4(Vector4)

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

Declaration

public void FromVector4(Vector4 vector)

Parameters

Type	Name	Description
Vector4	vector	The vector to load the pixel from.

| Improve this Doc View Source

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
Int32

Overrides

ValueType.GetHashCode()

| Improve this Doc View Source

ToRgba32(ref Rgba32)

Convert the pixel instance into Rgba32 representation.

Declaration

public void ToRgba32(ref Rgba32 dest)

Parameters

Type	Name	Description
Rgba32	dest	The reference to the destination Rgba32 pixel

| Improve this Doc View Source

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.

Declaration

public readonly Vector4 ToScaledVector4()

Returns

Type	Description
Vector4	The Vector4.

| Improve this Doc View Source

ToString()

Gets a string representation of the packed vector.

Declaration

public override readonly string ToString()

Returns

Type	Description
String	A string representation of the packed vector.

Overrides

ValueType.ToString()

| Improve this Doc View Source

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.

Declaration

public readonly Vector4 ToVector4()

Returns

Type	Description
Vector4	The Vector4.

Operators

| Improve this Doc View Source

Equality(Argb32, Argb32)

Compares two Argb32 objects for equality.

Declaration

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

Parameters

Type	Name	Description
Argb32	left	The Argb32 on the left side of the operand.
Argb32	right	The Argb32 on the right side of the operand.

Returns

Type	Description
Boolean	True if the `left` parameter is equal to the `right` parameter; otherwise, false.

| Improve this Doc View Source

Implicit(Color to Argb32)

Converts a Color to Argb32.

Declaration

public static implicit operator Argb32(Color color)

Parameters

Type	Name	Description
Color	color	The Color.

Returns

Type	Description
Argb32	The Argb32.

| Improve this Doc View Source

Implicit(Argb32 to Color)

Converts an Argb32 to Color.

Declaration

public static implicit operator Color(Argb32 source)

Parameters

Type	Name	Description
Argb32	source	The Argb32.

Returns

Type	Description
Color	The Color.

| Improve this Doc View Source

Inequality(Argb32, Argb32)

Compares two Argb32 objects for equality.

Declaration

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

Parameters

Type	Name	Description
Argb32	left	The Argb32 on the left side of the operand.
Argb32	right	The Argb32 on the right side of the operand.

Returns

Type	Description
Boolean	True if the `left` parameter is not equal to the `right` parameter; otherwise, false.

Implements

IPixel<TSelf>

System.IEquatable<T>

IPackedVector<TPacked>

IPixel