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

Public Member Functions

 FFauxSlateCursor ()
 
virtual ~FFauxSlateCursor ()
 
virtual void SetTypeShape (EMouseCursor::Type InCursorType, void *CursorHandle) override
 
virtual FVector2D GetPosition () const override
 
virtual EMouseCursor::Type GetType () const override
 
virtual void SetType (const EMouseCursor::Type InNewCursor) override
 
virtual void Show (bool bShow) override
 
virtual void SetPosition (const int32 X, const int32 Y) override
 
virtual void GetSize (int32 &Width, int32 &Height) const override
 
virtual void Lock (const RECT *const Bounds) override
 
- Public Member Functions inherited from ICursor
virtual ~ICursor ()=default
 
virtual void * CreateCursorFromFile (const FString &InPathToCursorWithoutExtension, FVector2D HotSpot)
 
virtual bool IsCreateCursorFromRGBABufferSupported () const
 
virtual void * CreateCursorFromRGBABuffer (const FColor *Pixels, int32 Width, int32 Height, FVector2D InHotSpot)
 

Detailed Description

The cursor given to any additional input-providing SlateUsers beyond the first one (since the first one owns the platform cursor) Or, if we're on a platform without a cursor, User 0 gets one of these too

Constructor & Destructor Documentation

◆ FFauxSlateCursor()

FFauxSlateCursor::FFauxSlateCursor ( )
inline

◆ ~FFauxSlateCursor()

virtual FFauxSlateCursor::~FFauxSlateCursor ( )
inlinevirtual

Member Function Documentation

◆ GetPosition()

virtual FVector2D FFauxSlateCursor::GetPosition ( ) const
inlineoverridevirtual

The position of the cursor

Implements ICursor.

◆ GetSize()

virtual void FFauxSlateCursor::GetSize ( int32 &  Width,
int32 &  Height 
) const
inlineoverridevirtual

Gets the size of the cursor

Implements ICursor.

◆ GetType()

virtual EMouseCursor::Type FFauxSlateCursor::GetType ( ) const
inlineoverridevirtual

Gets the current type of the cursor

Implements ICursor.

◆ Lock()

virtual void FFauxSlateCursor::Lock ( const RECT *const  Bounds)
inlineoverridevirtual

Locks the cursor to the passed in bounds

Parameters
BoundsThe bounds to lock the cursor to. Pass NULL to unlock.

Implements ICursor.

◆ SetPosition()

virtual void FFauxSlateCursor::SetPosition ( const int32  X,
const int32  Y 
)
inlineoverridevirtual

Sets the position of the cursor

Implements ICursor.

◆ SetType()

virtual void FFauxSlateCursor::SetType ( const EMouseCursor::Type  InNewCursor)
inlineoverridevirtual

Sets the cursor

Implements ICursor.

◆ SetTypeShape()

virtual void FFauxSlateCursor::SetTypeShape ( EMouseCursor::Type  InCursorType,
void *  CursorHandle 
)
inlineoverridevirtual

Allows overriding the shape of a particular cursor.

Implements ICursor.

◆ Show()

virtual void FFauxSlateCursor::Show ( bool  bShow)
inlineoverridevirtual

Shows or hides the cursor

Parameters
bShowtrue to show the mouse cursor, false to hide it

Implements ICursor.

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