Skip to content

Commit

Permalink
libretro: Add documentation warning about libretro argv
Browse files Browse the repository at this point in the history
  • Loading branch information
RobLoach committed Nov 30, 2024
1 parent 575f5aa commit b33d660
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/physfs.h
Original file line number Diff line number Diff line change
Expand Up @@ -529,6 +529,11 @@ typedef struct PHYSFS_AndroidInit
* will hold it until PHYSFS_deinit is called.
* If you pass a NULL here, PhysicsFS will crash.
*
* \warning On libretro, argv0 should be a non-NULL pointer to the
* retro_environment_t callback. PhysicsFS will use this callback
* to get libretro's virtual file system interface, along with
* any other related directory paths.
*
* \param argv0 the argv[0] string passed to your program's mainline.
* This may be NULL on most platforms (such as ones without a
* standard main() function), but you should always try to pass
Expand Down

0 comments on commit b33d660

Please sign in to comment.