Banjo API 1.1.0-alpha
Low-level C99 game development API
Loading...
Searching...
No Matches
Core
Collaboration diagram for Core:

Topics

 Application
 Main Entry Point

Files

file  assert.h

Data Structures

struct  bj_build_info

Macros

#define BJ_FALSE   ((bj_bool)0)
#define BJ_TRUE   ((bj_bool)1)

Typedefs

typedef uint32_t bj_bool

Functions

const struct bj_build_info * bj_build_information (void)

Convenience typedefs for public API types

By default, Banjo provides typedefs that allow writing type names without the struct or enum keywords (e.g., bj_vec2 instead of struct bj_vec2).

To disable these typedefs and use explicit struct/enum keywords everywhere, define BJ_NO_TYPEDEF before including Banjo headers.

typedef struct bj_address bj_address
typedef struct bj_angular_2d bj_angular_2d
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_cli bj_cli
typedef struct bj_cli_argument bj_cli_argument
typedef struct bj_cursor_event bj_cursor_event
typedef struct bj_datagram bj_datagram
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_mat3 bj_mat3
typedef struct bj_mat32 bj_mat32
typedef struct bj_mat4 bj_mat4
typedef struct bj_mat43 bj_mat43
typedef struct bj_mat3 bj_mat3x3
typedef struct bj_mat32 bj_mat3x2
typedef struct bj_mat4 bj_mat4x4
typedef struct bj_mat43 bj_mat4x3
typedef struct bj_maze bj_maze
typedef struct bj_maze_builder bj_maze_builder
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_render_target bj_render_target
typedef struct bj_rigid_body_2d bj_rigid_body_2d
typedef struct bj_stopwatch bj_stopwatch
typedef struct bj_str bj_str
typedef struct bj_string bj_string
typedef struct bj_stream bj_stream
typedef struct bj_stream_callbacks bj_stream_callbacks
typedef struct bj_tcp_listener bj_tcp_listener
typedef struct bj_tcp_stream bj_tcp_stream
typedef struct bj_text_wrapper bj_text_wrapper
typedef struct bj_udp bj_udp
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

Platform detection

One of these will be defined to indicate the target OS.

#define BJ_OS_UNKNOWN

Compiler detection

One of these will be defined to indicate the compiler in use.

Additionally BJ_COMPILER_NAME and BJ_COMPILER_VERSION are provided.

#define BJ_COMPILER_NAME   "Doxygen"
#define BJ_COMPILER_VERSION   0

Build configuration

Exactly one of BJ_BUILD_DEBUG or BJ_BUILD_RELEASE is defined.

#define BJ_BUILD_RELEASE
#define BJ_BUILD_DEBUG

C++ linkage helper

#define BJ_EXTERN_C

Export/visibility helpers

BANJO_EXPORT marks public symbols.

BANJO_NO_EXPORT hides symbols.

#define BANJO_EXPORT   BJ_EXTERN_C
#define BANJO_NO_EXPORT

Restrict qualifier macro

#define BJ_RESTRICT   restrict

Inline helper macro

#define BJ_INLINE   inline

Detailed Description

General-purpose API.


Data Structure Documentation

◆ bj_build_info

struct bj_build_info

Structure holding build information of the binary.

Fields are only ever added at the end, so a program built against an earlier version of this header still reads the fields it knows.

Examples
banjo-info.c.

Definition at line 288 of file api.h.

Data Fields
bj_bool backend_alsa Built with ALSA audio.
bj_bool backend_cocoa Built with Cocoa/macOS support.
bj_bool backend_coreaudio Built with CoreAudio audio (since 1.1).
bj_bool backend_emscripten Built with Emscripten support.
bj_bool backend_fake Built with the fake video and audio backends (since 1.1).
bj_bool backend_mme Built with Windows MME audio.
bj_bool backend_wayland Built with Wayland window support.
bj_bool backend_win32 Built with Win32 window support.
bj_bool backend_x11 Built with X11 window support.
bj_bool checks_abort Built with BJ_CONFIG_CHECKS_ABORT, deprecated and without effect.
bj_bool checks_log Checks log failures.
const char * compiler_name Compiler name string.
int compiler_version Compiler version number.
bj_bool debug Non-zero if built with debug info: describes this library's own build, not the including program's NDEBUG.
bj_bool fastmath Built with fast-math optimizations.
bj_bool log_color Colored log output enabled.
const char * name API name (see BJ_NAME).
bj_bool pedantic Extra runtime checks enabled.
size_t real_size Size of bj_real in the library, in bytes (since 1.1).
const char * variant API name variant (see BJ_NAME_VARIANT).
uint32_t version Packed API version (see BJ_VERSION).

