UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMovieViewport Class Reference

#include <MoviePlayer.h>

+ Inheritance diagram for FMovieViewport:

Public Member Functions

 FMovieViewport ()
 
 ~FMovieViewport ()
 
virtual FIntPoint GetSize () const override
 
virtual class FSlateShaderResourceGetViewportRenderTargetTexture () const override
 
virtual bool RequiresVsync () const override
 
void SetTexture (TWeakPtr< FSlateTexture2DRHIRef, ESPMode::ThreadSafe > InTexture)
 
void SetDefaultSize (FIntPoint InSize)
 
- 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< boolOnQueryShowFocus (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< SWidgetGetWidget ()
 
virtual FReply OnViewportActivated (const FWindowActivateEvent &InActivateEvent)
 
virtual void OnViewportDeactivated (const FWindowActivateEvent &InActivateEvent)
 
- Public Member Functions inherited from TSharedFromThis< FMovieViewport >
TSharedRef< FMovieViewport, Mode > AsShared ()
 
TSharedRef< FMovieViewport const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FMovieViewport, Mode > AsWeak ()
 
TWeakPtr< FMovieViewport 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
 

Additional Inherited Members

- Protected Member Functions inherited from TSharedFromThis< FMovieViewport >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< FMovieViewport >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Detailed Description

This viewport is a simple interface for the loading to use to display the video textures.

Constructor & Destructor Documentation

◆ FMovieViewport()

FMovieViewport::FMovieViewport ( )
inline

◆ ~FMovieViewport()

FMovieViewport::~FMovieViewport ( )
inline

Member Function Documentation

◆ GetSize()

virtual FIntPoint FMovieViewport::GetSize ( ) const
inlineoverridevirtual

Returns the size of the viewport

Implements ISlateViewport.

◆ GetViewportRenderTargetTexture()

virtual class FSlateShaderResource * FMovieViewport::GetViewportRenderTargetTexture ( ) const
inlineoverridevirtual

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

Implements ISlateViewport.

◆ RequiresVsync()

virtual bool FMovieViewport::RequiresVsync ( ) const
inlineoverridevirtual

Returns true if the viewport should be vsynced.

Implements ISlateViewport.

◆ SetDefaultSize()

void FMovieViewport::SetDefaultSize ( FIntPoint  InSize)
inline

Sets the size to use when there is no texture.

◆ SetTexture()

void FMovieViewport::SetTexture ( TWeakPtr< FSlateTexture2DRHIRef, ESPMode::ThreadSafe InTexture)
inline

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