imgui_impl_sdl.h File Reference

#include "../imgui.h"

Go to the source code of this file.

Typedefs
typedef union SDL_Event	SDL_Event

Functions
IMGUI_IMPL_API bool	ImGui_ImplSDL2_InitForOpenGL (SDL_Window *window, void *sdl_gl_context)
IMGUI_IMPL_API bool	ImGui_ImplSDL2_InitForVulkan (SDL_Window *window)
IMGUI_IMPL_API bool	ImGui_ImplSDL2_InitForD3D (SDL_Window *window)
IMGUI_IMPL_API bool	ImGui_ImplSDL2_InitForMetal (SDL_Window *window)
IMGUI_IMPL_API void	ImGui_ImplSDL2_Shutdown ()
IMGUI_IMPL_API void	ImGui_ImplSDL2_NewFrame (SDL_Window *window)
IMGUI_IMPL_API bool	ImGui_ImplSDL2_ProcessEvent (const SDL_Event *event)
IMGUI_IMPL_API void	ImGui_ImplSDL2_SetActiveWindowOverride (bool override_state)
	Special function used to override active window checks. More...

Typedef Documentation

SDL_Event

typedef union SDL_Event SDL_Event

Function Documentation

ImGui_ImplSDL2_InitForD3D()

IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForD3D

(

SDL_Window *

window

)

ImGui_ImplSDL2_InitForMetal()

IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForMetal

(

SDL_Window *

window

)

ImGui_ImplSDL2_InitForOpenGL()

IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForOpenGL	(	SDL_Window *	window,
		void *	sdl_gl_context
	)

ImGui_ImplSDL2_InitForVulkan()

IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForVulkan

(

SDL_Window *

window

)

ImGui_ImplSDL2_NewFrame()

IMGUI_IMPL_API void ImGui_ImplSDL2_NewFrame

(

SDL_Window *

window

)

ImGui_ImplSDL2_ProcessEvent()

IMGUI_IMPL_API bool ImGui_ImplSDL2_ProcessEvent

(

const SDL_Event *

event

)

ImGui_ImplSDL2_SetActiveWindowOverride()

IMGUI_IMPL_API void ImGui_ImplSDL2_SetActiveWindowOverride

(

bool

override_state

)

Special function used to override active window checks.

When the engine is hooked using Qt (aka, when the engine is rendering to a viewport in the editing kit), SDL simply refuses to set the active window state - and there is no way to override this using SDL alone.

The solution implemented is to add an optional override check that can be called when using Qt. When this is set to true, ImGUI will always behave as though the window is focused - which may or may not cause issues. It is best to keep this state consistent with the focused state of the Qt5 widget itself.

Parameters

override_state

- Whether or not to behave as though the engine viewport is focused.

ImGui_ImplSDL2_Shutdown()

IMGUI_IMPL_API void ImGui_ImplSDL2_Shutdown

(

)