OKColors on OKColors Docs

BreakOutLCHA

Mon, 01 Jan 0001 00:00:00 +0000

BreakOutLCHA#

Inputs#

LCHColor (float4)

Output#

L (float)

C (float)

H (float)

A (float)

Behaviour#

Breaks out L,C,H and A scalars from a Vector4.

ClampLCH

Mon, 01 Jan 0001 00:00:00 +0000

Clamp LCH#

Inputs#

LCHColor (float4)

Output#

LCHColor (float4)

Behaviour#

Clamps the LCHColor to a valid range to ensure consistency. You will only need this if there are some floating point errors happening from multiple transformations. In general this should only be used if you are encountering issues with the colors, when converting back to linear color.

FLCHColor

Mon, 01 Jan 0001 00:00:00 +0000

FLCHColor#

A 32 bit/component floating point OKLCH color

Module OKColors

Header /OKColors/Source/OkColors/Public/LCHColor.h

Include "LCHColor.h"

Variables#

float L

float C

float H

float A

Constructors#

FLCHColor()

FLCHColor(EForceInit)

constexpr LCHColor(float inL, float inC, float inH, float inA)

Functions#

bool Serialize(FArchive& ar)

bool Serialize(FStructuredArchive::FSlot slot)

static FLCHColor GetClamped(const FLCHColor& color)

Clamp all values into valid ranges for LCH

FLCHColor GetClamped(const FLCHColor& color) const

Clamp all values into valid ranges for LCH

static FLCHColor FromLinearColor(const FLinearColor& color)

Convert from Linear Color to LCH

FLinearColor ToLinearColor() const

Convert back to Linear Color

LCHColor to Linear

Mon, 01 Jan 0001 00:00:00 +0000

LCHColor to LinearColor#

Inputs#

LCHColor (float4)

Output#

LinearColor (float4)

Behaviour#

Converts an ingoing LCHColor to linear color space. This is mainly used when you finished all operations in OKLCH and want to display the result in your material.

Lerp

Mon, 01 Jan 0001 00:00:00 +0000

Lerp#

Inputs#

A (FLCHColor)

B (FLCHColor)

Alpha (float)

Output#

LCHColor

Behaviour#

Linearly interpolates luminosity, chroma, hue, and transparency from A to B using alpha as the interpolation value.
This interpolation happens in the OKLch Color space since both colors are LCHColors and produces different results from directly Lerping between LinearColor values.

Linear To LCHColor

Mon, 01 Jan 0001 00:00:00 +0000

LinearColor To LCHColor#

Inputs#

LinearColor (float4)

Output#

LCHColor (float4)

Behaviour#

Converts an ingoing linear color to an LCHColor.

BlueprintFunctionLibrary

Mon, 01 Jan 0001 00:00:00 +0000

UOKColorConversionBlueprintFunctionLibrary#

A blueprint function providing new nodes to interact with and transform FLCHColor. See Blueprint Nodes for the Nodes Documentation

Module OKColors

Header /OKColors/Source/OkColors/Public/OKColorConversionBlueprintFunctionLibrary.h

Include "OKColorConversionBlueprintFunctionLibrary.h"

Functions#

	static FLinearColor LCHColorToLinearColor(const FLCHColor& color);

Converts to LinearColor from FLCHColor, clipping back to the SRGB color gammut.

	static FLinearColor LCHColorToLinearColorFast(const FLCHColor& color);

Converts to LinearColor from FLCHColor. It’s fast but only correct for OKLCH colors in the SRGB color gammut. When in doubt use LCHColorToLinearColor.

	static FLCHColor LCHColorFromLinearColor(const FLinearColor& color);

Converts to FLCHColor from FLinearColor.

LCHColor from LinearColor

Mon, 01 Jan 0001 00:00:00 +0000

LCHColor from LinearColor#

Input#

Color (LinearColor)

Output#

LCHColor

Behaviour#

Converts a provided LinearColor to the OKLCH color space, outputting an LCHColor. The provided color should be a linear non SRGB color, so avoid gamma correcting the color before plugging it into the input.

LCHColor To LinearColor

Mon, 01 Jan 0001 00:00:00 +0000

LCHColor To LinearColor#

Input#

Color (LCHColor)

Output#

LinearColor

Behaviour#

Converts a provided LCHColor to the linear color space, outputting a LinearColor. The color is clipped back to the SRGB color gamut when converting back so the color is displayed correctly.
Use this when you want to display your LCH Color again or set it on widgets.

LCHColor To LinearColor Fast

Mon, 01 Jan 0001 00:00:00 +0000

LCHColor To LinearColor Fast#

Input#

Color (LCHColor)

Output#

LinearColor

Behaviour#

Converts a provided LCHColor to the linear color space, outputting an LinearColor.
Color is clamped back to the SRGB color gammut when converting back, this is lossy and not always correct so only use it if you need the speed and are sure you can live with ther errors, otherwhise use LCHColor To LinearColor.
Use this when you want to display your LCH Color again or set it on widgets.

Interpret As LinearColor

Mon, 01 Jan 0001 00:00:00 +0000

Interpret As LinearColor#

Inputs#

Color (FLCHColor)

Output#

LinearColor

Behaviour#

Reinterprets an LCHColor as a LinearColor so it can be sent to a material using Set Vector Parameter Value.

Clip To SRGB Gammut

Mon, 01 Jan 0001 00:00:00 +0000

Clip To SRGB Gammut#

Inputs#

Color (FLCHColor)

Output#

FLCHColor

Behaviour#

Clips the LCHColor to the SRGB color gamut. This is usually used before converting to LinearColor, and the LCHColor To LinearColor node does this automatically.

Get Clamped

Mon, 01 Jan 0001 00:00:00 +0000

Get Clamped#

Inputs#

Color (FLCHColor)

Output#

FLCHColor

Behaviour#

Clamps the input LCHColor to the SRGB color gammut this is wrong in some cases but faster than clipping.

Get Formatted

Mon, 01 Jan 0001 00:00:00 +0000

Get Formatted#

Inputs#

Color (FLCHColor)

Output#

FString

Behaviour#

Provides a human readable output for display in consoles as an FString.

MakeLCHA

Mon, 01 Jan 0001 00:00:00 +0000

MakeLCHA#

Inputs#

L (float)

C (float)

H (float)

A (float)

Output#

LCHColor (float4)

Behaviour#

Combines individual L,C,H and A scalars into a Vector4 with LCHA as RGBA.