FColorPickerArgs Struct Reference

#include <SColorPicker.h>

Public Member Functions
	FColorPickerArgs ()=default
	FColorPickerArgs (FLinearColor InInitialColor, FOnLinearColorValueChanged InOnColorCommitted)
PRAGMA_DISABLE_DEPRECATION_WARNINGS	FColorPickerArgs (const FColorPickerArgs &)=default
	FColorPickerArgs (FColorPickerArgs &&)=default

Public Attributes
bool	bIsModal = false
TSharedPtr< SWidget >	ParentWidget
bool	bUseAlpha = false
bool	bOnlyRefreshOnMouseUp = false
bool	bOnlyRefreshOnOk = false
bool	bExpandAdvancedSection = true
bool	bOpenAsMenu = false
bool	bClampValue = false
TAttribute< float >	DisplayGamma = 2.2f
TOptional< bool >	sRGBOverride = TOptional<bool>()
const TArray< FColor * > *	ColorArray = nullptr
const TArray< FLinearColor * > *	LinearColorArray = nullptr
const TArray< FColorChannels > *	ColorChannelsArray = nullptr
FOnLinearColorValueChanged	OnColorCommitted
FOnLinearColorValueChanged	PreColorCommitted
FOnWindowClosed	OnColorPickerWindowClosed
FOnColorPickerCancelled	OnColorPickerCancelled
FSimpleDelegate	OnInteractivePickBegin
FSimpleDelegate	OnInteractivePickEnd
FLinearColor	InitialColorOverride = FLinearColor::White
FLinearColor	InitialColor = FLinearColor::White
TSharedPtr< SWidget >	OptionalOwningDetailsView

Constructor & Destructor Documentation

FColorPickerArgs() [1/4]

FColorPickerArgs::FColorPickerArgs ( )

default

Default constructor.

FColorPickerArgs() [2/4]

FColorPickerArgs::FColorPickerArgs ( FLinearColor  InInitialColor, FOnLinearColorValueChanged  InOnColorCommitted  )

inline

FColorPickerArgs() [3/4]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FColorPickerArgs::FColorPickerArgs ( const FColorPickerArgs &  )

default

FColorPickerArgs() [4/4]

FColorPickerArgs::FColorPickerArgs ( FColorPickerArgs &&  )

default

Member Data Documentation

bClampValue

bool FColorPickerArgs::bClampValue = false

Set true if values should be max to 1.0. HDR values may go over 1.0.

bExpandAdvancedSection

bool FColorPickerArgs::bExpandAdvancedSection = true

Whether to automatically expand the Advanced section.

bIsModal

bool FColorPickerArgs::bIsModal = false

Whether or not the new color picker is modal.

bOnlyRefreshOnMouseUp

bool FColorPickerArgs::bOnlyRefreshOnMouseUp = false

Whether to disable the refresh except on mouse up for performance reasons.

bOnlyRefreshOnOk

bool FColorPickerArgs::bOnlyRefreshOnOk = false

Whether to disable the refresh until the picker closes.

bOpenAsMenu

bool FColorPickerArgs::bOpenAsMenu = false

Whether to open the color picker as a menu window.

bUseAlpha

bool FColorPickerArgs::bUseAlpha = false

Whether or not to enable the alpha slider.

ColorArray

const TArray<FColor*>* FColorPickerArgs::ColorArray = nullptr

An array of FColors to target.

ColorChannelsArray

const TArray<FColorChannels>* FColorPickerArgs::ColorChannelsArray = nullptr

An array of FColorChannels to target. (deprecated now that wx is gone?)

DisplayGamma

TAttribute<float> FColorPickerArgs::DisplayGamma = 2.2f

The current display gamma used to correct colors picked from the display.

InitialColor

FLinearColor FColorPickerArgs::InitialColor = FLinearColor::White

The initial color set on the color picker.

InitialColorOverride

FLinearColor FColorPickerArgs::InitialColorOverride = FLinearColor::White

Overrides the initial color set on the color picker.

LinearColorArray

const TArray<FLinearColor*>* FColorPickerArgs::LinearColorArray = nullptr

An array of FLinearColors to target.

OnColorCommitted

FOnLinearColorValueChanged FColorPickerArgs::OnColorCommitted

A delegate to be called when the color changes.

OnColorPickerCancelled

FOnColorPickerCancelled FColorPickerArgs::OnColorPickerCancelled

A delegate to be called when the color picker cancel button is pressed

OnColorPickerWindowClosed

FOnWindowClosed FColorPickerArgs::OnColorPickerWindowClosed

A delegate to be called when the color picker window closes.

OnInteractivePickBegin

FSimpleDelegate FColorPickerArgs::OnInteractivePickBegin

A delegate to be called when a slider drag, color wheel drag or dropper grab starts

OnInteractivePickEnd

FSimpleDelegate FColorPickerArgs::OnInteractivePickEnd

A delegate to be called when a slider drag, color wheel drag or dropper grab finishes

OptionalOwningDetailsView

TSharedPtr<SWidget> FColorPickerArgs::OptionalOwningDetailsView

Allows a details view to own the color picker so refreshing another details view doesn't close it

ParentWidget

TSharedPtr<SWidget> FColorPickerArgs::ParentWidget

The parent for the new color picker window

PreColorCommitted

FOnLinearColorValueChanged FColorPickerArgs::PreColorCommitted

A delegate to be called before the color change is committed.

sRGBOverride

TOptional<bool> FColorPickerArgs::sRGBOverride = TOptional<bool>()

If set overrides the global option for the desired setting of sRGB mode.

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/AppFramework/Public/Widgets/Colors/SColorPicker.h