#include <sdl_window.hpp>

Public Member Functions
	SdlWindow (const std::string &title, Sint32 startupX, Sint32 startupY, Sint32 width, Sint32 height, Uint32 flags)

	SdlWindow (const SdlWindow &other)=delete

	SdlWindow (SdlWindow &&other) noexcept

SdlWindow &	operator= (const SdlWindow &other)=delete

SdlWindow &	operator= (SdlWindow &&other)=delete

Uint32	id () const

int	displayIndex () const

SDL_Rect	rect () const

SDL_Window *	window () const

Sint32	offsetX () const

void	setOffsetX (Sint32 x)

void	setOffsetY (Sint32 y)

Sint32	offsetY () const

bool	grabKeyboard (bool enable)

bool	grabMouse (bool enable)

void	setBordered (bool bordered)

void	raise ()

void	resizeable (bool use)

void	fullscreen (bool enter)

void	minimize ()

bool	fill (Uint8 r=0x00, Uint8 g=0x00, Uint8 b=0x00, Uint8 a=0xff)

bool	blit (SDL_Surface *surface, SDL_Rect src, SDL_Rect &dst)

void	updateSurface ()

	SdlWindow (SdlWindow &&other) noexcept

	SdlWindow (const SdlWindow &other)=delete

SdlWindow &	operator= (const SdlWindow &other)=delete

SdlWindow &	operator= (SdlWindow &&other)=delete

SDL_WindowID	id () const

SDL_DisplayID	displayIndex () const

SDL_Rect	rect () const

SDL_Rect	bounds () const

SDL_Window *	window () const

Sint32	offsetX () const

void	setOffsetX (Sint32 x)

void	setOffsetY (Sint32 y)

Sint32	offsetY () const

rdpMonitor	monitor (bool isPrimary) const

float	scale () const

SDL_DisplayOrientation	orientation () const

bool	grabKeyboard (bool enable)

bool	grabMouse (bool enable)

void	setBordered (bool bordered)

void	raise ()

void	resizeable (bool use)

void	fullscreen (bool enter)

void	minimize ()

bool	resize (const SDL_Point &size)

bool	drawRect (SDL_Surface *surface, SDL_Point offset, const SDL_Rect &srcRect)

bool	drawRects (SDL_Surface *surface, SDL_Point offset, const std::vector< SDL_Rect > &rects={})

bool	drawScaledRect (SDL_Surface *surface, const SDL_FPoint &scale, const SDL_Rect &srcRect)

bool	drawScaledRects (SDL_Surface *surface, const SDL_FPoint &scale, const std::vector< SDL_Rect > &rects={})

bool	fill (Uint8 r=0x00, Uint8 g=0x00, Uint8 b=0x00, Uint8 a=0xff)

bool	blit (SDL_Surface *surface, const SDL_Rect &src, SDL_Rect &dst)

void	updateSurface ()

Static Public Member Functions
static SdlWindow	create (SDL_DisplayID id, const std::string &title, Uint32 flags, Uint32 width=0, Uint32 height=0)

Protected Member Functions
	SdlWindow (const std::string &title, const SDL_Rect &rect, Uint32 flags)

Detailed Description

FreeRDP: A Remote Desktop Protocol Implementation SDL Client

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition at line 25 of file SDL2/sdl_window.hpp.

Constructor & Destructor Documentation

◆ SdlWindow() [1/3]

SdlWindow::SdlWindow	(	const std::string &	title,
		Sint32	startupX,
		Sint32	startupY,
		Sint32	width,
		Sint32	height,
		Uint32	flags
	)

FreeRDP: A Remote Desktop Protocol Implementation SDL Client

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition at line 23 of file SDL2/sdl_window.cpp.

    : _window(SDL_CreateWindow(title.c_str(), startupX, startupY, width, height, flags))
{
}

◆ SdlWindow() [2/3]

SdlWindow::SdlWindow ( SdlWindow && other )

noexcept

Definition at line 29 of file SDL2/sdl_window.cpp.

    : _window(other._window), _offset_x(other._offset_x), _offset_y(other._offset_y)
{
  other._window = nullptr;
}

◆ ~SdlWindow()

SdlWindow::~SdlWindow ( )

