Sign in to follow this  

OpenGL Implementing Effect Scripting

Recommended Posts

dopplex    164
So I took a first pass at implementing effect scripting, and was hoping to get some feedback on the approach I took. While I'm pretty happy with the approach (which seems extremely flexible), I'm still (relatively) new to game programming and have never had any real code review, so I have a constant worry that I'm making a large number of high level and low level errors. The most recent thing I'm working on is implementing SAS scripting for my effects (I'm using cgfx with OpenGL, though I think most of the things here would be equally valid (minus slight implementation differences) in DirectX.) So here's what I'm doing: Data:
union ScriptArg
	unsigned int uiArg;
	float floatArg;
	float vec2Arg[2];
	float vec3Arg[3];
	float vec4Arg[4];

typedef void(*ScriptCommand)(IFXScript &scriptInstance, const ScriptArg &scriptArg);

struct ScriptElem
	ScriptCommand command;
	ScriptArg	  arg;

typedef void(*ScriptCommandBuilder)(IFXScript &scriptInstance, ScriptElem &scriptElem, const std::string &stringArg);

typedef void(*RenderFunc)();

So I'm essentially just storing a function pointer corresponding to whatever implementation I have of the SAS command along with a union holding whatever the argument was (With some preprocessing of the arguments done - each command has its own function for putting together its ScriptElem struct. And here are the script classes:
class IFXScript
	RenderFunc tempFunc;
	unsigned int effectHandle;
	unsigned int handle;
	std::vector<ScriptElem> script;

	unordered_map<unsigned int, TexInfo> TextureMap;  
	void AddElem(const std::string &commandString, const std::string &argString);
	void AddTex(unsigned int paramNum);
	void Run(RenderFunc);
	virtual void SetSurface() = 0;  


class TechniqueScript : public IFXScript
	TechniqueScript() {};
	TechniqueScript(unsigned int techniqueHandle, unsigned int effect_handle);
	unordered_map<unsigned int, PassScript*> passMap;  
	SurfConfig Surface;
	inline void SetSurface() {SetSurf(Surface);};

class PassScript : public IFXScript
	TechniqueScript* parentTechnique;
	unsigned int passHandle;
	std::vector<ScriptElem> script;
	PassScript() {};
	PassScript(unsigned int passHandle, unsigned int effect_handle, TechniqueScript* parent);
	~PassScript() {};

	//Sets the FBO with the rendertargets 
	//currently defined in the TechniqueScript's
	//Surface variable.  PassScript will pass this
	//up to its parent TechniqueScript
	//Rendertarget change script commands
	//should only change the Surface variable.
	//SetSurface will need to be called before
	//the Draw to actually set the targets
	inline void SetSurface() {parentTechnique->SetSurface();};

(I know - nothing is encapsulated. I'm going to go back and fix that once I get a better handle on what I need to create accessor functions for) So after parsing, what I end up with for each Technique or Pass script is a vector full of function pointers and arguments. Running the script is just:
void IFXScript::Run(RenderFunc tFunc)
	tempFunc = tFunc;
	vector<ScriptElem>::iterator myScriptIter;
	for (myScriptIter = script.begin(); myScriptIter != script.end(); ++myScriptIter)
		ScriptElem &curElem = *myScriptIter;
		(curElem.command)(*this, curElem.arg);

I'm midway through implementing the actual command functions at the moment. Mostly, I just want to know if this approach to implementing the scripting looks good on paper, and whether I'm making any severely suboptimal choices in my implementation. I'm worrying more about the overall architecture of it, and if I'm unwittingly making a mistake that will hurt me in the long run. Any constructive criticism would be much appreciated!

Share this post

Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

Sign in to follow this  

  • Similar Content

    • By pseudomarvin
      I assumed that if a shader is computationally expensive then the execution is just slower. But running the following GLSL FS instead just crashes
      void main() { float x = 0; float y = 0; int sum = 0; for (float x = 0; x < 10; x += 0.00005) { for (float y = 0; y < 10; y += 0.00005) { sum++; } } fragColor = vec4(1, 1, 1 , 1.0); } with unhandled exception in nvoglv32.dll. Are there any hard limits on the number of steps/time that a shader can take before it is shut down? I was thinking about implementing some time intensive computation in shaders where it would take on the order of seconds to compute a frame, is that possible? Thanks.
    • By Arulbabu Donbosco
      There are studios selling applications which is just copying any 3Dgraphic content and regenerating into another new window. especially for CAVE Virtual reality experience. so that the user opens REvite or CAD or any other 3D applications and opens a model. then when the user selects the rendered window the VR application copies the 3D model information from the OpenGL window. 
      I got the clue that the VR application replaces the windows opengl32.dll file. how this is possible ... how can we copy the 3d content from the current OpenGL window.
      anyone, please help me .. how to go further... to create an application like VR CAVE. 
    • By cebugdev
      hi all,

      i am trying to build an OpenGL 2D GUI system, (yeah yeah, i know i should not be re inventing the wheel, but this is for educational and some other purpose only),
      i have built GUI system before using 2D systems such as that of HTML/JS canvas, but in 2D system, i can directly match a mouse coordinates to the actual graphic coordinates with additional computation for screen size/ratio/scale ofcourse.
      now i want to port it to OpenGL, i know that to render a 2D object in OpenGL we specify coordiantes in Clip space or use the orthographic projection, now heres what i need help about.
      1. what is the right way of rendering the GUI? is it thru drawing in clip space or switching to ortho projection?
      2. from screen coordinates (top left is 0,0 nd bottom right is width height), how can i map the mouse coordinates to OpenGL 2D so that mouse events such as button click works? In consideration ofcourse to the current screen/size dimension.
      3. when let say if the screen size/dimension is different, how to handle this? in my previous javascript 2D engine using canvas, i just have my working coordinates and then just perform the bitblk or copying my working canvas to screen canvas and scale the mouse coordinates from there, in OpenGL how to work on a multiple screen sizes (more like an OpenGL ES question).
      lastly, if you guys know any books, resources, links or tutorials that handle or discuss this, i found one with marekknows opengl game engine website but its not free,
      Just let me know. Did not have any luck finding resource in google for writing our own OpenGL GUI framework.
      IF there are no any available online, just let me know, what things do i need to look into for OpenGL and i will study them one by one to make it work.
      thank you, and looking forward to positive replies.
    • By fllwr0491
      I have a few beginner questions about tesselation that I really have no clue.
      The opengl wiki doesn't seem to talk anything about the details.
      What is the relationship between TCS layout out and TES layout in?
      How does the tesselator know how control points are organized?
          e.g. If TES input requests triangles, but TCS can output N vertices.
             What happens in this case?
      In this article,
      the isoline example TCS out=4, but TES in=isoline.
      And gl_TessCoord is only a single one.
      So which ones are the control points?
      How are tesselator building primitives?
    • By Orella
      I've been developing a 2D Engine using SFML + ImGui.
      Here you can see an image
      The editor is rendered using ImGui and the scene window is a sf::RenderTexture where I draw the GameObjects and then is converted to ImGui::Image to render it in the editor.
      Now I need to create a 3D Engine during this year in my Bachelor Degree but using SDL2 + ImGui and I want to recreate what I did with the 2D Engine. 
      I've managed to render the editor like I did in the 2D Engine using this example that comes with ImGui. 
      3D Editor preview
      But I don't know how to create an equivalent of sf::RenderTexture in SDL2, so I can draw the 3D scene there and convert it to ImGui::Image to show it in the editor.
      If you can provide code will be better. And if you want me to provide any specific code tell me.
  • Popular Now