Macro Definition Documentation

◆ BANJO_EXPORT

#define BANJO_EXPORT   BJ_EXTERN_C

Definition at line 179 of file api.h.

Referenced by bj_accept_tcp(), bj_accept_tcp_stream(), bj_address_count(), bj_address_equals(), bj_address_next(), bj_address_port(), bj_address_reset(), bj_address_string(), bj_address_to_string(), bj_allocate_bitmap(), bj_allocate_stream(), bj_app_fixed_step_rate(), bj_app_frame_rate(), bj_append_string(), bj_apply_angular_torque_2d(), bj_apply_drag_2d(), bj_apply_gravity_2d(), bj_apply_particle_force_2d(), bj_apply_point_gravity_2d(), bj_apply_point_gravity_softened_2d(), bj_apply_rigid_body_force_2d(), bj_apply_rigidbody_force_2d(), bj_apply_torque_2d(), bj_assign_bitmap(), bj_audio_backends(), bj_audio_device_is_playing(), bj_audio_playing(), bj_begin(), bj_begin_system(), bj_bernoulli_distribution(), bj_bind_window(), bj_bitmap_height(), bj_bitmap_mode(), bj_bitmap_pixel(), bj_bitmap_pixel_data(), bj_bitmap_pixel_rgb(), bj_bitmap_pixels(), bj_bitmap_stride(), bj_bitmap_width(), bj_blit(), bj_blit_bitmap(), bj_blit_bitmap_mask(), bj_blit_bitmap_mask_stretched(), bj_blit_bitmap_stretched(), bj_blit_mask(), bj_blit_mask_stretched(), bj_blit_stretched(), bj_blit_text(), bj_build_information(), bj_call_main(), bj_calloc(), bj_check_circle_segment_hit(), bj_check_segments_hit(), bj_circle_hits_segment_2d(), bj_circle_pixels(), bj_clear_bitmap(), bj_clear_error(), bj_clear_maze_marks(), bj_clear_stream_status(), bj_clear_text_wrapper_status(), bj_close_audio_device(), bj_close_datagram(), bj_close_maze(), bj_close_maze_cell(), bj_close_on_escape(), bj_close_stream(), bj_close_tcp_listener(), bj_close_tcp_stream(), bj_close_udp(), bj_compute_bitmap_stride(), bj_compute_kinematics_2d(), bj_compute_kinematics_velocity_2d(), bj_compute_particle_drag_coefficient_2d(), bj_compute_particle_drag_force_2d(), bj_compute_pixel_mode(), bj_connect_tcp(), bj_connect_tcp_stream(), bj_connect_tcp_stream_to(), bj_connect_tcp_to(), bj_convert_bitmap(), bj_copy_bitmap(), bj_copy_error(), bj_create_audio_device(), bj_create_bitmap(), bj_create_bitmap_from_file(), bj_create_bitmap_from_pixels(), bj_create_bitmap_from_stream(), bj_create_maze_builder(), bj_create_maze_marks(), bj_create_maze_ortho2d(), bj_create_stream(), bj_create_stream_from_callbacks(), bj_create_stream_from_memory(), bj_create_stream_from_path(), bj_create_stream_from_read_memory(), bj_create_stream_from_tcp(), bj_create_stream_span(), bj_create_string(), bj_create_tcp_listener(), bj_create_text_wrapper(), bj_create_udp(), bj_create_window(), bj_datagram_addr(), bj_datagram_address(), bj_datagram_data(), bj_datagram_len(), bj_datagram_length(), bj_datagram_port(), bj_destroy_address(), bj_destroy_audio_device(), bj_destroy_bitmap(), bj_destroy_datagram(), bj_destroy_maze(), bj_destroy_maze_builder(), bj_destroy_maze_marks(), bj_destroy_stream(), bj_destroy_string(), bj_destroy_tcp_listener(), bj_destroy_tcp_stream(), bj_destroy_text_wrapper(), bj_destroy_udp(), bj_destroy_window(), bj_disable_bitmap_colorkey(), bj_disable_tcp_keepalive(), bj_discard_pcg32(), bj_dispatch_event(), bj_dispatch_events(), bj_draw_circle(), bj_draw_filled_circle(), bj_draw_filled_rectangle(), bj_draw_filled_triangle(), bj_draw_line(), bj_draw_line_mode(), bj_draw_polyline(), bj_draw_polyline_mode(), bj_draw_rectangle(), bj_draw_text(), bj_draw_textf(), bj_draw_triangle(), bj_enable_bitmap_colorkey(), bj_enable_colorkey(), bj_enable_tcp_keepalive(), bj_end(), bj_end_system(), bj_enumerate_circle_pixels(), bj_enumerate_grid_ray_cells(), bj_enumerate_line_pixels(), bj_error_code(), bj_error_matches(), bj_error_matches_kind(), bj_error_message(), bj_flush_stream(), bj_flush_text_wrapper(), bj_format_version(), bj_free(), bj_free_address(), bj_get_cli_help_string(), bj_get_key(), bj_get_log_level(), bj_get_log_level_string(), bj_get_pixel_value(), bj_get_stream_length(), bj_get_tcp_keepalive(), bj_get_tcp_recv_timeout(), bj_get_tcp_send_timeout(), bj_get_time(), bj_get_window_flags(), bj_get_window_size(), bj_grid_ray_cells(), bj_init_bitmap(), bj_invalidate_rect(), bj_is_window_fullscreen(), bj_key_name(), bj_library_symbol(), bj_line_pixels(), bj_listen_tcp(), bj_load_library(), bj_log_level_name(), bj_log_message(), bj_make_bitmap_pixel(), bj_make_bitmap_rgb(), bj_make_pixel_rgb(), bj_malloc(), bj_mark_maze_cell(), bj_max_pcg32(), bj_maze_adjacent(), bj_maze_adjacent_cell(), bj_maze_algorithm_aldous_broder(), bj_maze_algorithm_backtracker(), bj_maze_algorithm_btree(), bj_maze_algorithm_hunt_and_kill(), bj_maze_algorithm_sidewinder(), bj_maze_algorithm_wilson(), bj_maze_builder_completed(), bj_maze_builder_is_complete(), bj_maze_cell_count(), bj_maze_cell_is_open(), bj_maze_cell_marks(), bj_maze_cell_opened(), bj_maze_close_all(), bj_maze_degree(), bj_maze_open_all(), bj_maze_ortho2d_cell(), bj_measure_text(), bj_memcmp(), bj_memcpy(), bj_memmove(), bj_memset(), bj_memzero(), bj_min_pcg32(), bj_next_pcg32(), bj_normal_double_distribution(), bj_normal_double_minmax_distribution(), bj_normal_float_distribution(), bj_normal_float_minmax_distribution(), bj_normal_long_double_distribution(), bj_normal_long_double_minmax_distribution(), bj_open_audio_device(), bj_open_maze(), bj_open_maze_cell(), bj_open_stream_file(), bj_open_stream_read(), bj_open_udp(), bj_pack_bitmap_rgb(), bj_pack_pixel_rgb(), bj_parse_cli(), bj_pause_audio_device(), bj_pcg32_max(), bj_pcg32_min(), bj_peek_tcp(), bj_peek_text_wrapper(), bj_play_audio_device(), bj_play_audio_note(), bj_poll_event(), bj_poll_events(), bj_prefix_error(), bj_prefix_error_fmt(), bj_print_cli_help(), bj_print_cli_help_action(), bj_propagate_error(), bj_propagate_prefixed_error(), bj_push_button_event(), bj_push_cursor_event(), bj_push_enter_event(), bj_push_event(), bj_push_key_event(), bj_put_pixel(), bj_quit_app(), bj_rand(), bj_random_bernoulli(), bj_random_normal_f32(), bj_random_normal_f64(), bj_random_normal_ld(), bj_random_normal_range_f32(), bj_random_normal_range_f64(), bj_random_normal_range_ld(), bj_random_uniform_f32(), bj_random_uniform_f64(), bj_random_uniform_i32(), bj_random_uniform_ld(), bj_random_uniform_u32(), bj_read_stream(), bj_read_stream_i16_be(), bj_read_stream_i16_le(), bj_read_stream_i32_be(), bj_read_stream_i32_le(), bj_read_stream_i64_be(), bj_read_stream_i64_le(), bj_read_stream_i8(), bj_read_stream_u16_be(), bj_read_stream_u16_le(), bj_read_stream_u32_be(), bj_read_stream_u32_le(), bj_read_stream_u64_be(), bj_read_stream_u64_le(), bj_read_stream_u8(), bj_read_text_wrapper(), bj_read_text_wrapper_line(), bj_realloc(), bj_receive_tcp(), bj_receive_udp(), bj_rect_intersection(), bj_rect_intersects(), bj_rect_union(), bj_render_target_bitmap(), bj_reset_audio_device(), bj_reset_bitmap(), bj_reset_maze_builder(), bj_reset_stopwatch(), bj_resolve_address(), bj_run_app(), bj_run_maze_builder(), bj_run_time(), bj_seed_pcg32(), bj_seek_stream(), bj_segment_hits_segment_2d(), bj_send_tcp(), bj_send_udp(), bj_send_udp_to(), bj_set_bitmap_clear_color(), bj_set_bitmap_color(), bj_set_bitmap_colorkey(), bj_set_button_callback(), bj_set_cursor_callback(), bj_set_draw_callback(), bj_set_enter_callback(), bj_set_error(), bj_set_error_fmt(), bj_set_fixed_step_rate(), bj_set_frame_rate(), bj_set_key_callback(), bj_set_log_level(), bj_set_memory_defaults(), bj_set_resize_callback(), bj_set_tcp_keepalive(), bj_set_tcp_receive_timeout(), bj_set_tcp_recv_timeout(), bj_set_tcp_send_timeout(), bj_set_text_wrapper_line_ending(), bj_set_window_draw_callback(), bj_set_window_fullscreen(), bj_set_window_resize_callback(), bj_set_window_should_close(), bj_shade_bitmap(), bj_shader_bitmap(), bj_should_close_window(), bj_shutdown_tcp(), bj_sleep(), bj_sleep_ms(), bj_srand(), bj_step_angular_2d(), bj_step_delay_stopwatch(), bj_step_maze_builder(), bj_step_particle_2d(), bj_step_rigid_body_2d(), bj_step_stopwatch(), bj_stop_audio_device(), bj_stopwatch_delay(), bj_stopwatch_elapsed(), bj_stopwatch_split(), bj_stopwatch_total(), bj_store_cli_bool(), bj_store_cli_cstring(), bj_store_cli_double(), bj_store_cli_int(), bj_store_cli_uint(), bj_str_eq(), bj_str_from_cstr(), bj_str_slice(), bj_stream_flags(), bj_stream_has_flag(), bj_stream_is_mapped(), bj_stream_is_seekable(), bj_stream_length(), bj_stream_peek(), bj_stream_position(), bj_stream_status(), bj_string_cstr(), bj_string_view(), bj_tcp_available(), bj_tcp_has_keepalive(), bj_tcp_listener_port(), bj_tcp_local_address(), bj_tcp_peek(), bj_tcp_peer_address(), bj_tcp_receive_timeout(), bj_tcp_recv(), bj_tcp_send(), bj_tcp_send_timeout(), bj_tcp_shutdown(), bj_tcp_wait(), bj_tell_stream(), bj_text_wrapper_line_ending(), bj_text_wrapper_status(), bj_time_counter(), bj_time_frequency(), bj_udp_available(), bj_udp_has_data(), bj_udp_local_address(), bj_udp_local_port(), bj_udp_recv(), bj_udp_send(), bj_udp_send_to(), bj_udp_wait(), bj_unbind_window(), bj_uniform_double_distribution(), bj_uniform_float_distribution(), bj_uniform_int32_distribution(), bj_uniform_long_double_distribution(), bj_uniform_uint32_distribution(), bj_unload_library(), bj_unmark_maze_cell(), bj_unpack_pixel_rgb(), bj_unset_memory_defaults(), bj_utf8_encode(), bj_utf8_next(), bj_utf8_prev(), bj_utf8_scan(), bj_utf8_validate(), bj_validate_cli(), bj_video_backends(), bj_wait_tcp(), bj_wait_udp(), bj_window_enter_fullscreen(), bj_window_flags(), bj_window_has_flag(), bj_window_is_fullscreen(), bj_window_is_key_pressed(), bj_window_leave_fullscreen(), bj_window_should_close(), bj_window_size(), bj_write_stream(), bj_write_stream_i16_be(), bj_write_stream_i16_le(), bj_write_stream_i32_be(), bj_write_stream_i32_le(), bj_write_stream_i64_be(), bj_write_stream_i64_le(), bj_write_stream_i8(), bj_write_stream_u16_be(), bj_write_stream_u16_le(), bj_write_stream_u32_be(), bj_write_stream_u32_le(), bj_write_stream_u64_be(), bj_write_stream_u64_le(), bj_write_stream_u8(), bj_write_text_wrapper(), and bj_write_text_wrapper_line().

