1. Epic GamesDeveloper
  3. FSlateColor

FSlateColor

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

Unreal Engine C++ API Reference > Runtime > SlateCore > Styling

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

  Type Name Description
Protected variable ESlateColorStylingMode ColorUseRule The rule for which color to pick.
Protected variable FLinearColor SpecifiedColor The current specified color; only meaningful when ColorToUse == UseColor_Specified.

Constructors

  Type Name Description
Public function   Default constructor.Uninitialized Slate colors are Fuchsia by default.
Public function  

FSlateColor ( const FLinearColor& InColor
)

 Creates a new Slate color with the specified values.
Public function  

FSlateColor ( const FColor InColor
)

 Creates a new Slate color with the specified values.
Public function  

FSlateColor ( const TSharedRef< FLinearColor >& InColor
)

 Creates a new Slate color that is linked to the given values.
Public function  

FSlateColor ( EStyleColor InColorTableId
)

  
Protected function  

FSlateColor ( ESlateColorStylingMode InColorUseRule
)

 Private constructor to prevent construction of invalid FSlateColors.

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const const FLinearColor &

GetColor ( const FWidgetStyle& InWidgetStyle
)

 Gets the color value represented by this Slate color.
Protected function Const const FLinearColor &  
Public function Const FLinearColor Gets the specified color value.
Public function Const bool Checks whether the values for this color have been specified.
Public function bool Used to upgrade an FColor or FLinearColor property to an FSlateColor property
Public function 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.
Public function Static FSlateColor  
Public function Static FSlateColor  
Public function Static FSlateColor  

Operators

  Type Name Description
Public function Const bool

operator!= ( const FSlateColor& Other
)

 Compares this color with another for inequality.
Public function Const bool

operator== ( const FSlateColor& Other
)

 Compares this color with another for equality.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page