#include <SRetainerWidget.h>

Inheritance diagram for SRetainerWidget:

Public Member Functions
	SLATE_BEGIN_ARGS (SRetainerWidget)

UMG_API	SRetainerWidget ()

UMG_API	~SRetainerWidget ()

UMG_API void	Construct (const FArguments &Args)

UMG_API void	SetRenderingPhase (int32 Phase, int32 PhaseCount)

UMG_API void	RequestRender ()

UMG_API void	SetRetainedRendering (bool bRetainRendering)

UMG_API void	SetContent (const TSharedRef< SWidget > &InContent)

UMG_API UMaterialInstanceDynamic *	GetEffectMaterial () const

UMG_API void	SetEffectMaterial (UMaterialInterface *EffectMaterial)

UMG_API void	SetTextureParameter (FName TextureParameter)

virtual UMG_API FChildren *	GetChildren () override

UMG_API void	SetWorld (UWorld *World)

Public Member Functions inherited from SCompoundWidget
const FVector2D	GetContentScale () const

void	SetContentScale (TAttribute< FVector2D > InContentScale)

FLinearColor	GetColorAndOpacity () const

void	SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)

void	SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)

virtual SLATECORE_API void	OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override

virtual SLATECORE_API FSlateColor	GetForegroundColor () const override

virtual SLATECORE_API void	SetVisibility (TAttribute< EVisibility > InVisibility) override final

Public Member Functions inherited from SWidget
SLATECORE_API int32	Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const

virtual SLATECORE_API void	Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime)

virtual SLATECORE_API FReply	OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent)

virtual SLATECORE_API void	OnFocusLost (const FFocusEvent &InFocusEvent)

virtual SLATECORE_API void	OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent)

virtual SLATECORE_API FReply	OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)

virtual SLATECORE_API FReply	OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)

virtual SLATECORE_API FReply	OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnMouseLeave (const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FCursorReply	OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const

virtual SLATECORE_API TOptional< TSharedRef< SWidget > >	OnMapCursor (const FCursorReply &CursorReply) const

virtual SLATECORE_API FReply	OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)

virtual SLATECORE_API bool	OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)

virtual SLATECORE_API TSharedPtr< FPopupLayer >	OnVisualizePopup (const TSharedRef< SWidget > &PopupContent)

virtual SLATECORE_API FReply	OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API void	OnDragLeave (const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)

virtual SLATECORE_API FReply	OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)

virtual SLATECORE_API TOptional< bool >	OnQueryShowFocus (const EFocusCause InFocusCause) const

virtual SLATECORE_API FPopupMethodReply	OnQueryPopupMethod () const

virtual SLATECORE_API TOptional< FVirtualPointerPosition >	TranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const

virtual SLATECORE_API void	OnFinishedPointerInput ()

virtual SLATECORE_API void	OnFinishedKeyInput ()

virtual SLATECORE_API FNavigationReply	OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)

virtual SLATECORE_API EWindowZone::Type	GetWindowZoneOverride () const

bool	NeedsPrepass () const

SLATECORE_API void	SlatePrepass ()

SLATECORE_API void	SlatePrepass (float InLayoutScaleMultiplier)

void	SetCanTick (bool bInCanTick)

bool	GetCanTick () const

bool	HasRegisteredSlateAttribute () const

bool	IsAttributesUpdatesEnabled () const

const FSlateWidgetPersistentState &	GetPersistentState () const

const FWidgetProxyHandle	GetProxyHandle () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetDesiredSize () const

SLATECORE_API void	AssignParentWidget (TSharedPtr< SWidget > InParent)

SLATECORE_API bool	ConditionallyDetatchParentWidget (SWidget *InExpectedParent)

virtual bool	ValidatePathToChild (SWidget *InChild)

bool	IsParentValid () const

TSharedPtr< SWidget >	GetParentWidget () const

TSharedPtr< SWidget >	Advanced_GetPaintParentWidget () const

SLATECORE_API FSlateRect	CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const

bool	HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const

TStatId	GetStatID (bool bForDeferredUse=false) const

virtual SLATECORE_API float	GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const

SLATECORE_API void	ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const

virtual FChildren *	GetAllChildren ()

virtual SLATECORE_API bool	SupportsKeyboardFocus () const

virtual SLATECORE_API bool	HasKeyboardFocus () const

SLATECORE_API TOptional< EFocusCause >	HasUserFocus (int32 UserIndex) const

SLATECORE_API TOptional< EFocusCause >	HasAnyUserFocus () const

SLATECORE_API bool	HasUserFocusedDescendants (int32 UserIndex) const

