pu::ui::render::RendererInitOptions Struct Reference

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

#include <render_Renderer.hpp>

Public Member Functions
	RendererInitOptions (const u32 sdl_flags, const u32 sdl_render_flags, const u32 w=ScreenWidth, const u32 h=ScreenHeight)
	Creates a new RendererInitOptions with the specified parameters.
void	SetPlServiceType (const PlServiceType type=PlServiceType_User)
	Sets the pl: service type to use.
void	AddDefaultSharedFont (const PlSharedFontType type)
	Adds a default shared font to load.
void	AddDefaultAllSharedFonts ()
	Adds all shared fonts to load.
void	AddDefaultFontPath (const std::string &font_path)
	Adds a default font path to load.
void	AddExtraDefaultFontSize (const u32 font_size)
	Adds an extra default font size to load.
void	UseImage (const i32 sdl_img_flags)
	Enables the Renderer to use SDL2_image with the specified flags.
void	UseRomfs ()
	Enables the Renderer to use RomFs.
void	SetInputPlayerCount (const u32 count)
	Sets the amount of players to use for input.
void	AddInputNpadIdType (const u64 type)
	Adds an input Npad ID type to use for input.
void	AddInputNpadStyleTag (const u32 tag)
	Adds an input Npad style tag to use for input.
bool	NeedsPlService ()
	Checks if the Renderer has initialized / will initialize the pl: service.
bool	NeedsTtf ()
	Checks if the Renderer has initialized / will initialize SDL2-TTF.

Public Attributes
u32	sdl_flags
u32	sdl_render_flags
u32	width
u32	height
i32	pl_srv_type
std::vector< PlSharedFontType >	default_shared_fonts
std::vector< std::string >	default_font_paths
std::vector< u32 >	extra_default_font_sizes
bool	init_img
i32	sdl_img_flags
bool	init_romfs
u32	pad_player_count
u64	pad_id_mask
u32	pad_style_tag

Detailed Description

Represents the options for initializing the Renderer.

Constructor & Destructor Documentation

RendererInitOptions()

pu::ui::render::RendererInitOptions::RendererInitOptions ( const u32 sdl_flags, const u32 sdl_render_flags, const u32 w = ScreenWidth, const u32 h = ScreenHeight )

inline

Creates a new RendererInitOptions with the specified parameters.

Parameters

sdl_flags	The flags for initializing SDL2.
sdl_render_flags	The flags for initializing the Renderer.
w	The width of the screen. By default, it is set to 1920.
h	The height of the screen. By default, it is set to 1080.

Member Function Documentation

AddDefaultAllSharedFonts()

void pu::ui::render::RendererInitOptions::AddDefaultAllSharedFonts ( )

inline

Adds all shared fonts to load.

AddDefaultFontPath()

void pu::ui::render::RendererInitOptions::AddDefaultFontPath ( const std::string & font_path )

inline

Adds a default font path to load.

Parameters

font_path

The path to the font to load.

AddDefaultSharedFont()

void pu::ui::render::RendererInitOptions::AddDefaultSharedFont ( const PlSharedFontType type )

inline

Adds a default shared font to load.

Parameters

type	The shared font type to load.

AddExtraDefaultFontSize()

void pu::ui::render::RendererInitOptions::AddExtraDefaultFontSize ( const u32 font_size )

inline

Adds an extra default font size to load.

Parameters

font_size

The font size to load.

AddInputNpadIdType()

void pu::ui::render::RendererInitOptions::AddInputNpadIdType ( const u64 type )

inline

Adds an input Npad ID type to use for input.

Parameters

type	The Npad ID type to use for input.

Note

You will need to add at least one Npad ID type to have any input.

AddInputNpadStyleTag()

void pu::ui::render::RendererInitOptions::AddInputNpadStyleTag ( const u32 tag )

inline

Adds an input Npad style tag to use for input.

Parameters

tag	The Npad style tag to use for input.

Note

You will need to add at least one Npad style tag to have any input.

NeedsPlService()

bool pu::ui::render::RendererInitOptions::NeedsPlService ( )

inline

Checks if the Renderer has initialized / will initialize the pl: service.

Returns

true if the Renderer has initialized / will initialize the pl: service, false otherwise.

NeedsTtf()

bool pu::ui::render::RendererInitOptions::NeedsTtf ( )

inline

Checks if the Renderer has initialized / will initialize SDL2-TTF.

Returns

true if the Renderer has initialized / will initialize SDL2-TTF, false otherwise.

SetInputPlayerCount()

void pu::ui::render::RendererInitOptions::SetInputPlayerCount ( const u32 count )

inline

Sets the amount of players to use for input.

Parameters

count

The amount of players to use for input.

SetPlServiceType()

void pu::ui::render::RendererInitOptions::SetPlServiceType ( const PlServiceType type = PlServiceType_User )

inline

Sets the pl: service type to use.

Parameters

type	The pl: service type to use.

Note

This function must be called for the Rendere to initialize any text/TTF functionalities.

You should probably use PlServiceType_User for your purposes, only use other types if you know what you're doing.

UseImage()

void pu::ui::render::RendererInitOptions::UseImage ( const i32 sdl_img_flags )

inline

Enables the Renderer to use SDL2_image with the specified flags.

Parameters

sdl_img_flags

The flags to use for SDL2_image.

UseRomfs()

void pu::ui::render::RendererInitOptions::UseRomfs ( )

inline

Enables the Renderer to use RomFs.

Note

If RomFs is enabled, Plutonium itself will handle RomFs initializing/exiting.

Member Data Documentation

default_font_paths

std::vector<std::string> pu::ui::render::RendererInitOptions::default_font_paths

default_shared_fonts

std::vector<PlSharedFontType> pu::ui::render::RendererInitOptions::default_shared_fonts

extra_default_font_sizes

std::vector<u32> pu::ui::render::RendererInitOptions::extra_default_font_sizes

height

u32 pu::ui::render::RendererInitOptions::height

init_img

bool pu::ui::render::RendererInitOptions::init_img

init_romfs

bool pu::ui::render::RendererInitOptions::init_romfs

pad_id_mask

u64 pu::ui::render::RendererInitOptions::pad_id_mask

pad_player_count

u32 pu::ui::render::RendererInitOptions::pad_player_count

pad_style_tag

u32 pu::ui::render::RendererInitOptions::pad_style_tag

pl_srv_type

i32 pu::ui::render::RendererInitOptions::pl_srv_type

sdl_flags

u32 pu::ui::render::RendererInitOptions::sdl_flags

sdl_img_flags

i32 pu::ui::render::RendererInitOptions::sdl_img_flags

sdl_render_flags

u32 pu::ui::render::RendererInitOptions::sdl_render_flags

width

u32 pu::ui::render::RendererInitOptions::width

---

The documentation for this struct was generated from the following file:

• Plutonium/include/pu/ui/render/render_Renderer.hpp