Struct Argb32P

Namespace

SixLabors.ImageSharp.PixelFormats

Assembly

SixLabors.ImageSharp.dll

Packed pixel type containing alpha and associated red, green, and blue components as 8-bit unsigned normalized values. Components are stored in alpha, red, green, and blue order from least to most significant byte.

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

Implements

IPixel<Argb32P>

IEquatable<Argb32P>

IPackedVector<uint>

IPixel

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

The native component, packed, and vector representations use associated alpha.

Constructors

Argb32P(byte, byte, byte)

Initializes a new instance of the Argb32P struct from associated components.

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

Parameters

r byte

The associated red component.

g byte

The associated green component.

b byte

The associated blue component.

Argb32P(byte, byte, byte, byte)

Initializes a new instance of the Argb32P struct from associated components.

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

Parameters

r byte

The associated red component.

g byte

The associated green component.

b byte

The associated blue component.

a byte

The alpha component.

Argb32P(Vector3)

Initializes a new instance of the Argb32P struct from an associated vector.

public Argb32P(Vector3 vector)

Parameters

vector Vector3

The associated vector.

Argb32P(Vector4)

Initializes a new instance of the Argb32P struct from an associated vector.

public Argb32P(Vector4 vector)

Parameters

vector Vector4

The associated vector.

Argb32P(float, float, float)

Initializes a new instance of the Argb32P struct from associated components.

public Argb32P(float r, float g, float b)

Parameters

r float

The associated red component.

g float

The associated green component.

b float

The associated blue component.

Argb32P(float, float, float, float)

Initializes a new instance of the Argb32P struct from associated components.

public Argb32P(float r, float g, float b, float a)

Parameters

r float

The associated red component.

g float

The associated green component.

b float

The associated blue component.

a float

The alpha component.

Argb32P(uint)

Initializes a new instance of the Argb32P struct from a packed associated value.

public Argb32P(uint packed)

Parameters

packed uint

The packed associated value.

Fields

A

Gets or sets the alpha component.

public byte A

Field Value

byte

B

Gets or sets the associated blue component.

public byte B

Field Value

byte

G

Gets or sets the associated green component.

public byte G

Field Value

byte

R

Gets or sets the associated red component.

public byte R

Field Value

byte

Properties

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 static PixelOperations<Argb32P> CreatePixelOperations()

Returns

PixelOperations<Argb32P>

The PixelOperations<TPixel> instance.

Equals(Argb32P)

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

public readonly bool Equals(Argb32P other)

Parameters

other Argb32P

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 Argb32P FromAbgr32(Abgr32 source)

Parameters

source Abgr32

The Abgr32 value.

Returns

Argb32P

The Argb32P.

FromArgb32(Argb32)

Initializes the pixel instance from an Argb32 value.

public static Argb32P FromArgb32(Argb32 source)

Parameters

source Argb32

The Argb32 value.

Returns

Argb32P

The Argb32P.

FromAssociatedScaledVector4(Vector4)

Initializes the pixel instance from a generic ("scaled") Vector4 whose color components use associated alpha, representing color multiplied by the logical opacity represented by alpha. The scaled representation uses 0 and 1 as its nominal component bounds.

public static Argb32P FromAssociatedScaledVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Argb32P

The Argb32P.

FromAssociatedVector4(Vector4)

Initializes the pixel instance from a Vector4 which is specific to the current pixel type and whose color components use associated alpha, representing color multiplied by the logical opacity represented by alpha.

public static Argb32P FromAssociatedVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Argb32P

The Argb32P.

FromBgr24(Bgr24)

Initializes the pixel instance from an Bgr24 value.

public static Argb32P FromBgr24(Bgr24 source)

Parameters

source Bgr24

The Bgr24 value.

Returns

Argb32P

The Argb32P.

FromBgra32(Bgra32)

Initializes the pixel instance from an Bgra32 value.

public static Argb32P FromBgra32(Bgra32 source)

Parameters

source Bgra32

The Bgra32 value.

Returns

Argb32P

The Argb32P.

FromBgra5551(Bgra5551)

Initializes the pixel instance from an Bgra5551 value.

public static Argb32P FromBgra5551(Bgra5551 source)

Parameters

source Bgra5551

The Bgra5551 value.

Returns

Argb32P

The Argb32P.

FromL16(L16)

Initializes the pixel instance from an L16 value.

public static Argb32P FromL16(L16 source)

Parameters

source L16

The L16 value.

Returns

Argb32P

The Argb32P.

FromL8(L8)

Initializes the pixel instance from an L8 value.

