shadps4-emu/ext-SDL
1
0
Fork 0
mirror of https://github.com/shadps4-emu/ext-SDL.git synced 2024-11-23 18:19:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix comments

Browse Source
This commit is contained in:
Sylvain 2023-06-22 15:42:51 +02:00 committed by Sylvain Becker
parent 4339113072
commit 627165a2b2
5 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
include/SDL3/SDL_audio.h
View File

@ -758,6 +758,7 @@ extern DECLSPEC int SDLCALL SDL_GetAudioStreamFormat(SDL_AudioStream *stream,
* will reflect the new format, and future calls to SDL_PutAudioStreamData
* must provide data in the new input formats.
*
* \param stream The stream the format is being changed
* \param src_format The format of the audio input
* \param src_channels The number of channels of the audio input
* \param src_rate The sampling rate of the audio input

1
include/SDL3/SDL_clipboard.h
View File

@ -195,6 +195,7 @@ extern DECLSPEC void *SDLCALL SDL_GetClipboardUserdata(void);
/**
* Get the data from clipboard for a given mime type
*
* \param length Length of the data
* \param mime_type The mime type to read from the clipboard
* \returns the retrieved data buffer or NULL on failure; call SDL_GetError()
* for more information. Caller must call SDL_free() on the returned

3
include/SDL3/SDL_filesystem.h
View File

@ -221,9 +221,12 @@ typedef enum
*
* If NULL is returned, the error may be obtained with SDL_GetError().
*
* \param folder The type of folder to find
* \returns Either a null-terminated C string containing the full path to the
* folder, or NULL if an error happened.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_Folder
*/
extern DECLSPEC char *SDLCALL SDL_GetPath(SDL_Folder folder);

4
include/SDL3/SDL_hidapi.h
View File

@ -511,6 +511,8 @@ extern DECLSPEC int SDLCALL SDL_hid_get_indexed_string(SDL_hid_device *dev, int
* in the case of failure; call SDL_GetError() for more information.
* This struct is valid until the device is closed with
* SDL_hid_close().
*
* \since This function is available since SDL 3.0.0.
*/
extern DECLSPEC SDL_hid_device_info * SDLCALL SDL_hid_get_device_info(SDL_hid_device *dev);
@ -525,6 +527,8 @@ extern DECLSPEC SDL_hid_device_info * SDLCALL SDL_hid_get_device_info(SDL_hid_de
* \param buf_size The size of the buffer in bytes.
* \returns the number of bytes actually copied, or -1 on error; call
* SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*/
extern DECLSPEC int SDLCALL SDL_hid_get_report_descriptor(SDL_hid_device *dev, unsigned char *buf, size_t buf_size);

2
include/SDL3/SDL_video.h
View File

@ -477,6 +477,7 @@ extern DECLSPEC const SDL_DisplayMode **SDLCALL SDL_GetFullscreenDisplayModes(SD
* \param h the height in pixels of the desired display mode
* \param refresh_rate the refresh rate of the desired display mode, or 0.0f
* for the desktop refresh rate
* \param include_high_density_modes Boolean to include high density modes in the search
* \returns a pointer to the closest display mode equal to or larger than the
* desired mode, or NULL on error; call SDL_GetError() for more
* information.
@ -1360,6 +1361,7 @@ extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window *window, SDL_bool
/**
* Return whether the window has a surface associated with it.
*
* \param window the window to query
* \returns SDL_TRUE if there is a surface associated with the window, or
* SDL_FALSE otherwise.
*