Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FSlateColor

A Slate color can be a directly specified value, or the color can be pulled from a WidgetStyle.

Windows

MacOS

Linux

References

Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Styling/SlateColor.h
Include	#include "Styling/SlateColor.h"

Syntax

struct FSlateColor

Remarks

A Slate color can be a directly specified value, or the color can be pulled from a WidgetStyle.

Variables

		Name	Description
	TEnumAsByte< ES...	ColorUseRule	The rule for which color to pick.
	FLinearColor	SpecifiedColor	The current specified color; only meaningful when ColorToUse == UseColor_Specified.

Constructors

	Name	Description
	FSlateColor()	Default constructor. Uninitialized Slate colors are Fuchsia by default.
	FSlateColor ( const FLinearColor& InColor )	Creates a new Slate color with the specified values.
	FSlateColor ( const TSharedRef< FLinearColor >& ... )	Creates a new Slate color that is linked to the given values.
	FSlateColor ( ESlateColorStylingMode::Type InColo... )	Private constructor to prevent construction of invalid FSlateColors.

Destructors

	Name	Description
	~FSlateColor()

Functions

	Name	Description
const FLinea...	GetColor ( const FWidgetStyle& InWidgetStyle )	Gets the color value represented by this Slate color.
FLinearColor	GetSpecifiedColor()	Gets the specified color value.
bool	IsColorSpecified()	Checks whether the values for this color have been specified.
bool	SerializeFromMismatchedTag ( const FPropertyTag& Tag, FStructuredArchive::FSlot Slot )	Used to upgrade an FColor or FLinearColor property to an FSlateColor property
void	Unlink()	If the color rule is set to UseColor_Specified_Link, this will copy the linked color internally, unlink it and set the color rule to UseColor_Specified.
FSlateColor	UseForeground()
FSlateColor	UseSubduedForeground()

Operators

		Name	Description
	bool	operator!= ( const FSlateColor& Other )	Compares this color with another for inequality.
	bool	operator== ( const FSlateColor& Other )	Compares this color with another for equality.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss