Struct Bgra5551

Namespace

SixLabors.ImageSharp.PixelFormats

Assembly

SixLabors.ImageSharp.dll

Packed pixel type containing four unsigned normalized values. The x, y, and z components use 5 bits, and the w component uses 1 bit.

public struct Bgra5551 : IPixel<Bgra5551>, IEquatable<Bgra5551>, IPackedVector<ushort>, IPixel

Implements

IPixel<Bgra5551>

IEquatable<Bgra5551>

IPackedVector<ushort>

IPixel

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

ToVector4() and scaled vector conversions return all components in [0, 1]. The storage layout matches DXGI_FORMAT_B5G5R5A1_UNORM.

Constructors

Bgra5551(Vector4)

Initializes a new instance of the Bgra5551 struct.

public Bgra5551(Vector4 vector)

Parameters

vector Vector4

The vector containing the components for the packed vector.

Bgra5551(float, float, float, float)

Initializes a new instance of the Bgra5551 struct.

public Bgra5551(float x, float y, float z, float w)

Parameters

x float

The x-component

y float

The y-component

z float

The z-component

w float

The w-component

Properties

PackedValue

Gets or sets the packed representation of the value.

public ushort PackedValue { readonly get; set; }

Property Value

ushort

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

Returns

PixelOperations<Bgra5551>

The PixelOperations<TPixel> instance.

Equals(Bgra5551)

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

public readonly bool Equals(Bgra5551 other)

Parameters

other Bgra5551

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

Parameters

source Abgr32

The Abgr32 value.

Returns

Bgra5551

The Bgra5551.

FromArgb32(Argb32)

Initializes the pixel instance from an Argb32 value.

public static Bgra5551 FromArgb32(Argb32 source)

Parameters

source Argb32

The Argb32 value.

Returns

Bgra5551

The Bgra5551.

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 Bgra5551 FromAssociatedScaledVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Bgra5551

The Bgra5551.

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 Bgra5551 FromAssociatedVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Bgra5551

The Bgra5551.

FromBgr24(Bgr24)

Initializes the pixel instance from an Bgr24 value.

public static Bgra5551 FromBgr24(Bgr24 source)

Parameters

source Bgr24

The Bgr24 value.

Returns

Bgra5551

The Bgra5551.

FromBgra32(Bgra32)

Initializes the pixel instance from an Bgra32 value.

public static Bgra5551 FromBgra32(Bgra32 source)

Parameters

source Bgra32

The Bgra32 value.

Returns

Bgra5551

The Bgra5551.

FromBgra5551(Bgra5551)

Initializes the pixel instance from an Bgra5551 value.

public static Bgra5551 FromBgra5551(Bgra5551 source)

Parameters

source Bgra5551

The Bgra5551 value.

Returns

Bgra5551

The Bgra5551.

FromL16(L16)

Initializes the pixel instance from an L16 value.

public static Bgra5551 FromL16(L16 source)

Parameters

source L16

The L16 value.

Returns

Bgra5551

The Bgra5551.

FromL8(L8)

Initializes the pixel instance from an L8 value.

public static Bgra5551 FromL8(L8 source)

Parameters

source L8

The L8 value.

Returns

Bgra5551

The Bgra5551.

FromLa16(La16)

Initializes the pixel instance from an La16 value.

public static Bgra5551 FromLa16(La16 source)

Parameters

source La16

The La16 value.

Returns

Bgra5551

The Bgra5551.

FromLa32(La32)

Initializes the pixel instance from an La32 value.

public static Bgra5551 FromLa32(La32 source)

Parameters

source La32

The La32 value.

Returns

Bgra5551

The Bgra5551.

FromRgb24(Rgb24)

Initializes the pixel instance from an Rgb24 value.

public static Bgra5551 FromRgb24(Rgb24 source)

Parameters

source Rgb24

The Rgb24 value.

Returns

Bgra5551

The Bgra5551.

FromRgb48(Rgb48)

Initializes the pixel instance from an Rgb48 value.

public static Bgra5551 FromRgb48(Rgb48 source)

Parameters

source Rgb48

The Rgb48 value.

Returns

Bgra5551

The Bgra5551.

FromRgba32(Rgba32)

Initializes the pixel instance from an Rgba32 value.

public static Bgra5551 FromRgba32(Rgba32 source)

Parameters

source Rgba32

The Rgba32 value.

Returns

Bgra5551

The Bgra5551.

FromRgba64(Rgba64)

Initializes the pixel instance from an Rgba64 value.

public static Bgra5551 FromRgba64(Rgba64 source)

Parameters

source Rgba64

The Rgba64 value.

Returns

Bgra5551

The Bgra5551.

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 Bgra5551 FromScaledVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Bgra5551

The Bgra5551.

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 Bgra5551 FromUnassociatedScaledVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Bgra5551

The Bgra5551.

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 Bgra5551 FromUnassociatedVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Bgra5551

The Bgra5551.

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 Bgra5551 FromVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Bgra5551

The Bgra5551.

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 ==(Bgra5551, Bgra5551)

Compares two Bgra5551 objects for equality.

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

Parameters

left Bgra5551

The Bgra5551 on the left side of the operand.

right Bgra5551

The Bgra5551 on the right side of the operand.

Returns

bool

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

operator !=(Bgra5551, Bgra5551)

Compares two Bgra5551 objects for equality.

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

Parameters

left Bgra5551

The Bgra5551 on the left side of the operand.

right Bgra5551

The Bgra5551 on the right side of the operand.

Returns

bool

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