MapleShrine
/
mkxp
1
0
Fork 0
Code Issues 32 Pull Requests 11 Projects Releases Wiki Activity
mkxp/src/sharedstate.h

128 lines
2.9 KiB
C
Raw Normal View History

Initial commit
2013-09-01 14:27:21 +00:00
/*
Rename 'GlobalState' to 'SharedState' to avoid confusion with GLState This was particularly nasty with the shorthand macros 'gState' and 'glState'. The former is now 'shState'.
2013-10-09 10:30:33 +00:00
** sharedstate.h
Initial commit
2013-09-01 14:27:21 +00:00
**
** This file is part of mkxp.
**
** Copyright (C) 2013 Jonas Kulla <Nyocurio@gmail.com>
**
** mkxp is free software: you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation, either version 2 of the License, or
** (at your option) any later version.
**
** mkxp is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with mkxp. If not, see <http://www.gnu.org/licenses/>.
*/
Rename 'GlobalState' to 'SharedState' to avoid confusion with GLState This was particularly nasty with the shorthand macros 'gState' and 'glState'. The former is now 'shState'.
2013-10-09 10:30:33 +00:00
#ifndef SHAREDSTATE_H
#define SHAREDSTATE_H
Initial commit
2013-09-01 14:27:21 +00:00
Sanitize #include statements The general rule I'm aiming for is to <> include system wide / installed paths / generally everything that's outside the git managed source tree (this means mruby paths too!), and "" include everything else, ie. local mkxp headers. The only current exception are the mri headers, which all have './' at their front as to not clash with system wide ruby headers. I'm leaving them be for now until I can come up with a better general solution.
2013-12-04 16:48:37 +00:00
#include <sigc++/signal.h>
Initial commit
2013-09-01 14:27:21 +00:00
Rename 'GlobalState' to 'SharedState' to avoid confusion with GLState This was particularly nasty with the shorthand macros 'gState' and 'glState'. The former is now 'shState'.
2013-10-09 10:30:33 +00:00
#define shState SharedState::instance
#define glState shState->_glState()
Merge separate RGSS version build configs into one Setup active RGSS version at runtime. Desired version can be specified via config, or as default, auto detected from the game files. This removes the need to build specifically for each version, which should help packaging a lot. This also greatly reduces the danger of introducing code that wouldn't compile on all RGSS version paths (as certain code paths were completely ifdef'd out). This can be optimized more, eg. not compiling shaders that aren't needed in the active version.
2014-08-28 21:11:10 +00:00
#define rgssVer SharedState::rgssVersion
Initial commit
2013-09-01 14:27:21 +00:00
Rename 'GlobalState' to 'SharedState' to avoid confusion with GLState This was particularly nasty with the shorthand macros 'gState' and 'glState'. The former is now 'shState'.
2013-10-09 10:30:33 +00:00
struct SharedStatePrivate;
Initial commit
2013-09-01 14:27:21 +00:00
struct RGSSThreadData;
struct GlobalIBO;
struct SDL_Window;
Rename 'Tex' to 'TEX' for consistency
2013-09-06 10:26:41 +00:00
struct TEXFBO;
Provide general purpose Quad in GlobalState
2013-09-04 17:07:28 +00:00
struct Quad;
Shader: Group all shaders in one collective struct Makes sharedstate.{cpp|h} a lot easier to read, and adding new shaders a one liner.
2013-12-11 04:22:13 +00:00
struct ShaderSet;
Initial commit
2013-09-01 14:27:21 +00:00
class Scene;
class FileSystem;
class EventThread;
class Graphics;
class Input;
class Audio;
class GLState;
class TexPool;
class Font;
Font: Overhaul font asset discovery Previously, any font names requested by RGSS would be translated directly to filenames by lowercasing and replacing spaces with underscores (and finally doing some extension substitution). To make this whole thing work smoother as well as get closer to how font discovery is done in VX, we now scan the "Fonts/" folder at startup and index all present font assets by their family name; now, if an "Open Sans" font is present in "Fonts/", it will be used regardless of filename. Font assets with "Regular" style are preferred, but in their absence, mkxp will make use of any other style it can find for the respective family. This is not the exact same behavior as VX, but it should cover 95% of use cases. Previously, one could substitute fonts via filenames, ie. to substitute "Arial" with "Open Sans", one would just rename "OpenSans.ttf" to "arial.ttf" and put it in "Fonts/". With the above change, this is no longer possible. As an alternative, one can now explicitly specify font family substitutions via mkxp.conf; eg. for the above case, one would add fontSub=Arial>Open Sans to the configuration file. Multiple such rules can be specified. In the process, I also added the ability to provide 'Font.(default_)name' with an array of font families to search for the first existing one instead of a plain string. This makes the behavior closer to RMXP; however, it doesn't work 100% the same: when a reference to the 'Font.name' array is held and additional strings are added to it without re-assignig the array to 'Font.name', those will be ignored.
2014-04-11 11:37:14 +00:00
class SharedFontState;
Initial commit
2013-09-01 14:27:21 +00:00
struct GlobalIBO;
struct Config;
Remove the remaining bits of deprecated GL usage The drawing is now completely shader based, which makes away with all usage of the depracted matrix stack. This also allows us to do things like simple translations and texture coordinate translation directly instead of doing everything indirectly through matrices. Fixed vertex attributes ('vertexPointer()' etc) are also replaced with user defined attribute arrays.
2013-09-23 05:15:01 +00:00
struct Vec2i;
Audio: Add MIDI format playback support This adds a new dependency with libfuildsynth. MIDI support is built by default, but can be disabled if not desired. All RTP songs should work well, but there are known problems with other files (see README). Also, the pitch shift implementation is somewhat poor and doesn't match RMXP (at least subjectively). A soundfont is not included and must be provided by the user themself.
2014-07-31 01:32:07 +00:00
struct SharedMidiState;
Rename 'GlobalState' to 'SharedState' to avoid confusion with GLState This was particularly nasty with the shorthand macros 'gState' and 'glState'. The former is now 'shState'.
2013-10-09 10:30:33 +00:00
struct SharedState
Initial commit
2013-09-01 14:27:21 +00:00
{
SharedState: Constify most getter methods
2014-08-12 18:33:40 +00:00
void *bindingData() const;
Initial commit
2013-09-01 14:27:21 +00:00
void setBindingData(void *data);
SharedState: Constify most getter methods
2014-08-12 18:33:40 +00:00
SDL_Window *sdlWindow() const;
Initial commit
2013-09-01 14:27:21 +00:00
SharedState: Constify most getter methods
2014-08-12 18:33:40 +00:00
Scene *screen() const;
Initial commit
2013-09-01 14:27:21 +00:00
void setScreen(Scene &screen);
SharedState: Constify most getter methods
2014-08-12 18:33:40 +00:00
FileSystem &fileSystem() const;
Initial commit
2013-09-01 14:27:21 +00:00
SharedState: Constify most getter methods
2014-08-12 18:33:40 +00:00
EventThread &eThread() const;
RGSSThreadData &rtData() const;
Config &config() const;
Initial commit
2013-09-01 14:27:21 +00:00
SharedState: Constify most getter methods
2014-08-12 18:33:40 +00:00
Graphics &graphics() const;
Input &input() const;
Audio &audio() const;
Initial commit
2013-09-01 14:27:21 +00:00
SharedState: Constify most getter methods
2014-08-12 18:33:40 +00:00
GLState &_glState() const;
Initial commit
2013-09-01 14:27:21 +00:00
SharedState: Constify most getter methods
2014-08-12 18:33:40 +00:00
ShaderSet &shaders() const;
Start ifdef'ing out RGSS2 functionality
2013-10-02 20:40:09 +00:00
SharedState: Constify most getter methods
2014-08-12 18:33:40 +00:00
TexPool &texPool() const;
Initial commit
2013-09-01 14:27:21 +00:00
SharedState: Constify most getter methods
2014-08-12 18:33:40 +00:00
SharedFontState &fontState() const;
Font &defaultFont() const;
Initial commit
2013-09-01 14:27:21 +00:00
SharedState: Constify most getter methods
2014-08-12 18:33:40 +00:00
SharedMidiState &midiState() const;
Audio: Add MIDI format playback support This adds a new dependency with libfuildsynth. MIDI support is built by default, but can be disabled if not desired. All RTP songs should work well, but there are known problems with other files (see README). Also, the pitch shift implementation is somewhat poor and doesn't match RMXP (at least subjectively). A soundfont is not included and must be provided by the user themself.
2014-07-31 01:32:07 +00:00
Initial commit
2013-09-01 14:27:21 +00:00
sigc::signal<void> prepareDraw;
unsigned int genTimeStamp();
/* Returns global quad IBO, and ensures it has indices
* for at least minSize quads */
quadarray.h: Use size_t for everything (quad) count related
2014-08-12 17:46:30 +00:00
void ensureQuadIBO(size_t minSize);
GLMeta: Add vertex array object support
2014-07-13 12:03:18 +00:00
GlobalIBO &globalIBO();
Initial commit
2013-09-01 14:27:21 +00:00
/* Global general purpose texture */
void bindTex();
Remove the remaining bits of deprecated GL usage The drawing is now completely shader based, which makes away with all usage of the depracted matrix stack. This also allows us to do things like simple translations and texture coordinate translation directly instead of doing everything indirectly through matrices. Fixed vertex attributes ('vertexPointer()' etc) are also replaced with user defined attribute arrays.
2013-09-23 05:15:01 +00:00
void ensureTexSize(int minW, int minH, Vec2i &currentSizeOut);
Initial commit
2013-09-01 14:27:21 +00:00
Rename 'Tex' to 'TEX' for consistency
2013-09-06 10:26:41 +00:00
TEXFBO &gpTexFBO(int minW, int minH);
Initial commit
2013-09-01 14:27:21 +00:00
SharedState: Constify most getter methods
2014-08-12 18:33:40 +00:00
Quad &gpQuad() const;
Provide general purpose Quad in GlobalState
2013-09-04 17:07:28 +00:00
Tilemap: Use simple "TexPool" replacement for atlas allocation Releasing a Tilemap atlas into the pool on every map switch will blow out tons of smaller textures for very little gain, as atlas textures are already pretty much impossible to recycle anywhere but in new Tilemaps.
2013-10-22 04:36:13 +00:00
/* Basically just a simple "TexPool"
* replacement for Tilemap atlas use */
void requestAtlasTex(int w, int h, TEXFBO &out);
void releaseAtlasTex(TEXFBO &tex);
Initial commit
2013-09-01 14:27:21 +00:00
/* Checks EventThread's shutdown request flag and if set,
* requests the binding to terminate. In this case, this
* function will most likely not return */
void checkShutdown();
Rename 'GlobalState' to 'SharedState' to avoid confusion with GLState This was particularly nasty with the shorthand macros 'gState' and 'glState'. The former is now 'shState'.
2013-10-09 10:30:33 +00:00
static SharedState *instance;
Merge separate RGSS version build configs into one Setup active RGSS version at runtime. Desired version can be specified via config, or as default, auto detected from the game files. This removes the need to build specifically for each version, which should help packaging a lot. This also greatly reduces the danger of introducing code that wouldn't compile on all RGSS version paths (as certain code paths were completely ifdef'd out). This can be optimized more, eg. not compiling shaders that aren't needed in the active version.
2014-08-28 21:11:10 +00:00
static int rgssVersion;
SharedState: Throw exception on errors (and handle them) First up: throw if chdir(gameFolder) fails.
2013-12-30 00:26:39 +00:00
/* This function will throw an Exception instance
* on initialization error */
Initial commit
2013-09-01 14:27:21 +00:00
static void initInstance(RGSSThreadData *threadData);
static void finiInstance();
private:
Rename 'GlobalState' to 'SharedState' to avoid confusion with GLState This was particularly nasty with the shorthand macros 'gState' and 'glState'. The former is now 'shState'.
2013-10-09 10:30:33 +00:00
SharedState(RGSSThreadData *threadData);
~SharedState();
Initial commit
2013-09-01 14:27:21 +00:00
Rename 'GlobalState' to 'SharedState' to avoid confusion with GLState This was particularly nasty with the shorthand macros 'gState' and 'glState'. The former is now 'shState'.
2013-10-09 10:30:33 +00:00
SharedStatePrivate *p;
Initial commit
2013-09-01 14:27:21 +00:00
};
Rename 'GlobalState' to 'SharedState' to avoid confusion with GLState This was particularly nasty with the shorthand macros 'gState' and 'glState'. The former is now 'shState'.
2013-10-09 10:30:33 +00:00
#endif // SHAREDSTATE_H