Fission FSN
Loading...
Searching...
No Matches
fsITextRenderData.h
Go to the documentation of this file.
1/********************************************************************
2*
3* File: fsITextRenderData.h
4*
5* Purpose: Information required to render text
6*
7*********************************************************************/
8
9#ifndef fsITextRenderDatahdr
10#define fsITextRenderDatahdr
11
12#include "fsIRenderData.h"
14
15class fsIFont;
16
17
19{
20public:
21
22 void outlineSet(const fsSColour4B& pOutline, fsF32 pSize) const;
23 void shadowSet(const fsSColour4B& pShadow, fsVec2d pOffset, fsF32 pBlurRadius) const;
24 void glowSet(const fsSColour4B& pGlow) const;
25
26 virtual void implRender()
27 {
28 };
29
30 virtual void uvsCopyToImpl()
31 {
32 };
33
34 virtual void vertsCopyToImpl(void* const pImpl) const
35 {
36 };
37
38 virtual void colourCopyToImpl(void* const pImpl) const
39 {
40 };
41
42 fsS32 vertexCountGet() const;
43 const fsIFont* fontGet() const;
44
45 void dirtyTextProcess(const fsAffineMtx2d& pRenderMatrix, const fsRect& pFormattingRect, const fsStr& pText);
46
47 void initialise(fsIFont* pFont);
48 void formattingRectSizeSet(const fsRect& pFormatting);
49 void wordWrapSet(fsBool pEnabled);
52
53 virtual fsS32 stringWidthInPixelsGet() const = 0;
54
55 ~fsITextRenderData() override;
56
57protected:
58
59 virtual void outlineSetDo(const fsSColour4B& pOutline, fsF32 pSize) const {}
60 virtual void shadowSetDo(const fsSColour4B& pShadow, fsVec2d pOffset, fsF32 pBlurRadius) const {}
61 virtual void glowSetDo(const fsSColour4B& pGlow) const {}
62
63 void passToEngineRendererDo(fsIRenderer* pRenderer, fsS32 pFirstMaterialIndex, fsS32 pLastMaterialInJob) override;
64
65 void renderDo() override;
66
67 void matrixApplyDo(const fsAffineMtx2d& pRenderMatrix) override;
68
69 virtual void dirtyTextProcessDo(const fsAffineMtx2d& pRenderMatrix, const fsRect& pFormattingRect,
70 const fsStr& pText) = 0;
71
72 virtual void formattingRectSizeSetDo(const fsRect& pFormatting)
73 {
74 }
75
76 virtual void wordWrapSetDo(fsBool pEnabled)
77 {
78 }
79
80 virtual void alignmentSetDo()
81 {
82 };
83
84 void buffersResize();
85
87
89
92
95
98
99private:
100};
101
102#endif
Definition fsAffineMtx2d.h:27
Definition fsIFont.h:34
fsIRenderData()=default
Definition fsIRenderer.h:73
virtual void wordWrapSetDo(fsBool pEnabled)
Definition fsITextRenderData.h:76
const fsIFont * fontGet() const
Definition fsITextRenderData.cpp:32
virtual fsS32 stringWidthInPixelsGet() const =0
virtual void vertsCopyToImpl(void *const pImpl) const
Definition fsITextRenderData.h:34
fsIFont * mFont
Definition fsITextRenderData.h:88
void dirtyTextProcess(const fsAffineMtx2d &pRenderMatrix, const fsRect &pFormattingRect, const fsStr &pText)
Definition fsITextRenderData.cpp:37
void initialise(fsIFont *pFont)
Definition fsITextRenderData.cpp:71
fsITextRenderData()
Definition fsITextRenderData.cpp:96
virtual void outlineSetDo(const fsSColour4B &pOutline, fsF32 pSize) const
Definition fsITextRenderData.h:59
virtual void uvsCopyToImpl()
Definition fsITextRenderData.h:30
void renderDo() override
Definition fsITextRenderData.cpp:27
virtual void implRender()
Definition fsITextRenderData.h:26
void outlineSet(const fsSColour4B &pOutline, fsF32 pSize) const
Definition fsITextRenderData.cpp:6
void formattingRectSizeSet(const fsRect &pFormatting)
Definition fsITextRenderData.cpp:78
virtual void dirtyTextProcessDo(const fsAffineMtx2d &pRenderMatrix, const fsRect &pFormattingRect, const fsStr &pText)=0
void alignmentSet(fsITextSpriteComponent::eHORIZONTAL_ALIGNMENT pAlignH, fsITextSpriteComponent::eVERTICAL_ALIGNMENT pAlignV)
Definition fsITextRenderData.cpp:88
void passToEngineRendererDo(fsIRenderer *pRenderer, fsS32 pFirstMaterialIndex, fsS32 pLastMaterialInJob) override
Definition fsITextRenderData.cpp:21
virtual void formattingRectSizeSetDo(const fsRect &pFormatting)
Definition fsITextRenderData.h:72
fsITextSpriteComponent::eVERTICAL_ALIGNMENT mAlignV
Definition fsITextRenderData.h:97
fsITextSpriteComponent::eHORIZONTAL_ALIGNMENT mAlignH
Definition fsITextRenderData.h:96
virtual void glowSetDo(const fsSColour4B &pGlow) const
Definition fsITextRenderData.h:61
fsS32 mTotalCharacters
Definition fsITextRenderData.h:93
void shadowSet(const fsSColour4B &pShadow, fsVec2d pOffset, fsF32 pBlurRadius) const
Definition fsITextRenderData.cpp:11
~fsITextRenderData() override
Definition fsITextRenderData.cpp:107
void glowSet(const fsSColour4B &pGlow) const
Definition fsITextRenderData.cpp:16
virtual void colourCopyToImpl(void *const pImpl) const
Definition fsITextRenderData.h:38
void matrixApplyDo(const fsAffineMtx2d &pRenderMatrix) override
Definition fsITextRenderData.cpp:66
fsVec2d * mRawVerts
Definition fsITextRenderData.h:90
fsVec2d * mTransformedVerts
Definition fsITextRenderData.h:91
virtual void alignmentSetDo()
Definition fsITextRenderData.h:80
fsS32 vertexCountGet() const
Definition fsITextRenderData.cpp:46
virtual void shadowSetDo(const fsSColour4B &pShadow, fsVec2d pOffset, fsF32 pBlurRadius) const
Definition fsITextRenderData.h:60
void buffersResize()
Definition fsITextRenderData.cpp:51
void wordWrapSet(fsBool pEnabled)
Definition fsITextRenderData.cpp:83
fsS32 mVertBufferSize
Definition fsITextRenderData.h:94
eVERTICAL_ALIGNMENT
Definition fsITextSpriteComponent.h:33
eHORIZONTAL_ALIGNMENT
Definition fsITextSpriteComponent.h:26
Definition fsRect.h:16
Definition fsStr.h:23
bool fsBool
Definition fsBaseTypes.h:26
int fsS32
Definition fsBaseTypes.h:20
float fsF32
Definition fsBaseTypes.h:28
Definition fsSColour.h:54
Definition fsVec2d.h:16