Definition at line 35 of file SDL2/sdl_window.cpp.

{
  SDL_DestroyWindow(_window);
}

◆ SdlWindow() [3/3]

SdlWindow::SdlWindow	(	const std::string &	title,
		const SDL_Rect &	rect,
		Uint32	flags
	)

protected

FreeRDP: A Remote Desktop Protocol Implementation SDL Client

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition at line 26 of file SDL3/sdl_window.cpp.

{
  auto props = SDL_CreateProperties();
  SDL_SetStringProperty(props, SDL_PROP_WINDOW_CREATE_TITLE_STRING, title.c_str());
  SDL_SetNumberProperty(props, SDL_PROP_WINDOW_CREATE_X_NUMBER, rect.x);
  SDL_SetNumberProperty(props, SDL_PROP_WINDOW_CREATE_Y_NUMBER, rect.y);
  SDL_SetNumberProperty(props, SDL_PROP_WINDOW_CREATE_WIDTH_NUMBER, rect.w);
  SDL_SetNumberProperty(props, SDL_PROP_WINDOW_CREATE_HEIGHT_NUMBER, rect.h);
 
  if (flags & SDL_WINDOW_HIGH_PIXEL_DENSITY)
    SDL_SetBooleanProperty(props, SDL_PROP_WINDOW_CREATE_HIGH_PIXEL_DENSITY_BOOLEAN, true);
 
  if (flags & SDL_WINDOW_FULLSCREEN)
    SDL_SetBooleanProperty(props, SDL_PROP_WINDOW_CREATE_FULLSCREEN_BOOLEAN, true);
 
  if (flags & SDL_WINDOW_BORDERLESS)
    SDL_SetBooleanProperty(props, SDL_PROP_WINDOW_CREATE_BORDERLESS_BOOLEAN, true);
 
  _window = SDL_CreateWindowWithProperties(props);
  SDL_DestroyProperties(props);
 
  auto sc = scale();
  const int iscale = static_cast<int>(sc * 100.0f);
  auto w = 100 * rect.w / iscale;
  auto h = 100 * rect.h / iscale;
  std::ignore = resize({ w, h });
  SDL_SetHint(SDL_HINT_APP_NAME, "");
  std::ignore = SDL_SyncWindow(_window);
}

Member Function Documentation

◆ blit() [1/2]

bool SdlWindow::blit	(	SDL_Surface *	surface,
		const SDL_Rect &	src,
		SDL_Rect &	dst
	)

Definition at line 291 of file SDL3/sdl_window.cpp.

{
  auto screen = SDL_GetWindowSurface(_window);
  if (!screen || !surface)
    return false;
  if (!SDL_SetSurfaceClipRect(surface, &srcRect))
    return true;
  if (!SDL_SetSurfaceClipRect(screen, &dstRect))
    return true;
  if (!SDL_BlitSurfaceScaled(surface, &srcRect, screen, &dstRect, SDL_SCALEMODE_LINEAR))
  {
    SDL_LogError(SDL_LOG_CATEGORY_RENDER, "SDL_BlitScaled: %s", SDL_GetError());
    return false;
  }
  return true;
}

◆ blit() [2/2]

bool SdlWindow::blit	(	SDL_Surface *	surface,
		SDL_Rect	src,
		SDL_Rect &	dst
	)

Definition at line 187 of file SDL2/sdl_window.cpp.

{
  auto screen = SDL_GetWindowSurface(_window);
  if (!screen || !surface)
    return false;
  if (!SDL_SetClipRect(surface, &srcRect))
    return true;
  if (!SDL_SetClipRect(screen, &dstRect))
    return true;
  auto rc = SDL_BlitScaled(surface, &srcRect, screen, &dstRect);
  if (rc != 0)
  {
    SDL_LogError(SDL_LOG_CATEGORY_RENDER, "SDL_BlitScaled: %s [%d]", sdl_error_string(rc), rc);
  }
  return rc == 0;
}

◆ bounds()

SDL_Rect SdlWindow::bounds ( ) const

Definition at line 92 of file SDL3/sdl_window.cpp.

