Epok Engine

EPOK RUNTIME

epok::hud_core::clipped_rectangle

Function template · 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.

Function template

Performs `clipped rectangle` as part of native HUD layout, drawing and focus navigation.

Belongs to
epok::hud_core
Header
hud_core.hpp
Overloads
1

Declaration

template
Declaration
template<class Rectangle> inline bool clipped_rectangle(Rect r,int width,int height,Rectangle& result)

Performs `clipped rectangle` as part of native HUD layout, drawing and focus navigation.

ParameterTypeMeaning
rRectNot documented; consult the linked header.
widthintNot documented; consult the linked header.
heightintNot documented; consult the linked header.
resultRectangle &Not documented; consult the linked header.

Returns: bool. Consult the linked header for its meaning.

Example sketch

C++ example
#include "hud_core.hpp"

// Replace these template arguments with types or values accepted by the declaration:
// Rectangle

// Assume these named values have been initialized with valid data:
// Rect r
// int width
// int height
// Rectangle & result

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

auto result = object.clipped_rectangle<Rectangle>(r, width, height, result);

Trade-offs and warnings

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

Declared in runtime/hud_core.hpp:24

Related members