Struct Byte4

Namespace

SixLabors.ImageSharp.PixelFormats

Assembly

SixLabors.ImageSharp.dll

Packed pixel type containing four 8-bit unsigned integer values, ranging from 0 to 255.

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

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

Implements

IPixel<Byte4>

IEquatable<Byte4>

IPackedVector<uint>

IPixel

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

Byte4(Vector4)

Initializes a new instance of the Byte4 struct.

public Byte4(Vector4 vector)

Parameters

vector Vector4

A vector containing the initial values for the components of the Byte4 structure.

Byte4(float, float, float, float)

Initializes a new instance of the Byte4 struct.

public Byte4(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 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<Byte4> CreatePixelOperations()

Returns

PixelOperations<Byte4>

The PixelOperations<TPixel> instance.

Equals(Byte4)

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

public readonly bool Equals(Byte4 other)

Parameters

other Byte4

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

Parameters

source Abgr32

The Abgr32 value.

Returns

Byte4

The Byte4.

FromArgb32(Argb32)

Initializes the pixel instance from an Argb32 value.

public static Byte4 FromArgb32(Argb32 source)

Parameters

source Argb32

The Argb32 value.

Returns

Byte4

The Byte4.

FromBgr24(Bgr24)

Initializes the pixel instance from an Bgr24 value.

public static Byte4 FromBgr24(Bgr24 source)

Parameters

source Bgr24

The Bgr24 value.

Returns

Byte4

The Byte4.

FromBgra32(Bgra32)

Initializes the pixel instance from an Bgra32 value.

public static Byte4 FromBgra32(Bgra32 source)

Parameters

source Bgra32

The Bgra32 value.

Returns

Byte4

The Byte4.

FromBgra5551(Bgra5551)

Initializes the pixel instance from an Bgra5551 value.

public static Byte4 FromBgra5551(Bgra5551 source)

Parameters

source Bgra5551

The Bgra5551 value.

Returns

Byte4

The Byte4.

FromL16(L16)

Initializes the pixel instance from an L16 value.

public static Byte4 FromL16(L16 source)

Parameters

source L16

The L16 value.

Returns

Byte4

The Byte4.

FromL8(L8)

Initializes the pixel instance from an L8 value.

public static Byte4 FromL8(L8 source)

Parameters

source L8

The L8 value.

Returns

Byte4

The Byte4.

FromLa16(La16)

Initializes the pixel instance from an La16 value.

public static Byte4 FromLa16(La16 source)

Parameters

source La16

The La16 value.

Returns

Byte4

The Byte4.

FromLa32(La32)

Initializes the pixel instance from an La32 value.

public static Byte4 FromLa32(La32 source)

Parameters

source La32

The La32 value.

Returns

Byte4

The Byte4.

FromRgb24(Rgb24)

Initializes the pixel instance from an Rgb24 value.

public static Byte4 FromRgb24(Rgb24 source)

Parameters

source Rgb24

The Rgb24 value.

Returns

Byte4

The Byte4.

FromRgb48(Rgb48)

Initializes the pixel instance from an Rgb48 value.

public static Byte4 FromRgb48(Rgb48 source)

Parameters

source Rgb48

The Rgb48 value.

Returns

Byte4

The Byte4.

FromRgba32(Rgba32)

Initializes the pixel instance from an Rgba32 value.

public static Byte4 FromRgba32(Rgba32 source)

Parameters

source Rgba32

The Rgba32 value.

Returns

Byte4

The Byte4.

FromRgba64(Rgba64)

Initializes the pixel instance from an Rgba64 value.

public static Byte4 FromRgba64(Rgba64 source)

Parameters

source Rgba64

The Rgba64 value.

Returns

Byte4

The Byte4.

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

Parameters

source Vector4

The vector to load the pixel from.

Returns

Byte4

The Byte4.

FromVector4(Vector4)

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

public static Byte4 FromVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Byte4

The Byte4.

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.

ToRgba32()

Convert the pixel instance into Rgba32 representation.

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

Compares two Byte4 objects for equality.

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

Parameters

left Byte4

The Byte4 on the left side of the operand.

right Byte4

The Byte4 on the right side of the operand.

Returns

bool

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

operator !=(Byte4, Byte4)

Compares two Byte4 objects for equality.

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

Parameters

left Byte4

The Byte4 on the left side of the operand.

right Byte4

The Byte4 on the right side of the operand.

Returns

bool

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