{
  SDL_Rect rect = {};
  if (_window)
  {
    SDL_GetWindowPosition(_window, &rect.x, &rect.y);
    SDL_GetWindowSize(_window, &rect.w, &rect.h);
  }
  return rect;
}

◆ create()

SdlWindow SdlWindow::create	(	SDL_DisplayID	id,
		const std::string &	title,
		Uint32	flags,
		Uint32	width = `0`,
		Uint32	height = `0`
	)

static

Definition at line 313 of file SDL3/sdl_window.cpp.

{
  flags |= SDL_WINDOW_HIGH_PIXEL_DENSITY;
 
  SDL_Rect rect = { static_cast<int>(SDL_WINDOWPOS_CENTERED_DISPLAY(id)),
                  static_cast<int>(SDL_WINDOWPOS_CENTERED_DISPLAY(id)), static_cast<int>(width),
                  static_cast<int>(height) };
 
  if ((flags & SDL_WINDOW_FULLSCREEN) != 0)
  {
    std::ignore = SDL_GetDisplayBounds(id, &rect);
  }
 
  SdlWindow window{ title, rect, flags };
 
  if ((flags & (SDL_WINDOW_FULLSCREEN)) != 0)
  {
    window.setOffsetX(rect.x);
    window.setOffsetY(rect.y);
  }
 
  return window;
}

◆ displayIndex()

SDL_DisplayID SdlWindow::displayIndex ( ) const

Definition at line 47 of file SDL2/sdl_window.cpp.

{
  if (!_window)
    return 0;
  return SDL_GetWindowDisplayIndex(_window);
}

◆ drawRect()

bool SdlWindow::drawRect	(	SDL_Surface *	surface,
		SDL_Point	offset,
		const SDL_Rect &	srcRect
	)

Definition at line 231 of file SDL3/sdl_window.cpp.

{
  WINPR_ASSERT(surface);
  SDL_Rect dstRect = { offset.x + srcRect.x, offset.y + srcRect.y, srcRect.w, srcRect.h };
  return blit(surface, srcRect, dstRect);
}

◆ drawRects()

bool SdlWindow::drawRects	(	SDL_Surface *	surface,
		SDL_Point	offset,
		const std::vector< SDL_Rect > &	rects = `{}`
	)

Definition at line 238 of file SDL3/sdl_window.cpp.

{
  if (rects.empty())
  {
    return drawRect(surface, offset, { 0, 0, surface->w, surface->h });
  }
  for (auto& srcRect : rects)
  {
    if (!drawRect(surface, offset, srcRect))
      return false;
  }
  return true;
}

◆ drawScaledRect()

bool SdlWindow::drawScaledRect	(	SDL_Surface *	surface,
		const SDL_FPoint &	scale,
		const SDL_Rect &	srcRect
	)

Definition at line 253 of file SDL3/sdl_window.cpp.

{
  SDL_Rect dstRect = srcRect;
  dstRect.x = static_cast<Sint32>(static_cast<float>(dstRect.x) * scale.x);
  dstRect.w = static_cast<Sint32>(static_cast<float>(dstRect.w) * scale.x);
  dstRect.y = static_cast<Sint32>(static_cast<float>(dstRect.y) * scale.y);
  dstRect.h = static_cast<Sint32>(static_cast<float>(dstRect.h) * scale.y);
  return blit(surface, srcRect, dstRect);
}

◆ drawScaledRects()

bool SdlWindow::drawScaledRects	(	SDL_Surface *	surface,
		const SDL_FPoint &	scale,
		const std::vector< SDL_Rect > &	rects = `{}`
	)

Definition at line 264 of file SDL3/sdl_window.cpp.

{
  if (rects.empty())
  {
    return drawScaledRect(surface, scale, { 0, 0, surface->w, surface->h });
  }
  for (const auto& srcRect : rects)
  {
    if (!drawScaledRect(surface, scale, srcRect))
      return false;
  }
  return true;
}

◆ fill()

bool SdlWindow::fill	(	Uint8	r = `0x00`,
		Uint8	g = `0x00`,
		Uint8	b = `0x00`,
		Uint8	a = `0xff`
	)

Definition at line 175 of file SDL2/sdl_window.cpp.