public static Argb32P FromL8(L8 source)

Parameters

source L8

The L8 value.

Returns

Argb32P

The Argb32P.

FromLa16(La16)

Initializes the pixel instance from an La16 value.

public static Argb32P FromLa16(La16 source)

Parameters

source La16

The La16 value.

Returns

Argb32P

The Argb32P.

FromLa32(La32)

Initializes the pixel instance from an La32 value.

public static Argb32P FromLa32(La32 source)

Parameters

source La32

The La32 value.

Returns

Argb32P

The Argb32P.

FromRgb24(Rgb24)

Initializes the pixel instance from an Rgb24 value.

public static Argb32P FromRgb24(Rgb24 source)

Parameters

source Rgb24

The Rgb24 value.

Returns

Argb32P

The Argb32P.

FromRgb48(Rgb48)

Initializes the pixel instance from an Rgb48 value.

public static Argb32P FromRgb48(Rgb48 source)

Parameters

source Rgb48

The Rgb48 value.

Returns

Argb32P

The Argb32P.

FromRgba32(Rgba32)

Initializes the pixel instance from an Rgba32 value.

public static Argb32P FromRgba32(Rgba32 source)

Parameters

source Rgba32

The Rgba32 value.

Returns

Argb32P

The Argb32P.

FromRgba64(Rgba64)

Initializes the pixel instance from an Rgba64 value.

public static Argb32P FromRgba64(Rgba64 source)

Parameters

source Rgba64

The Rgba64 value.

Returns

Argb32P

The Argb32P.

FromScaledVector4(Vector4)

Initializes the pixel instance from a generic ("scaled") Vector4 representation using the pixel type's native alpha representation. The scaled representation uses 0 and 1 as its nominal component bounds.

public static Argb32P FromScaledVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Argb32P

The Argb32P.

FromUnassociatedScaledVector4(Vector4)

Initializes the pixel instance from a generic ("scaled") Vector4 whose color components use unassociated alpha. The scaled representation uses 0 and 1 as its nominal component bounds.

public static Argb32P FromUnassociatedScaledVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Argb32P

The Argb32P.

FromUnassociatedVector4(Vector4)

Initializes the pixel instance from a Vector4 which is specific to the current pixel type and whose color components use unassociated alpha.

public static Argb32P FromUnassociatedVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Argb32P

The Argb32P.

FromVector4(Vector4)

Initializes the pixel instance from a Vector4 which is specific to the current pixel type and uses its native alpha representation.

public static Argb32P FromVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Argb32P

The Argb32P.

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.

ToAssociatedScaledVector4()

Expands the pixel into a generic ("scaled") Vector4 whose color components use associated alpha, representing color multiplied by the logical opacity represented by alpha. The scaled representation uses 0 and 1 as its nominal component bounds.

public readonly Vector4 ToAssociatedScaledVector4()

Returns

Vector4

The Vector4.

ToAssociatedVector4()

Expands the pixel into a Vector4 which is specific to the current pixel type and whose color components use associated alpha, representing color multiplied by the logical opacity represented by alpha.

public readonly Vector4 ToAssociatedVector4()

Returns

Vector4

The Vector4.

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 using the pixel type's native alpha representation. The scaled representation uses 0 and 1 as its nominal component bounds. 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.

ToUnassociatedScaledVector4()

Expands the pixel into a generic ("scaled") Vector4 whose color components use unassociated alpha. The scaled representation uses 0 and 1 as its nominal component bounds. When alpha is zero and the pixel's native representation is associated, the color components remain unchanged because no unassociated value can be recovered.

public readonly Vector4 ToUnassociatedScaledVector4()

Returns

Vector4

The Vector4.

ToUnassociatedVector4()

Expands the pixel into a Vector4 which is specific to the current pixel type and whose color components use unassociated alpha. When alpha is zero and the pixel's native representation is associated, the color components remain unchanged because no unassociated value can be recovered.

public readonly Vector4 ToUnassociatedVector4()

Returns

Vector4

The Vector4.

ToVector4()

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

public readonly Vector4 ToVector4()

Returns

Vector4

The Vector4.

Operators

operator ==(Argb32P, Argb32P)

Compares two Argb32P values for equality.

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

Parameters

left Argb32P

The left value.

right Argb32P

The right value.

Returns

bool

true when the values are equal.

operator !=(Argb32P, Argb32P)

Compares two Argb32P values for inequality.

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

Parameters

left Argb32P

The left value.

right Argb32P

The right value.

Returns

bool

true when the values are not equal.