EPOK RUNTIME

epok::InputLibrary::axis

Method · 1 overload

Method

Performs `axis` as part of the gameplay api module.

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

Declaration

static

Declaration

static InputAxisSample axis(Axis axis,uint32_t port)

Performs `axis` as part of the gameplay api module.

Parameter	Type	Meaning
`axis`	`Axis`	Value supplied for axis. Keep referenced or pointed-to data valid for the complete call.
`port`	`uint32_t`	Value supplied for port. Keep referenced or pointed-to data valid for the complete call.

Returns: InputAxisSample. 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:
// Axis axis
// uint32_t port

auto result = epok::InputLibrary::axis(axis, port);

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

Related members

analogPerforms `analog` as part of the gameplay api module.Method connectedPerforms `connected` as part of the gameplay api module.Method frame_pressedPerforms `frame pressed` as part of the gameplay api module.Method frame_releasedPerforms `frame released` as part of the gameplay api module.Method heldPerforms `held` as part of the gameplay api module.Method pressedPerforms `pressed` as part of the gameplay api module.Method releasedPerforms `released` as part of the gameplay api module.Method