{
  auto surface = SDL_GetWindowSurface(_window);
  if (!surface)
    return false;
  SDL_Rect rect = { 0, 0, surface->w, surface->h };
  auto color = SDL_MapRGBA(surface->format, r, g, b, a);
 
  SDL_FillRect(surface, &rect, color);
  return true;
}

◆ fullscreen()

void SdlWindow::fullscreen ( bool enter )

Definition at line 131 of file SDL2/sdl_window.cpp.

{
  auto curFlags = SDL_GetWindowFlags(_window);
 
  if (enter)
  {
    if (!(curFlags & SDL_WINDOW_BORDERLESS))
    {
      auto idx = SDL_GetWindowDisplayIndex(_window);
      SDL_DisplayMode mode = {};
      SDL_GetCurrentDisplayMode(idx, &mode);
 
      SDL_RestoreWindow(_window); // Maximize so we can see the caption and
                                  // bits
      SDL_SetWindowBordered(_window, SDL_FALSE);
      SDL_SetWindowPosition(_window, 0, 0);
#if SDL_VERSION_ATLEAST(2, 0, 16)
      SDL_SetWindowAlwaysOnTop(_window, SDL_TRUE);
#endif
      SDL_RaiseWindow(_window);
      SDL_SetWindowSize(_window, mode.w, mode.h);
    }
  }
  else
  {
    if (curFlags & SDL_WINDOW_BORDERLESS)
    {
 
      SDL_SetWindowBordered(_window, SDL_TRUE);
#if SDL_VERSION_ATLEAST(2, 0, 16)
      SDL_SetWindowAlwaysOnTop(_window, SDL_FALSE);
#endif
      SDL_RaiseWindow(_window);
      SDL_MinimizeWindow(_window); // Maximize so we can see the caption and bits
      SDL_MaximizeWindow(_window); // Maximize so we can see the caption and bits
    }
  }
}

◆ grabKeyboard()

bool SdlWindow::grabKeyboard ( bool enable )

Definition at line 90 of file SDL2/sdl_window.cpp.

{
  if (!_window)
    return false;
#if SDL_VERSION_ATLEAST(2, 0, 16)
  SDL_SetWindowKeyboardGrab(_window, enable ? SDL_TRUE : SDL_FALSE);
  return true;
#else
  SDL_LogError(SDL_LOG_CATEGORY_INPUT, "Keyboard grabbing not supported by SDL2 < 2.0.16");
  return false;
#endif
}

◆ grabMouse()

bool SdlWindow::grabMouse ( bool enable )

Definition at line 103 of file SDL2/sdl_window.cpp.

{
  if (!_window)
    return false;
#if SDL_VERSION_ATLEAST(2, 0, 16)
  SDL_SetWindowMouseGrab(_window, enable ? SDL_TRUE : SDL_FALSE);
#else
  SDL_SetWindowGrab(_window, enable ? SDL_TRUE : SDL_FALSE);
#endif
  return true;
}

◆ id()

SDL_WindowID SdlWindow::id ( ) const

Definition at line 40 of file SDL2/sdl_window.cpp.

{
  if (!_window)
    return 0;
  return SDL_GetWindowID(_window);
}

◆ minimize()

void SdlWindow::minimize ( )

Definition at line 170 of file SDL2/sdl_window.cpp.

{
  SDL_MinimizeWindow(_window);
}

◆ monitor()

rdpMonitor SdlWindow::monitor ( bool isPrimary ) const

Definition at line 128 of file SDL3/sdl_window.cpp.

{
  rdpMonitor mon{};
 
  const auto factor = scale();
  const auto dsf = static_cast<UINT32>(100 * factor);
  mon.attributes.desktopScaleFactor = dsf;
  mon.attributes.deviceScaleFactor = 100;
 
  const auto r = rect();
  mon.width = r.w;
  mon.height = r.h;
 
  mon.attributes.physicalWidth = WINPR_ASSERTING_INT_CAST(uint32_t, r.w);
  mon.attributes.physicalHeight = WINPR_ASSERTING_INT_CAST(uint32_t, r.h);
 
  SDL_Rect rect = {};
  auto did = SDL_GetDisplayForWindow(_window);
  auto rc = SDL_GetDisplayBounds(did, &rect);
 
  if (rc)
  {
    mon.x = rect.x;
    mon.y = rect.y;
  }
 
  const auto orient = orientation();
  mon.attributes.orientation = sdl::utils::orientaion_to_rdp(orient);
 
  auto primary = SDL_GetPrimaryDisplay();
  mon.is_primary = isPrimary || (SDL_GetWindowID(_window) == primary);
  mon.orig_screen = did;
  if (mon.is_primary)
  {
    mon.x = 0;
    mon.y = 0;
  }
  return mon;
}

