Class TextRenderer

#include <Geode/ui/TextRenderer.hpp>

classTextRenderer:publiccocos2d::CCObject{ ... }

Utility class for creating rich text content. Use to incrementally render strings, and push variables to modify the renderer’s state. Use begin to start rendering to a target and end to finish rendering.

Works for any type of label, although relies heavily on content sizes for labels and nodes.

Not too well-performant and the rendering is done linearly without so this is not suitable for dynamic content. For something like a static rich text -area though this can prove useful. Used in MDTextArea.

Examples0

Public static methods1

staticgeode::TextRenderer*create()

Create a TextRenderer

Return value

Created TextRenderer

Public member functions43

voidbegin(

cocos2d::CCNode*target

cocos2d::CCPointconst&pos

cocos2d::CCSizeconst&size

)

Initialize renderer

Parameters

target

Target node to render to. If nullptr, a new CCNode will be created.

pos

Position to render to

size

Size of the render area. Needed for text wrapping & alignment

cocos2d::CCNode*end(

boolfitToContent

geode::TextAlignmenthorizontalAlign

geode::TextAlignmentverticalAlign

)

Finish rendering and clean up renderer

Parameters

fitToContent

Resize the target's content size to match the rendered content

horizontalAlign

Horizontal alignment of the rendered text

verticalAlign

Vertical alignment of the rendered text

Return value

Target that was rendered onto

std::vector<geode::TextRenderer::Label>renderStringEx(

std::stringconst&str

geode::TextRenderer::Fontfont

floatscale

cocos2d::ccColor3Bcolor

_::GLubyteopacity

intstyle

intdeco

geode::TextCapitalizationcaps

booladdToTarget

boolisButton

cocos2d::CCObject*buttonTarget

cocos2d::SEL_MenuHandlercallback

)

Render a string with specific settings, bypassing current variable stacks.

Parameters

str

String to render

font

Font function to use

scale

Scale of label

color

Label color

opacity

Label opacity

style

Label style (TextStyle enum)

deco

Label decorations (TextDecoration enum)

caps

String capitalization

addToTarget

Whether to add the created label(s) onto the target

isButton

If the label should be created as an interactive linked button

buttonTarget

Target for the label if isButton is true, defaults to current renderer target

callback

Callback for the label if isButton is true

Return value

Vector of rendered labels. The label may be split on multiple lines if it exceeds bounds

std::vector<geode::TextRenderer::Label>renderString(

std::stringconst&str

)

Render a string to target. Uses current variable stacks for styling and parameters

Parameters

str

String to render

Return value

Vector of rendered labels. The label may be split on multiple lines if it exceeds bounds

std::vector<geode::TextRenderer::Label>renderStringInteractive(

std::stringconst&str

cocos2d::CCObject*buttonTarget

cocos2d::SEL_MenuHandlercallback

)

Render a string to target as a button. Note that the target should be a CCMenu for the button to do anything. Uses current variable stacks for styling and parameters

Parameters

str

String to render

buttonTarget

Target for the label if isButton is true, defaults to current renderer target

callback

Callback for the label if isButton is true

Return value

Vector of rendered labels. The label may be split on multiple lines if it exceeds bounds

cocos2d::CCNode*renderNode(

cocos2d::CCNode*node

)