WindowManager Class Reference

#include <WindowManager.hxx>

Inheritance diagram for WindowManager:

Collaboration diagram for WindowManager:

Public Member Functions
	WindowManager (WindowManager const &)=delete
WindowManager &	operator= (WindowManager const &)=delete
void	toggleFullScreen () const
void	setWindowTitle (const std::string &title)
	sets title of the window More...
SDL_Renderer *	getRenderer () const
	get SDL Renderer More...
SDL_Window *	getWindow () const
	get SDL Window More...
const std::vector< std::unique_ptr< SDL_DisplayMode > > &	getSupportedScreenResolutions () const
void	setScreenResolution (int mode)
void	setFullScreenMode (FULLSCREEN_MODE mode) const
	sets the game's window mode More...
void	newImGuiFrame ()
	creates and renders a new ImGui frame More...
void	renderScreen ()

Public Attributes
friend	Singleton< WindowManager >

Private Member Functions
	WindowManager ()
	Construct a new WindowManager object. More...
	~WindowManager ()
	Destroy the WindowManager object. More...
void	initializeScreenResolutions ()
void	initializeImguiRenderer ()
	Sets up platform/renderer backends and theme. More...
void	destroyImGuiRenderer ()
	shuts down the renderer for ImGui and the ImGui context. More...

Private Attributes
std::string	m_title = "Cytopia"
	title of the window More...
const std::string	m_windowIcon = "resources/images/app_icons/cytopia_icon.png"
	the window's icon More...
SDL_Window *	m_window = nullptr
	pointer to the SDL_Window More...
SDL_Renderer *	m_renderer = nullptr
	pointer to the SDL_Renderer More...
std::vector< std::unique_ptr< SDL_DisplayMode > >	m_resolutions
int	m_numOfDisplays = 0
int	m_activeDisplay = 0

Additional Inherited Members
Static Public Member Functions inherited from Singleton< WindowManager >
static WindowManager &	instance (void)
	Get an instance of the singleton. More...
Protected Member Functions inherited from Singleton< WindowManager >
	Singleton () noexcept=default
	~Singleton () noexcept=default

Detailed Description

Definition at line 19 of file WindowManager.hxx.

Constructor & Destructor Documentation

WindowManager() [1/2]

WindowManager::WindowManager ( WindowManager const &  )

delete

WindowManager() [2/2]

WindowManager::WindowManager ( )

private

Construct a new WindowManager object.

Exceptions

UIError	if window or renderer creation fails, or if the window icon cannot be loaded
ConfigurationError	if the path to the window icon doesn't exist

Definition at line 14 of file WindowManager.cxx.

{
  Uint32 windowFlags = 0;
  Uint32 rendererFlags = 0;
 
#ifdef __ANDROID__
  // Android is always fullscreen.. We also need to set screenWidth / screenHeight to the max. resolution in Fullscreen
  windowFlags = SDL_WINDOW_FULLSCREEN;
  SDL_DisplayMode mode;
  SDL_GetDesktopDisplayMode(0, &mode);
  Settings::instance().screenWidth = mode.w;
  Settings::instance().screenHeight = mode.h;
#endif
 
#ifdef TESTING_ENABLED
  windowFlags = SDL_WINDOW_HIDDEN;
  m_window = SDL_CreateWindow(m_title.c_str(), SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED, 800, 600, windowFlags);
#else
  m_window = SDL_CreateWindow(m_title.c_str(), SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED, Settings::instance().screenWidth,
                              Settings::instance().screenHeight, windowFlags);
#endif
 
  if (!m_window)
    throw UIError(TRACE_INFO "Failed to create window: " + string{SDL_GetError()});
 
  rendererFlags = SDL_RENDERER_ACCELERATED | (Settings::instance().vSync ? SDL_RENDERER_PRESENTVSYNC : 0);
 
#if defined(TESTING_ENABLED) && defined(__linux)
  // Set the index to 2 for running tests
  m_renderer = SDL_CreateRenderer(m_window, 2, rendererFlags);
#else
  m_renderer = SDL_CreateRenderer(m_window, -1, rendererFlags);
#endif
 
  SDL_RendererInfo info;
  SDL_GetRendererInfo(m_renderer, &info);
  LOG(LOG_DEBUG) << "Current SDL_Renderer: " << info.name;
 
  if (!m_renderer)
    throw UIError(TRACE_INFO "Failed to create Renderer: " + string{SDL_GetError()});
 
  string iconFName = fs::getBasePath() + m_windowIcon;
 
  if (!fs::fileExists(iconFName))
    throw ConfigurationError(TRACE_INFO "File " + iconFName + " doesn't exist");
 
  SDL_Surface *icon = IMG_Load(iconFName.c_str());
 
  if (!icon)
    throw UIError(TRACE_INFO "Could not load icon " + iconFName + ": " + IMG_GetError());
 
  SDL_SetWindowIcon(m_window, icon);
  SDL_FreeSurface(icon);
  m_numOfDisplays = SDL_GetNumVideoDisplays();
  initializeScreenResolutions();
  setFullScreenMode(static_cast<FULLSCREEN_MODE>(Settings::instance().fullScreenMode));
 
  initializeImguiRenderer();
}

