Struct Short2

Packed pixel type containing two 16-bit signed integer values.

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

Implements
Inherited Members
Namespace: SixLabors.ImageSharp.PixelFormats
Assembly: SixLabors.ImageSharp.dll
Syntax
public struct Short2 : IPixel<Short2>, IEquatable<Short2>, IPackedVector<uint>, IPixel

Constructors

| Edit this page View Source

Short2(Vector2)

Initializes a new instance of the Short2 struct.

Declaration
public Short2(Vector2 vector)
Parameters
Type Name Description
Vector2 vector

The vector containing the component values.
| Edit this page View Source

Short2(float, float)

Initializes a new instance of the Short2 struct.

Declaration
public Short2(float x, float y)
Parameters
Type Name Description
float x

The x-component.
float y

The y-component.

Properties

| Edit this page View Source

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 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<Short2> CreatePixelOperations()
Returns
Type Description
PixelOperations<Short2>

The PixelOperations<TPixel> instance.
| Edit this page View Source

Equals(Short2)

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

Declaration
public readonly bool Equals(Short2 other)
Parameters
Type Name Description
Short2 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
| 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

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
| 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
| Edit this page View Source

ToVector2()

Expands the packed representation into a Vector2. The vector components are typically expanded in least to greatest significance order.

Declaration
public readonly Vector2 ToVector2()
Returns
Type Description
Vector2

The Vector2.
| 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 ==(Short2, Short2)

Compares two Short2 objects for equality.

Declaration
public static bool operator ==(Short2 left, Short2 right)
Parameters
Type Name Description
Short2 left

The Short2 on the left side of the operand.
Short2 right

The Short2 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.
| Edit this page View Source

operator !=(Short2, Short2)

Compares two Short2 objects for equality.

Declaration
public static bool operator !=(Short2 left, Short2 right)
Parameters
Type Name Description
Short2 left

The Short2 on the left side of the operand.
Short2 right

The Short2 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