Sync SDL3 wiki -> header

main
SDL Wiki Bot 2024-02-10 00:05:26 +00:00
parent f6b92c9b88
commit 9ff8df932a
2 changed files with 10 additions and 4 deletions

View File

@ -141,7 +141,8 @@ extern DECLSPEC void SDLCALL SDL_UnlockProperties(SDL_PropertiesID props);
* Set a property on a set of properties with a cleanup function that is
* called when the property is deleted
*
* The cleanup function is also called if setting the property fails for any reason.
* The cleanup function is also called if setting the property fails for any
* reason.
*
* \param props the properties to modify
* \param name the name of the property to modify

View File

@ -1028,7 +1028,8 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_GetWindowParent(SDL_Window *window);
*
* The following read-only properties are provided by SDL:
*
* - `SDL_PROP_WINDOW_SHAPE_POINTER`: the surface associated with a shaped window
* - `SDL_PROP_WINDOW_SHAPE_POINTER`: the surface associated with a shaped
* window
*
* On Android:
*
@ -2125,12 +2126,16 @@ extern DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_HitTest
/**
* Set the shape of a transparent window.
*
* This sets the alpha channel of a transparent window and any fully transparent areas are also transparent to mouse clicks. If you are using something besides the SDL render API, then you are responsible for setting the alpha channel of the window yourself.
* This sets the alpha channel of a transparent window and any fully
* transparent areas are also transparent to mouse clicks. If you are using
* something besides the SDL render API, then you are responsible for setting
* the alpha channel of the window yourself.
*
* The window must have been created with the SDL_WINDOW_TRANSPARENT flag.
*
* \param window the window
* \param shape the surface representing the shape of the window, or NULL to remove any current shape
* \param shape the surface representing the shape of the window, or NULL to
* remove any current shape
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*