Struct Abgr32
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.
Inherited Members
Namespace: SixLabors.ImageSharp.PixelFormats
Assembly: SixLabors.ImageSharp.dll
Syntax
public struct Abgr32 : IPixel<Abgr32>, IEquatable<Abgr32>, 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
| Edit this page View SourceAbgr32(byte, byte, byte)
Initializes a new instance of the Abgr32 struct.
Declaration
public Abgr32(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. |
Abgr32(byte, byte, byte, byte)
Initializes a new instance of the Abgr32 struct.
Declaration
public Abgr32(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. |
Abgr32(Vector3)
Initializes a new instance of the Abgr32 struct.
Declaration
public Abgr32(Vector3 vector)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | vector | The vector containing the components for the packed vector. |
Abgr32(Vector4)
Initializes a new instance of the Abgr32 struct.
Declaration
public Abgr32(Vector4 vector)
Parameters
Type | Name | Description |
---|---|---|
Vector4 | vector | The vector containing the components for the packed vector. |
Abgr32(float, float, float, float)
Initializes a new instance of the Abgr32 struct.
Declaration
public Abgr32(float r, float g, float b, float a = 1)
Parameters
Type | Name | Description |
---|---|---|
float | r | The red component. |
float | g | The green component. |
float | b | The blue component. |
float | a | The alpha component. |
Abgr32(uint)
Initializes a new instance of the Abgr32 struct.
Declaration
public Abgr32(uint packed)
Parameters
Type | Name | Description |
---|---|---|
uint | packed | The packed value. |
Fields
| Edit this page View SourceA
Gets or sets the alpha component.
Declaration
public byte A
Field Value
Type | Description |
---|---|
byte |
B
Gets or sets the blue component.
Declaration
public byte B
Field Value
Type | Description |
---|---|
byte |
G
Gets or sets the green component.
Declaration
public byte G
Field Value
Type | Description |
---|---|
byte |
R
Gets or sets the red component.
Declaration
public byte R
Field Value
Type | Description |
---|---|
byte |
Properties
| Edit this page View SourceAbgr
Gets or sets the packed representation of the Abgrb32 struct.
Declaration
public uint Abgr { readonly get; set; }
Property Value
Type | Description |
---|---|
uint |
PackedValue
Gets or sets the packed representation of the value.
Declaration
public uint PackedValue { readonly get; set; }
Property Value
Type | Description |
---|---|
uint |
Methods
| Edit this page View SourceCreatePixelOperations()
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<Abgr32> CreatePixelOperations()
Returns
Type | Description |
---|---|
PixelOperations<Abgr32> | The PixelOperations<TPixel> instance. |
Equals(Abgr32)
Indicates whether the current object is equal to another object of the same type.
Declaration
public readonly bool Equals(Abgr32 other)
Parameters
Type | Name | Description |
---|---|---|
Abgr32 | other | An object to compare with this object. |
Returns
Type | Description |
---|---|
bool | true if the current object is equal to the |
Equals(object?)
Indicates whether this instance and a specified object are equal.
Declaration
public override readonly bool Equals(object? obj)
Parameters
Type | Name | Description |
---|---|---|
object | obj | The object to compare with the current instance. |
Returns
Type | Description |
---|---|
bool | true if |
Overrides
| Edit this page View SourceFromAbgr32(Abgr32)
Initializes the pixel instance from an Abgr32 value.
Declaration
public void FromAbgr32(Abgr32 source)
Parameters
Type | Name | Description |
---|---|---|
Abgr32 | source | The Abgr32 value. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
GetHashCode()
Returns the hash code for this instance.
Declaration
public override readonly int GetHashCode()
Returns
Type | Description |
---|---|
int | A 32-bit signed integer that is the hash code for this instance. |
Overrides
| Edit this page View SourceToRgba32(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 |
ToScaledVector4()
Expands the pixel into a generic ("scaled") Vector4 representation
with values scaled and clamped between
Declaration
public readonly Vector4 ToScaledVector4()
Returns
Type | Description |
---|---|
Vector4 | The Vector4. |
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
| Edit this page View SourceToVector4()
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
| Edit this page View Sourceoperator ==(Abgr32, Abgr32)
Compares two Argb32 objects for equality.
Declaration
public static bool operator ==(Abgr32 left, Abgr32 right)
Parameters
Type | Name | Description |
---|---|---|
Abgr32 | left | The Abgr32 on the left side of the operand. |
Abgr32 | right | The Abgr32 on the right side of the operand. |
Returns
Type | Description |
---|---|
bool | True if the |
implicit operator Abgr32(Color)
Declaration
public static implicit operator Abgr32(Color color)
Parameters
Type | Name | Description |
---|---|---|
Color | color | The Color. |
Returns
Type | Description |
---|---|
Abgr32 | The Abgr32. |
implicit operator Color(Abgr32)
Declaration
public static implicit operator Color(Abgr32 source)
Parameters
Type | Name | Description |
---|---|---|
Abgr32 | source | The Abgr32. |
Returns
Type | Description |
---|---|
Color | The Color. |
operator !=(Abgr32, Abgr32)
Compares two Abgr32 objects for equality.
Declaration
public static bool operator !=(Abgr32 left, Abgr32 right)
Parameters
Type | Name | Description |
---|---|---|
Abgr32 | left | The Abgr32 on the left side of the operand. |
Abgr32 | right | The Abgr32 on the right side of the operand. |
Returns
Type | Description |
---|---|
bool | True if the |