Struct Rgba32

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 red, green, blue, and alpha order (least significant to most significant byte).

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

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

Implements

IPixel<Rgba32>

IEquatable<Rgba32>

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

Rgba32(byte, byte, byte)

Initializes a new instance of the Rgba32 struct.

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

Parameters

r byte

The red component.

g byte

The green component.

b byte

The blue component.

Rgba32(byte, byte, byte, byte)

Initializes a new instance of the Rgba32 struct.

public Rgba32(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.

Rgba32(Vector3)

Initializes a new instance of the Rgba32 struct.

public Rgba32(Vector3 vector)

Parameters

vector Vector3

The vector containing the components for the packed vector.

Rgba32(Vector4)

Initializes a new instance of the Rgba32 struct.

public Rgba32(Vector4 vector)

Parameters

vector Vector4

The vector containing the components for the packed vector.

Rgba32(float, float, float, float)

Initializes a new instance of the Rgba32 struct.

public Rgba32(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.

Rgba32(uint)

Initializes a new instance of the Rgba32 struct.

public Rgba32(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

Bgr

Gets or sets the RGB components of this struct as Bgr24 reverting the component order.

public Bgr24 Bgr { readonly get; set; }

Property Value

Bgr24

PackedValue

public uint PackedValue { readonly get; set; }

Property Value

uint

Rgb

Gets or sets the RGB components of this struct as Rgb24

public Rgb24 Rgb { readonly get; set; }

Property Value

Rgb24

Rgba

Gets or sets the packed representation of the Rgba32 struct.

public uint Rgba { readonly get; set; }

Property Value

uint

Methods

CreatePixelOperations()

public readonly PixelOperations<Rgba32> CreatePixelOperations()

Returns

PixelOperations<Rgba32>

Equals(Rgba32)

public readonly bool Equals(Rgba32 other)

Parameters

other Rgba32

Returns

bool

Equals(object?)

public override readonly bool Equals(object? obj)

Parameters

obj object

Returns

bool

FromAbgr32(Abgr32)

public void FromAbgr32(Abgr32 source)

Parameters

source Abgr32

FromArgb32(Argb32)

public void FromArgb32(Argb32 source)

Parameters

source Argb32

FromBgr24(Bgr24)

public void FromBgr24(Bgr24 source)

Parameters

source Bgr24

FromBgra32(Bgra32)

public void FromBgra32(Bgra32 source)

Parameters

source Bgra32

FromBgra5551(Bgra5551)

public void FromBgra5551(Bgra5551 source)

Parameters

source Bgra5551

FromL16(L16)

public void FromL16(L16 source)

Parameters

source L16

FromL8(L8)

public void FromL8(L8 source)

Parameters

source L8

FromLa16(La16)

public void FromLa16(La16 source)

Parameters

source La16

FromLa32(La32)

public void FromLa32(La32 source)

Parameters

source La32

FromRgb24(Rgb24)

public void FromRgb24(Rgb24 source)

Parameters

source Rgb24

FromRgb48(Rgb48)

public void FromRgb48(Rgb48 source)

Parameters

source Rgb48

FromRgba32(Rgba32)

public void FromRgba32(Rgba32 source)

Parameters

source Rgba32

FromRgba64(Rgba64)

public void FromRgba64(Rgba64 source)

Parameters

source Rgba64

FromScaledVector4(Vector4)

public void FromScaledVector4(Vector4 vector)

Parameters

vector Vector4

FromVector4(Vector4)

public void FromVector4(Vector4 vector)

Parameters

vector Vector4

GetHashCode()

public override readonly int GetHashCode()

Returns

int

ParseHex(string)

Creates a new instance of the Rgba32 struct from the given hexadecimal string.

public static Rgba32 ParseHex(string hex)

Parameters

hex string

The hexadecimal representation of the combined color components arranged in rgb, rgba, rrggbb, or rrggbbaa format to match web syntax.

Returns

Rgba32

The Rgba32.

Exceptions

ArgumentException

Hexadecimal string is not in the correct format.

ToHex()

Converts the value of this instance to a hexadecimal string.

public readonly string ToHex()

Returns

string

A hexadecimal string representation of the value.

ToRgba32(ref Rgba32)

public void ToRgba32(ref Rgba32 dest)

Parameters

dest Rgba32

ToScaledVector4()

public readonly Vector4 ToScaledVector4()

Returns

Vector4

ToString()

public override readonly string ToString()

Returns

string

ToVector4()

public readonly Vector4 ToVector4()

Returns

Vector4

TryParseHex(string?, out Rgba32)

Attempts to creates a new instance of the Rgba32 struct from the given hexadecimal string.

public static bool TryParseHex(string? hex, out Rgba32 result)

Parameters

hex string

The hexadecimal representation of the combined color components arranged in rgb, rgba, rrggbb, or rrggbbaa format to match web syntax.

result Rgba32

When this method returns, contains the Rgba32 equivalent of the hexadecimal input.

Returns

bool

The bool.

Operators

operator ==(Rgba32, Rgba32)

Compares two Rgba32 objects for equality.

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

Parameters

left Rgba32

The Rgba32 on the left side of the operand.

right Rgba32

The Rgba32 on the right side of the operand.

Returns

bool

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

implicit operator Rgba32(Color)

Converts a Color to Rgba32.

public static implicit operator Rgba32(Color color)

Parameters

color Color

The Color.

Returns

Rgba32

The Rgba32.

implicit operator Rgba32(Rgb)

Allows the implicit conversion of an instance of Rgb to a Rgba32.

public static implicit operator Rgba32(Rgb color)

Parameters

color Rgb

The instance of Rgb to convert.

Returns

Rgba32

An instance of Rgba32.

implicit operator Color(Rgba32)

Converts an Rgba32 to Color.

public static implicit operator Color(Rgba32 source)

Parameters

source Rgba32

The Rgba32.

Returns

Color

The Color.

operator !=(Rgba32, Rgba32)

Compares two Rgba32 objects for equality.

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

Parameters

left Rgba32

The Rgba32 on the left side of the operand.

right Rgba32

The Rgba32 on the right side of the operand.

Returns

bool

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