Wiki Page Content

Differences between revisions 10 and 41 (spanning 31 versions)
⇤ ← Revision 10 as of 2010-09-26 00:40:57 →
Size: 1254
Editor: SheenaSmith
Comment: minor change
← Revision 41 as of 2016-12-01 08:58:06 → ⇥
Size: 3476
Editor: realitix
Comment: Update from changeset fbd8834ba7b8
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
#pragma disable-camelcase #pragma camelcase off
Line 10: Line 10:
||||||''For Windows''||
||SDL_version||'''version'''||the version field you fill in before you call [[SDL_GetWindowWMInfo]]()||
||HWND||'''window'''||the Win32 display window||
||||||''For X11 window management systems (Unix)''||
||SDL_version||'''version'''||the version field you fill in before you call [[SDL_GetWindowWMInfo]]()||
||SDL_SYSWM_TYPE||'''subsystem'''||the windowing system type; see [[#Remarks|Remarks]] for details||
||Display||'''info.x11.display'''||the X11 display||
||Window||'''info.x11.window'''||the X11 window||		 ||||||<bgcolor="#EDEDED">''All Subsystems''||
||[[SDL_version]]||'''version'''||an [[SDL_version]] structure that contains the current SDL version||
||[[SDL_SYSWM_TYPE]]||'''subsystem'''||the windowing system type; see [[#Remarks|Remarks]] for details||
||<style="color: #808080;">int||<style="color: #808080;">'''dummy'''||<style="color: #808080;">unused (to help compilers when no specific system is available)||
||||||<bgcolor="#EDEDED">''SDL_SYSWM_WINDOWS''||
||HWND||'''win.window'''||the window handle||
||HDC ||'''win.hdc''' ||the window device context (>= SDL 2.0.4)||
||HINSTANCE ||'''win.hinstance''' ||the window hinstance (>= SDL 2.0.6)||
||||||<bgcolor="#EDEDED">''SDL_SYSWM_WINRT'' (>= SDL 2.0.3)||
||IInspectable*||'''winrt.window'''||the WinRT !CoreWindow||
||||||<bgcolor="#EDEDED">''SDL_SYSWM_X11''||
||Display*||'''x11.display'''||the X11 display||
||Window||'''x11.window'''||the X11 window||
||||||<bgcolor="#EDEDED">''SDL_SYSWM_DIRECTFB''||
||IDirectFB*||'''dfb.dfb'''||the DirectFB main interface||
||IDirectFBWindow*||'''dfb.window'''||the DirectFB window handle||
||IDirectFBSurface*||'''dfb.surface'''||the DirectFB client surface||
||||||<bgcolor="#EDEDED">''SDL_SYSWM_COCOA''||
||NSWindow*||'''cocoa.window'''||the Cocoa window||
||||||<bgcolor="#EDEDED">''SDL_SYSWM_UIKIT''||
||UIWindow*||'''uikit.window'''||the UIKit window||
||GLuint ||'''uikit.framebuffer''' ||the GL view's Framebuffer Object; it must be bound when rendering to the screen using GL (>= SDL 2.0.4)||
||GLuint ||'''uikit.colorbuffer''' ||the GL view's color Renderbuffer Object; it must be bound when [[SDL_GL_SwapWindow]]() is called (>= SDL 2.0.4)||
||GLuint ||'''uikit.resolveFramebuffer''' ||the Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used (>= SDL 2.0.4)||
||||||<bgcolor="#EDEDED">''SDL_SYSWM_WAYLAND'' (>= SDL 2.0.2)||
||wl_display*||'''wl.display'''||the Wayland display||
||wl_surface*||'''wl.surface'''||the Wayland surface||
||wl_shell_surface*||'''wl.shell_surface'''||the Wayland shell_surface (window manager handle)||
||||||<bgcolor="#EDEDED">''SDL_SYSWM_MIR'' (>= SDL 2.0.2)||
||!MirConnection*||'''mir.connection'''||the Mir display server connection||
||!MirSurface*||'''mir.surface'''||the Mir surface||
||||||<bgcolor="#EDEDED">''SDL_SYSWM_ANDROID'' (>= SDL 2.0.4)||
||ANativeWindow*||'''android.window'''||the Android native window||
||EGLSurface||'''android.surface'''||the Android EGL surface||
||||||<bgcolor="#EDEDED">''SDL_SYSWM_VIVANTE'' (>= SDL 2.0.5)||
||EGLNativeDisplayType||'''vivante.display'''||the Vivante EGL display type||
||EGLNativeWindowType||'''vivante.window'''||the Vivante EGL window type||
Line 25: Line 54:
''For X11 window management systems (Unix)''
Line 29: Line 56:
When [[SDL_GetWindowWMInfo]]() returns the structure holds information specific to the low level windowing system being used, which is one of SDL_SYSWM_TYPE.
||SDL_SYSWM_X11||the X11 windowing system||		 This structure holds low level information about the window and '''subsystem''' is set to the windowing system in use, one of:
<<Include(SDL_SYSWM_TYPE, , , from="== Values ==", to="== Code Examples ==")>>

== Related Enumerations ==
 .[[SDL_SYSWM_TYPE]]

== Related Structures ==
 .[[SDL_version]]

SDL_SysWMinfo

A structure that contains system-dependent information about a window.

Contents

  1. SDL_SysWMinfo
    1. Data Fields
    2. Code Examples
    3. Remarks
    4. Related Enumerations
    5. Related Structures
    6. Related Functions

Data Fields

All Subsystems

SDL_version

version

an SDL_version structure that contains the current SDL version

SDL_SYSWM_TYPE

subsystem

the windowing system type; see Remarks for details

int

dummy

unused (to help compilers when no specific system is available)

SDL_SYSWM_WINDOWS

HWND

win.window

the window handle

HDC

win.hdc

the window device context (>= SDL 2.0.4)

HINSTANCE

win.hinstance

the window hinstance (>= SDL 2.0.6)

SDL_SYSWM_WINRT (>= SDL 2.0.3)

IInspectable*

winrt.window

the WinRT CoreWindow

SDL_SYSWM_X11

Display*

x11.display

the X11 display

Window

x11.window

the X11 window

SDL_SYSWM_DIRECTFB

IDirectFB*

dfb.dfb

the DirectFB main interface

IDirectFBWindow*

dfb.window

the DirectFB window handle

IDirectFBSurface*

dfb.surface

the DirectFB client surface

SDL_SYSWM_COCOA

NSWindow*

cocoa.window

the Cocoa window

SDL_SYSWM_UIKIT

UIWindow*

uikit.window

the UIKit window

GLuint

uikit.framebuffer

the GL view's Framebuffer Object; it must be bound when rendering to the screen using GL (>= SDL 2.0.4)

GLuint

uikit.colorbuffer

the GL view's color Renderbuffer Object; it must be bound when SDL_GL_SwapWindow() is called (>= SDL 2.0.4)

GLuint

uikit.resolveFramebuffer

the Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used (>= SDL 2.0.4)

SDL_SYSWM_WAYLAND (>= SDL 2.0.2)

wl_display*

wl.display

the Wayland display

wl_surface*

wl.surface

the Wayland surface

wl_shell_surface*

wl.shell_surface

the Wayland shell_surface (window manager handle)

SDL_SYSWM_MIR (>= SDL 2.0.2)

MirConnection*

mir.connection

the Mir display server connection

MirSurface*

mir.surface

the Mir surface

SDL_SYSWM_ANDROID (>= SDL 2.0.4)

ANativeWindow*

android.window

the Android native window

EGLSurface

android.surface

the Android EGL surface

SDL_SYSWM_VIVANTE (>= SDL 2.0.5)

EGLNativeDisplayType

vivante.display

the Vivante EGL display type

EGLNativeWindowType

vivante.window

the Vivante EGL window type

Code Examples

You can add your code example here

Remarks

This structure is filled in by SDL_GetWindowWMInfo().

This structure holds low level information about the window and subsystem is set to the windowing system in use, one of:

SDL_SYSWM_UNKNOWN

SDL_SYSWM_WINDOWS

Microsoft Windows

SDL_SYSWM_X11

X Window System

SDL_SYSWM_DIRECTFB

DirectFB

SDL_SYSWM_COCOA

Apple Mac OS X

SDL_SYSWM_UIKIT

Apple iOS

SDL_SYSWM_WAYLAND

Wayland (>= SDL 2.0.2)

SDL_SYSWM_MIR

Mir (>= SDL 2.0.2)

SDL_SYSWM_WINRT

WinRT (>= SDL 2.0.3)

SDL_SYSWM_ANDROID

Android (>= SDL 2.0.4)

SDL_SYSWM_VIVANTE

Vivante (>= SDL 2.0.5)

CategoryStruct, CategorySWM

None: SDL_SysWMinfo (last edited 2016-12-01 08:58:06 by realitix)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit