Epok Engine

EPOK RUNTIME

epok::Camera2DComponent::shake

Method · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Method

Shakes the view by up to `amplitude` pixels, fading out over `seconds`.

Belongs to
epok::Camera2DComponent
Header
world2d_components.hpp
Overloads
1

Declaration

Declaration
void shake(Fixed amplitude, Fixed seconds)

Shakes the view by up to `amplitude` pixels, fading out over `seconds`.

ParameterTypeMeaning
amplitudeFixedNot documented; consult the linked header.
secondsFixedNot documented; consult the linked header.

Returns: Nothing (void).

Example sketch

C++ example
#include "world2d_components.hpp"

// Assume these named values have been initialized with valid data:
// Fixed amplitude
// Fixed seconds

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

object.shake(amplitude, seconds);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/world2d_components.hpp:294

Related members