SoftwareRenderer Class Reference

Public Member Functions#
void	putPixel (glm::ivec2 position, AColor color, AOptional< Blending > blending=std::nullopt) noexcept
_< IMultiStringCanvas >	newMultiStringCanvas (const AFontStyle &style) override
	Creates new canvas for batching multiple prerender string calls.
void	rectangle (const ABrush &brush, glm::vec2 position, glm::vec2 size) override
	Draws simple rectangle.
void	roundedRectangle (const ABrush &brush, glm::vec2 position, glm::vec2 size, float radius) override
	Draws rounded rect (with antialiasing, if msaa enabled).
void	rectangleBorder (const ABrush &brush, glm::vec2 position, glm::vec2 size, float lineWidth) override
	Draws rectangle's border.
void	roundedRectangleBorder (const ABrush &brush, glm::vec2 position, glm::vec2 size, float radius, int borderWidth) override
	Draws rounded rectangle's border.
void	boxShadow (glm::vec2 position, glm::vec2 size, float blurRadius, const AColor &color) override
	Draws a rectangle-shaped shadow.
void	boxShadowInner (glm::vec2 position, glm::vec2 size, float blurRadius, float spreadRadius, float borderRadius, const AColor &color, glm::vec2 offset) override
	Draws inner (inset) rectangle-shaped shadow.
void	string (glm::vec2 position, const AString &string, const AFontStyle &fs) override
	Draws string.
_< IPrerenderedString >	prerenderString (glm::vec2 position, const AString &text, const AFontStyle &fs) override
	Analyzes string and creates an instance of IRenderer::IPrerenderedString which helps IRenderer to efficiently render the string.
void	setBlending (Blending blending) override
	Sets blending mode.
void	setWindow (AWindowBase *window) override
	Sets the window to render on.
glm::mat4	getProjectionMatrix () const override
void	pushMaskBefore () override
	witches drawing to the stencil buffer instead of color buffer.
void	pushMaskAfter () override
	Switches drawing to the color buffer back from the stencil. Increases stencil depth.
void	popMaskBefore () override
	Switches drawing to the stencil buffer instead of color buffer.
void	popMaskAfter () override
	Switches drawing to the color buffer back from the stencil. Decreases stencil depth.
_unique< IRenderViewToTexture >	newRenderViewToTexture () noexcept override
	Returns a new instance of IRenderViewToTexture interface associated with this renderer.
void	lines (const ABrush &brush, AArrayView< glm::vec2 > points, const ABorderStyle &style, AMetric width) override
	Draws polyline (non-loop line strip).
void	points (const ABrush &brush, AArrayView< glm::vec2 > points, AMetric size) override
	Draws points list.
void	lines (const ABrush &brush, AArrayView< std::pair< glm::vec2, glm::vec2 > > points, const ABorderStyle &style, AMetric width) override
	Draws multiple individual lines in a batch.
void	squareSector (const ABrush &brush, const glm::vec2 &position, const glm::vec2 &size, AAngleRadians begin, AAngleRadians end) override
	Draws sector in rectangle shape. The sector is drawn clockwise from begin to end angles.
Public Member Functions inherited from IRenderer
_< ITexture >	getNewTexture ()
	Creates new texture (image representation optimized for GPU rendering).
void	line (const ABrush &brush, glm::vec2 p1, glm::vec2 p2, const ABorderStyle &style=ABorderStyle::Solid{}, AMetric width=1_dp)
void	lines (const ABrush &brush, AArrayView< glm::vec2 > points, const ABorderStyle &style=ABorderStyle::Solid{})
	Draws polyline (non-loop line strip).
void	lines (const ABrush &brush, AArrayView< std::pair< glm::vec2, glm::vec2 > > points, const ABorderStyle &style=ABorderStyle::Solid{})
	Draws multiple individual lines in a batch.
void	setColorForced (const AColor &color)
	Sets the color which is multiplied with any brush.
void	setColor (const AColor &color)
	Sets the color which is multiplied with any brush. Unlike setColorForced, the new color is multiplied by the previous color.
const AColor &	getColor () const
void	setTransform (const glm::mat4 &transform)
	Sets the transform matrix which is applicable for any figure. Unlike setTransformForced, the new matrix is multiplied by the previous matrix.