SLATECORE_API bool	HasFocusedDescendants () const

SLATECORE_API bool	HasAnyUserFocusOrFocusedDescendants () const

SLATECORE_API bool	HasMouseCapture () const

SLATECORE_API bool	HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const

virtual SLATECORE_API void	OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)

void	SetEnabled (TAttribute< bool > InEnabledState)

bool	IsEnabled () const

virtual bool	IsInteractable () const

virtual SLATECORE_API TSharedPtr< IToolTip >	GetToolTip ()

virtual SLATECORE_API void	OnToolTipClosing ()

SLATECORE_API void	EnableToolTipForceField (const bool bEnableForceField)

bool	HasToolTipForceField () const

bool	IsHovered () const

SLATECORE_API bool	IsDirectlyHovered () const

EVisibility	GetVisibility () const

bool	IsVolatile () const

bool	IsVolatileIndirectly () const

void	ForceVolatile (bool bForce)

bool	ShouldInvalidatePrepassDueToVolatility ()

SLATECORE_API void	Invalidate (EInvalidateWidgetReason InvalidateReason)

void	CacheVolatility ()

void	MarkPrepassAsDirty ()

float	GetRenderOpacity () const

void	SetRenderOpacity (float InRenderOpacity)

void	SetTag (FName InTag)

const TOptional< FSlateRenderTransform > &	GetRenderTransform () const

TOptional< FSlateRenderTransform >	GetRenderTransformWithRespectToFlowDirection () const

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivotWithRespectToFlowDirection () const

void	SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivot () const

void	SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)

SLATECORE_API void	SetClipping (EWidgetClipping InClipping)

EWidgetClipping	GetClipping () const

SLATECORE_API void	SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)

EWidgetPixelSnapping	GetPixelSnapping () const

void	SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)

FMargin	GetCullingBoundsExtension () const

void	SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)

EFlowDirectionPreference	GetFlowDirectionPreference () const

SLATECORE_API void	SetToolTipText (const TAttribute< FText > &ToolTipText)

SLATECORE_API void	SetToolTipText (const FText &InToolTipText)

SLATECORE_API void	SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)

SLATECORE_API void	SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)

template<typename MetaDataType >
TSharedPtr< MetaDataType >	GetMetaData () const

template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > >	GetAllMetaData () const

template<typename MetaDataType >
void	AddMetadata (const TSharedRef< MetaDataType > &AddMe)

template<typename MetaDataType >
int32	RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)

