FColorList

Windows
MacOS
Linux

Inheritance Hierarchy

FExec

FColorList

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Math/ColorList.h

Include

#include "Math/ColorList.h"

Syntax

class FColorList : public FExec

Variables

Name Description

Protected variable

TColorsLookup

 

ColorsLookup

Array of colors for fast lookup when using index.

Protected variable

TColorsMap

 

ColorsMap

List of common colors.

Functions

Name Description

Public function

void

 

CreateColorMap()

Initializes list of common colors.

Public function Const

int32

 

GetColorIndex

(
    const TCHAR* ColorName
)

Returns index of color.

Public function Const

const FStrin...

 

GetColorNameByIndex

(
    int32 ColorIndex
)

Resturn color's name based on index. If index is invalid, returns BadIndex.

Public function Const

int32

 

GetColorsNum()

Returns the number of colors.

Public function Const

const FColor...

 

GetFColorByIndex

(
    int32 ColorIndex
)

Returns a color based on index. If index is invalid, returns White.

Public function Const

const FColor...

 

GetFColorByName

(
    const TCHAR* ColorName
)

Returns a color based on ColorName if not found returs White.

Public function Const

const FLinea...

 

GetFLinearColorByName

(
    const TCHAR* ColorName
)

Returns a linear color based on ColorName if not found returs White.

Protected function

void

 

InitializeColor

(
    const TCHAR* ColorName,
    const FColor* ColorPtr,
    int32& CurrentIndex
)

Public function Const

bool

 

IsValidColorName

(
    const TCHAR* ColorName
)

Returns true if color is valid common colors, returns false otherwise.

Public function

void

 

LogColors()

Prints to log all colors information.

Typedefs

Name

Description

TColorsLookup

TColorsMap

Constants

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