1. Epic GamesDeveloper
  3. UWidgetBlueprintLibrary

UWidgetBlueprintLibrary

Unreal Engine C++ API Reference > Runtime > UMG > Blueprint

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Blueprint/WidgetBlueprintLibrary.h
Include #include "Blueprint/WidgetBlueprintLibrary.h"

Syntax

class UWidgetBlueprintLibrary : public UBlueprintFunctionLibrary

Constructors

  Type Name Description
Public function  

UWidgetBlueprintLibrary ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void Cancels any current drag drop operation.
Public function Static FEventReply

CaptureJoystick ( FEventReply& Reply,
UWidget* CapturingWidget,
bool bInAllJoysticks
)

  
Public function Static FEventReply

CaptureMouse ( FEventReply& Reply,
UWidget* CapturingWidget
)

  
Public function Static FEventReply

ClearUserFocus ( FEventReply& Reply,
bool bInAllUsers
)

  
Public function Static UUserWidget *

Create ( UObject* WorldContextObject,
TSubclassOf< class UUserWidget > WidgetType,
APlayerController* OwningPlayer
)

 Creates a widget
Public function Static UDragDropOperation * Creates a new drag and drop operation that can be returned from a drag begin to inform the UI what i being dragged and dropped and what it looks like.
Public function Static FEventReply

DetectDrag ( FEventReply& Reply,
UWidget* WidgetDetectingDrag,
FKey DragKey
)

 Ask Slate to detect if a user starts dragging in this widget later.
Public function Static FEventReply

DetectDragIfPressed ( const FPointerEvent& PointerEvent,
UWidget* WidgetDetectingDrag,
FKey DragKey
)

 Given the pointer event, emit the DetectDrag reply if the provided key was pressed.
Public function Static void Closes any popup menu
Public function Static void

DrawBox ( FPaintContext& Context,
FVector2D Position,
FVector2D Size,
USlateBrushAsset* Brush,
FLinearColor Tint
)

 Draws a box
Public function Static void

DrawLine ( FPaintContext& Context,
FVector2D PositionA,
FVector2D PositionB,
FLinearColor Tint,
bool bAntiAlias,
float Thickness
)

 Draws a line.
Public function Static void

DrawLines ( FPaintContext& Context,
const TArray< FVector2D >& Points,
FLinearColor Tint,
bool bAntiAlias,
float Thickness
)

 Draws several line segments.
Public function Static void

DrawSpline ( FPaintContext& Context,
FVector2D Start,
FVector2D StartDir,
FVector2D End,
FVector2D EndDir,
FLinearColor Tint,
float Thickness
)

 Draws a hermite spline.
Public function Static void

DrawText ( FPaintContext& Context,
const FString& InString,
FVector2D Position,
FLinearColor Tint
)

 Draws text.
Public function Static void

DrawTextFormatted ( FPaintContext& Context,
const FText& Text,
FVector2D Position,
UFont* Font,
float FontSize,
FName FontTypeFace,
FLinearColor Tint
)

 Draws text.
Public function Static FEventReply An event should return FReply::Handled().EndDragDrop() to request that the current drag/drop operation be terminated.
Public function Static void

GetAllWidgetsOfClass ( UObject* WorldContextObject,
TArray< UUserWidget* >& FoundWidgets,
TSubclassOf< UUserWidget > WidgetClass,
bool TopLevelOnly
)

 Find all widgets of a certain class.
Public function Static void

GetAllWidgetsWithInterface ( UObject* WorldContextObject,
TArray< UUserWidget* >& FoundWidgets,
TSubclassOf< UInterface > Interface,
bool TopLevelOnly
)

 Find all widgets in the world with the specified interface.
Public function Static UObject *

GetBrushResource ( const FSlateBrush& Brush
)

 Gets the resource object on a brush.