SLATECORE_API void	SetOnMouseButtonDown (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseButtonUp (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseMove (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseDoubleClick (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)

virtual SLATECORE_API FString	ToString () const

SLATECORE_API FString	GetTypeAsString () const

SLATECORE_API FName	GetType () const

virtual SLATECORE_API FString	GetReadableLocation () const

SLATECORE_API FName	GetCreatedInLocation () const

virtual SLATECORE_API FName	GetTag () const

virtual SLATECORE_API FSlateColor	GetDisabledForegroundColor () const

SLATECORE_API const FGeometry &	GetCachedGeometry () const

SLATECORE_API const FGeometry &	GetTickSpaceGeometry () const

SLATECORE_API const FGeometry &	GetPaintSpaceGeometry () const

const TOptional< FSlateClippingState > &	GetCurrentClippingState () const

virtual bool	Advanced_IsWindow () const

SLATECORE_API TSharedRef< FActiveTimerHandle >	RegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)

SLATECORE_API void	UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)

bool	HasActiveTimers () const

Public Member Functions inherited from FSlateControlledConstruction
	FSlateControlledConstruction ()=default

virtual	~FSlateControlledConstruction ()=default

virtual const FSlateWidgetClassData &	GetWidgetClass () const =0

void	operator delete (void *mem)

Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode >	AsShared ()

TSharedRef< SWidget const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< SWidget, Mode >	AsWeak ()

TWeakPtr< SWidget const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Public Member Functions inherited from FSlateInvalidationRoot
SLATECORE_API	FSlateInvalidationRoot ()

virtual SLATECORE_API	~FSlateInvalidationRoot ()

virtual SLATECORE_API void	AddReferencedObjects (FReferenceCollector &Collector) override

virtual SLATECORE_API FString	GetReferencerName () const override

SLATECORE_API void	InvalidateRootChildOrder (const SWidget *Investigator=nullptr)

SLATECORE_API void	InvalidateRootLayout (const SWidget *Investigator=nullptr)

SLATECORE_API void	InvalidateScreenPosition (const SWidget *Investigator=nullptr)

bool	NeedsSlowPath () const

FHittestGrid *	GetHittestGrid () const

FSlateCachedElementData &	GetCachedElements ()

const FSlateCachedElementData &	GetCachedElements () const

const SWidget *	GetInvalidationRootWidget () const

FSlateInvalidationRootHandle	GetInvalidationRootHandle () const

const FSlateInvalidationWidgetList &	GetFastPathWidgetList () const

SLATECORE_API const TSharedPtr< SWidget >	GetFastPathWidgetListRoot () const

SLATECORE_API FSlateInvalidationResult	PaintInvalidationRoot (const FSlateInvalidationContext &Context)

void	OnWidgetDestroyed (const SWidget *Widget)

SLATECORE_API void	Advanced_ResetInvalidation (bool bClearResourcesImmediately)

Public Member Functions inherited from FGCObject
	FGCObject ()

	FGCObject (const FGCObject &Other)

	FGCObject (FGCObject &&Other)

	FGCObject (EFlags Flags)

virtual	~FGCObject ()

FGCObject &	operator= (const FGCObject &)

FGCObject &	operator= (FGCObject &&)

COREUOBJECT_API void	RegisterGCObject ()

COREUOBJECT_API void	UnregisterGCObject ()

virtual bool	GetReferencerPropertyName (UObject *Object, FString &OutPropertyName) const

Static Public Attributes
static UMG_API int32	Shared_MaxRetainerWorkPerFrame

Static Public Attributes inherited from FGCObject
static COREUOBJECT_API UGCObjectReferencer *	GGCObjectReferencer = nullptr

Protected Types
enum class	EPaintRetainedContentResult { NotPainted , Painted , Queued , TextureSizeTooBig , TextureSizeZero }

Protected Member Functions
virtual UMG_API int32	OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override

virtual UMG_API FVector2D	ComputeDesiredSize (float Scale) const override

virtual bool	Advanced_IsInvalidationRoot () const

virtual const FSlateInvalidationRoot *	Advanced_AsInvalidationRoot () const override

virtual UMG_API bool	CustomPrepass (float LayoutScaleMultiplier) override

virtual UMG_API TSharedRef< SWidget >	GetRootWidget () override

virtual UMG_API int32	PaintSlowPath (const FSlateInvalidationContext &Context) override

UMG_API EPaintRetainedContentResult	PaintRetainedContentImpl (const FSlateInvalidationContext &Context, const FGeometry &AllottedGeometry, int32 LayerId)

UMG_API void	RefreshRenderingMode ()

UMG_API bool	ShouldBeRenderingOffscreen () const

UMG_API bool	IsAnythingVisibleToRender () const

UMG_API void	OnRetainerModeChanged ()

UMG_API void	OnRootInvalidated ()

Protected Member Functions inherited from SCompoundWidget
TSlateAttributeRef< FVector2D >	GetContentScaleAttribute () const

TSlateAttributeRef< FLinearColor >	GetColorAndOpacityAttribute () const

TSlateAttributeRef< FSlateColor >	GetForegroundColorAttribute () const

SLATECORE_API	SCompoundWidget ()

virtual SLATECORE_API	~SCompoundWidget ()

Protected Member Functions inherited from SWidget
void	SetVolatilePrepass (bool bVolatile)

virtual SLATECORE_API void	CacheDesiredSize (float InLayoutScaleMultiplier)

void	SetHover (TAttribute< bool > InHovered)

bool	IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const

SLATECORE_API void	InvalidateChildRemovedFromTree (SWidget &Child)

bool	Advanced_InvalidateVolatility ()

EFlowDirection	ComputeFlowDirection () const

SLATECORE_API void	SetDebugInfo (const ANSICHAR InType, const ANSICHAR InFile, int32 OnLine, size_t InAllocSize)

virtual SLATECORE_API TOptional< EMouseCursor::Type >	GetCursor () const

SLATECORE_API	SWidget ()

SLATECORE_API void	SWidgetConstruct (const FSlateBaseNamedArgs &Args)

bool	IsConstructed () const

SLATECORE_API bool	FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API void	FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API FGeometry	FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const

bool	ShouldBeEnabled (bool InParentEnabled) const

virtual SLATECORE_API const FSlateBrush *	GetFocusBrush () const

virtual bool	ComputeVolatility () const

virtual SLATECORE_API void	OnClippingChanged ()

float	GetPrepassLayoutScaleMultiplier () const

SLATECORE_API void	Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)

template<typename TargetValueType , typename SourceValueType >
bool	SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)

TSlateAttributeRef< bool >	GetEnabledStateAttribute () const

TSlateAttributeRef< bool >	GetHoveredAttribute () const

