Classes
class	Renderer
	The main class dealing with rendering. More...

struct	RendererInitOptions
	Represents the options for initializing the Renderer. More...

struct	TextureRenderOptions
	Represents the options for rendering a texture. More...

Functions
sdl2::Renderer	GetMainRenderer ()
	Gets the underlying SDL2 renderer.

sdl2::Window	GetMainWindow ()
	Gets the underlying SDL2 window.

sdl2::Surface	GetMainSurface ()
	Gets the underlying SDL2 surface.

std::pair< u32, u32 >	GetDimensions ()
	Gets the underlying SDL2 window width/height.

bool	AddFont (const std::string &font_name, std::shared_ptr< ttf::Font > &font)
	Creates a font to the internal font list.

bool	LoadSingleSharedFontInFont (std::shared_ptr< ttf::Font > &font, const PlSharedFontType type)
	Loads a system shared font (pl:) in a font object.

bool	LoadAllSharedFontsInFont (std::shared_ptr< ttf::Font > &font)
	Loads all system shared fonts (pl:) in a font object.

void	AddDefaultFont (std::shared_ptr< ttf::Font > &font)
	Adds a font object as a default font to the internal font list.

bool	GetTextDimensions (const std::string &font_name, const std::string &text, i32 &out_width, i32 &out_height)
	Gets the resulting text size for rendering a text with the specified font.

i32	GetTextWidth (const std::string &font_name, const std::string &text)
	Gets the resulting text width for rendering a text with the specified font.

i32	GetTextHeight (const std::string &font_name, const std::string &text)
	Gets the resulting text height for rendering a text with the specified font.

sdl2::Texture	RenderText (const std::string &font_name, const std::string &text, const Color clr, const u32 max_width=0, const u32 max_height=0)
	Renders a text to a texture.

sdl2::Texture	ConvertToTexture (sdl2::Surface surface)
	Converts a Surface to a Texture.

sdl2::Texture	LoadImage (const std::string &path)
	Loads an image from the specified path.

i32	GetTextureWidth (sdl2::Texture texture)
	Gets the width of a Texture.

i32	GetTextureHeight (sdl2::Texture texture)
	Gets the height of a Texture.

void	SetAlphaValue (sdl2::Texture texture, const u8 alpha)
	Sets the alpha value (for blending) of a Texture.

void	DeleteTexture (sdl2::Texture &texture)
	Frees a Texture from memory, and sets nullptr to the reference.

Variables
constexpr u32	BaseScreenWidth = 1280

constexpr u32	BaseScreenHeight = 720

constexpr u32	ScreenWidth = 1920

constexpr u32	ScreenHeight = 1080

constexpr double	ScreenFactor = (double)ScreenWidth / (double)BaseScreenWidth

constexpr u32	ImgAllFlags = IMG_INIT_PNG \| IMG_INIT_JPG \| IMG_INIT_WEBP

constexpr u32	RendererSoftwareFlags = SDL_RENDERER_SOFTWARE

constexpr u32	RendererHardwareFlags = SDL_RENDERER_PRESENTVSYNC \| SDL_RENDERER_ACCELERATED

Function Documentation

◆ AddDefaultFont()

void pu::ui::render::AddDefaultFont ( std::shared_ptr< ttf::Font > & font )

inline

Adds a font object as a default font to the internal font list.

Parameters

font	The font object to add.

◆ AddFont()

bool pu::ui::render::AddFont	(	const std::string &	font_name,
		std::shared_ptr< ttf::Font > &	font )

Creates a font to the internal font list.

Parameters

font_name	The name to use for the font.
font	The font to add.

Note: For simple font management, consider using RendererInitOptions.

◆ ConvertToTexture()

sdl2::Texture pu::ui::render::ConvertToTexture ( sdl2::Surface surface )

Converts a Surface to a Texture.

Parameters

surface The Surface to convert.

Note: The Surface will be freed after conversion.

Returns: The converted Texture.

◆ DeleteTexture()

void pu::ui::render::DeleteTexture ( sdl2::Texture & texture )

Frees a Texture from memory, and sets nullptr to the reference.

Parameters

texture The Texture to free.

Note: If the Texture is nullptr, this function will do nothing.

◆ GetDimensions()

std::pair< u32, u32 > pu::ui::render::GetDimensions ( )

Gets the underlying SDL2 window width/height.

Returns: The underlying SDL2 window width/height.

◆ GetMainRenderer()

sdl2::Renderer pu::ui::render::GetMainRenderer ( )

Gets the underlying SDL2 renderer.

Returns: The underlying SDL2 renderer.

◆ GetMainSurface()

sdl2::Surface pu::ui::render::GetMainSurface ( )

Gets the underlying SDL2 surface.

Returns: The underlying SDL2 surface.

◆ GetMainWindow()

sdl2::Window pu::ui::render::GetMainWindow ( )

Gets the underlying SDL2 window.

Returns: The underlying SDL2 window.

◆ GetTextDimensions()

bool pu::ui::render::GetTextDimensions	(	const std::string &	font_name,
		const std::string &	text,
		i32 &	out_width,
		i32 &	out_height )

Gets the resulting text size for rendering a text with the specified font.

Parameters

font_name	The name of the font to use.
text	The text to render.
out_width	The resulting width of the text.
out_height	The resulting height of the text.

