pu::ui::render::Renderer Class Reference

The main class dealing with rendering. More...

#include <render_Renderer.hpp>

Public Member Functions
	Renderer (const RendererInitOptions init_opts)
	Creates a new Renderer with the specified initialization options.
Result	Initialize ()
	Initializes the Renderer.
void	Finalize ()
	Finalizes the Renderer.
bool	HasInitialized ()
	Checks if the Renderer has been initialized.
void	InitializeRender (const Color clr)
	Initializes the rendering process.
void	FinalizeRender ()
	Finalizes the rendering process.
void	RenderTexture (sdl2::Texture texture, const i32 x, const i32 y, const TextureRenderOptions opts=TextureRenderOptions())
	Renders a texture to the screen.
void	RenderRectangle (const Color clr, const i32 x, const i32 y, const i32 width, const i32 height)
	Renders a rectangle to the screen (only the border).
void	RenderRectangleFill (const Color clr, const i32 x, const i32 y, const i32 width, const i32 height)
	Renders a filled rectangle to the screen.
void	RenderRectangleOutline (const Color clr, const i32 x, const i32 y, const i32 width, const i32 height, const i32 border_width)
	Renders a rectangle outline to the screen.
void	RenderRoundedRectangle (const Color clr, const i32 x, const i32 y, const i32 width, const i32 height, const i32 radius)
	Renders a rounded rectangle to the screen (only the border).
void	RenderRoundedRectangleFill (const Color clr, const i32 x, const i32 y, const i32 width, const i32 height, const i32 radius)
	Renders a filled rounded rectangle to the screen.
void	RenderCircle (const Color clr, const i32 x, const i32 y, const i32 radius)
	Renders a circle to the screen (only the border).
void	RenderCircleFill (const Color clr, const i32 x, const i32 y, const i32 radius)
	Renders a filled circle to the screen.
void	RenderShadowSimple (const i32 x, const i32 y, const i32 width, const i32 height, const i32 base_alpha, const u8 main_alpha=0xFF)
	Renders a simple shadow to the screen.
void	SetBaseRenderPosition (const i32 x, const i32 y)
	Sets the base render position for all rendering functions.
void	ResetBaseRenderPosition ()
	Resets the base render position to (0, 0).
void	SetBaseRenderAlpha (const u8 alpha)
	Sets the base render alpha for all rendering functions.
void	ResetBaseRenderAlpha ()
	Resets the base render alpha(no alpha modifications).
void	UpdateInput ()
	Updates the input state.
u64	GetButtonsDown ()
	Gets the buttons that are currently pressed.
u64	GetButtonsUp ()
	Gets the buttons that are currently released.
u64	GetButtonsHeld ()
	Gets the buttons that are currently held.

Detailed Description

The main class dealing with rendering.

Constructor & Destructor Documentation

Renderer()

pu::ui::render::Renderer::Renderer ( const RendererInitOptions init_opts )

inline

Creates a new Renderer with the specified initialization options.

Parameters

init_opts

The options to use for initializing the Renderer.

Member Function Documentation

Finalize()

void pu::ui::render::Renderer::Finalize

(

)

Finalizes the Renderer.

Note

This function should not be called manually, it is called by the Application using this Renderer.

FinalizeRender()

void pu::ui::render::Renderer::FinalizeRender

(

)

Finalizes the rendering process.

Note

This function is called internally by the Application using this Renderer.

GetButtonsDown()

u64 pu::ui::render::Renderer::GetButtonsDown ( )

inline

Gets the buttons that are currently pressed.

Returns

The buttons that are currently pressed.

GetButtonsHeld()

u64 pu::ui::render::Renderer::GetButtonsHeld ( )

inline

Gets the buttons that are currently held.

Returns

The buttons that are currently held.

GetButtonsUp()

u64 pu::ui::render::Renderer::GetButtonsUp ( )

inline

Gets the buttons that are currently released.

Returns

The buttons that are currently released.

HasInitialized()

bool pu::ui::render::Renderer::HasInitialized ( )

inline

Checks if the Renderer has been initialized.

Returns

true if the Renderer has been initialized, false otherwise.

Initialize()

Result pu::ui::render::Renderer::Initialize

(

)

Initializes the Renderer.

Note

This function should not be called manually, it is called by the Application using this Renderer.

Returns

The result of the initialization.

InitializeRender()

void pu::ui::render::Renderer::InitializeRender

(

const Color

clr

)

Initializes the rendering process.

Parameters

clr	The color to use for the background.

Note

This function is called internally by the Application using this Renderer.

RenderCircle()

void pu::ui::render::Renderer::RenderCircle	(	const Color	clr,
		const i32	x,
		const i32	y,
		const i32	radius )

Renders a circle to the screen (only the border).

Parameters

clr	The color to use for the rectangle.
x	The X position to render the rectangle.
y	The Y position to render the rectangle.
radius	The radius of the circle.

Note

This function should be called each render loop / OnRender call.

RenderCircleFill()

void pu::ui::render::Renderer::RenderCircleFill	(	const Color	clr,
		const i32	x,
		const i32	y,
		const i32	radius )

Renders a filled circle to the screen.

Parameters

clr	The color to use for the rectangle.
x	The X position to render the rectangle.
y	The Y position to render the rectangle.
radius	The radius of the circle.

Note

This function should be called each render loop / OnRender call.

RenderRectangle()

void pu::ui::render::Renderer::RenderRectangle	(	const Color	clr,
		const i32	x,
		const i32	y,
		const i32	width,
		const i32	height )

Renders a rectangle to the screen (only the border).

Parameters

clr	The color to use for the rectangle.
x	The X position to render the rectangle.
y	The Y position to render the rectangle.
width	The width of the rectangle.
height	The height of the rectangle.

Note

This function should be called each render loop / OnRender call.

RenderRectangleFill()

void pu::ui::render::Renderer::RenderRectangleFill	(	const Color	clr,
		const i32	x,
		const i32	y,
		const i32	width,
		const i32	height )

Renders a filled rectangle to the screen.

Parameters

clr	The color to use for the rectangle.
x	The X position to render the rectangle.
y	The Y position to render the rectangle.
width	The width of the rectangle.
height	The height of the rectangle.

Note

This function should be called each render loop / OnRender call.

RenderRectangleOutline()

void pu::ui::render::Renderer::RenderRectangleOutline ( const Color clr, const i32 x, const i32 y, const i32 width, const i32 height, const i32 border_width )

inline

Renders a rectangle outline to the screen.

Parameters

clr	The color to use for the rectangle.
x	The X position to render the rectangle.
y	The Y position to render the rectangle.
width	The width of the rectangle.
height	The height of the rectangle.
border_width	The width of the border.

Note

This function should be called each render loop / OnRender call.

RenderRoundedRectangle()

void pu::ui::render::Renderer::RenderRoundedRectangle	(	const Color	clr,
		const i32	x,
		const i32	y,
		const i32	width,
		const i32	height,
		const i32	radius )

Renders a rounded rectangle to the screen (only the border).

Parameters

clr	The color to use for the rectangle.
x	The X position to render the rectangle.
y	The Y position to render the rectangle.
width	The width of the rectangle.
height	The height of the rectangle.
radius	The radius of the rounded corners.

Note

This function should be called each render loop / OnRender call.

RenderRoundedRectangleFill()

void pu::ui::render::Renderer::RenderRoundedRectangleFill	(	const Color	clr,
		const i32	x,
		const i32	y,
		const i32	width,
		const i32	height,
		const i32	radius )

Renders a filled rounded rectangle to the screen.

Parameters

clr	The color to use for the rectangle.
x	The X position to render the rectangle.
y	The Y position to render the rectangle.
width	The width of the rectangle.
height	The height of the rectangle.
radius	The radius of the rounded corners.

Note

This function should be called each render loop / OnRender call.

RenderShadowSimple()

void pu::ui::render::Renderer::RenderShadowSimple	(	const i32	x,
		const i32	y,
		const i32	width,
		const i32	height,
		const i32	base_alpha,
		const u8	main_alpha = 0xFF )

Renders a simple shadow to the screen.

Parameters

x	The X position to render the shadow.
y	The Y position to render the shadow.
width	The width of the shadow.
height	The height of the shadow.
base_alpha	The base alpha to use for the shadow. This is the starting alpha value at the top of the shadow.
main_alpha	The main alpha to use for the shadow. The shadow's alpha will be blended with this value.

Note

This function should be called each render loop / OnRender call.

RenderTexture()

void pu::ui::render::Renderer::RenderTexture	(	sdl2::Texture	texture,
		const i32	x,
		const i32	y,
		const TextureRenderOptions	opts = TextureRenderOptions() )

Renders a texture to the screen.

Parameters

texture	The texture to render.
x	The X position to render the texture.
y	The Y position to render the texture.
opts	The options to use for rendering the texture.

Note

This function should be called each render loop / OnRender call.

ResetBaseRenderAlpha()

void pu::ui::render::Renderer::ResetBaseRenderAlpha ( )

inline

Resets the base render alpha(no alpha modifications).

ResetBaseRenderPosition()

void pu::ui::render::Renderer::ResetBaseRenderPosition ( )

inline

Resets the base render position to (0, 0).

SetBaseRenderAlpha()

void pu::ui::render::Renderer::SetBaseRenderAlpha ( const u8 alpha )

inline

Sets the base render alpha for all rendering functions.

Parameters

alpha

The alpha to use as the base render alpha.

Note

Every rendered shape/texture will be rendered blended with this base alpha value.

SetBaseRenderPosition()

void pu::ui::render::Renderer::SetBaseRenderPosition ( const i32 x, const i32 y )

inline

Sets the base render position for all rendering functions.

Parameters

x	The X position to use as the base render position.
y	The Y position to use as the base render position.

Note

Every rendered shape/texture will be rendered with this base position added to their X and Y positions.

UpdateInput()

void pu::ui::render::Renderer::UpdateInput ( )

inline

Updates the input state.

Note

This function is internally called by the Application using this Renderer.

---

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

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