UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FBackgroundView Class Reference
+ Inheritance diagram for FBackgroundView:

Public Member Functions

 FBackgroundView (FTextureRHIRef RenderTargetTexture, FIntPoint InSize)
 
 ~FBackgroundView ()
 
virtual FIntPoint GetSize () const override
 
virtual FSlateShaderResource * GetViewportRenderTargetTexture () const override
 
virtual bool RequiresVsync () const override
 
- Public Member Functions inherited from ISlateViewport
virtual ~ISlateViewport ()
 
virtual void OnDrawViewport (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, class FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled)
 
virtual EPixelFormat GetSceneTargetFormat () const
 
virtual bool IsViewportTextureAlphaOnly () const
 
virtual bool IsStereoscopic3D () const
 
virtual bool UseSeparateRenderTarget () const
 
virtual ESlateViewportDynamicRange GetViewportDynamicRange () const
 
virtual void Tick (const FGeometry &AllottedGeometry, double InCurrentTime, float DeltaTime)
 
virtual bool AllowScaling () const
 
virtual FCursorReply OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent)
 
virtual TOptional< TSharedRef< SWidget > > OnMapCursor (const FCursorReply &CursorReply)
 
virtual bool IsSoftwareCursorVisible () const
 
virtual FVector2D GetSoftwareCursorPosition () const
 
virtual FReply OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual FReply OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual void OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual void OnMouseLeave (const FPointerEvent &MouseEvent)
 
virtual FReply OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual FReply OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual FReply OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)
 
virtual FReply OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual FReply OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual FReply OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)
 
virtual FReply OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)
 
virtual FReply OnFocusReceived (const FFocusEvent &InFocusEvent)
 
virtual FReply OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual FReply OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual FReply OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual FReply OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual FReply OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual FReply OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &InGestureEvent)
 
virtual FReply OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)
 
virtual TOptional< bool > OnQueryShowFocus (const EFocusCause InFocusCause) const
 
virtual void OnFinishedPointerInput ()
 
virtual FPopupMethodReply OnQueryPopupMethod () const
 
virtual FNavigationReply OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)
 
virtual bool HandleNavigation (const uint32 InUserIndex, TSharedPtr< SWidget > InDestination)
 
virtual void OnFocusLost (const FFocusEvent &InFocusEvent)
 
virtual FReply OnRequestWindowClose ()
 
virtual void OnViewportClosed ()
 
virtual TWeakPtr< SWidget > GetWidget ()
 
virtual FReply OnViewportActivated (const FWindowActivateEvent &InActivateEvent)
 
virtual void OnViewportDeactivated (const FWindowActivateEvent &InActivateEvent)
 

Constructor & Destructor Documentation

◆ FBackgroundView()

FBackgroundView::FBackgroundView ( FTextureRHIRef  RenderTargetTexture,
FIntPoint  InSize 
)
inline

◆ ~FBackgroundView()

FBackgroundView::~FBackgroundView ( )
inline

Member Function Documentation

◆ GetSize()

virtual FIntPoint FBackgroundView::GetSize ( ) const
inlineoverridevirtual

Returns the size of the viewport

Implements ISlateViewport.

◆ GetViewportRenderTargetTexture()

virtual FSlateShaderResource * FBackgroundView::GetViewportRenderTargetTexture ( ) const
inlineoverridevirtual

Returns a slate texture used to draw the rendered viewport in Slate.

Implements ISlateViewport.

◆ RequiresVsync()

virtual bool FBackgroundView::RequiresVsync ( ) const
inlineoverridevirtual

Returns true if the viewport should be vsynced.

Implements ISlateViewport.

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