UGameViewportClient::GetCursor

Retrieves the cursor that should be displayed by the OS

Choose your operating system:

Windows

macOS

Linux

Override Hierarchy

FViewportClient::GetCursor()

UGameViewportClient::GetCursor()

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/GameViewportClient.h

Include

#include "Engine/GameViewportClient.h"

Source

/Engine/Source/Runtime/Engine/Private/GameViewportClient.cpp

Syntax

virtual EMouseCursor::Type GetCursor
(
    FViewport * Viewport,
    int32 X,
    int32 Y
)

Remarks

Retrieves the cursor that should be displayed by the OS

Returns

the cursor that the OS should display

Parameters

Parameter

Description

Viewport

the viewport that contains the cursor

X

the x position of the cursor

Y

the Y position of the cursor