FWindowsCursor Class Reference

#include <WindowsCursor.h>

Inheritance diagram for FWindowsCursor:

Public Member Functions
	FWindowsCursor ()
virtual	~FWindowsCursor ()
virtual void *	CreateCursorFromFile (const FString &InPathToCursorWithoutExtension, FVector2D HotSpot) override
virtual bool	IsCreateCursorFromRGBABufferSupported () const override
virtual void *	CreateCursorFromRGBABuffer (const FColor *Pixels, int32 Width, int32 Height, FVector2D InHotSpot) override
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 bShow) 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

Constructor & Destructor Documentation

FWindowsCursor()

FWindowsCursor::FWindowsCursor

(

)

~FWindowsCursor()

FWindowsCursor::~FWindowsCursor ( )

virtual

Member Function Documentation

CreateCursorFromFile()

void * FWindowsCursor::CreateCursorFromFile ( const FString &  InPathToCursorWithoutExtension, FVector2D  HotSpot  )

overridevirtual

Creates a hardware cursor from file. Can return nullptr when not available.

Reimplemented from ICursor.

CreateCursorFromRGBABuffer()

void * FWindowsCursor::CreateCursorFromRGBABuffer ( const FColor *  Pixels, int32  Width, int32  Height, FVector2D  InHotSpot  )

overridevirtual

Creates a hardware cursor from bitmap data. Can return nullptr when not available.

Reimplemented from ICursor.

GetPosition()

FVector2D FWindowsCursor::GetPosition ( ) const

overridevirtual

The position of the cursor

Implements ICursor.

GetSize()

void FWindowsCursor::GetSize ( int32 &  Width, int32 &  Height  ) const

overridevirtual

Gets the size of the cursor

Implements ICursor.

GetType()

virtual EMouseCursor::Type FWindowsCursor::GetType ( ) const

inlineoverridevirtual

Gets the current type of the cursor

Implements ICursor.

IsCreateCursorFromRGBABufferSupported()

virtual bool FWindowsCursor::IsCreateCursorFromRGBABufferSupported ( ) const

inlineoverridevirtual

Is CreateCursorFromRGBABuffer() supported by this cursor?

Reimplemented from ICursor.

Lock()

void FWindowsCursor::Lock ( const RECT *const  Bounds )

overridevirtual

Locks the cursor to the passed in bounds

Parameters

Bounds

The bounds to lock the cursor to. Pass NULL to unlock.

Implements ICursor.

SetPosition()

void FWindowsCursor::SetPosition ( const int32  X, const int32  Y  )

overridevirtual

Sets the position of the cursor

Implements ICursor.

SetType()

void FWindowsCursor::SetType ( const EMouseCursor::Type  InNewCursor )

overridevirtual

Sets the cursor

Implements ICursor.

SetTypeShape()

void FWindowsCursor::SetTypeShape ( EMouseCursor::Type  InCursorType, void *  CursorHandle  )

overridevirtual

Allows overriding the shape of a particular cursor.

Implements ICursor.

Show()

void FWindowsCursor::Show ( bool  bShow )

overridevirtual

Shows or hides the cursor

Parameters

bShow

true to show the mouse cursor, false to hide it

Implements ICursor.

---

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

• Engine/Source/Runtime/ApplicationCore/Public/Windows/WindowsCursor.h
• Engine/Source/Runtime/ApplicationCore/Private/Windows/WindowsCursor.cpp