The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

SDL2::syswm - SDL Custom System Window Manager Hooks

SYNOPSIS

    use SDL2 qw[:syswm];

DESCRIPTION

Your application has access to a special type of event ::SDL_SYSWMEVENT, which contains window-manager specific information and arrives whenever an unhandled window event occurs. This event is ignored by default, but you can enable it with SDL_EventState( ).

Functions

These may be imported by name or with the :syswm tag.

SDL_GetWindowWMInfo( )

Get driver-specific information about a window.

The caller must initialize the info structure's version by using SDL_VERSION( $info->version), and then this function will fill in the rest of the structure with information about the given window.

Expected parameters include:

window - the window about which information is being requested
info - an SDL2::SysWMinfo structure filled in with window information

Returns SDL_TRUE if the function is implemented and the version member of the info struct is valid, or SDL_FALSE if the information could not be retrieved; call SDL_GetError( ) for more information.

Defined Variables and Enumerations

Variables may be imported by name or with the :syswm tag.

SDL_SYSWM_TYPE

These are the various supported windowing subsystems.

SDL_SYSWM_UNKNOWN
SDL_SYSWM_WINDOWS
SDL_SYSWM_X11
SDL_SYSWM_DIRECTFB
SDL_SYSWM_COCOA
SDL_SYSWM_UIKIT
SDL_SYSWM_WAYLAND
SDL_SYSWM_MIR - no longer available, left for API/ABI compatibility. Remove in 2.1!
SDL_SYSWM_WINRT
SDL_SYSWM_ANDROID
SDL_SYSWM_VIVANTE
SDL_SYSWM_OS2
SDL_SYSWM_HAIKU
SDL_SYSWM_KMSDRM

LICENSE

Copyright (C) Sanko Robinson.

This library is free software; you can redistribute it and/or modify it under the terms found in the Artistic License 2. Other copyrights, terms, and conditions may apply to data transmitted through this module.

AUTHOR

Sanko Robinson <sanko@cpan.org>