api.h

Go to the documentation of this file.

#ifndef BJ_API_H
#define BJ_API_H
 
#include <stddef.h>
#include <stdint.h>

#define BJ_VERSION_RELEASE 0  
#define BJ_VERSION_DEV     1  
#define BJ_VERSION_BETA    2  
#define BJ_VERSION_RC      3  

#define BJ_VERSION_VARIANT(version) ((version) & 0x3U)

#define BJ_VERSION_MAJOR(version) (((version) >> 22U) & 0x3FFU)

#define BJ_VERSION_MINOR(version) (((version) >> 12U) & 0x3FFU)

#define BJ_VERSION_PATCH(version) (((version) >> 2U) & 0x3FFU)

#define BJ_MAKE_VERSION(major, minor, patch, variant) \
    ((((uint32_t)(major)) << 22U) | (((uint32_t)(minor)) << 12U) | \
     (((uint32_t)(patch)) << 2U) | ((uint32_t)(variant)))
 
#define BJ_VERSION_MAJOR_NUMBER 0 
#define BJ_VERSION_MINOR_NUMBER 1 
#define BJ_VERSION_PATCH_NUMBER 0 
#define BJ_VERSION_VARIANT_NUMBER BJ_VERSION_DEV 

#define BJ_VERSION BJ_MAKE_VERSION(BJ_VERSION_MAJOR_NUMBER, BJ_VERSION_MINOR_NUMBER, BJ_VERSION_PATCH_NUMBER, BJ_VERSION_VARIANT_NUMBER)

#define BJ_NAME "Banjo"

#if defined(__EMSCRIPTEN__)
#   define BJ_OS_EMSCRIPTEN
#elif defined(WIN32) || defined(_WIN32) || defined(__WIN32__)
#   define BJ_OS_WINDOWS
#elif defined(__linux__) || defined(__gnu_linux__)
#   define BJ_OS_LINUX
#elif __APPLE__
#   define BJ_OS_APPLE
#   include <TargetConditionals.h>
#   if TARGET_OS_IPHONE
#       define BJ_OS_IOS
#   elif TARGET_IPHONE_SIMULATOR
#       define BJ_OS_IOS
#       define BJ_OS_IOS_SIMULATOR
#   elif TARGET_OS_MAC
#       define BJ_OS_MACOS
#       define BJ_OS_UNIX
#   else
#       define BJ_OS_APPLE_UNKNOWN
#   endif
#else
#   define BJ_OS_UNKNOWN
#endif
 
#if defined(__unix__)
#   define BJ_OS_UNIX
#endif

#if defined(BJ_COMPILER_DOXYGEN)
#    define BJ_COMPILER_NAME "Doxygen"
#    define BJ_COMPILER_VERSION 0
#elif defined(__EMSCRIPTEN__)
#    include <emscripten/version.h>
#    define BJ_COMPILER_EMSCRIPTEN
#    define BJ_COMPILER_NAME "Emscripten"
#    define BJ_COMPILER_VERSION __EMSCRIPTEN_major__
#elif defined(__GNUC__) && !defined(__clang__)
#    define BJ_COMPILER_GCC
#    define BJ_COMPILER_NAME "GCC"
#    define BJ_COMPILER_VERSION __GNUC__
#elif defined(__clang__)
#    define BJ_COMPILER_CLANG
#    define BJ_COMPILER_NAME "Clang"
#    define BJ_COMPILER_VERSION __clang_major__
#elif defined(_MSC_VER)
#    define BJ_COMPILER_MSVC
#    define BJ_COMPILER_NAME "MSVC"
#    define BJ_COMPILER_VERSION _MSC_VER
#elif defined(__MINGW32__)
#    define BJ_COMPILER_MINGW
#    define BJ_COMPILER_NAME "MinGW"
#    define BJ_COMPILER_VERSION 0
#else
#    define BJ_COMPILER_UNKNOWN
#    define BJ_COMPILER_NAME "Unknown"
#    define BJ_COMPILER_VERSION 0
#endif

#if defined(NDEBUG) || defined(BJ_COMPILER_DOXYGEN)
#   define BJ_BUILD_RELEASE
#endif
#if !defined(NDEBUG) || defined(BJ_COMPILER_DOXYGEN)
#   define BJ_BUILD_DEBUG
#endif


#if defined(BANJO_STATIC) || defined(BJ_COMPILER_DOXYGEN)
#  define BANJO_EXPORT
#  define BANJO_NO_EXPORT
#else
#    ifdef _MSC_VER
#      ifndef BANJO_EXPORT
#        ifdef BANJO_EXPORTS
#          define BANJO_EXPORT __declspec(dllexport)
#        else
#          define BANJO_EXPORT  __declspec( dllexport )
#        endif
#      endif
#      ifndef BANJO_NO_EXPORT
#        define BANJO_NO_EXPORT 
#      endif
#    else
#      ifndef BANJO_EXPORT
#        ifdef BANJO_EXPORTS
#          define BANJO_EXPORT __attribute__((visibility("default")))
#        else
#          define BANJO_EXPORT __attribute__((visibility("default")))
#        endif
#      endif
#      ifndef BANJO_NO_EXPORT
#        define BANJO_NO_EXPORT __attribute__((visibility("hidden")))
#      endif
#    endif
#endif

