Fission FSN
Loading...
Searching...
No Matches
fsIRenderableTexture.h
Go to the documentation of this file.
1/********************************************************************
2*
3* File: fsIRenderableTexture.h
4*
5* Purpose: Interface for texture that can be rendered to
6*
7*********************************************************************/
8
9#ifndef fsIRenderableTexturehdr
10#define fsIRenderableTexturehdr
11
12#include <functional>
13#include <vector>
14
15#include <fsCore/fsSColour.h>
17
18#if defined fsFRAMEWORK_CX
20#elif defined fsFRAMEWORK_AX
22#elif defined fsFRAMEWORK_MG
24#elif defined fsFRAMEWORK_RL
26#elif defined fsFRAMEWORK_BF
28#else
29 #error Unhandled platform.
30#endif
31
32
33struct fsPoint;
34class fsRect;
35class fsCBrush;
36class fsAffineMtx2d;
37
39{
40public:
41
42 void resize(fsPoint const& pSize);
43 void screenShotStart();
44 void screenShotEnd(const fsStr& pSceneName);
45 void shadersCreate(const fsStr& pVertex, const fsStr& pFragment);
46 void screenEffectParamsSet(fsPoint const& pFocusPos, fsF32 pRadius);
48 void targetSet();
49 void partialEnd();
50 void partialStart();
51 void targetClear();
52
53 void brushSet(fsCResourceName const& pBrushFilename);
54
55 void save(fsCResourceName const& pFilename);
56 void captureRegionSave(const fsRect& pCaptureRect, fsPoint const& pOutputDimensions, fsCResourceName const& pFilename);
57 // Writes the texture's own content (not the screen) to pPath, absolute; .png keeps alpha, .jpg
58 // doesn't. pDone(saved) follows once the file is written, possibly a frame later; at once with false
59 // where the backend can't read textures back.
60 void contentSave(const fsStr& pPath, std::function<void(fsBool)> pDone);
61 void recolour(fsSColour4B const& pOld, fsSColour4B const& pNew);
62 void paintWithSpriteBrush(fsPoint const& pPos);
63 void paint(std::vector<fsPoint> const& pPos, fsSColour4B const& pColour);
64
65 ~fsIRenderableTexture() override;
66
67protected:
68
69 virtual void resizeDo(fsPoint const& pSize) {}
70
71 virtual void screenShotStartDo() {}
72 virtual void screenShotEndDo(const fsStr& pSceneName) {}
73 virtual void shadersCreateDo(const fsStr& pVertex, const fsStr& pFragment) {}
74 virtual void screenEffectParamsSetDo(fsPoint const& pFocusPos, fsF32 pRadius) {}
75 virtual void screenEffectParamsClearDo() {}
76 virtual void targetSetDo() {}
77 virtual void partialEndDo() {}
78 virtual void partialStartDo() {}
79 virtual void targetClearDo() {}
80
81 virtual void brushSetDo(fsCResourceName const& pBrushFilename) {}
82
83 virtual void saveDo(fsCResourceName const& pFilename) {}
84 virtual void captureRegionSaveDo(const fsRect& pCaptureRect, fsPoint const& pOutputDimensions, fsCResourceName const& pFilename) {}
85 virtual void contentSaveDo(const fsStr& pPath, std::function<void(fsBool)> pDone) { if (pDone) pDone(false); }
86
87 virtual void recolourDo(fsSColour4B const& pOld, fsSColour4B const& pNew) {}
88 virtual void paintWithSpriteBrushDo(fsPoint const& pPos) {}
89 virtual void paintDo(std::vector<fsPoint> const& pPos, fsSColour4B const& pColour) {}
90
92
93private:
94};
95
96#endif
Definition fsAffineMtx2d.h:27
Definition fsCBrush.h:26
Definition fsCResourceName.h:32
fsINative()=default
Definition fsINative.cpp:72
virtual void targetClearDo()
Definition fsIRenderableTexture.h:79
virtual void brushSetDo(fsCResourceName const &pBrushFilename)
Definition fsIRenderableTexture.h:81
virtual void screenEffectParamsSetDo(fsPoint const &pFocusPos, fsF32 pRadius)
Definition fsIRenderableTexture.h:74
virtual void paintDo(std::vector< fsPoint > const &pPos, fsSColour4B const &pColour)
Definition fsIRenderableTexture.h:89
virtual void paintWithSpriteBrushDo(fsPoint const &pPos)
Definition fsIRenderableTexture.h:88
virtual void screenShotStartDo()
Definition fsIRenderableTexture.h:71
~fsIRenderableTexture() override
Definition fsIRenderableTexture.cpp:111
void partialStart()
Definition fsIRenderableTexture.cpp:62
void targetSet()
Definition fsIRenderableTexture.cpp:52
virtual void shadersCreateDo(const fsStr &pVertex, const fsStr &pFragment)
Definition fsIRenderableTexture.h:73
virtual void screenShotEndDo(const fsStr &pSceneName)
Definition fsIRenderableTexture.h:72
virtual void resizeDo(fsPoint const &pSize)
Definition fsIRenderableTexture.h:69
void screenShotEnd(const fsStr &pSceneName)
Definition fsIRenderableTexture.cpp:27
void resize(fsPoint const &pSize)
Definition fsIRenderableTexture.cpp:32
void screenEffectParamsSet(fsPoint const &pFocusPos, fsF32 pRadius)
Definition fsIRenderableTexture.cpp:42
virtual void contentSaveDo(const fsStr &pPath, std::function< void(fsBool)> pDone)
Definition fsIRenderableTexture.h:85
void save(fsCResourceName const &pFilename)
Definition fsIRenderableTexture.cpp:77
void recolour(fsSColour4B const &pOld, fsSColour4B const &pNew)
Definition fsIRenderableTexture.cpp:92
void contentSave(const fsStr &pPath, std::function< void(fsBool)> pDone)
Definition fsIRenderableTexture.cpp:87
virtual void saveDo(fsCResourceName const &pFilename)
Definition fsIRenderableTexture.h:83
void brushSet(fsCResourceName const &pBrushFilename)
Definition fsIRenderableTexture.cpp:72
void paint(std::vector< fsPoint > const &pPos, fsSColour4B const &pColour)
Definition fsIRenderableTexture.cpp:102
virtual void targetSetDo()
Definition fsIRenderableTexture.h:76
virtual void recolourDo(fsSColour4B const &pOld, fsSColour4B const &pNew)
Definition fsIRenderableTexture.h:87
void targetClear()
Definition fsIRenderableTexture.cpp:67
void partialEnd()
Definition fsIRenderableTexture.cpp:57
void shadersCreate(const fsStr &pVertex, const fsStr &pFragment)
Definition fsIRenderableTexture.cpp:37
virtual void partialStartDo()
Definition fsIRenderableTexture.h:78
fsIRenderableTexture()
Definition fsIRenderableTexture.cpp:107
virtual void screenEffectParamsClearDo()
Definition fsIRenderableTexture.h:75
void captureRegionSave(const fsRect &pCaptureRect, fsPoint const &pOutputDimensions, fsCResourceName const &pFilename)
Definition fsIRenderableTexture.cpp:82
void screenShotStart()
Definition fsIRenderableTexture.cpp:22
void paintWithSpriteBrush(fsPoint const &pPos)
Definition fsIRenderableTexture.cpp:97
virtual void partialEndDo()
Definition fsIRenderableTexture.h:77
void screenEffectParamsClear()
Definition fsIRenderableTexture.cpp:47
virtual void captureRegionSaveDo(const fsRect &pCaptureRect, fsPoint const &pOutputDimensions, fsCResourceName const &pFilename)
Definition fsIRenderableTexture.h:84
Definition fsRect.h:16
Definition fsStr.h:23
bool fsBool
Definition fsBaseTypes.h:26
float fsF32
Definition fsBaseTypes.h:28
Definition fsPoint.h:17
Definition fsSColour.h:54