void	setTransformForced (const glm::mat4 &transform)
	Sets the transform matrix which is applicable for any figure.
AWindowBase *	getWindow () const noexcept
const glm::mat4 &	getTransform ()
std::uint8_t	getStencilDepth () const noexcept
void	setStencilDepth (uint8_t stencilDepth)
void	translate (const glm::vec2 &offset)
	Wrapper for setTransform applying matrix translate transformation.
void	rotate (const glm::vec3 &axis, AAngleRadians angle)
	wrapper for setTransform applying matrix rotation along the specified axis.
void	rotate (AAngleRadians angle)
	wrapper for setTransform applying matrix rotation along z axis.
void	setAllowRenderToTexture (bool allowRenderToTexture)
bool	allowRenderToTexture () const noexcept
void	backdrops (glm::ivec2 position, glm::ivec2 size, std::span< ass::Backdrop::Any > backdrops)
	Draws rectangular backdrop effects.
Public Member Functions inherited from aui::noncopyable
	noncopyable (const noncopyable &)=delete
noncopyable &	operator= (const noncopyable &)=delete

Protected Member Functions#
_unique< ITexture >	createNewTexture () override
void	drawLine (const ABrush &brush, glm::vec2 p1, glm::vec2 p2, const ABorderStyle &style, AMetric width)
Protected Member Functions inherited from IRenderer
void	stub (glm::vec2 position, glm::vec2 size)
	Draws stub (i.e., gray rectangle)
virtual void	backdrops (glm::ivec2 position, glm::ivec2 size, std::span< ass::Backdrop::Preprocessed > backdrops)

Additional Inherited Members#
Protected Attributes inherited from IRenderer
AColor	mColor
glm::mat4	mTransform
AWindowBase *	mWindow = nullptr
APool< ITexture >	mTexturePool
uint8_t	mStencilDepth = 0

Member Function Documentation#

boxShadow()#

void SoftwareRenderer::boxShadow ( glm::vec2 position, glm::vec2 size, float blurRadius, const AColor & color )

overridevirtual

Parameters

position	position
size	rectangle size
blurRadius	blur radius
color	shadow color

Implements IRenderer.

boxShadowInner()#

void SoftwareRenderer::boxShadowInner ( glm::vec2 position, glm::vec2 size, float blurRadius, float spreadRadius, float borderRadius, const AColor & color, glm::vec2 offset )

overridevirtual

Parameters

position	position
size	rectangle size
blurRadius	blur radius
spreadRadius	spread (offset) radius
borderRadius	border radius of the rectangle.
color	shadow color
offset	shadow offset. Unlike outer shadow (ctx.render.boxShadow), the offset is passed to the shader instead of a simple rectangle position offset.

Implements IRenderer.

createNewTexture()#

_unique< ITexture > SoftwareRenderer::createNewTexture ( )

overrideprotectedvirtual

Implements IRenderer.

getProjectionMatrix()#

glm::mat4 SoftwareRenderer::getProjectionMatrix ( ) const

overridevirtual

Implements IRenderer.

lines() [1/2]#

void SoftwareRenderer::lines ( const ABrush & brush, AArrayView< glm::vec2 > points, const ABorderStyle & style, AMetric width )

overridevirtual

Parameters

brush	brush
points	polyline points
style	style
width	line width

Implements IRenderer.

lines() [2/2]#

void SoftwareRenderer::lines ( const ABrush & brush, AArrayView< std::pair< glm::vec2, glm::vec2 > > points, const ABorderStyle & style, AMetric width )

overridevirtual

Parameters

brush	brush
points	line points
style	style
width	line width

Implements IRenderer.

newMultiStringCanvas()#

_< IMultiStringCanvas > SoftwareRenderer::newMultiStringCanvas ( const AFontStyle & style )

overridevirtual

Returns

a new instance of IMultiStringCanvas

Implements IRenderer.

newRenderViewToTexture()#

_unique< IRenderViewToTexture > SoftwareRenderer::newRenderViewToTexture ( )

overridevirtualnoexcept

Returns

A new instance. Can return null if unsupported.

Implements IRenderer.

points()#

void SoftwareRenderer::points ( const ABrush & brush, AArrayView< glm::vec2 > points, AMetric size )

overridevirtual

Parameters

brush	brush
points	points
size	point size

Implements IRenderer.

popMaskAfter()#

void SoftwareRenderer::popMaskAfter ( )

overridevirtual

Stencil buffer should not be changed after calling this function. Should be called after the popMaskBefore function.

Implements IRenderer.

popMaskBefore()#

void SoftwareRenderer::popMaskBefore ( )

overridevirtual

Stencil pixel is decreased by each affected pixel. Should be called before the popMaskAfter function.

Implements IRenderer.

prerenderString()#

_< IPrerenderedString > SoftwareRenderer::prerenderString ( glm::vec2 position, const AString & text, const AFontStyle & fs )

overridevirtual

Parameters

position	string's top left point
text	string to prerender
fs	font style

Returns

an instance of IPrerenderedString

Implements IRenderer.

pushMaskAfter()#

void SoftwareRenderer::pushMaskAfter ( )

overridevirtual

Stencil buffer should not be changed after calling this function. Should be called after the pushMaskBefore function.

Implements IRenderer.

pushMaskBefore()#

void SoftwareRenderer::pushMaskBefore ( )

overridevirtual

Stencil pixel is increased by each affected pixel. Should be called before the pushMaskAfter function.

Implements IRenderer.

putPixel()#

void SoftwareRenderer::putPixel ( glm::ivec2 position, AColor color, AOptional< Blending > blending = std::nullopt )

inlinenoexcept

Draws a pixel onto the software framebuffer following the stencil and blending rules.

Sneaky assertions

position is inside the framebuffer.

Parameters

position	position. An assertion is triggered if position is not inside the framebuffer.
color	color.
blending	blending. Optional. Cheaper. When set, the one set by the setBlending function is ignored.

rectangle()#

void SoftwareRenderer::rectangle ( const ABrush & brush, glm::vec2 position, glm::vec2 size )

overridevirtual

Parameters

brush	brush to use
position	rectangle position (px)
size	rectangle size (px)

Implements IRenderer.

rectangleBorder()#

void SoftwareRenderer::rectangleBorder ( const ABrush & brush, glm::vec2 position, glm::vec2 size, float lineWidth )

overridevirtual

Parameters

brush	brush to use
position	rectangle position (px)
size	rectangle size (px)
lineWidth	border line width (px)

Implements IRenderer.

roundedRectangle()#

void SoftwareRenderer::roundedRectangle ( const ABrush & brush, glm::vec2 position, glm::vec2 size, float radius )

overridevirtual

Parameters

brush	brush to use
position	rectangle position (px)
size	rectangle size (px)
radius	corner radius (px)

Implements IRenderer.

roundedRectangleBorder()#

void SoftwareRenderer::roundedRectangleBorder ( const ABrush & brush, glm::vec2 position, glm::vec2 size, float radius, int borderWidth )

overridevirtual

Parameters

brush	brush to use
position	rectangle position (px)
size	rectangle size (px)
radius	corner radius (px)
borderWidth	border line width (px)

Implements IRenderer.

setBlending()#

void SoftwareRenderer::setBlending ( Blending blending )

overridevirtual

Parameters

blending

new blending mode

Implements IRenderer.

setWindow()#

void SoftwareRenderer::setWindow ( AWindowBase * window )

overridevirtual

Parameters

window

target window

Reimplemented from IRenderer.

squareSector()#

void SoftwareRenderer::squareSector ( const ABrush & brush, const glm::vec2 & position, const glm::vec2 & size, AAngleRadians begin, AAngleRadians end )

overridevirtual

Parameters

brush	brush to use
position	rectangle position (px)
size	rectangle size (px)
begin	begin angle of the sector
end	end angle of the sector

The method can be used as mask to ctx.render.roundedRect, creating arc shape.

Implements IRenderer.

string()#

void SoftwareRenderer::string ( glm::vec2 position, const AString & string, const AFontStyle & fs )

overridevirtual

Parameters

position	string's top left point
string	string to render
fs	font style (optional)

Note

This function is dramatically inefficient since it does symbol lookup for every character is the string and does GPU buffer allocations. If you want to render the same string for several times (frames), consider using the IRenderer::prerenderString function or high level views (such as ALabel) instead.

Implements IRenderer.

© 2025 AUI Framework Contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.

Contents

Public Member Functions

Protected Member Functions

Additional Inherited Members

View Page SourceEdit Page Source