Here is the call graph for this function:

~WindowManager()

WindowManager::~WindowManager ( )

private

Destroy the WindowManager object.

Definition at line 74 of file WindowManager.cxx.

{
  destroyImGuiRenderer();
 
  SDL_DestroyRenderer(m_renderer);
  SDL_DestroyWindow(m_window);
}

Here is the call graph for this function:

Member Function Documentation

destroyImGuiRenderer()

void WindowManager::destroyImGuiRenderer ( )

private

shuts down the renderer for ImGui and the ImGui context.

Definition at line 181 of file WindowManager.cxx.

{
  ImGui_ImplSDLRenderer_Shutdown();
  ImGui_ImplSDL2_Shutdown();
  ImGui::DestroyContext();
}

Here is the caller graph for this function:

getRenderer()

SDL_Renderer* WindowManager::getRenderer ( ) const

inline

get SDL Renderer

Returns

Pointer to the SDL_Renderer

Definition at line 38 of file WindowManager.hxx.

{ return m_renderer; };

getSupportedScreenResolutions()

const std::vector<std::unique_ptr<SDL_DisplayMode> >& WindowManager::getSupportedScreenResolutions ( ) const

inline

Definition at line 45 of file WindowManager.hxx.

{ return m_resolutions; };

getWindow()

SDL_Window* WindowManager::getWindow ( ) const

inline

get SDL Window

Returns

Pointer to the SDL_Window

Definition at line 43 of file WindowManager.hxx.

{ return m_window; };

initializeImguiRenderer()

void WindowManager::initializeImguiRenderer ( )

private

Sets up platform/renderer backends and theme.

Definition at line 169 of file WindowManager.cxx.

{
  // create context and default theme
  IMGUI_CHECKVERSION();
  ImGui::CreateContext();
  ImGui::StyleColorsDark();
 
  // Setup Platform/Renderer backends
  ImGui_ImplSDL2_InitForSDLRenderer(m_window, m_renderer);
  ImGui_ImplSDLRenderer_Init(m_renderer);
}

Here is the caller graph for this function:

initializeScreenResolutions()

void WindowManager::initializeScreenResolutions ( )

private

Definition at line 141 of file WindowManager.cxx.

{
  if (m_activeDisplay > m_numOfDisplays)
    throw UIError(TRACE_INFO "There is no display with number " + std::to_string(m_activeDisplay) + ". Resetting to display 0");
 
  // get the number of different screen modes
  for (int modeIndex = 0; modeIndex <= SDL_GetNumDisplayModes(m_activeDisplay); modeIndex++)
  {
    std::unique_ptr<SDL_DisplayMode> displayMode =
        std::make_unique<SDL_DisplayMode>((SDL_DisplayMode{SDL_PIXELFORMAT_UNKNOWN, 0, 0, 0, nullptr}));
 
    auto isResolitionExist = [&](int w, int h)
    {
      auto it = std::find_if(m_resolutions.begin(), m_resolutions.end(),
                             [w, h](auto &mode) { return (mode->w == w) && (mode->h == h); });
      return it != m_resolutions.end();
    };
 
    if (SDL_GetDisplayMode(m_activeDisplay, modeIndex, displayMode.get()) == 0)
    {
      if (isResolitionExist(displayMode->w, displayMode->h))
        continue;
 
      m_resolutions.push_back(std::move(displayMode));
    }
  }
}

Here is the caller graph for this function:

newImGuiFrame()

void WindowManager::newImGuiFrame

(

)

creates and renders a new ImGui frame

Definition at line 224 of file WindowManager.cxx.

{
  ImGui_ImplSDLRenderer_NewFrame();
  ImGui_ImplSDL2_NewFrame();
  ImGui::NewFrame();
}

Here is the caller graph for this function:

operator=()

WindowManager& WindowManager::operator= ( WindowManager const &  )

delete

renderScreen()

void WindowManager::renderScreen

(

)

Definition at line 231 of file WindowManager.cxx.

{
  // reset renderer color back to black
  SDL_SetRenderDrawColor(m_renderer, 0, 0, 0, SDL_ALPHA_OPAQUE);
 
  ImGui::Render();
  ImGui_ImplSDLRenderer_RenderDrawData(ImGui::GetDrawData());
 
  // Render the Frame
  SDL_RenderPresent(m_renderer);
}

Here is the caller graph for this function:

setFullScreenMode()

void WindowManager::setFullScreenMode

(

FULLSCREEN_MODE

mode

)

const

sets the game's window mode

Changes the game's window mode to fullscreen, borderless, or windowed

Parameters

mode	the new window mode, WINDOWED, BORDERLESS, or FULLSCREEN

Definition at line 96 of file WindowManager.cxx.

{
  Settings::instance().fullScreenMode = static_cast<int>(mode);
 
  // reset the actual resolution back to the desired resolution
  Settings::instance().currentScreenHeight = Settings::instance().screenHeight;
  Settings::instance().currentScreenWidth = Settings::instance().screenWidth;
  switch (mode)
  {
  case FULLSCREEN_MODE::WINDOWED:
    SDL_SetWindowFullscreen(m_window, 0);
    break;
  case FULLSCREEN_MODE::FULLSCREEN:
    SDL_SetWindowFullscreen(m_window, SDL_WINDOW_FULLSCREEN);
    break;
  case FULLSCREEN_MODE::BORDERLESS:
    SDL_DisplayMode desktopScreenMode;
    if (SDL_GetDesktopDisplayMode(0, &desktopScreenMode) != 0)
    {
      LOG(LOG_INFO) << "SDL_GetDesktopDisplayMode failed: " << SDL_GetError();
    }
    // set the actual resolution to the desktop resolution for Borderless
    Settings::instance().currentScreenHeight = desktopScreenMode.h;
    Settings::instance().currentScreenWidth = desktopScreenMode.w;
 
    // As a workaround, need to switch back into windowed mode before changing the display mode, then back to full screen mode.
    // Minimize / Restore is another workaround to get the change from fullscreen to Borderless working
    SDL_SetWindowFullscreen(m_window, 0);
    SDL_SetWindowFullscreen(m_window, SDL_WINDOW_FULLSCREEN_DESKTOP);
    SDL_MinimizeWindow(m_window);
    SDL_RestoreWindow(m_window);
 
    break;
  default:
    // do nothing or log message on the off chance this is reached
    break;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

setScreenResolution()

void WindowManager::setScreenResolution

(

int

mode

)

Definition at line 188 of file WindowManager.cxx.

{
  // check if the desired mode exists first
  if (mode >= 0 && mode < static_cast<int>(m_resolutions.size()) && m_resolutions[mode])
  {
    // m_lastSelectedResolutionIdx = mode;
    Settings::instance().screenWidth = m_resolutions[mode]->w;
    Settings::instance().screenHeight = m_resolutions[mode]->h;
 
    // update the actual resolution
    Settings::instance().currentScreenWidth = Settings::instance().screenWidth;
    Settings::instance().currentScreenHeight = Settings::instance().screenHeight;
 
    switch (static_cast<FULLSCREEN_MODE>(Settings::instance().fullScreenMode))
    {
    case FULLSCREEN_MODE::FULLSCREEN:
      SDL_SetWindowDisplayMode(m_window, m_resolutions[mode].get());
      // workaround. After setting Display Resolution in fullscreen, it won't work until disabling / enabling Fullscreen again.
      SDL_SetWindowFullscreen(m_window, 0);
      SDL_SetWindowFullscreen(m_window, SDL_WINDOW_FULLSCREEN);
      break;
    case FULLSCREEN_MODE::WINDOWED:
      SDL_SetWindowSize(m_window, m_resolutions[mode]->w, m_resolutions[mode]->h);
      SDL_SetWindowPosition(m_window, SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED);
      break;
    default: //AKA FULLSCREEN_MODE::BORDERLESS
      // do nothing for Borderless fullscreen, it's always the screenSize
      break;
    }
  }
  else
  {
    throw UIError(TRACE_INFO "Cannot set screen mode " + std::to_string(mode));
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

setWindowTitle()

void WindowManager::setWindowTitle

(

const std::string &

title

)

sets title of the window

Parameters

title

the new title of the window

Definition at line 135 of file WindowManager.cxx.

{
  m_title = title;
  SDL_SetWindowTitle(m_window, m_title.c_str());
}

Here is the caller graph for this function:

toggleFullScreen()

void WindowManager::toggleFullScreen

(

)

const

Definition at line 82 of file WindowManager.cxx.

{
  Settings::instance().fullScreen = !Settings::instance().fullScreen;
 
  if (Settings::instance().fullScreen)
  {
    SDL_SetWindowFullscreen(m_window, SDL_WINDOW_FULLSCREEN);
  }
  else
  {
    SDL_SetWindowFullscreen(m_window, 0);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_activeDisplay

int WindowManager::m_activeDisplay = 0

private

Definition at line 82 of file WindowManager.hxx.

m_numOfDisplays

int WindowManager::m_numOfDisplays = 0

private

Definition at line 81 of file WindowManager.hxx.

m_renderer

SDL_Renderer* WindowManager::m_renderer = nullptr

private

pointer to the SDL_Renderer

Definition at line 77 of file WindowManager.hxx.

m_resolutions

std::vector<std::unique_ptr<SDL_DisplayMode> > WindowManager::m_resolutions

private

Definition at line 79 of file WindowManager.hxx.

m_title

std::string WindowManager::m_title = "Cytopia"

private

title of the window

Definition at line 73 of file WindowManager.hxx.

m_window

SDL_Window* WindowManager::m_window = nullptr

private

pointer to the SDL_Window

Definition at line 76 of file WindowManager.hxx.

m_windowIcon

const std::string WindowManager::m_windowIcon = "resources/images/app_icons/cytopia_icon.png"

private

the window's icon

Definition at line 74 of file WindowManager.hxx.

Singleton< WindowManager >

friend WindowManager::Singleton< WindowManager >

Definition at line 22 of file WindowManager.hxx.

---

The documentation for this class was generated from the following files:

• src/engine/WindowManager.hxx
• src/engine/WindowManager.cxx