Epok Engine

EPOK RUNTIME

epok::World2DLibrary::screen_to_world

Method · 1 overload

Method

Performs `screen to world` as part of the gameplay api module.

Belongs to
epok::World2DLibrary
Header
gameplay_api.hpp
Overloads
1

Declaration

static
Declaration
static GameplayVector2 screen_to_world(GameplayCamera2D value,GameplayVector2 screen)

Performs `screen to world` as part of the gameplay api module.

ParameterTypeMeaning
valueGameplayCamera2DValue supplied for value. Keep referenced or pointed-to data valid for the complete call.
screenGameplayVector2Value supplied for screen. Keep referenced or pointed-to data valid for the complete call.

Returns: GameplayVector2. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "gameplay_api.hpp"

// Assume these named values have been initialized with valid data:
// GameplayCamera2D value
// GameplayVector2 screen

auto result = epok::World2DLibrary::screen_to_world(value, screen);

Why use it

It provides direct, allocation-conscious access to the gameplay api module. No exception-based error path is implied by the signature.

Trade-offs and warnings

Call it only in the lifecycle phase described by the module. Validate indices, capacities and object state before use.

Declared in runtime/gameplay_api.hpp:242

Related members