diff --git a/JoeyLib-Definitions.md b/JoeyLib-Definitions.md index 8ad3e76..e462469 100644 --- a/JoeyLib-Definitions.md +++ b/JoeyLib-Definitions.md @@ -1,32 +1,62 @@ -#### JOEY_DEBUG -If defined in `joey.h`, enables several debugging functions. JoeyLib memory management operations will be double-checked and tracked. In addition, after the program exits, JoeyLib will generate a file named `JLSTATS` containing allocation statistics and the contents of `why` that was passed to `jlUtilDie()`. Recommended to use this when bracketing debug code in your apps that use JoeyLib. - -#### JOEY_MEM_BLOCKS -In `joey.h` this controls how many concurrent allocations the JoeyLib memory debugging routines will track. If you receive an error about being out of blocks, increase this value. A fixed number of memory block entries is currently used instead of re-implementing the stack code without JoeyLib. +#### JOEY_AMIGA +Defined if the application is running on a Commodore Amiga. #### JOEY_BIG_ENDIAN Defined if the platform the application is running on uses big-endian memory order. -#### JOEY_LITTLE_ENDIAN -Defined if the platform the application is running on uses little-endian memory order. +#### JOEY_DEBUG +If defined in `joey.h`, enables several debugging functions. JoeyLib memory management operations will be double-checked and tracked. In addition, after the program exits, JoeyLib will generate a file named `JLSTATS` containing allocation statistics and the contents of `why` that was passed to `jlUtilDie()`. Recommended to use this when bracketing debug code in your apps that use JoeyLib. -#### JOEY_PC -Defined if the application is running on a PC platform (Windows, Linux, macOS). Embedded and single board computers such as the Raspberry Pi are not considered to be PCs. - -#### JOEY_LINUX -Defined if the application is running on a PC under Linux. - -#### JOEY_MACOS -Defined if the application is running on a PC under macOS. - -#### JOEY_WINDOWS -Defined if the application is running on a PC under Windows. +#### JOEY_DISPLAY +Used to specify the actual display surface for drawing routines. #### JOEY_IIGS Defined if the application is running on an Apple IIgs. -#### JOEY_AMIGA -Defined if the application is running on a Commodore Amiga. +#### JINT16_MAX +Minimum value able to be represented in a signed 16 bit `jint16` variable. + +#### JINT16_MIN +Maximum value able to be represented in a signed 16 bit `jint16` variable. + +#### JINT32_MAX +Minimum value able to be represented in a signed 32 bit `jint32` variable. + +#### JINT32_MIN +Maximum value able to be represented in a signed 32 bit `jint32` variable. + +#### JOEY_LINUX +Defined if the application is running on a PC under Linux. + +#### JOEY_LITTLE_ENDIAN +Defined if the platform the application is running on uses little-endian memory order. + +#### JOEY_MACOS +Defined if the application is running on a PC under macOS. + +#### JOEY_MEM_BLOCKS +In `joey.h` this controls how many concurrent allocations the JoeyLib memory debugging routines will track. If you receive an error about being out of blocks, increase this value. A fixed number of memory block entries is currently used instead of re-implementing the stack code without JoeyLib. + +#### JOEY_PATH_SEPARATOR +Provides the target-specific path separation character such as `\`, `/`, etc. + +#### JOEY_PC +Defined if the application is running on a PC platform (Windows, Linux, macOS). Embedded and single board computers such as the Raspberry Pi are not considered to be PCs. #### JOEY_ST Defined if the application is running on an Atari ST. + +#### JUINT16_MAX +Minimum value able to be represented in an unsigned 16 bit `juint16` variable. + +#### JUINT16_MIN +Maximum value able to be represented in an unsigned 16 bit `juint16` variable. + +#### JUINT32_MAX +Minimum value able to be represented in an unsigned 32 bit `juint32` variable. + +#### JUINT32_MIN +Maximum value able to be represented in an unsigned 32 bit `juint32` variable. + +#### JOEY_WINDOWS +Defined if the application is running on a PC under Windows.