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.Equals(object, object)

object.GetType()

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

Gets or sets the packed representation of the value.

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

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

public static PixelOperations<Rgba32> CreatePixelOperations()

Returns

PixelOperations<Rgba32>

The PixelOperations<TPixel> instance.

Equals(Rgba32)

Indicates whether the current object is equal to another object of the same type.

public readonly bool Equals(Rgba32 other)

Parameters

other Rgba32

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

public override readonly bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

FromAbgr32(Abgr32)

Initializes the pixel instance from an Abgr32 value.

public static Rgba32 FromAbgr32(Abgr32 source)

Parameters

source Abgr32

The Abgr32 value.

Returns

Rgba32

The Rgba32.

FromArgb32(Argb32)

Initializes the pixel instance from an Argb32 value.

public static Rgba32 FromArgb32(Argb32 source)

Parameters

source Argb32

The Argb32 value.

Returns

Rgba32

The Rgba32.

FromBgr24(Bgr24)

Initializes the pixel instance from an Bgr24 value.

public static Rgba32 FromBgr24(Bgr24 source)

Parameters

source Bgr24

The Bgr24 value.

Returns

Rgba32

The Rgba32.

FromBgra32(Bgra32)

Initializes the pixel instance from an Bgra32 value.

public static Rgba32 FromBgra32(Bgra32 source)

Parameters

source Bgra32

The Bgra32 value.

Returns

Rgba32

The Rgba32.

FromBgra5551(Bgra5551)

Initializes the pixel instance from an Bgra5551 value.

public static Rgba32 FromBgra5551(Bgra5551 source)

Parameters

source Bgra5551

The Bgra5551 value.

Returns

Rgba32

The Rgba32.

FromL16(L16)

Initializes the pixel instance from an L16 value.

public static Rgba32 FromL16(L16 source)

Parameters

source L16

The L16 value.

Returns

Rgba32

The Rgba32.

FromL8(L8)

Initializes the pixel instance from an L8 value.

public static Rgba32 FromL8(L8 source)

Parameters

source L8

The L8 value.

Returns

Rgba32

The Rgba32.

FromLa16(La16)

Initializes the pixel instance from an La16 value.

public static Rgba32 FromLa16(La16 source)

Parameters

source La16

The La16 value.

Returns

Rgba32

The Rgba32.

FromLa32(La32)

Initializes the pixel instance from an La32 value.

public static Rgba32 FromLa32(La32 source)

Parameters

source La32

The La32 value.

Returns

Rgba32

The Rgba32.

FromRgb24(Rgb24)

Initializes the pixel instance from an Rgb24 value.

public static Rgba32 FromRgb24(Rgb24 source)

Parameters

source Rgb24

The Rgb24 value.

Returns

Rgba32

The Rgba32.

FromRgb48(Rgb48)

Initializes the pixel instance from an Rgb48 value.

public static Rgba32 FromRgb48(Rgb48 source)

Parameters

source Rgb48

The Rgb48 value.

Returns

Rgba32

The Rgba32.

FromRgb96(Rgb96)

Initializes the pixel instance from an Rgb96 value.

public static Rgba32 FromRgb96(Rgb96 source)

Parameters

source Rgb96

The Rgb96 value.

Returns

Rgba32

The pixel value as Rgba32.

FromRgba128(Rgba128)

Initializes the pixel instance from an Rgba128 value.

public static Rgba32 FromRgba128(Rgba128 source)

Parameters

source Rgba128

The Rgba128 value.

Returns

Rgba32

The pixel value as Rgba32.

FromRgba32(Rgba32)

Initializes the pixel instance from an Rgba32 value.

public static Rgba32 FromRgba32(Rgba32 source)

Parameters

source Rgba32

The Rgba32 value.

Returns

Rgba32

The Rgba32.

FromRgba64(Rgba64)

Initializes the pixel instance from an Rgba64 value.

public static Rgba32 FromRgba64(Rgba64 source)

Parameters

source Rgba64

The Rgba64 value.

Returns

Rgba32

The Rgba32.

FromScaledVector4(Vector4)

Initializes the pixel instance from a generic a generic ("scaled") Vector4 representation with values scaled and clamped between 0 and 1

public static Rgba32 FromScaledVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Rgba32

The Rgba32.

FromVector4(Vector4)

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

public static Rgba32 FromVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Rgba32

The Rgba32.

GetHashCode()

Returns the hash code for this instance.

public override readonly int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

GetPixelTypeInfo()

Gets the pixel type information.

public static PixelTypeInfo GetPixelTypeInfo()

Returns

PixelTypeInfo

The PixelTypeInfo.

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

Convert the pixel instance into Rgba32 representation.

public readonly Rgba32 ToRgba32()

Returns

Rgba32

The Rgba32

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

Returns the fully qualified type name of this instance.

public override readonly string ToString()

Returns

string

The fully qualified type name.

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 ==(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(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.

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.