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

> Unreal Engine API Reference > Runtime > AppFramework > Widgets > Colors > SColorPicker

Light Theme

Dark Theme

SColorPicker

Class for placing a color picker.

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SColorPicker

References

Module	AppFramework
Header	/Engine/Source/Runtime/AppFramework/Public/Widgets/Colors/SColorPicker.h
Include	#include "Widgets/Colors/SColorPicker.h"

Syntax

class SColorPicker : public SCompoundWidget

Remarks

Class for placing a color picker. If all you need is a standalone color picker, use the functions OpenColorPicker and DestroyColorPicker, since they hold a static instance of the color picker.

Destructors

	Name	Description
	~SColorPicker()	Destructor.

Functions

	Name	Description
bool	ApplyNewTargetColor ( bool bForceUpdate )
void	BackupColors()	Backup all the colors that are being modified
void	BeginAnimation ( FLinearColor Start, FLinearColor End )
void	Construct ( const FArguments& InArgs )	Construct the widget
void	CycleMode()	Cycles the color picker's mode.
void	DiscardColor()	Calls the user defined delegate for when the color changes are discarded
void	GenerateDefaultColorPickerContent ( bool bAdvancedSectionExpanded )
void	GenerateInlineColorPickerContent()
FLinearColor	GetCurrentColor()
TSharedPtr< ...	GetOptionalOwningDetailsView()	Gets the (optionally set) owning details view of the current color picker
void	HideSmallTrash()
TSharedRef< ...	MakeColorPreviewBox()	Creates the color preview box widget.
TSharedRef< ...	MakeColorSlider ( EColorPickerChannels Channel )	Creates a color slider widget for the specified channel.
TSharedRef< ...	MakeColorSpinBox ( EColorPickerChannels Channel )	Creates a color spin box widget for the specified channel.
void	RestoreColors()	Restore all the modified colors to their original state
void	SetColors ( const FLinearColor& InColor )	Set all the colors to this new color
bool	SetNewTargetColorHSV ( const FLinearColor& NewValue, bool bForceUpdate )
bool	SetNewTargetColorRGB ( const FLinearColor& NewValue, bool bForceUpdate )	Sets new color in ether RGB or HSV
void	ShowSmallTrash()
void	UpdateColorPick()
void	UpdateColorPickMouseUp()

Classes

	Name	Description
	FArguments

Typedefs

Name	Description
FOnColorPickerCreationOverride	Delegate to override color picker creation behavior
FOnColorPickerDestructionOverride	Delegate to override color picker destruction behavior

Constants

Name	Description
ColorThemesViewer	A static pointer to the global color themes viewer
DEFAULT_WINDOW_SIZE	A default window size for the color picker which looks nice
MAX_ALLOWED_UPDATE_TIME	The max time allowed for updating before we shut off auto-updating
OnColorPickerDestroyOverride
OnColorPickerNonModalCreateOverride

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

Take our survey

Dismiss