◆ offsetX()

Sint32 SdlWindow::offsetX ( ) const

Definition at line 70 of file SDL2/sdl_window.cpp.

{
  return _offset_x;
}

◆ offsetY()

Sint32 SdlWindow::offsetY ( ) const

Definition at line 85 of file SDL2/sdl_window.cpp.

{
  return _offset_y;
}

◆ orientation()

SDL_DisplayOrientation SdlWindow::orientation ( ) const

Definition at line 173 of file SDL3/sdl_window.cpp.

{
  const auto did = displayIndex();
  return SDL_GetCurrentDisplayOrientation(did);
}

◆ raise()

void SdlWindow::raise ( )

Definition at line 121 of file SDL2/sdl_window.cpp.

{
  SDL_RaiseWindow(_window);
}

◆ rect()

SDL_Rect SdlWindow::rect ( ) const

Definition at line 54 of file SDL2/sdl_window.cpp.

{
  SDL_Rect rect = {};
  if (_window)
  {
    SDL_GetWindowPosition(_window, &rect.x, &rect.y);
    SDL_GetWindowSize(_window, &rect.w, &rect.h);
  }
  return rect;
}

◆ resize()

bool SdlWindow::resize ( const SDL_Point & size )

Definition at line 226 of file SDL3/sdl_window.cpp.

{
  return SDL_SetWindowSize(_window, size.x, size.y);
}

◆ resizeable()

void SdlWindow::resizeable ( bool use )

Definition at line 126 of file SDL2/sdl_window.cpp.

{
  SDL_SetWindowResizable(_window, use ? SDL_TRUE : SDL_FALSE);
}

◆ scale()

float SdlWindow::scale ( ) const

Definition at line 168 of file SDL3/sdl_window.cpp.

{
  return SDL_GetWindowDisplayScale(_window);
}

◆ setBordered()

void SdlWindow::setBordered ( bool bordered )

Definition at line 115 of file SDL2/sdl_window.cpp.

{
  if (_window)
    SDL_SetWindowBordered(_window, bordered ? SDL_TRUE : SDL_FALSE);
}

◆ setOffsetX()

void SdlWindow::setOffsetX ( Sint32 x )

Definition at line 75 of file SDL2/sdl_window.cpp.

{
  _offset_x = x;
}

◆ setOffsetY()

void SdlWindow::setOffsetY ( Sint32 y )

Definition at line 80 of file SDL2/sdl_window.cpp.

{
  _offset_y = y;
}

◆ updateSurface()

void SdlWindow::updateSurface ( )

Definition at line 204 of file SDL2/sdl_window.cpp.

{
  SDL_UpdateWindowSurface(_window);
}

◆ window()

SDL_Window * SdlWindow::window ( ) const

Definition at line 65 of file SDL2/sdl_window.cpp.

{
  return _window;
}

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SdlWindow() [1/3]

◆ SdlWindow() [2/3]

◆ ~SdlWindow()

◆ SdlWindow() [3/3]

Member Function Documentation

◆ blit() [1/2]

◆ blit() [2/2]

◆ bounds()

◆ create()

◆ displayIndex()

◆ drawRect()

◆ drawRects()

◆ drawScaledRect()

◆ drawScaledRects()

◆ fill()

◆ fullscreen()

◆ grabKeyboard()

◆ grabMouse()

◆ id()

◆ minimize()

◆ monitor()

◆ offsetX()

◆ offsetY()

◆ orientation()

◆ raise()

◆ rect()

◆ resize()

◆ resizeable()

◆ scale()

◆ setBordered()

◆ setOffsetX()

◆ setOffsetY()

◆ updateSurface()

◆ window()