Public function Static UMaterialInterface * Gets the brush resource as a material.
Public function Static UTexture2D * Gets the brush resource as a texture 2D.
Public function Static UDragDropOperation * Returns the drag and drop operation that is currently occurring if any, otherwise nothing.
Public function Static UMaterialInstanceDynamic * Gets the material that allows changes to parameters at runtime.
Public function Static FInputEvent  
Public function Static FInputEvent  
Public function Static FInputEvent  
Public function Static FInputEvent  
Public function Static FKeyEvent  
Public function Static void

GetSafeZonePadding ( UObject* WorldContextObject,
FVector4& SafePadding,
FVector2D& SafePaddingScale,
FVector4& SpillOverPadding
)

 Gets the amount of padding that needs to be added when accounting for the safe zone on TVs.
Public function Static FEventReply

Handled ()

 The event reply to use when you choose to handle an event.
Public function Static bool Returns true if a drag/drop event is occurring that a widget can handle.
Public function Static FEventReply

LockMouse ( FEventReply& Reply,
UWidget* CapturingWidget
)

  
Public function Static FSlateBrush Creates a Slate Brush from a Slate Brush Asset
Public function Static FSlateBrush

MakeBrushFromMaterial ( UMaterialInterface* Material,
int32 Width,
int32 Height
)

 Creates a Slate Brush from a Material.
Public function Static FSlateBrush

MakeBrushFromTexture ( UTexture2D* Texture,
int32 Width,
int32 Height
)

 Creates a Slate Brush from a Texture2D
Public function Static FSlateBrush Creates a Slate Brush that wont draw anything, the "Null Brush".
Public function Static FEventReply

ReleaseJoystickCapture ( FEventReply& Reply,
bool bInAllJoysticks
)

  
Public function Static FEventReply  
Public function Static void  
Public function Static void Sets the resource on a brush to be a Material.
Public function Static void Sets the resource on a brush to be a UTexture2D.
Public function Static void

SetColorVisionDeficiencyType ( EColorVisionDeficiency Type,
float Severity,
bool CorrectDeficiency,
bool ShowCorrectionWithDeficiency
)

 Apply color deficiency correction settings to the game window
Public function Static void  
Public function Static bool

SetHardwareCursor ( UObject* WorldContextObject,
EMouseCursor::Type CursorShape,
FName CursorName,
FVector2D HotSpot
)

 Loads or sets a hardware cursor from the content directory in the game.
Public function Static void

SetInputMode_GameAndUIEx ( APlayerController* PlayerController,
UWidget* InWidgetToFocus,
EMouseLockMode InMouseLockMode,
bool bHideCursorDuringCapture,
const bool bFlushInput
)

 Setup an input mode that allows only the UI to respond to user input, and if the UI doesn't handle it player input / player controller gets a chance.
Public function Static void

SetInputMode_GameOnly ( APlayerController* PlayerController,
const bool bFlushInput
)

 Setup an input mode that allows only player input / player controller to respond to user input.
Public function Static void

SetInputMode_UIOnlyEx ( APlayerController* PlayerController,
UWidget* InWidgetToFocus,
EMouseLockMode InMouseLockMode,
const bool bFlushInput
)

 Setup an input mode that allows only the UI to respond to user input.
Public function Static FEventReply

SetMousePosition ( FEventReply& Reply,
FVector2D NewMousePosition
)

  
Public function Static FEventReply

SetUserFocus ( FEventReply& Reply,
UWidget* FocusWidget,
bool bInAllUsers
)

  
Public function Static void  
Public function Static void  
Public function Static void

SetWindowTitleBarState ( UWidget* TitleBarContent,
EWindowTitleBarMode Mode,
bool bTitleBarDragEnabled,
bool bWindowButtonsVisible,
bool bTitleBarVisible
)

  
Public function Static FEventReply The event reply to use when you choose not to handle an event.
Public function Static FEventReply  

Classes

  Type Name Description
Public class FOnGameWindowCloseButtonClickedDelegate    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.