Skip to content

Commit d9d8838

Browse files
Update SDL_GetWindowWMInfo func. + comment
1 parent c8a85d6 commit d9d8838

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

units/sdlsyswm.inc

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -337,23 +337,22 @@ type
337337
SDL_SYSWM_UNKNOWN: (dummy: array[0..63] of Byte);
338338
end;
339339

340-
{* Function prototypes *}
341340
(**
342-
* \brief This function allows access to driver-dependent window information.
341+
* Get driver-specific information about a window.
343342
*
344-
* \param window The window about which information is being requested
345-
* \param info This structure must be initialized with the SDL version, and is
346-
* then filled in with information about the given window.
343+
* You must include SDL_syswm.h for the declaration of SDL_SysWMinfo.
347344
*
348-
* \return SDL_TRUE if the function is implemented and the version member of
349-
* the \c info struct is valid, SDL_FALSE otherwise.
345+
* The caller must initialize the `info` structure's version by using
346+
* `SDL_VERSION(&info.version)`, and then this function will fill in the rest
347+
* of the structure with information about the given window.
350348
*
351-
* You typically use this function like this:
352-
* \code
353-
* SDL_SysWMinfo info;
354-
* SDL_VERSION(&info.version);
355-
* if ( SDL_GetWindowWMInfo(window, &info) ) { ... }
356-
* \endcode
349+
* \param window the window about which information is being requested
350+
* \param info an SDL_SysWMinfo structure filled in with window information
351+
* \returns SDL_TRUE if the function is implemented and the `version` member
352+
* of the `info` struct is valid, or SDL_FALSE if the information
353+
* could not be retrieved; call SDL_GetError() for more information.
354+
*
355+
* \since This function is available since SDL 2.0.0.
357356
*)
358-
Function SDL_GetWindowWMInfo(window:PSDL_Window; info : PSDL_SysWMinfo):TSDL_bool; cdecl;
357+
function SDL_GetWindowWMInfo(window: PSDL_Window; info: PSDL_SysWMinfo): TSDL_bool; cdecl;
359358
external SDL_LibName {$IFDEF DELPHI} {$IFDEF MACOS} name '_SDL_GetWindowWMInfo' {$ENDIF} {$ENDIF};

0 commit comments

Comments
 (0)