Miguel Ruiz / SDL_lib

Dependents:   H261_encoder

Embed: (wiki syntax)

« Back to documentation index

SDL_syswm.h File Reference

SDL_syswm.h File Reference

Include file for SDL custom system window manager hooks. More...

Go to the source code of this file.

Data Structures

struct  SDL_SysWMmsg
 The custom event structure. More...
struct  SDL_SysWMinfo
 The custom window manager information structure. More...

Enumerations

enum  SDL_SYSWM_TYPE
 

These are the various supported windowing subsystems.

More...

Functions

DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo (SDL_Window *window, SDL_SysWMinfo *info)
 This function allows access to driver-dependent window information.

Detailed Description

Include file for SDL custom system window manager hooks.

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().

Definition in file SDL_syswm.h.


Enumeration Type Documentation

These are the various supported windowing subsystems.

Definition at line 104 of file SDL_syswm.h.


Function Documentation

DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo ( SDL_Window window,
SDL_SysWMinfo info 
)

This function allows access to driver-dependent window information.

Parameters:
windowThe window about which information is being requested
infoThis structure must be initialized with the SDL version, and is then filled in with information about the given window.
Returns:
SDL_TRUE if the function is implemented and the version member of the info struct is valid, SDL_FALSE otherwise.

You typically use this function like this:

  SDL_SysWMinfo info;
  SDL_VERSION(&info.version);
  if ( SDL_GetWindowWMInfo(window, &info) ) { ... }