◆ BANJO_NO_EXPORT

#define BANJO_NO_EXPORT

Definition at line 180 of file api.h.

◆ BJ_BUILD_DEBUG

#define BJ_BUILD_DEBUG

Set when NDEBUG is not defined where this header is included, with the same caveat as BJ_BUILD_RELEASE.

Definition at line 159 of file api.h.

◆ BJ_BUILD_RELEASE

#define BJ_BUILD_RELEASE

Set when NDEBUG is defined where this header is included.

It follows the build mode of the including code, which may differ from the mode Banjo itself was built in (see bj_build_information for that).

Definition at line 153 of file api.h.

◆ BJ_COMPILER_NAME

#define BJ_COMPILER_NAME   "Doxygen"

Definition at line 115 of file api.h.

◆ BJ_COMPILER_VERSION

#define BJ_COMPILER_VERSION   0

Definition at line 116 of file api.h.

◆ BJ_EXTERN_C

#define BJ_EXTERN_C

Expands to extern "C" when compiling as C++, empty otherwise.

Definition at line 171 of file api.h.

◆ BJ_FALSE

#define BJ_FALSE   ((bj_bool)0)

Boolean false value (0).

See also
bj_bool
BJ_TRUE
Examples
stream_file.c.

Definition at line 273 of file api.h.

Referenced by bj_mat3_invert(), bj_mat4_invert(), and write_text().

◆ BJ_INLINE

#define BJ_INLINE   inline

BJ_INLINE expands to an inline specifier appropriate for the toolchain.

If BJ_API_FORCE_INLINE is defined, stronger inlining is requested.

Definition at line 248 of file api.h.

Referenced by bj_galileo_position(), bj_galileo_velocity(), bj_mat32_from_mat3(), bj_mat32_mul(), bj_mat32_set_identity(), bj_mat32_set_rotation_z(), bj_mat32_set_scaling_xy(), bj_mat32_set_translation(), bj_mat32_transform_dir(), bj_mat32_transform_point(), bj_mat3_add(), bj_mat3_col(), bj_mat3_compose_translation(), bj_mat3_copy(), bj_mat3_determinant(), bj_mat3_from_mat32(), bj_mat3_invert(), bj_mat3_invert_unsafe(), bj_mat3_mul(), bj_mat3_mul_scalar(), bj_mat3_row(), bj_mat3_set_identity(), bj_mat3_set_ortho(), bj_mat3_set_rotation_z(), bj_mat3_set_scaling_xy(), bj_mat3_set_shear_xy(), bj_mat3_set_translation(), bj_mat3_set_viewport(), bj_mat3_sub(), bj_mat3_transform_point(), bj_mat3_transform_vec3(), bj_mat3_translate(), bj_mat3_transpose(), bj_mat43_from_mat4(), bj_mat43_mul(), bj_mat43_set_identity(), bj_mat43_set_rotation_x(), bj_mat43_set_rotation_y(), bj_mat43_set_rotation_z(), bj_mat43_set_scaling_xyz(), bj_mat43_set_translation(), bj_mat43_transform_dir(), bj_mat43_transform_point(), bj_mat4_add(), bj_mat4_col(), bj_mat4_compose_translation(), bj_mat4_copy(), bj_mat4_from_mat43(), bj_mat4_invert(), bj_mat4_invert_unsafe(), bj_mat4_mul(), bj_mat4_mul_scalar(), bj_mat4_orthonormalize(), bj_mat4_rotate_arcball(), bj_mat4_rotate_axis_angle(), bj_mat4_rotate_x(), bj_mat4_rotate_y(), bj_mat4_rotate_z(), bj_mat4_row(), bj_mat4_scale_axes(), bj_mat4_set_frustum(), bj_mat4_set_identity(), bj_mat4_set_lookat(), bj_mat4_set_ortho(), bj_mat4_set_outer_product(), bj_mat4_set_perspective(), bj_mat4_set_translation(), bj_mat4_set_viewport(), bj_mat4_sub(), bj_mat4_transform_vec4(), bj_mat4_translate(), bj_mat4_transpose(), bj_newton_gravitation(), bj_newton_plummer_gravitation(), bj_pcg32_generator(), bj_quat_conjugate(), bj_quat_dot(), bj_quat_from_axis_angle(), bj_quat_from_mat4(), bj_quat_identity(), bj_quat_inverse(), bj_quat_mul(), bj_quat_norm(), bj_quat_norm2(), bj_quat_normalize(), bj_quat_rotate_vec3(), bj_quat_rotate_vec4(), bj_quat_slerp(), bj_quat_to_mat4(), bj_rand_generator(), bj_vec2_add(), bj_vec2_add_scaled(), bj_vec2_distance(), bj_vec2_distance_sq(), bj_vec2_dot(), bj_vec2_len(), bj_vec2_map(), bj_vec2_max(), bj_vec2_min(), bj_vec2_mul_comp(), bj_vec2_normalize(), bj_vec2_normalize_unsafe(), bj_vec2_perp_dot(), bj_vec2_scale(), bj_vec2_scale_to_len(), bj_vec2_sub(), bj_vec3_add(), bj_vec3_add_scaled(), bj_vec3_cross(), bj_vec3_distance(), bj_vec3_distance_sq(), bj_vec3_dot(), bj_vec3_len(), bj_vec3_map(), bj_vec3_max(), bj_vec3_min(), bj_vec3_mul_comp(), bj_vec3_normalize(), bj_vec3_normalize_unsafe(), bj_vec3_reflect(), bj_vec3_scale(), bj_vec3_scale_to_len(), bj_vec3_sub(), bj_vec4_add(), bj_vec4_add_scaled(), bj_vec4_cross_xyz(), bj_vec4_distance(), bj_vec4_distance_sq(), bj_vec4_dot(), bj_vec4_len(), bj_vec4_map(), bj_vec4_max(), bj_vec4_min(), bj_vec4_mul_comp(), bj_vec4_normalize(), bj_vec4_normalize_unsafe(), bj_vec4_reflect(), bj_vec4_scale(), bj_vec4_scale_to_len(), and bj_vec4_sub().