Returns: Whether the specified font is available (was added) or not, and the text size was calculated.

◆ GetTextHeight()

i32 pu::ui::render::GetTextHeight	(	const std::string &	font_name,
		const std::string &	text )

Gets the resulting text height for rendering a text with the specified font.

Parameters

font_name	The name of the font to use.
text	The text to render.

Returns: The resulting height of the text. If the font is not available, 0 will be returned.

◆ GetTextureHeight()

i32 pu::ui::render::GetTextureHeight ( sdl2::Texture texture )

Gets the height of a Texture.

Parameters

texture The Texture to get the height from.

Returns: The height of the Texture.

◆ GetTextureWidth()

i32 pu::ui::render::GetTextureWidth ( sdl2::Texture texture )

Gets the width of a Texture.

Parameters

texture The Texture to get the width from.

Returns: The width of the Texture.

◆ GetTextWidth()

i32 pu::ui::render::GetTextWidth	(	const std::string &	font_name,
		const std::string &	text )

Gets the resulting text width for rendering a text with the specified font.

Parameters

font_name	The name of the font to use.
text	The text to render.

Returns: The resulting width of the text. If the font is not available, 0 will be returned.

◆ LoadAllSharedFontsInFont()

bool pu::ui::render::LoadAllSharedFontsInFont ( std::shared_ptr< ttf::Font > & font )

Loads all system shared fonts (pl:) in a font object.

Parameters

font	The font object to load the shared fonts in.

Note: For simple font management, consider using RendererInitOptions.; The pl: service must have been initialized for this function to work, either from RendererInitOptions or manually.

◆ LoadImage()

sdl2::Texture pu::ui::render::LoadImage ( const std::string & path )

Loads an image from the specified path.

Parameters

path	The path to the image.

Returns: The loaded image as a Texture, or nullptr if the image could not be loaded.

◆ LoadSingleSharedFontInFont()

bool pu::ui::render::LoadSingleSharedFontInFont	(	std::shared_ptr< ttf::Font > &	font,
		const PlSharedFontType	type )

Loads a system shared font (pl:) in a font object.

Parameters

font	The font object to load the shared font in.
type	The shared font type to add.

Note: For simple font management, consider using RendererInitOptions.; The pl: service must have been initialized for this function to work, either from RendererInitOptions or manually.

◆ RenderText()

sdl2::Texture pu::ui::render::RenderText	(	const std::string &	font_name,
		const std::string &	text,
		const Color	clr,
		const u32	max_width = 0,
		const u32	max_height = 0 )

Renders a text to a texture.

Parameters

font_name	The name of the font to use.
text	The text to render.
clr	The color to use for the text.
max_width	The maximum width of the text.
max_height	The maximum height of the text.

Note: If max_width or max_height are 0, they will be ignored. If the text exceeds the dimensions, it will be clamped and ended by appending "...".

Returns: The rendered text texture. If the font is not available, nullptr will be returned.

◆ SetAlphaValue()

void pu::ui::render::SetAlphaValue	(	sdl2::Texture	texture,
		const u8	alpha )

Sets the alpha value (for blending) of a Texture.

Parameters

texture	The Texture to set the alpha value to.
alpha	The alpha value to set.

Variable Documentation

◆ BaseScreenHeight

u32 pu::ui::render::BaseScreenHeight = 720

constexpr

◆ BaseScreenWidth

u32 pu::ui::render::BaseScreenWidth = 1280

constexpr

◆ ImgAllFlags

u32 pu::ui::render::ImgAllFlags = IMG_INIT_PNG | IMG_INIT_JPG | IMG_INIT_WEBP

constexpr

◆ RendererHardwareFlags

u32 pu::ui::render::RendererHardwareFlags = SDL_RENDERER_PRESENTVSYNC | SDL_RENDERER_ACCELERATED

constexpr

◆ RendererSoftwareFlags

u32 pu::ui::render::RendererSoftwareFlags = SDL_RENDERER_SOFTWARE

constexpr

◆ ScreenFactor

double pu::ui::render::ScreenFactor = (double)ScreenWidth / (double)BaseScreenWidth

constexpr

◆ ScreenHeight

u32 pu::ui::render::ScreenHeight = 1080

constexpr

◆ ScreenWidth

u32 pu::ui::render::ScreenWidth = 1920

constexpr

Classes

Functions

Variables

Function Documentation

◆ AddDefaultFont()

◆ AddFont()

◆ ConvertToTexture()

◆ DeleteTexture()

◆ GetDimensions()

◆ GetMainRenderer()

◆ GetMainSurface()

◆ GetMainWindow()

◆ GetTextDimensions()

◆ GetTextHeight()

◆ GetTextureHeight()

◆ GetTextureWidth()

◆ GetTextWidth()

◆ LoadAllSharedFontsInFont()

◆ LoadImage()

◆ LoadSingleSharedFontInFont()

◆ RenderText()

◆ SetAlphaValue()

Variable Documentation

◆ BaseScreenHeight

◆ BaseScreenWidth

◆ ImgAllFlags

◆ RendererHardwareFlags

◆ RendererSoftwareFlags

◆ ScreenFactor

◆ ScreenHeight

◆ ScreenWidth