Epok Engine

EPOK RUNTIME

epok::Input::analog

Method · 1 overload

Method

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

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

Declaration

const
Declaration
bool analog(unsigned port=0) const

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

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

Returns: bool. 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:
// unsigned int port

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

auto result = object.analog(port);

Why use it

The method is `const`, so it does not mutate the object through this API surface. The boolean result makes success, availability or state explicit without exceptions.

Trade-offs and warnings

Check the return value; `false` is part of normal control flow for many PSX resource operations.

Declared in runtime/input.hpp:18

Related members