fixadd(3alleg)

fixadd3alleg

Safe function to add fixed point numbers clamping overflow. allegro game programming library.

Usage

#include <allegro.h>

fixed fixadd(fixed x, fixed y);

Overview

Although fixed point numbers can be added with the normal '+' integer operator, that doesn't provide any protection against overflow. If overflow is a problem, you should use this function instead. It is slower than using integer operators, but if an overflow occurs it will set `errno' and clamp the result, rather than just letting it wrap. Example:

   fixed result;
   /* This will put 5035 into `result'. */
   result = fixadd(itofix(5000), itofix(35));
   /* Sets `errno' and puts -32768 into `result'. */
   result = fixadd(itofix(-31000), itofix(-3000));
   ASSERT(!errno); /* This will fail. */

Return value

Returns the clamped result of adding `x' to `y', setting `errno' to ERANGE if there was an overflow.

Releases

4 releases since Debian 3.1 (Sarge); the text changed 2 times.

  1. 3.1
  2. 4.0
  3. 5.0–6.0

From liballegro-doc 2:4.2.2-2.2 in Debian 6.0 (Squeeze). Parsed by carta from the page's man source.