Struct RgbaVector

Unpacked pixel type containing four 32-bit floating-point values typically ranging from 0 to 1. The color components are stored in red, green, blue, and alpha order.

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

Implements

IPixel<RgbaVector>

IPixel

IEquatable<RgbaVector>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SixLabors.ImageSharp.PixelFormats

Assembly: SixLabors.ImageSharp.dll

Syntax

public struct RgbaVector : IPixel<RgbaVector>, IPixel, IEquatable<RgbaVector>

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 Source

RgbaVector(float, float, float, float)

Initializes a new instance of the RgbaVector struct.

Declaration

public RgbaVector(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.

Fields

| Edit this page View Source

A

Gets or sets the alpha component.

Declaration

public float A

Field Value

Type	Description
float

| Edit this page View Source

B

Gets or sets the blue component.

Declaration

public float B

Field Value

Type	Description
float

| Edit this page View Source

G

Gets or sets the green component.

Declaration

public float G

Field Value

Type	Description
float

| Edit this page View Source

R

Gets or sets the red component.

Declaration

public float R

Field Value

Type	Description
float

Methods

| Edit this page View Source

CreatePixelOperations()

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

Returns

Type	Description
PixelOperations<RgbaVector>	The PixelOperations<TPixel> instance.

| Edit this page View Source

Equals(RgbaVector)

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

Declaration

public readonly bool Equals(RgbaVector other)

Parameters

Type	Name	Description
RgbaVector	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the `other` parameter; otherwise, false.

| Edit this page View Source

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 `obj` and this instance are the same type and represent the same value; otherwise, false.

Overrides

ValueType.Equals(object)

| Edit this page View Source

FromAbgr32(Abgr32)

Initializes the pixel instance from an Abgr32 value.

Declaration

public void FromAbgr32(Abgr32 source)

Parameters

Type	Name	Description
Abgr32	source	The Abgr32 value.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

FromHex(string)

Creates a new instance of the RgbaVector struct.

Declaration

public static RgbaVector FromHex(string hex)

Parameters

Type	Name	Description
string	hex	The hexadecimal representation of the combined color components arranged in rgb, rgba, rrggbb, or rrggbbaa format to match web syntax.

Returns

Type	Description
RgbaVector	The RgbaVector.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

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

ValueType.GetHashCode()

| Edit this page View Source

ToHex()

Converts the value of this instance to a hexadecimal string.

Declaration

public readonly string ToHex()

Returns

Type	Description
string	A hexadecimal string representation of the value.

| Edit this page View Source

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

| Edit this page View Source

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.

Declaration

public readonly Vector4 ToScaledVector4()

Returns

Type	Description
Vector4	The Vector4.

| Edit this page View Source

ToString()

Returns the fully qualified type name of this instance.

Declaration

public override readonly string ToString()

Returns

Type	Description
string	The fully qualified type name.

Overrides

ValueType.ToString()

| Edit this page View Source

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.

Declaration

public readonly Vector4 ToVector4()

Returns

Type	Description
Vector4	The Vector4.

Operators

| Edit this page View Source

operator ==(RgbaVector, RgbaVector)

Compares two RgbaVector objects for equality.

Declaration

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

Parameters

Type	Name	Description
RgbaVector	left	The RgbaVector on the left side of the operand.
RgbaVector	right	The RgbaVector on the right side of the operand.

Returns

Type	Description
bool	True if the `left` parameter is equal to the `right` parameter; otherwise, false.

| Edit this page View Source

operator !=(RgbaVector, RgbaVector)

Compares two RgbaVector objects for equality.

Declaration

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

Parameters

Type	Name	Description
RgbaVector	left	The RgbaVector on the left side of the operand.
RgbaVector	right	The RgbaVector on the right side of the operand.

Returns

Type	Description
bool	True if the `left` parameter is not equal to the `right` parameter; otherwise, false.

Implements

IPixel<TSelf>

IPixel

IEquatable<T>