#if defined(__cplusplus)
    #if defined(__GNUC__) || defined(__clang__)
        #define BJ_RESTRICT __restrict__
    #elif defined(_MSC_VER)
        #define BJ_RESTRICT __restrict
    #else
        #define BJ_RESTRICT /* nothing */
    #endif
#else
    /* pure C (C99 or newer) */
    #if defined(BJ_COMPILER_DOXYGEN) || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
        #define BJ_RESTRICT restrict
    #elif defined(__GNUC__) || defined(__clang__)
        #define BJ_RESTRICT __restrict__
    #elif defined(_MSC_VER)
        #define BJ_RESTRICT __restrict
    #else
        #define BJ_RESTRICT /* nothing */
    #endif
#endif

#if defined(_MSC_VER)
    #if defined(BJ_API_FORCE_INLINE)
        #define BJ_INLINE __forceinline
    #else
        #if !defined(__cplusplus) && !defined(inline)
            #define BJ_INLINE __inline
        #else
            #define BJ_INLINE inline
        #endif
    #endif
#elif defined(__GNUC__) || defined(__clang__)
    #if defined(BJ_API_FORCE_INLINE)
        #define BJ_INLINE inline __attribute__((always_inline))
    #else
        #define BJ_INLINE inline
    #endif
#else
    #if defined(BJ_COMPILER_DOXYGEN) || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
        #define BJ_INLINE inline
    #else
        #define BJ_INLINE /* no inline available */
    #endif
#endif

typedef uint32_t bj_bool;

#define BJ_FALSE ((bj_bool)0)

#define BJ_TRUE ((bj_bool)1)

struct bj_build_info {
    const char* name;                
    uint32_t    version;             
    const char* compiler_name;       
    int         compiler_version;    
    bj_bool     debug;               
    bj_bool     backend_alsa;        
    bj_bool     backend_cocoa;       
    bj_bool     backend_emscripten;  
    bj_bool     backend_mme;         
    bj_bool     backend_win32;       
    bj_bool     backend_x11;         
    bj_bool     checks_abort;        
    bj_bool     checks_log;          
    bj_bool     fastmath;            
    bj_bool     log_color;           
    bj_bool     pedantic;            
};

BANJO_EXPORT const struct bj_build_info* bj_build_information(void);

#ifndef BJ_NO_TYPEDEF
 
typedef enum bj_audio_format bj_audio_format;
typedef enum bj_blit_op bj_blit_op;
typedef enum bj_callback_result bj_callback_result;
typedef enum bj_error_code bj_error_code;
typedef enum bj_event_action bj_event_action;
typedef enum bj_event_type bj_event_type;
typedef enum bj_key bj_key;
typedef enum bj_log_level bj_log_level;
typedef enum bj_pixel_mode bj_pixel_mode;
typedef enum bj_renderer_type bj_renderer_type;
typedef enum bj_seek_origin bj_seek_origin;
typedef enum bj_shader_flag bj_shader_flag;
typedef enum bj_window_flag bj_window_flag;
typedef struct bj_angular_2d bj_angular_2d;
typedef struct bj_cli bj_cli;
typedef struct bj_cli_argument bj_cli_argument;
typedef struct bj_audio_device bj_audio_device;
typedef struct bj_audio_play_note_data bj_audio_play_note_data;
typedef struct bj_audio_properties bj_audio_properties;
typedef struct bj_bitmap bj_bitmap;
typedef struct bj_build_info bj_build_info;
typedef struct bj_button_event bj_button_event;
typedef struct bj_cursor_event bj_cursor_event;
typedef struct bj_enter_event bj_enter_event;
typedef struct bj_error bj_error;
typedef struct bj_event bj_event;
typedef struct bj_key_event bj_key_event;
typedef struct bj_mat3x2 bj_mat3x2;
typedef struct bj_mat3x3 bj_mat3;
typedef struct bj_mat3x3 bj_mat3x3;
typedef struct bj_mat4x3 bj_mat4x3;
typedef struct bj_mat4x4 bj_mat4;
typedef struct bj_mat4x4 bj_mat4x4;
typedef struct bj_memory_callbacks bj_memory_callbacks;
typedef struct bj_particle_2d bj_particle_2d;
typedef struct bj_pcg32 bj_pcg32;
typedef struct bj_rect bj_rect;
typedef struct bj_renderer bj_renderer;
typedef struct bj_rigid_body_2d bj_rigid_body_2d;
typedef struct bj_stopwatch bj_stopwatch;
typedef struct bj_stream bj_stream;
typedef struct bj_vec2 bj_vec2;
typedef struct bj_vec3 bj_vec3;
typedef struct bj_vec4 bj_quat;
typedef struct bj_vec4 bj_vec4;
typedef struct bj_window bj_window;
 
#endif /* BJ_NO_TYPEDEF */
 
#endif /* BJ_API_H */