UGameplayStatics::ProjectWorldToScreen

Transforms the given 3D world-space point into a its 2D screen space coordinate.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Kismet/GameplayStatics.h

Include

#include "Kismet/GameplayStatics.h"

Source

/Engine/Source/Runtime/Engine/Private/GameplayStatics.cpp

Syntax

static bool ProjectWorldToScreen
(
    APlayerController const * Player,
    const FVector & WorldPosition,
    FVector2D & ScreenPosition,
    bool bPlayerViewportRelative
)

Remarks

Transforms the given 3D world-space point into a its 2D screen space coordinate.

Parameters

Parameter

Description

Player

Project using this player's view.

WorldPosition

World position to project.

ScreenPosition

(out) Corresponding 2D position in screen space

bPlayerViewportRelative

Should this be relative to the player viewport subregion (useful when using player attached widgets in split screen)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss