Gabriel Ravier b4c29fa50b Document z_eff_ss_stone1.[ch] (#2670) ...

* Document z_eff_ss_stone1.[ch]

* Incorporate feedback from PR review.

From https://github.com/zeldaret/oot/pull/2670:
- Shortened excessively verbose
  suppressRTransFadeFlashAlphaStepAfterTwoFrames name to
  suppressFadeFlash
- Fixed up comment that went waaaaaay beyond the column limit in
  z_eff_ss_stone1.h
- Shortened comparison with 0 of variable bool semantics in
  z_eff_ss_stone1.c

Signed-off-by: Gabriel Ravier <gabravier@gmail.com>

* Fix misnaming from PR review and document some more

From https://github.com/zeldaret/oot/pull/2670:
- shortenFadeFlash is incorrect - renamed to freezeFadeFlash
- Used `false` instead of 0 in EnArrow_Fly
- Elaborated comments about what exactly freezeFadeFlash does

Also added a few extra comments to z_eff_ss_stone1.c

* Ran clang-format

* More feedback from PR review, clarified comment

From https://github.com/zeldaret/oot/pull/2670:
- Change 0 to false in header comment
- Remove verbose speculation about former use of unused variable
- Made comment on use of viewDepth clearer
- Separated matrix and gfx code with a newline

Signed-off-by: Gabriel Ravier <gabravier@gmail.com>

* Marked the "1500" as being in units

---------

Signed-off-by: Gabriel Ravier <gabravier@gmail.com>

2026-08-19 14:04:49 +02:00

..

audio

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

libc

[iQue] Define EGCS macro instead of relying on __GNUC__ (#2423)

2025-01-13 08:32:25 -05:00

libc64

Cleanup includes in header files (#2540)

2025-05-24 16:20:51 -04:00

libu64

Remove functions.h (#2501)

2025-04-05 19:16:52 -04:00

tables

oot-gc-eu-dbg-2 OK (#2714)

2026-04-07 11:18:17 +02:00

ultra64

[rsp] Introduce microcode build process, disassemble and build both rspboot versions (#2764)

2026-08-02 16:27:33 +02:00

actor_profile.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

actor.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

alignment.h

Remove gSystemHeap and use _buffersSegmentEnd instead, make buffer alignments explicit for gcc (#1901)

2024-02-27 19:01:47 -05:00

animation_legacy.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

animation.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

array_count.h

add array_count.h (#2514)

2025-04-26 18:17:02 -04:00

attributes.h

Cleanup includes in header files (#2540)

2025-05-24 16:20:51 -04:00

audio.h

Rename NoteSubEu -> NoteSampleState (#2738)

2026-04-24 21:15:28 +02:00

audiomgr.h

Document CIC6105 (#2739)

2026-05-06 09:25:34 +02:00

audiothread_cmd.h

SoundMode -> SoundOutputMode (#2475)

2025-03-27 01:47:44 -04:00

avoid_ub.h

macros.h 3/5: Split various macros (#2512)

2025-04-25 21:12:35 -04:00

bgcheck.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

boot.h

Improve the state of handwritten assembly files (#865)

2022-05-01 01:03:22 +02:00

buffers.h

Delete macros.h; Delete global.h (#2516)

2025-04-27 12:48:11 -04:00

build.h

variables.h: migrate all remaining varaibles, remove other dependencies except z64.h (#2505)

2025-04-16 08:22:42 -04:00

camera.h

Camera_KeepOn4 docs 2: RO and RW data (#2632)

2025-06-26 21:11:38 +02:00

carthandle.h

variables.h: migrate all remaining varaibles, remove other dependencies except z64.h (#2505)

2025-04-16 08:22:42 -04:00

cic6105.h

Document CIC6105 (#2739)

2026-05-06 09:25:34 +02:00

collision_check.h

Cleanup extracted colliders 3: Use HIT_SPECIAL_EFFECT_, HIT_BACKLASH_ names (#2646)

2025-06-28 18:06:42 -04:00

color.h

macros.h 3/5: Split various macros (#2512)

2025-04-25 21:12:35 -04:00

command_macros_base.h

Misc. doc/cleanup 5 (#1096)

2022-01-12 15:48:04 -05:00

console_logo_state.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

controller.h

Move button macros to include/controller.h (#2138)

2024-09-06 10:24:19 +02:00

curve.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

cutscene_commands.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

cutscene_flags.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

cutscene_spline.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

cutscene.h

Document Save.cutsceneIndex and adjacent data / code (#2286)

2025-06-17 15:54:52 +02:00

db_camera.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

debug_arena.h

Reduce overlay dependencies on global.h (8) (#2478)

2025-02-19 05:54:39 -05:00

debug_display.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

debug.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

dma.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

draw.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

effect.h

Document z_eff_ss_stone1.[ch] (#2670)

2026-08-19 14:04:49 +02:00

environment.h

Add ENV_LIGHT_SETTINGS_BLEND_RATE_AND_FOG_NEAR_PACK, fix extracted negative blendRate (#2653)

2025-07-15 01:52:22 -04:00

face_change.h

Cleanup includes in header files (#2540)

2025-05-24 16:20:51 -04:00

face_reaction.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

fault.h

Fix misc 23 (#2699)

2026-02-22 19:08:12 +01:00

file_select_state.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

flag_set.h

Remove functions.h (#2501)

2025-04-05 19:16:52 -04:00

font.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

frame_advance.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

game_over.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

game.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

gamealloc.h

Reduce overlay dependencies on global.h (8) (#2478)

2025-02-19 05:54:39 -05:00

gfx_setupdl.h

[PAL N64] Match file select language selection (#2240)

2024-09-28 13:12:57 -04:00

gfx.h

Cleanup includes in header files (#2540)

2025-05-24 16:20:51 -04:00

gfxalloc.h

[headers] Create gfxalloc.h, map.h, move protos to gfx.h, z64{player,view}.h (#2233)

2024-09-27 14:51:00 -04:00

horse.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

ichain.h

Add names to all typedef'd structs, unions, and enums (#2028)

2024-08-12 03:07:48 -04:00

idle.h

variables.h: migrate all remaining varaibles, remove other dependencies except z64.h (#2505)

2025-04-16 08:22:42 -04:00

inflate.h

Cleanup includes in header files (#2540)

2025-05-24 16:20:51 -04:00

interface.h

Commit do_action_static (#2597)

2025-06-07 21:31:57 -04:00

inventory.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

irqmgr.h

Reduce dependencies on global.h (10) (#2490)

2025-02-26 17:18:30 -05:00

is_debug.h

Cleanup includes in header files (#2540)

2025-05-24 16:20:51 -04:00

item.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

jpeg.h

[headers 11] stackcheck.h, jpeg functions (#2171)

2024-09-08 12:02:38 -04:00

kaleido_manager.h

[headers 12] Add kaleido_manager.h, move various protos to headers (#2174)

2024-09-11 10:17:47 +02:00

kanji_tex.h

[cc0 oot] kanji_tex (#2784)

2026-08-19 14:03:21 +02:00

language_array.h

macros.h 3/5: Split various macros (#2512)

2025-04-25 21:12:35 -04:00

letterbox.h

[headers] Create letterbox.h, move more protos from functions.h (#2225)

2024-09-25 13:45:06 -04:00

lifemeter.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

light.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

line_numbers.h

oot-gc-eu-dbg-2 OK (#2714)

2026-04-07 11:18:17 +02:00

listalloc.h

Reduce dependencies on global.h (10) (#2490)

2025-02-26 17:18:30 -05:00

macro.inc

Rework disassembly: out of makefile, separate sections, relocs (#1728)

2024-02-12 20:20:25 -05:00

main.h

[headers 8] Add main.h, segmented_address.h, and changes for main.c symbols (#2151)

2024-09-07 16:55:06 -04:00

map_mark.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

map_select_state.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

map.h

variables.h: migrate all remaining varaibles, remove other dependencies except z64.h (#2505)

2025-04-16 08:22:42 -04:00

memory_utils.h

[cc0 oot] z_memory_utils (#2783)

2026-08-05 18:32:30 +02:00

mempak.h

Mempak doc (#1382)

2022-11-16 02:32:07 -05:00

message_data_fmt.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

message_data_static.h

[iQue] Match z_kanfont (#2428)

2025-01-19 19:41:14 -05:00

message.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

mio0.h

Remove functions.h (#2501)

2025-04-05 19:16:52 -04:00

n64dd.h

Document src/n64dd/n64dd_error_headers.c (#2667)

2026-02-21 09:17:30 +01:00

object.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

ocarina.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

olib.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

one_point_cutscene.h

[headers] Create one_point_cutscene.h, z64olib.h and move stuff to z64{object,player,scene}.h (#2250)

2024-10-01 13:14:54 -04:00

padmgr.h

Cleanup includes in header files (#2540)

2025-05-24 16:20:51 -04:00

path.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

pause.h

Macro-ify access to pauseCtx->playerSegment regions (#2693)

2026-04-16 22:33:07 +02:00

play_state.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

player.h

Reevaluate player hit response names (#2640)

2025-06-27 04:45:44 +09:00

prenmi_buff.h

Clean out z64.h (#2484)

2025-02-22 14:01:09 -05:00

prenmi_state.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

prerender.h

Some functions.h and variables.h work (#2491)

2025-03-26 16:08:10 -04:00

printf.h

macros.h 1/?: PRINTF and T (#2509)

2025-04-23 19:31:49 -04:00

quake.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

quest_hint_commands.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

quest_hint.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

rand.h

[headers 9] Add src/libc64/ and new "z64" rand.h (#2164)

2024-09-08 17:11:41 -04:00

region.h

Introduce OOT_VERSION and OOT_REGION defines for build info and ROM header (#2003)

2024-07-28 00:46:55 -04:00

regs.h

Document CIC6105 (#2739)

2026-05-06 09:25:34 +02:00

romfile.h

Cleanup includes in header files (#2540)

2025-05-24 16:20:51 -04:00

room.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

rumble.h

Add names to all typedef'd structs, unions, and enums (#2028)

2024-08-12 03:07:48 -04:00

sample_state.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

save.h

Document EnIn (AKA the hard-working Ingo) (#2778)

2026-08-19 14:03:48 +02:00

scene.h

Finish rename scene lists (#2652)

2025-07-15 01:31:41 -04:00

sched.h

Some functions.h and variables.h work (#2491)

2025-03-26 16:08:10 -04:00

segment_symbols.h

Reduce overlay dependencies on global.h (7) (#2472)

2025-02-16 15:33:55 -05:00

segmented_address.h

[headers 8] Add main.h, segmented_address.h, and changes for main.c symbols (#2151)

2024-09-07 16:55:06 -04:00

seqcmd.h

SoundMode -> SoundOutputMode (#2475)

2025-03-27 01:47:44 -04:00

sequence.h

[ntsc-1.0/1.1] Match audio library (#2243)

2024-10-09 10:53:16 -04:00

setup_state.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

sfx_source.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

sfx.h

Fix misc 23 (#2699)

2026-02-22 19:08:12 +01:00

skin_matrix.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

skin.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

skybox.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

speed_meter.h

Reduce dependencies on global.h (10) (#2490)

2025-02-26 17:18:30 -05:00

sram.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

ss_sram.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

stack.h

[headers 11] stackcheck.h, jpeg functions (#2171)

2024-09-08 12:02:38 -04:00

stackcheck.h

[headers 11] stackcheck.h, jpeg functions (#2171)

2024-09-08 12:02:38 -04:00

sys_cfb.h

Remove functions.h (#2501)

2025-04-05 19:16:52 -04:00

sys_debug_controller.h

Reduce dependencies on global.h (10) (#2490)

2025-02-26 17:18:30 -05:00

sys_freeze.h

Document sys_freeze.[ch] (#2666)

2026-02-18 12:36:07 +01:00

sys_math3d.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

sys_math.h

Experiment: remove global.h dependency from sys_math, sys_math3d, z_lib (#1956)

2024-06-19 00:00:23 -04:00

sys_matrix.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

sys_ucode.h

Reduce overlay dependencies on global.h (6) (#2468)

2025-02-13 18:15:14 -05:00

terminal.h

Restore terminal colors in retail, except in __osMalloc.c (#1899)

2024-02-27 14:08:20 -05:00

tex_len.h

Introduce TEX_LEN macro for texture arrays lengths (#2541)

2025-05-25 12:33:24 -04:00

tha.h

Cleanup includes in header files (#2540)

2025-05-24 16:20:51 -04:00

thga.h

Add names to all typedef'd structs, unions, and enums (#2028)

2024-08-12 03:07:48 -04:00

thread.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

title_setup_state.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

transition_circle.h

Remove functions.h (#2501)

2025-04-05 19:16:52 -04:00

transition_fade.h

Remove functions.h (#2501)

2025-04-05 19:16:52 -04:00

transition_instances.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

transition_tile.h

Remove functions.h (#2501)

2025-04-05 19:16:52 -04:00

transition_triforce.h

Remove functions.h (#2501)

2025-04-05 19:16:52 -04:00

transition_wipe.h

Remove functions.h (#2501)

2025-04-05 19:16:52 -04:00

transition.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

translation.h

T() macro loose ends 2 (#2564)

2025-06-04 13:15:01 -04:00

ucode_disas.h

create ucode_disas.h (#2222)

2024-09-24 13:45:53 -04:00

ultra64.h

Cleanup includes in header files (#2540)

2025-05-24 16:20:51 -04:00

unk.h

Use debug macros even in N64-only code (#2298)

2024-11-15 13:18:05 -05:00

versions.h

oot-gc-eu-dbg-2 OK (#2714)

2026-04-07 11:18:17 +02:00

vi_mode.h

Some functions.h and variables.h work (#2491)

2025-03-26 16:08:10 -04:00

view.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

vis.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

yaz0.h

Cleanup includes in header files (#2540)

2025-05-24 16:20:51 -04:00

z_actor_dlftbls.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

z_en_a_obj.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

z_en_item00.h

Item_DropCollectibleRandom: params macro and drop tables enum (#2707)

2026-04-24 21:55:03 +02:00

z_game_dlftbls.h

Reduce dependencies on global.h (10) (#2490)

2025-02-26 17:18:30 -05:00

z_lib.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

z_locale.h

Cleanup includes in header files (#2540)

2025-05-24 16:20:51 -04:00

z_math.h

Remove "z64" prefix from all headers (#2518)

2025-06-04 14:38:33 -04:00

zelda_arena.h

Reduce dependencies on global.h (9) (#2488)

2025-02-24 20:55:55 -05:00