1. Epic GamesDeveloper
  3. URetainerBox

URetainerBox

The Retainer Box 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/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/RetainerBox.h
Include #include "Components/RetainerBox.h"

Syntax

UCLASS (MinimalAPI)  
class URetainerBox : public UContentWidget

Remarks

The Retainer Box 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.

  • Single Child
  • Caching / Performance

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter bool bRetainRender  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bShowEffectsInDesigner If true, retained rendering occurs in designer
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter TObjectPtr< UMaterialInterface > EffectMaterial The effect to optionally apply to the render target.
Protected variable TSharedPtr< class SRetainerWidget > MyRetainerWidget  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly getter int32 Phase The Phase this widget will draw on.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly getter int32 PhaseCount The PhaseCount controls how many phases are possible know what to modulus the current frame count by to determine if this is the current frame to draw the widget on.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly getter bool RenderOnInvalidation Should this widget redraw the contents it has every time it receives an invalidation request from it's children, similar to the invalidation panel.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly getter bool RenderOnPhase Should this widget redraw the contents it has every time the phase occurs.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FName TextureParameter The texture sampler parameter of the @EffectMaterial, that we'll set to the render target.

Constructors

  Type Name Description
Public function  

URetainerBox ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

  
Public function Const FGeometry  
Public function Const UFunction BlueprintCallable, Category UMaterialInstanceDynamic * Get the current dynamic effect material applied to the retainer box.
Public function Const const UMaterialInterface * Gets the current dynamic effect material applied to the retainer box.
Public function Const int32 Get the phase to render on.
Public function Const int32 Get the total number of phases.
Public function Const const FName & Gets the name of the texture parameter to set the render target to on the material.
Protected function void

InitPhase ( int32 InPhase
)

 Initialize Phase in the constructor before the SWidget is constructed.
Protected function void

InitPhaseCount ( int32 InPhaseCount
)

 Initialize PhaseCount in the constructor before the SWidget is constructed.
Protected function void

InitRenderOnInvalidation ( bool InRenderOnInvalidation
)

 Initialize RenderOnInvalidation in the constructor before the SWidget is constructed.
Protected function void

InitRenderOnPhase ( bool InRenderOnPhase
)

 Initialize RenderOnPhase in the constructor before the SWidget is constructed.
Public function Const bool Get whether this widget should redraw the contents it has every time it receives an invalidation request.
Public function Const bool Get whether this widget should redraw the contents it has every time the phase occurs.
Public function Const bool Get the flag for if we retain the render or pass-through.
Public function UFunction BlueprintCallable, Category void Requests the retainer redrawn the contents it has.
Public function UFunction BlueprintCallable, Category void

SetEffectMaterial ( UMaterialInterface* EffectMaterial
)

 Set a new effect material to the retainer widget.
Public function UFunction BlueprintCallable, Category void

SetRenderingPhase ( int32 RenderPhase,
int32 TotalPhases
)

 Requests the retainer redrawn the contents it has.
Public function UFunction BlueprintCallable, Category void

SetRetainRendering ( bool bInRetainRendering
)

 Set the flag for if we retain the render or pass-through
Public function UFunction BlueprintCallable, Category void

SetTextureParameter ( FName TextureParameter
)

 Sets the name of the texture parameter to set the render target to on the material.

Overridden from UPanelWidget

  Type Name Description
Protected function Virtual void  
Protected function Virtual void  

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Protected function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page