Function grid_map::wrapIndexToRange(Index&, const Size&)

Function Documentation

void grid_map::wrapIndexToRange(Index &index, const Size &bufferSize)

Wraps an index that runs out of the range of the buffer back into allowed the region. This means that an index that overflows is reset to zero. This is the 2d version of wrapIndexToRange(int&, const int&).

Parameters:

  • [in/out] – index the indeces that will be wrapped into the valid region of the buffer.

  • bufferSize – [in] the size of the buffer.