◆ BJ_OS_UNKNOWN

#define BJ_OS_UNKNOWN

Definition at line 94 of file api.h.

◆ BJ_RESTRICT

#define BJ_RESTRICT   restrict

BJ_RESTRICT expands to the appropriate restrict qualifier per toolchain.

Definition at line 214 of file api.h.

Referenced by bj_apply_point_gravity_2d(), bj_apply_point_gravity_softened_2d(), bj_mat32_from_mat3(), bj_mat32_mul(), bj_mat32_set_identity(), bj_mat32_set_rotation_z(), bj_mat32_set_scaling_xy(), bj_mat32_set_translation(), bj_mat32_transform_dir(), bj_mat32_transform_point(), bj_mat3_add(), bj_mat3_col(), bj_mat3_copy(), bj_mat3_determinant(), bj_mat3_from_mat32(), bj_mat3_invert(), bj_mat3_invert_unsafe(), bj_mat3_mul(), bj_mat3_mul_scalar(), bj_mat3_row(), bj_mat3_set_identity(), bj_mat3_set_ortho(), bj_mat3_set_rotation_z(), bj_mat3_set_scaling_xy(), bj_mat3_set_shear_xy(), bj_mat3_set_translation(), bj_mat3_set_viewport(), bj_mat3_sub(), bj_mat3_transform_point(), bj_mat3_transform_vec3(), bj_mat3_translate(), bj_mat43_from_mat4(), bj_mat43_mul(), bj_mat43_set_identity(), bj_mat43_set_rotation_x(), bj_mat43_set_rotation_y(), bj_mat43_set_rotation_z(), bj_mat43_set_scaling_xyz(), bj_mat43_set_translation(), bj_mat43_transform_dir(), bj_mat43_transform_point(), bj_mat4_add(), bj_mat4_col(), bj_mat4_copy(), bj_mat4_from_mat43(), bj_mat4_invert(), bj_mat4_invert_unsafe(), bj_mat4_mul(), bj_mat4_mul_scalar(), bj_mat4_orthonormalize(), bj_mat4_rotate_arcball(), bj_mat4_rotate_axis_angle(), bj_mat4_rotate_x(), bj_mat4_rotate_y(), bj_mat4_rotate_z(), bj_mat4_row(), bj_mat4_scale_axes(), bj_mat4_set_frustum(), bj_mat4_set_identity(), bj_mat4_set_lookat(), bj_mat4_set_ortho(), bj_mat4_set_outer_product(), bj_mat4_set_perspective(), bj_mat4_set_translation(), bj_mat4_set_viewport(), bj_mat4_sub(), bj_mat4_transform_vec4(), bj_mat4_translate(), bj_quat_from_mat4(), and bj_quat_to_mat4().

◆ BJ_TRUE

#define BJ_TRUE   ((bj_bool)1)

Boolean true value (1).

See also
bj_bool
BJ_FALSE
Examples
pixel_enumeration.c, and utf8_decode.c.

Definition at line 282 of file api.h.

Referenced by bj_mat3_invert(), bj_mat4_invert(), paint_cell(), paint_pixel(), and print_report().

Typedef Documentation

◆ bj_address

typedef struct bj_address bj_address

Definition at line 335 of file api.h.

◆ bj_angular_2d

typedef struct bj_angular_2d bj_angular_2d

Definition at line 336 of file api.h.

◆ bj_audio_device

Examples
audio_pcm.c.

Definition at line 337 of file api.h.

◆ bj_audio_play_note_data

typedef struct bj_audio_play_note_data bj_audio_play_note_data

Definition at line 338 of file api.h.

◆ bj_audio_properties

typedef struct bj_audio_properties bj_audio_properties

Definition at line 339 of file api.h.

◆ bj_bitmap

◆ bj_bool

typedef uint32_t bj_bool

Boolean type used throughout the Banjo API.

Defined as a 32-bit unsigned integer for portability and ABI clarity.

See also
BJ_FALSE
BJ_TRUE
Examples
maze.c, pixel_enumeration.c, stream_file.c, stream_memory.c, text_wrapper.c, and utf8_decode.c.

Definition at line 264 of file api.h.

◆ bj_build_info

typedef struct bj_build_info bj_build_info

Definition at line 341 of file api.h.

◆ bj_button_event

typedef struct bj_button_event bj_button_event

Definition at line 342 of file api.h.

◆ bj_cli

typedef struct bj_cli bj_cli

Definition at line 343 of file api.h.

◆ bj_cli_argument

typedef struct bj_cli_argument bj_cli_argument

Definition at line 344 of file api.h.

◆ bj_cursor_event

typedef struct bj_cursor_event bj_cursor_event

Definition at line 345 of file api.h.

◆ bj_datagram

typedef struct bj_datagram bj_datagram
Examples
net_udp_broadcast_recv.c, net_udp_client.c, and net_udp_server.c.

Definition at line 346 of file api.h.

◆ bj_enter_event

typedef struct bj_enter_event bj_enter_event

Definition at line 347 of file api.h.

◆ bj_error

◆ bj_event

typedef struct bj_event bj_event

Definition at line 349 of file api.h.

◆ bj_key_event

typedef struct bj_key_event bj_key_event

Definition at line 350 of file api.h.

◆ bj_mat3

typedef struct bj_mat3 bj_mat3

Definition at line 351 of file api.h.

◆ bj_mat32

typedef struct bj_mat32 bj_mat32

