Epok Engine

EPOK RUNTIME

epok::Input::axis_raw

Method · 1 overload

Method

Performs `axis raw` as part of controller sampling and simulation-tick input edges.

Belongs to
epok::Input
Header
input.hpp
Overloads
1

Declaration

const
Declaration
int16_t axis_raw(Axis axis,unsigned port=0) const

Performs `axis raw` as part of controller sampling and simulation-tick input edges.

ParameterTypeMeaning
axisAxisValue supplied for axis. Keep referenced or pointed-to data valid for the complete call.
portunsigned intValue supplied for port. Keep referenced or pointed-to data valid for the complete call.

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

Example

C++ example
#include "input.hpp"

// Assume these named values have been initialized with valid data:
// Axis axis
// unsigned int port

epok::Input& object = /* obtain a valid instance */;

auto result = object.axis_raw(axis, port);

Why use it

The method is `const`, so it does not mutate the object through this API surface.

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/input.hpp:19

Related members