mirror of
https://github.com/encounter/rust-sdl2.git
synced 2026-07-10 21:18:41 -07:00
47 lines
6.1 KiB
HTML
47 lines
6.1 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `SDL_GetPrefPath` fn in crate `sdl2_sys`."><meta name="keywords" content="rust, rustlang, rust-lang, SDL_GetPrefPath"><title>sdl2_sys::SDL_GetPrefPath - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../sdl2_sys/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>sdl2_sys</a></p><script>window.sidebarCurrent = {name: 'SDL_GetPrefPath', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/sdl2_sys/Users/travis/build/Rust-SDL2/rust-sdl2/target/debug/build/sdl2-sys-f32779682524d647/out/sdl_bindings.rs.html#13870-13871' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>sdl2_sys</a>::<wbr><a class="fn" href=''>SDL_GetPrefPath</a></span></h1><pre class='rust fn'>pub unsafe extern "C" fn SDL_GetPrefPath(<br> org: *const <a class="type" href="../libc/unix/bsd/apple/type.c_char.html" title="type libc::unix::bsd::apple::c_char">c_char</a>, <br> app: *const <a class="type" href="../libc/unix/bsd/apple/type.c_char.html" title="type libc::unix::bsd::apple::c_char">c_char</a><br>) -> *mut <a class="type" href="../libc/unix/bsd/apple/type.c_char.html" title="type libc::unix::bsd::apple::c_char">c_char</a></pre><div class='docblock'><p>\brief Get the user-and-app-specific path where files can be written.</p>
|
||
<p>Get the "pref dir". This is meant to be where users can write personal
|
||
files (preferences and save games, etc) that are specific to your
|
||
application. This directory is unique per user, per application.</p>
|
||
<p>This function will decide the appropriate location in the native filesystem,
|
||
create the directory if necessary, and return a string of the absolute
|
||
path to the directory in UTF-8 encoding.</p>
|
||
<p>On Windows, the string might look like:
|
||
"C:\Users\bob\AppData\Roaming\My Company\My Program Name\"</p>
|
||
<p>On Linux, the string might look like:
|
||
"/home/bob/.local/share/My Program Name/"</p>
|
||
<p>On Mac OS X, the string might look like:
|
||
"/Users/bob/Library/Application Support/My Program Name/"</p>
|
||
<p>(etc.)</p>
|
||
<p>You specify the name of your organization (if it's not a real organization,
|
||
your name or an Internet domain you own might do) and the name of your
|
||
application. These should be untranslated proper names.</p>
|
||
<p>Both the org and app strings may become part of a directory name, so
|
||
please follow these rules:</p>
|
||
<ul>
|
||
<li>Try to use the same org string (including case-sensitivity) for
|
||
all your applications that use this function.</li>
|
||
<li>Always use a unique app string for each one, and make sure it never
|
||
changes for an app once you've decided on it.</li>
|
||
<li>Unicode characters are legal, as long as it's UTF-8 encoded, but...</li>
|
||
<li>...only use letters, numbers, and spaces. Avoid punctuation like
|
||
"Game Name 2: Bad Guy's Revenge!" ... "Game Name 2" is sufficient.</li>
|
||
</ul>
|
||
<p>This returns an absolute path in UTF-8 encoding, and is guaranteed to
|
||
end with a path separator ('\' on Windows, '/' most other places).</p>
|
||
<p>The pointer returned by this function is owned by you. Please call
|
||
SDL_free() on the pointer when you are done with it, or it will be a
|
||
memory leak. This is not necessarily a fast call, though, so you should
|
||
call this once near startup and save the string if you need it.</p>
|
||
<p>You should assume the path returned by this function is the only safe
|
||
place to write files (and that SDL_GetBasePath(), while it might be
|
||
writable, or even the parent of the returned path, aren't where you
|
||
should be writing things).</p>
|
||
<p>Some platforms can't determine the pref path, and on other
|
||
platforms, this might be meaningless. In such cases, this function will
|
||
return NULL.</p>
|
||
<p>\param org The name of your organization.
|
||
\param app The name of your application.
|
||
\return UTF-8 string of user dir in platform-dependent notation. NULL
|
||
if there's a problem (creating directory failed, etc).</p>
|
||
<p>\sa SDL_GetBasePath</p>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "sdl2_sys";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |