SdlWidget Class Reference

Inheritance diagram for SdlWidget:

Public Member Functions
	SdlWidget (SDL_Renderer *renderer, SDL_Rect rect, bool input)
	SdlWidget (SdlWidget &&other) noexcept
bool	fill (SDL_Renderer *renderer, SDL_Color color)
bool	fill (SDL_Renderer *renderer, const std::vector< SDL_Color > &colors)
bool	update_text (SDL_Renderer *renderer, const std::string &text, SDL_Color fgcolor)
bool	update_text (SDL_Renderer *renderer, const std::string &text, SDL_Color fgcolor, SDL_Color bgcolor)
bool	wrap () const
bool	set_wrap (bool wrap=true, size_t width=0)
const SDL_Rect &	rect () const
	SdlWidget (const SdlWidget &other)=delete
SdlWidget &	operator= (const SdlWidget &other)=delete
SdlWidget &	operator= (SdlWidget &&other)=delete
	SdlWidget (std::shared_ptr< SDL_Renderer > &renderer, const SDL_FRect &rect)
	SdlWidget (const SdlWidget &other)=delete
	SdlWidget (SdlWidget &&other) noexcept
SdlWidget &	operator= (const SdlWidget &other)=delete
SdlWidget &	operator= (SdlWidget &&other)=delete
bool	fill (SDL_Color color) const
bool	fill (const std::vector< SDL_Color > &colors) const
bool	update_text (const std::string &text)
bool	wrap () const
bool	set_wrap (bool wrap=true, size_t width=0)
const SDL_FRect &	rect () const
bool	update ()

Static Public Member Functions
static bool	error_ex (Sint32 res, const char *what, const char *file, size_t line, const char *fkt)
static bool	error_ex (bool success, const char *what, const char *file, size_t line, const char *fkt)

Protected Member Functions
virtual bool	clear () const
virtual bool	updateInternal ()

Protected Attributes
std::shared_ptr< SDL_Renderer >	_renderer {}
SDL_Color	_backgroundcolor = { 0x56, 0x56, 0x56, 0xff }
SDL_Color	_fontcolor = { 0xd1, 0xcf, 0xcd, 0xff }
std::string	_text

Detailed Description

Definition at line 48 of file SDL2/dialogs/sdl_widget.hpp.

Constructor & Destructor Documentation

SdlWidget() [1/3]

SdlWidget::SdlWidget	(	SDL_Renderer *	renderer,
		SDL_Rect	rect,
		bool	input
	)

Definition at line 45 of file SDL2/dialogs/sdl_widget.cpp.

    : _rect(rect), _input(input)
{
  assert(renderer);
 
  auto ops = SDL2ResourceManager::get(SDLResourceManager::typeFonts(),
                                      "OpenSans-VariableFont_wdth,wght.ttf");
  if (!ops)
    widget_log_error(-1, "SDLResourceManager::get");
  else
  {
    _font = TTF_OpenFontRW(ops, 1, 64);
    if (!_font)
      widget_log_error(-1, "TTF_OpenFontRW");
  }
}

SdlWidget() [2/3]

SdlWidget::SdlWidget ( SdlWidget &&  other )

noexcept

Definition at line 74 of file SDL2/dialogs/sdl_widget.cpp.

    : _font(other._font), _image(other._image), _rect(other._rect), _input(other._input),
      _wrap(other._wrap), _text_width(other._text_width)
{
  other._font = nullptr;
  other._image = nullptr;
}

~SdlWidget()

SdlWidget::~SdlWidget ( )

virtualdefault

Definition at line 173 of file SDL2/dialogs/sdl_widget.cpp.

{
  TTF_CloseFont(_font);
  if (_image)
    SDL_DestroyTexture(_image);
}

SdlWidget() [3/3]

SdlWidget::SdlWidget	(	std::shared_ptr< SDL_Renderer > &	renderer,
		const SDL_FRect &	rect
	)

Definition at line 44 of file SDL3/dialogs/sdl_widget.cpp.

    : _renderer(renderer),
      _engine(TTF_CreateRendererTextEngine(renderer.get()), TTF_DestroyRendererTextEngine),
      _rect(rect)
{
  assert(renderer);
 
  auto ops = SDL3ResourceManager::get(SDLResourceManager::typeFonts(),
                                      "OpenSans-VariableFont_wdth,wght.ttf");
  if (!ops)
    widget_log_error(false, "SDLResourceManager::get");
  else
  {
    _font = std::shared_ptr<TTF_Font>(TTF_OpenFontIO(ops, true, 64), TTF_CloseFont);
    if (!_font)
      widget_log_error(false, "TTF_OpenFontRW");
  }
}

