logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_GetBasePath - Get the directory where the application was run from.

Availability

       This function is available since SDL 3.2.0.

Description

       SDL  caches  the  result  of this call internally, but the first call to this function is not necessarily
       fast, so plan accordingly.

       macOSandiOSSpecificFunctionality: If the application is in a ".app" bundle, this function returns the
       Resource directory (e.g. MyApp.app/Contents/Resources/). This behaviour can be  overridden  by  adding  a
       property  to  the  Info.plist file. Adding a string key with the name SDL_FILESYSTEM_BASE_DIR_TYPE with a
       supported value will change the behaviour.

       Supported   values   for   the   SDL_FILESYSTEM_BASE_DIR_TYPE   property   (Given   an   application   in
       /Applications/SDLApp/MyApp.app):

       •      resource:      bundle      resource      directory      (the      default).      For      example:
       /Applications/SDLApp/MyApp.app/Contents/Resourcesbundle: the Bundle directory. For example: /Applications/SDLApp/MyApp.app/parent: the containing directory of the bundle. For example: /Applications/SDLApp/Nintendo3DSSpecificFunctionality: This function returns "romfs" directory of the application as it  is
       uncommon to store resources outside the executable. As such it is not a writable directory.

       The  returned  path  is  guaranteed  to  end  with  a  path  separator ('\' on Windows, '/' on most other
       platforms).

Name

       SDL_GetBasePath - Get the directory where the application was run from.

Return Value

       for more information.

See Also

SDL_GetPrefPath(3)

Simple Directmedia Layer                           SDL 3.2.20                                 SDL_GetBasePath(3)

Synopsis

#include<SDL3/SDL_filesystem.h>constchar*SDL_GetBasePath(void);

See Also