nanocoat/include/sjme/fixed.h

   1 /* -*- Mode: C; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the Mozilla Public License Version 2.0.
   7 // See license.mkd for licensing and copyright information.
   8 // -------------------------------------------------------------------------*/
   9
  10 /**
  11  * Fixed point math.
  12  *
  13  * @since 2024/06/27
  14  */
  15
  16 #ifndef SQUIRRELJME_FIXED_H
  17 #define SQUIRRELJME_FIXED_H
  18
  19 #include "sjme/stdTypes.h"
  20
  21 /* Anti-C++. */
  22 #ifdef __cplusplus
  23         #ifndef SJME_CXX_IS_EXTERNED
  24                 #define SJME_CXX_IS_EXTERNED
  25                 #define SJME_CXX_SQUIRRELJME_FIXED_H
  26 extern "C" {
  27         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  28 #endif     /* #ifdef __cplusplus */
  29
  30 /*--------------------------------------------------------------------------*/
  31
  32 /**
  33  * Ceiling a fixed point number, removing any fractional value.
  34  *
  35  * @param v The value to ceiling.
  36  * @return The resultant ceiling value.
  37  * @since 2024/07/10
  38  */
  39 sjme_fixed sjme_fixed_ceil(
  40         sjme_attrInValue sjme_jint v);
  41
  42 /**
  43  * Divides two fixed values.
  44  *
  45  * @param num The numerator.
  46  * @param den The denominator.
  47  * @return The resultant fixed value.
  48  * @since 2024/06/27
  49  */
  50 sjme_fixed sjme_fixed_div(
  51         sjme_attrInValue sjme_fixed num,
  52         sjme_attrInValue sjme_fixed den);
  53
  54 /**
  55  * Floors a fixed point number, removing any fractional value.
  56  *
  57  * @param v The value to floor.
  58  * @return The resultant floored value.
  59  * @since 2024/07/10
  60  */
  61 sjme_fixed sjme_fixed_floor(
  62         sjme_attrInValue sjme_jint v);
  63
  64 /**
  65  * Calculates a fraction from two integers.
  66  *
  67  * @param num The numerator.
  68  * @param den The denominator.
  69  * @return The resultant fixed value.
  70  * @since 2024/06/27
  71  */
  72 sjme_fixed sjme_fixed_fraction(
  73         sjme_attrInValue sjme_jint num,
  74         sjme_attrInValue sjme_jint den);
  75
  76 /**
  77  * Converts an integer to a fixed value.
  78  *
  79  * @param val The input value to convert.
  80  * @return The resultant fixed value.
  81  * @since 2024/06/27
  82  */
  83 sjme_fixed sjme_fixed_hi(
  84         sjme_attrInValue sjme_jint val);
  85
  86 /**
  87  * Converts a fixed to an integer value.
  88  *
  89  * @param val The input value to convert.
  90  * @return The resultant integer value.
  91  * @since 2024/06/27
  92  */
  93 sjme_jint sjme_fixed_int(
  94         sjme_attrInValue sjme_fixed val);
  95
  96 /**
  97  * Multiplies two fixed values.
  98  *
  99  * @param a The first value.
 100  * @param b The second value.
 101  * @return The resultant fixed value.
 102  * @since 2024/06/27
 103  */
 104 sjme_fixed sjme_fixed_mul(
 105         sjme_attrInValue sjme_fixed a,
 106         sjme_attrInValue sjme_fixed b);
 107
 108 /**
 109  * Rounds a fixed point number, removing any fractional value.
 110  *
 111  * @param v The value to round.
 112  * @return The resultant rounded value.
 113  * @since 2024/07/10
 114  */
 115 sjme_fixed sjme_fixed_round(
 116         sjme_attrInValue sjme_jint v);
 117
 118 /*--------------------------------------------------------------------------*/
 119
 120 /* Anti-C++. */
 121 #ifdef __cplusplus
 122         #ifdef SJME_CXX_SQUIRRELJME_FIXED_H
 123 }
 124                 #undef SJME_CXX_SQUIRRELJME_FIXED_H
 125                 #undef SJME_CXX_IS_EXTERNED
 126         #endif /* #ifdef SJME_CXX_SQUIRRELJME_FIXED_H */
 127 #endif     /* #ifdef __cplusplus */
 128
 129 #endif /* SQUIRRELJME_FIXED_H */