TSlateAttributeRef< EVisibility >	GetVisibilityAttribute () const

TSlateAttributeRef< TOptional< FSlateRenderTransform > >	GetRenderTransformAttribute () const

TSlateAttributeRef< FVector2D >	GetRenderTransformPivotAttribute () const

virtual SLATECORE_API	~SWidget ()

Protected Member Functions inherited from TSharedFromThis< SWidget >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Protected Member Functions inherited from FSlateInvalidationRoot
void	SetInvalidationRootWidget (SWidget &InInvalidationRootWidget)

void	SetInvalidationRootHittestGrid (FHittestGrid &InHittestGrid)

int32	GetCachedMaxLayerId () const

SLATECORE_API bool	ProcessInvalidation ()

SLATECORE_API void	ClearAllFastPathData (bool bClearResourcesImmediately)

SLATECORE_API void	SetNeedsSlowPath (bool InNeedsSlowPath)

Protected Member Functions inherited from FNoncopyable
	FNoncopyable ()

	~FNoncopyable ()

Additional Inherited Members
Public Types inherited from FGCObject
enum class	EFlags : uint32 { None = 0 , RegisterLater = 1 << 0 , AddStableNativeReferencesOnly = 1 << 1 }

Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassData &	StaticWidgetClass ()

Static Public Member Functions inherited from FGCObject
static COREUOBJECT_API void	StaticInit ()

Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32	FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)

static SLATECORE_API int32	FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)

static TAttribute< EVisibility >	AccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)

Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot	ChildSlot

Protected Attributes inherited from SWidget
uint8	bCanSupportFocus: 1

uint8	bCanHaveChildren: 1

uint8	bClippingProxy: 1

uint8	bHasCustomPrepass: 1

uint8	bHasRelativeLayoutScale: 1

uint8	bVolatilityAlwaysInvalidatesPrepass: 1

EWidgetClipping	Clipping

EWidgetPixelSnapping	PixelSnappingMethod

FMargin	CullingBoundsExtension

float	RenderOpacity

Detailed Description

The SRetainerWidget renders children widgets to a render target first before later rendering that render target to the screen. This allows both frequency and phase to be controlled so that the UI can actually render less often than the frequency of the main game render. It also has the side benefit of allow materials to be applied to the render target after drawing the widgets to apply a simple post process.

Member Enumeration Documentation

◆ EPaintRetainedContentResult

enum class SRetainerWidget::EPaintRetainedContentResult

strongprotected

Enumerator
NotPainted
Painted
Queued
TextureSizeTooBig
TextureSizeZero

Constructor & Destructor Documentation

◆ SRetainerWidget()

SRetainerWidget::SRetainerWidget ( )

◆ ~SRetainerWidget()

SRetainerWidget::~SRetainerWidget ( )

Member Function Documentation

◆ Advanced_AsInvalidationRoot()

virtual const FSlateInvalidationRoot * SRetainerWidget::Advanced_AsInvalidationRoot ( ) const

inlineoverrideprotectedvirtual

Reimplemented from SWidget.

◆ Advanced_IsInvalidationRoot()

virtual bool SRetainerWidget::Advanced_IsInvalidationRoot ( ) const

inlineprotectedvirtual

Reimplemented from SWidget.

◆ ComputeDesiredSize()

FVector2D SRetainerWidget::ComputeDesiredSize ( float LayoutScaleMultiplier ) const

overrideprotectedvirtual

Compute the ideal size necessary to display this widget. For aggregate widgets (e.g. panels) this size should include the size necessary to show all of its children. CacheDesiredSize() guarantees that the size of descendants is computed and cached before that of the parents, so it is safe to call GetDesiredSize() for any children while implementing this method.

Note that ComputeDesiredSize() is meant as an aide to the developer. It is NOT meant to be very robust in many cases. If your widget is simulating a bouncing ball, you should just return a reasonable size; e.g. 160x160. Let the programmer set up a reasonable rule of resizing the bouncy ball simulation.

Parameters

LayoutScaleMultiplier This parameter is safe to ignore for almost all widgets; only really affects text measuring.

Returns: The desired size.

Reimplemented from SCompoundWidget.

◆ Construct()

void SRetainerWidget::Construct ( const FArguments & Args )

Constructor

◆ CustomPrepass()

bool SRetainerWidget::CustomPrepass ( float LayoutScaleMultiplier )

overrideprotectedvirtual

Reimplemented from SWidget.

◆ GetChildren()

FChildren * SRetainerWidget::GetChildren ( )

overridevirtual

Returns the useful children (if any) of this widget. Some widget type may hide widget if they are needed by the system. Allows for iteration over the Widget's children regardless of how they are actually stored.

