1. Epic GamesDeveloper
  3. SRetainerWidget

SRetainerWidget

The [SRetainerWidget](API\Runtime\UMG\Slate\SRetainerWidget) renders children widgets to a render target first before later rendering that render target to the screen.

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Slate

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Slate/SRetainerWidget.h
Include #include "Slate/SRetainerWidget.h"

Syntax

class SRetainerWidget :  
    public SCompoundWidget,  
    public FSlateInvalidationRoot

Remarks

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.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

Construct ( const FArguments& Args
)

 Constructor
Public function Const UMaterialInstanceDynamic *  
Protected function Const bool  
Protected function void  
Protected function EPaintRetainedContentResult

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

  
Protected function void  
Public function void Requests that the retainer redraw the hosted content next time it's painted.
Public function void

SetContent ( const TSharedRef< SWidget >& InContent
)

  
Public function void  
Public function void

SetIsDesignTime ( bool bInIsDesignTime
)

  
Public function void

SetRenderingPhase ( int32 Phase,
int32 PhaseCount
)

  
Public function void

SetRetainedRendering ( bool bRetainRendering
)

  
Public function void

SetShowEffectsInDesigner ( bool bInShowEffectsInDesigner
)

  
Public function void

SetTextureParameter ( FName TextureParameter
)

  
Public function void

SetWorld ( UWorld* World
)

  
Protected function Const bool  

Overridden from SWidget

  Type Name Description
Protected function Virtual Const const FSlateInvalidationRoot *  
Protected function Virtual Const bool  
Protected function Virtual Const FVector2D

ComputeDesiredSize ( float LayoutScaleMultiplier
)

 Compute the ideal size necessary to display this widget.
Protected function Virtual bool

CustomPrepass ( float LayoutScaleMultiplier
)

  
Public function Virtual FChildren * Returns all Widgets, including widget hidden from the invalidation system.
Public function Virtual FChildren * Returns the useful children (if any) of this widget.
Protected function Virtual Const int32

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

 SCompoundWidget interface

Overridden from FSlateInvalidationRoot

  Type Name Description
Protected function Virtual TSharedRef< SWidget >  
Protected function Virtual void  
Protected function Virtual int32  

Classes

  Type Name Description
Public struct FArguments    

Enums

  Type Name Description
Protected enum EPaintRetainedContentResult    

Constants

Name Description
OnRetainerModeChangedDelegate  
Shared_MaxRetainerWorkPerFrame  
Shared_RetainerWorkThisFrame  
Shared_WaitingToRender  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page