eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-31 17:07:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Sync SDL3 wiki -> header

Browse source
This commit is contained in:
SDL Wiki Bot 2024-09-06 02:17:29 +00:00
parent 702ed83f72
commit e7969553f8
4 changed files with 11 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

3
include/SDL3/SDL_iostream.h
View file

@ -366,7 +366,8 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromDynamicMem(void);
* This function makes a copy of `iface` and the caller does not need to keep * This function makes a copy of `iface` and the caller does not need to keep
* it around after this call. * it around after this call.
* *
* \param iface the interface that implements this SDL_IOStream, initialized using SDL_INIT_INTERFACE(). * \param iface the interface that implements this SDL_IOStream, initialized
* using SDL_INIT_INTERFACE().
* \param userdata the pointer that will be passed to the interface functions. * \param userdata the pointer that will be passed to the interface functions.
* \returns a pointer to the allocated memory on success or NULL on failure; * \returns a pointer to the allocated memory on success or NULL on failure;
* call SDL_GetError() for more information. * call SDL_GetError() for more information.

3
include/SDL3/SDL_joystick.h
View file

@ -414,7 +414,8 @@ typedef struct SDL_VirtualJoystickSensorDesc
/** /**
* The structure that describes a virtual joystick. * The structure that describes a virtual joystick.
* *
* This structure should be initialized using SDL_INIT_INTERFACE(). All elements of this structure are optional. * This structure should be initialized using SDL_INIT_INTERFACE(). All
* elements of this structure are optional.
* *
* \since This struct is available since SDL 3.0.0. * \since This struct is available since SDL 3.0.0.
* *

6
include/SDL3/SDL_stdinc.h
View file

@ -532,7 +532,8 @@ extern "C" {
/** /**
* A macro to initialize an SDL interface. * A macro to initialize an SDL interface.
* *
* This macro will initialize an SDL interface structure and should be called before you fill out the fields with your implementation. * This macro will initialize an SDL interface structure and should be called
* before you fill out the fields with your implementation.
* *
* You can use it like this: * You can use it like this:
* *
@ -547,7 +548,8 @@ extern "C" {
* stream = SDL_OpenIO(&iface, NULL); * stream = SDL_OpenIO(&iface, NULL);
* ``` * ```
* *
* If you are using designated initializers, you can use the size of the interface as the version, e.g. * If you are using designated initializers, you can use the size of the
* interface as the version, e.g.
* *
* ```c * ```c
* SDL_IOStreamInterface iface = { * SDL_IOStreamInterface iface = {

4
include/SDL3/SDL_storage.h
View file

@ -106,6 +106,7 @@ typedef struct SDL_StorageInterface
SDL_COMPILE_TIME_ASSERT(SDL_StorageInterface_SIZE, SDL_COMPILE_TIME_ASSERT(SDL_StorageInterface_SIZE,
(sizeof(void *) == 4 && sizeof(SDL_StorageInterface) == 48) || (sizeof(void *) == 4 && sizeof(SDL_StorageInterface) == 48) ||
(sizeof(void *) == 8 && sizeof(SDL_StorageInterface) == 96)); (sizeof(void *) == 8 && sizeof(SDL_StorageInterface) == 96));
/** /**
* An abstract interface for filesystem access. * An abstract interface for filesystem access.
* *
@ -195,7 +196,8 @@ extern SDL_DECLSPEC SDL_Storage * SDLCALL SDL_OpenFileStorage(const char *path);
* This function makes a copy of `iface` and the caller does not need to keep * This function makes a copy of `iface` and the caller does not need to keep
* it around after this call. * it around after this call.
* *
* \param iface the interface that implements this storage, initialized using SDL_INIT_INTERFACE(). * \param iface the interface that implements this storage, initialized using
* SDL_INIT_INTERFACE().
* \param userdata the pointer that will be passed to the interface functions. * \param userdata the pointer that will be passed to the interface functions.
* \returns a storage container on success or NULL on failure; call * \returns a storage container on success or NULL on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.