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

#include <IOSCursor.h>

+ Inheritance diagram for FIOSCursor:

Public Member Functions

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

Constructor & Destructor Documentation

◆ FIOSCursor()

FIOSCursor::FIOSCursor ( )

◆ ~FIOSCursor()

virtual FIOSCursor::~FIOSCursor ( )
inlinevirtual

Member Function Documentation

◆ GetPosition()

virtual FVector2D FIOSCursor::GetPosition ( ) const
inlineoverridevirtual

The position of the cursor

Implements ICursor.

◆ GetSize()

void FIOSCursor::GetSize ( int32 Width,
int32 Height 
) const
overridevirtual

Gets the size of the cursor

Implements ICursor.

◆ GetType()

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

Gets the current type of the cursor

Implements ICursor.

◆ Lock()

void FIOSCursor::Lock ( const RECT *const  Bounds)
overridevirtual

Locks the cursor to the passed in bounds

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

Implements ICursor.

◆ SetPosition()

void FIOSCursor::SetPosition ( const int32  X,
const int32  Y 
)
overridevirtual

Sets the position of the cursor

Implements ICursor.

◆ SetType()

void FIOSCursor::SetType ( const EMouseCursor::Type  InNewCursor)
overridevirtual

Sets the cursor

Implements ICursor.

◆ SetTypeShape()

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

Allows overriding the shape of a particular cursor.

Implements ICursor.

◆ Show()

void FIOSCursor::Show ( bool  bShow)
overridevirtual

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 files: