mk64/include
Jed Grabman a5526cc5bf
Document effects and define magic values (#733)
* Document projection matrix function

Document function for computing a projection matrix. Used for camera and graphics.

* Fix loop index bug

Fix straightforward loop index bug introduced in last commit

* Style guide updates

Changes to match style recommendations
* Update function variables to camelCase
* Use dOxygen tags
* Use block comment

* Document math functions

* Give all functions in src\racing\math_util.c descriptive names

* Improve documentation for math_util

Improves a number of functions by giving descriptive argument names and comments

* Additional merge

* Fix style issues

update variables / parameters to use camelCase instead of snakeCase

* doxygen and other documentation

* Add doxygen documentation
* Rename mat -> mtx for consistency among matrices
* Theta -> Angle for angles
* Give some arguments more descriptive names

* Partial documentation for calculate_orientation_matrix

Documentation for when cosAxisY is 1 and observations that things break when if it does not equal 1.

* Rename functions

Renamed multiple functions for accuracy or clarity

* doxygen whitespace alignment

Improve readability of doxygen info by aligning text

* Make format check

Formatting updates suggested by make format

* Make skyboxes static

* Change function name

angle_from_coords -> get_angle_between_coords

* Math values renamed

Functions:
render_distance_squared -> distance_if_visible
mtxf_rotation_zxy_translate -> mtxf_rotate_zxy_translate

Arguments:
vecTrans -> translate

* Document many effects

Define effects for
* Braking
* Drifting
* Spinning out (driving and bananas)
* Mini turbos
* Losing at GP
* Tumbling on terrain
* CPU rubberbanding

And substitute some pre-existing defined effect names in place of bit flags

* Replace effect magic numbers with defined values

* Separate effect bit-flags into components

* Document more effects

* Rename some effects

* Replace effect bit_flags with defined values

* Formatting fixes

---------

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
2025-07-17 20:53:11 -06:00
..
PR Match Mario Kart 64 (#709) 2025-05-11 18:03:50 -06:00
libc update clang and add action (#664) 2024-08-24 15:27:53 -06:00
actor_types.h update clang and add action (#664) 2024-08-24 15:27:53 -06:00
bomb_kart.h fix name introduce by the previous pr (#701) 2025-05-18 14:20:05 -06:00
common_structs.h Revert "Document sound effects (#735)" (#741) 2025-07-17 20:52:44 -06:00
config.h some rename and allow change the course engine (#691) 2024-10-20 17:24:37 -06:00
course.h Doc code 80005fd0 (#697) 2025-01-18 17:24:09 -07:00
course_offsets.h update clang and add action (#664) 2024-08-24 15:27:53 -06:00
debug.h update clang and add action (#664) 2024-08-24 15:27:53 -06:00
decode.h fix typo include (#658) 2024-07-31 21:10:19 -06:00
defines.h Document effects and define magic values (#733) 2025-07-17 20:53:11 -06:00
kart_attributes.h update clang and add action (#664) 2024-08-24 15:27:53 -06:00
macros.h move SQ macro define to header file so project builds (#705) 2025-05-02 16:52:04 -06:00
macros.inc update libultra asm (#648) 2024-08-22 23:31:24 -06:00
mk64.h some rename and allow change the course engine (#691) 2024-10-20 17:24:37 -06:00
objects.h PR Matching func_80086074 (#707) 2025-05-08 16:03:42 -06:00
path.h fix name introduce by the previous pr (#701) 2025-05-18 14:20:05 -06:00
save_data.h update clang and add action (#664) 2024-08-24 15:27:53 -06:00
segments.h update clang and add action (#664) 2024-08-24 15:27:53 -06:00
sounds.h update clang and add action (#664) 2024-08-24 15:27:53 -06:00
spline.h match func_80099AEC and fix some warnings (#699) 2025-01-24 11:18:03 -07:00
ultra64.h
vehicles.h Doc code 80005fd0 (#697) 2025-01-18 17:24:09 -07:00