Definition at line 352 of file api.h.

◆ bj_mat3x2

typedef struct bj_mat32 bj_mat3x2
Deprecated
Renamed to bj_mat32. Removed in 2.0.

Definition at line 358 of file api.h.

◆ bj_mat3x3

typedef struct bj_mat3 bj_mat3x3
Deprecated
Renamed to bj_mat3. Removed in 2.0.

Definition at line 356 of file api.h.

◆ bj_mat4

typedef struct bj_mat4 bj_mat4

Definition at line 353 of file api.h.

◆ bj_mat43

typedef struct bj_mat43 bj_mat43

Definition at line 354 of file api.h.

◆ bj_mat4x3

typedef struct bj_mat43 bj_mat4x3
Deprecated
Renamed to bj_mat43. Removed in 2.0.

Definition at line 362 of file api.h.

◆ bj_mat4x4

typedef struct bj_mat4 bj_mat4x4
Deprecated
Renamed to bj_mat4. Removed in 2.0.

Definition at line 360 of file api.h.

◆ bj_maze

typedef struct bj_maze bj_maze
Examples
maze.c.

Definition at line 363 of file api.h.

◆ bj_maze_builder

Examples
maze.c.

Definition at line 364 of file api.h.

◆ bj_memory_callbacks

typedef struct bj_memory_callbacks bj_memory_callbacks

Definition at line 365 of file api.h.

◆ bj_particle_2d

typedef struct bj_particle_2d bj_particle_2d

Definition at line 366 of file api.h.

◆ bj_pcg32

typedef struct bj_pcg32 bj_pcg32

Definition at line 367 of file api.h.

◆ bj_quat

typedef struct bj_vec4 bj_quat

Definition at line 382 of file api.h.

◆ bj_rect

typedef struct bj_rect bj_rect
Examples
maze.c.

Definition at line 368 of file api.h.

◆ bj_render_target

◆ bj_rigid_body_2d

typedef struct bj_rigid_body_2d bj_rigid_body_2d

Definition at line 370 of file api.h.

◆ bj_stopwatch

typedef struct bj_stopwatch bj_stopwatch

Definition at line 371 of file api.h.

◆ bj_str

typedef struct bj_str bj_str

Definition at line 372 of file api.h.

◆ bj_stream

typedef struct bj_stream bj_stream
Examples
stream_custom.c, stream_file.c, stream_memory.c, stream_spans.c, and text_wrapper.c.

Definition at line 374 of file api.h.

◆ bj_stream_callbacks

typedef struct bj_stream_callbacks bj_stream_callbacks

Definition at line 375 of file api.h.

◆ bj_string

typedef struct bj_string bj_string

Definition at line 373 of file api.h.

◆ bj_tcp_listener

Examples
net_tcp_nonblocking.c, net_tcp_server.c, and net_tcp_timeout.c.

Definition at line 376 of file api.h.

◆ bj_tcp_stream

◆ bj_text_wrapper

Examples
text_wrapper.c.

Definition at line 378 of file api.h.

◆ bj_udp

typedef struct bj_udp bj_udp

◆ bj_vec2

typedef struct bj_vec2 bj_vec2

Definition at line 380 of file api.h.

◆ bj_vec3

typedef struct bj_vec3 bj_vec3

Definition at line 381 of file api.h.

◆ bj_vec4

typedef struct bj_vec4 bj_vec4

Definition at line 383 of file api.h.

◆ bj_window

Function Documentation

◆ bj_build_information()

const struct bj_build_info * bj_build_information ( void )

Get runtime build information for the loaded Banjo binaries.

The returned pointer is owned by the library and remains valid for the lifetime of the process. The content is immutable.

Returns
Pointer to a struct bj_build_info structure describing the runtime build.
Examples
banjo-info.c.

Referenced by main().