Member Function Documentation

clear()

bool SdlWidget::clear ( ) const

protectedvirtual

Definition at line 274 of file SDL3/dialogs/sdl_widget.cpp.

{
  if (!_renderer)
    return false;
 
  SdlBlendModeGuard guard(_renderer, SDL_BLENDMODE_NONE);
 
  const auto drc = SDL_SetRenderDrawColor(_renderer.get(), _backgroundcolor.r, _backgroundcolor.g,
                                          _backgroundcolor.b, _backgroundcolor.a);
  if (widget_log_error(drc, "SDL_SetRenderDrawColor"))
    return false;
 
  const auto rcls = SDL_RenderRect(_renderer.get(), &_rect);
  return !widget_log_error(rcls, "SDL_RenderRect");
}

error_ex() [1/2]

bool SdlWidget::error_ex ( bool  success, const char *  what, const char *  file, size_t  line, const char *  fkt  )

static

Definition at line 204 of file SDL3/dialogs/sdl_widget.cpp.

{
  if (success)
  {
    // Flip SDL3 convention to existing code convention to minimize code changes
    return false;
  }
  static wLog* log = nullptr;
  if (!log)
    log = WLog_Get(TAG);
  // Use -1 as it indicates error similar to SDL2 conventions
  // sdl_log_error_ex treats any value other than 0 as SDL error
  return sdl_log_error_ex(-1, log, what, file, line, fkt);
}

error_ex() [2/2]

bool SdlWidget::error_ex ( Sint32  res, const char *  what, const char *  file, size_t  line, const char *  fkt  )

static

Definition at line 180 of file SDL2/dialogs/sdl_widget.cpp.

{
  static wLog* log = nullptr;
  if (!log)
    log = WLog_Get(TAG);
  return sdl_log_error_ex(res, log, what, file, line, fkt);
}

fill() [1/4]

bool SdlWidget::fill

(

const std::vector< SDL_Color > &

colors

)

const

Definition at line 241 of file SDL3/dialogs/sdl_widget.cpp.

{
  SdlBlendModeGuard guard(_renderer, SDL_BLENDMODE_NONE);
 
  for (auto color : colors)
  {
    if (!draw_rect(_rect, color))
      return false;
 
    if (!guard.update(SDL_BLENDMODE_ADD))
      return false;
  }
 
  return true;
}

fill() [2/4]

bool SdlWidget::fill

(

SDL_Color

color

)

const

Definition at line 235 of file SDL3/dialogs/sdl_widget.cpp.

{
  std::vector<SDL_Color> colors = { color };
  return fill(colors);
}

fill() [3/4]

bool SdlWidget::fill	(	SDL_Renderer *	renderer,
		const std::vector< SDL_Color > &	colors
	)

Definition at line 205 of file SDL2/dialogs/sdl_widget.cpp.

{
  assert(renderer);
  SDL_BlendMode mode = SDL_BLENDMODE_INVALID;
  SDL_GetRenderDrawBlendMode(renderer, &mode);
  SDL_SetRenderDrawBlendMode(renderer, SDL_BLENDMODE_NONE);
  for (auto color : colors)
  {
    draw_rect(renderer, &_rect, color);
    SDL_SetRenderDrawBlendMode(renderer, SDL_BLENDMODE_ADD);
  }
  SDL_SetRenderDrawBlendMode(renderer, mode);
  return true;
}

fill() [4/4]

bool SdlWidget::fill	(	SDL_Renderer *	renderer,
		SDL_Color	color
	)

Definition at line 199 of file SDL2/dialogs/sdl_widget.cpp.

{
  std::vector<SDL_Color> colors = { color };
  return fill(renderer, colors);
}

rect()

const SDL_FRect & SdlWidget::rect

(

)

const

Definition at line 242 of file SDL2/dialogs/sdl_widget.cpp.

{
  return _rect;
}

set_wrap()

bool SdlWidget::set_wrap	(	bool	wrap = true,
		size_t	width = 0
	)

Definition at line 235 of file SDL2/dialogs/sdl_widget.cpp.

{
  _wrap = wrap;
  _text_width = width;
  return _wrap;
}

update()

bool SdlWidget::update

(

)

Definition at line 290 of file SDL3/dialogs/sdl_widget.cpp.

