Interface IPixel

A base interface for all pixels, defining the mandatory operations to be implemented by a pixel type.

Namespace: SixLabors.ImageSharp.PixelFormats

Assembly: SixLabors.ImageSharp.dll

Syntax

public interface IPixel

Methods

| Improve this Doc View Source

FromArgb32(Argb32)

Initializes the pixel instance from an Argb32 value.

Declaration

void FromArgb32(Argb32 source)

Parameters

Type	Name	Description
Argb32	source	The Argb32 value.

| Improve this Doc View Source

FromBgr24(Bgr24)

Initializes the pixel instance from an Bgr24 value.

Declaration

void FromBgr24(Bgr24 source)

Parameters

Type	Name	Description
Bgr24	source	The Bgr24 value.

| Improve this Doc View Source

FromBgra32(Bgra32)

Initializes the pixel instance from an Bgra32 value.

Declaration

void FromBgra32(Bgra32 source)

Parameters

Type	Name	Description
Bgra32	source	The Bgra32 value.

| Improve this Doc View Source

FromBgra5551(Bgra5551)

Initializes the pixel instance from an Bgra5551 value.

Declaration

void FromBgra5551(Bgra5551 source)

Parameters

Type	Name	Description
Bgra5551	source	The Bgra5551 value.

| Improve this Doc View Source

FromL16(L16)

Initializes the pixel instance from an L16 value.

Declaration

void FromL16(L16 source)

Parameters

Type	Name	Description
L16	source	The L16 value.

| Improve this Doc View Source

FromL8(L8)

Initializes the pixel instance from an L8 value.

Declaration

void FromL8(L8 source)

Parameters

Type	Name	Description
L8	source	The L8 value.

| Improve this Doc View Source

FromLa16(La16)

Initializes the pixel instance from an La16 value.

Declaration

void FromLa16(La16 source)

Parameters

Type	Name	Description
La16	source	The La16 value.

| Improve this Doc View Source

FromLa32(La32)

Initializes the pixel instance from an La32 value.

Declaration

void FromLa32(La32 source)

Parameters

Type	Name	Description
La32	source	The La32 value.

| Improve this Doc View Source

FromRgb24(Rgb24)

Initializes the pixel instance from an Rgb24 value.

Declaration

void FromRgb24(Rgb24 source)

Parameters

Type	Name	Description
Rgb24	source	The Rgb24 value.

| Improve this Doc View Source

FromRgb48(Rgb48)

Initializes the pixel instance from an Rgb48 value.

Declaration

void FromRgb48(Rgb48 source)

Parameters

Type	Name	Description
Rgb48	source	The Rgb48 value.

| Improve this Doc View Source

FromRgba32(Rgba32)

Initializes the pixel instance from an Rgba32 value.

Declaration

void FromRgba32(Rgba32 source)

Parameters

Type	Name	Description
Rgba32	source	The Rgba32 value.

| Improve this Doc View Source

FromRgba64(Rgba64)

Initializes the pixel instance from an Rgba64 value.

Declaration

void FromRgba64(Rgba64 source)

Parameters

Type	Name	Description
Rgba64	source	The Rgba64 value.

| Improve this Doc View Source

FromScaledVector4(Vector4)

Initializes the pixel instance from a generic ("scaled") Vector4.

Declaration

void FromScaledVector4(Vector4 vector)

Parameters

Type	Name	Description
Vector4	vector	The vector to load the pixel from.

| Improve this Doc View Source

FromVector4(Vector4)

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

Declaration

void FromVector4(Vector4 vector)

Parameters

Type	Name	Description
Vector4	vector	The vector to load the pixel from.

| Improve this Doc View Source

ToRgba32(ref Rgba32)

Convert the pixel instance into Rgba32 representation.

Declaration

void ToRgba32(ref Rgba32 dest)

Parameters

Type	Name	Description
Rgba32	dest	The reference to the destination Rgba32 pixel

| Improve this Doc 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

Vector4 ToScaledVector4()

Returns

Type	Description
Vector4	The Vector4.

| Improve this Doc 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

Vector4 ToVector4()

Returns

Type	Description
Vector4	The Vector4.