Note: Should be renamed to GetVisibleChildren (not ALL children will be returned in all cases).

Reimplemented from SCompoundWidget.

◆ GetEffectMaterial()

UMaterialInstanceDynamic * SRetainerWidget::GetEffectMaterial ( ) const

◆ GetRootWidget()

TSharedRef< SWidget > SRetainerWidget::GetRootWidget ( )

overrideprotectedvirtual

Returns: the children root widget of the Invalidation root.

Implements FSlateInvalidationRoot.

◆ IsAnythingVisibleToRender()

bool SRetainerWidget::IsAnythingVisibleToRender ( ) const

protected

◆ OnPaint()

int32 SRetainerWidget::OnPaint	(	const FPaintArgs &	Args,
		const FGeometry &	AllottedGeometry,
		const FSlateRect &	MyCullingRect,
		FSlateWindowElementList &	OutDrawElements,
		int32	LayerId,
		const FWidgetStyle &	InWidgetStyle,
		bool	bParentEnabled
	)		const

overrideprotectedvirtual

SCompoundWidget interface

Reimplemented from SCompoundWidget.

◆ OnRetainerModeChanged()

void SRetainerWidget::OnRetainerModeChanged ( )

protected

◆ OnRootInvalidated()

void SRetainerWidget::OnRootInvalidated ( )

protectedvirtual

Reimplemented from FSlateInvalidationRoot.

◆ PaintRetainedContentImpl()

SRetainerWidget::EPaintRetainedContentResult SRetainerWidget::PaintRetainedContentImpl	(	const FSlateInvalidationContext &	Context,
		const FGeometry &	AllottedGeometry,
		int32	LayerId
	)

protected

◆ PaintSlowPath()

int32 SRetainerWidget::PaintSlowPath ( const FSlateInvalidationContext & Context )

overrideprotectedvirtual

Implements FSlateInvalidationRoot.

◆ RefreshRenderingMode()

void SRetainerWidget::RefreshRenderingMode ( )

protected

◆ RequestRender()

void SRetainerWidget::RequestRender ( )

Requests that the retainer redraw the hosted content next time it's painted.

◆ SetContent()

void SRetainerWidget::SetContent ( const TSharedRef< SWidget > & InContent )

◆ SetEffectMaterial()

void SRetainerWidget::SetEffectMaterial ( UMaterialInterface * EffectMaterial )

◆ SetRenderingPhase()

void SRetainerWidget::SetRenderingPhase	(	int32	Phase,
		int32	PhaseCount
	)

◆ SetRetainedRendering()

void SRetainerWidget::SetRetainedRendering ( bool bRetainRendering )

◆ SetTextureParameter()

void SRetainerWidget::SetTextureParameter ( FName TextureParameter )

◆ SetWorld()

void SRetainerWidget::SetWorld ( UWorld * World )

◆ ShouldBeRenderingOffscreen()

bool SRetainerWidget::ShouldBeRenderingOffscreen ( ) const

protected

◆ SLATE_BEGIN_ARGS()

SRetainerWidget::SLATE_BEGIN_ARGS ( SRetainerWidget )

inline

Member Data Documentation

◆ Shared_MaxRetainerWorkPerFrame

int32 SRetainerWidget::Shared_MaxRetainerWorkPerFrame

static

The documentation for this class was generated from the following files:

Engine/Source/Runtime/UMG/Public/Slate/SRetainerWidget.h
Engine/Source/Runtime/UMG/Private/Slate/SRetainerWidget.cpp

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ EPaintRetainedContentResult

Constructor & Destructor Documentation

◆ SRetainerWidget()

◆ ~SRetainerWidget()

Member Function Documentation

◆ Advanced_AsInvalidationRoot()

◆ Advanced_IsInvalidationRoot()

◆ ComputeDesiredSize()

◆ Construct()

◆ CustomPrepass()

◆ GetChildren()

◆ GetEffectMaterial()

◆ GetRootWidget()

◆ IsAnythingVisibleToRender()

◆ OnPaint()

◆ OnRetainerModeChanged()

◆ OnRootInvalidated()

◆ PaintRetainedContentImpl()

◆ PaintSlowPath()

◆ RefreshRenderingMode()

◆ RequestRender()

◆ SetContent()

◆ SetEffectMaterial()

◆ SetRenderingPhase()

◆ SetRetainedRendering()

◆ SetTextureParameter()

◆ SetWorld()

◆ ShouldBeRenderingOffscreen()

◆ SLATE_BEGIN_ARGS()

Member Data Documentation

◆ Shared_MaxRetainerWorkPerFrame