{
  if (!clear())
    return false;
  // TODO: Draw widget specifics
  return updateInternal();
}

update_text() [1/3]

bool SdlWidget::update_text

(

const std::string &

text

)

Definition at line 298 of file SDL3/dialogs/sdl_widget.cpp.

{
  _text = text;
  if (_text.empty())
    return true;
 
  SDL_FRect src{};
  SDL_FRect dst{};
 
  std::shared_ptr<SDL_Texture> texture;
  if (_image)
  {
    texture = _image;
    dst = _rect;
    auto propId = SDL_GetTextureProperties(_image.get());
    auto w = SDL_GetNumberProperty(propId, SDL_PROP_TEXTURE_WIDTH_NUMBER, -1);
    auto h = SDL_GetNumberProperty(propId, SDL_PROP_TEXTURE_HEIGHT_NUMBER, -1);
    if (w < 0 || h < 0)
      widget_log_error(false, "SDL_GetTextureProperties");
    src.w = static_cast<float>(w);
    src.h = static_cast<float>(h);
  }
  else if (_wrap)
    texture = render_text_wrapped(_text, _fontcolor, src, dst);
  else
    texture = render_text(_text, _fontcolor, src, dst);
  if (!texture)
    return false;
 
  const auto rc = SDL_RenderTexture(_renderer.get(), texture.get(), &src, &dst);
  return !widget_log_error(rc, "SDL_RenderCopy");
}

update_text() [2/3]

bool SdlWidget::update_text	(	SDL_Renderer *	renderer,
		const std::string &	text,
		SDL_Color	fgcolor
	)

Definition at line 247 of file SDL2/dialogs/sdl_widget.cpp.

{
 
  if (text.empty())
    return true;
 
  SDL_Rect src{};
  SDL_Rect dst{};
 
  SDL_Texture* texture = nullptr;
  if (_image)
  {
    texture = _image;
    dst = _rect;
    auto rc = SDL_QueryTexture(_image, nullptr, nullptr, &src.w, &src.h);
    if (rc < 0)
      widget_log_error(rc, "SDL_QueryTexture");
  }
  else if (_wrap)
    texture = render_text_wrapped(renderer, text, fgcolor, src, dst);
  else
    texture = render_text(renderer, text, fgcolor, src, dst);
  if (!texture)
    return false;
 
  const int rc = SDL_RenderCopy(renderer, texture, &src, &dst);
  if (!_image)
    SDL_DestroyTexture(texture);
  if (rc < 0)
    return !widget_log_error(rc, "SDL_RenderCopy");
  return true;
}

update_text() [3/3]

bool SdlWidget::update_text	(	SDL_Renderer *	renderer,
		const std::string &	text,
		SDL_Color	fgcolor,
		SDL_Color	bgcolor
	)

Definition at line 220 of file SDL2/dialogs/sdl_widget.cpp.

{
  assert(renderer);
 
  if (!fill(renderer, bgcolor))
    return false;
  return update_text(renderer, text, fgcolor);
}

updateInternal()

bool SdlWidget::updateInternal ( )

protectedvirtual

Definition at line 220 of file SDL3/dialogs/sdl_widget.cpp.

{
  return update_text(_text);
}

wrap()

bool SdlWidget::wrap

(

)

const

Definition at line 230 of file SDL2/dialogs/sdl_widget.cpp.

{
  return _wrap;
}

Field Documentation

_backgroundcolor

SDL_Color SdlWidget::_backgroundcolor = { 0x56, 0x56, 0x56, 0xff }

protected

Definition at line 78 of file SDL3/dialogs/sdl_widget.hpp.

{ 0x56, 0x56, 0x56, 0xff };

_fontcolor

SDL_Color SdlWidget::_fontcolor = { 0xd1, 0xcf, 0xcd, 0xff }

protected

Definition at line 79 of file SDL3/dialogs/sdl_widget.hpp.

{ 0xd1, 0xcf, 0xcd, 0xff };

_renderer

std::shared_ptr<SDL_Renderer> SdlWidget::_renderer {}

protected

Definition at line 77 of file SDL3/dialogs/sdl_widget.hpp.

{};

_text

std::string SdlWidget::_text

mutableprotected

Definition at line 80 of file SDL3/dialogs/sdl_widget.hpp.

---

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

• SDL2/dialogs/sdl_widget.hpp
• SDL3/dialogs/sdl_widget.hpp
• SDL2/dialogs/sdl_widget.cpp
• SDL3/dialogs/sdl_widget.cpp