ofxAddons
← Back

ofxPluginEffectTest

github.com/robksawyer/ofxPluginEffectTest · @robksawyer
OF 0.8 Shaders Templates

This is a starter project for those folks looking to get started with FreeFrameGL in Xcode on OSX.

0 0 Last commit 11y ago Created 11y ago

README

Open Frameworks Plugin FFGL Effect Test for OSX and Xcode



Getting started



1. Download the dependencies listed below. Also verify that you are running a similar setup to the one listed in My System below. 2. Clone this repo using git clone. 3. Move the latest version of robksawyer/ofFFGLPlugin/addons/ofxFFGLPlugin to openframeworks_v0.X.X/addons/ 4. Move ofxPluginEffectTest080 to openframeworks_v0.X.X/apps/myApps/. 5. Start hacking!

----------------------------------------------------------------------------------

Getting started with Open Frameworks Project Generator



Part 1

1. Download the dependencies listed below. Also verify that you are running a similar setup to the one listed in My System below. 2. Move the latest version of robksawyer/ofFFGLPlugin/addons/ofxFFGLPlugin to openframeworks_v0.X.X/addons/ 3. Open Project Generator and name your sketch. The project will be created in your openframeworks folder under apps/myApps. 4. Click "Addons:" and mark ofxFFGLPlugin, then click << Back 5. Now click Generate Project and close the app 6. Navigate to apps/myApps/YourProject/ and open YourProject.xcodeproj. Build and compile it to make sure it actualyl compiles. If it doesn't, you're going to have some issues later.
You'll notice that by default it creates apps, but we need a bundle. So now is when the customizing starts.
7. Match the following project settings:
Project build settings
Build Settings

Project Build Phases, Run Script
Run script

8. You should NOT have to touch the default settings, but confirm the following:
OpenFrameworks build settings:
9. Select the openFrameworksLib project in the openframeworks folder of the Project navigator. Ensure OpenFrameworks is the active scheme next to the Build (play) button in Xcode. Build OpenFrameworks, it should compile fine with no issues.

Part 2



1. Select YourProject in the Project navigator and ensure YourProject Debug or Release is set as the active scheme next to the Build (play) button in Xcode. 2. Confirm ofTex->texData.glType = GL_RGBA; in addons/ofxFFGLPlugin/src/ofxFFGLPlugin.cpp is commented out. 3. Confirm default: ; is in the addons/ofxFFGLPlugin/src/ofxFFGLPlugin.cpp switch/case. This suppresses two warnings. 4. Confirm that the following is at the beginning of addons/ofxFFGLPlugin/libs/FFGL/FFGL.h: ``

ifdef APPLE

include <TargetConditionals.h>

endif

at the beginning of FFGL.h

inf FFGLExtensions.h comment out typedef unsigned int GLhandleARB; and replace with

if defined(APPLE)

typedef void GLhandleARB;

else

typedef unsigned int GLhandleARB;

endif

then change the definition of GETProcAddress to void FFGLExtensions::GetProcAddress(char const name) (also in header file of course)

inf FFGLShader.h change as follows

ifdef APPLE

void m_glProgram; void m_glVertexShader; void m_glFragmentShader; GLuint m_linkStatus;

else

GLenum m_glProgram; GLenum m_glVertexShader; GLenum m_glFragmentShader; GLuint m_linkStatus;

endif


5. Confirm the following is between ofSetupOpenGL and ofRunApp in addons/ofxFFGLPlugin/src/ofxFFGLWindow.cpp.
glewExperimental = GL_TRUE; GLenum err = glewInit(); if (GLEW_OK != err) { / Problem: glewInit failed, something is seriously wrong. / ofLogError("ofAppRunner") << "couldn't init GLEW: " << glewGetErrorString(err); }

glDisable( GL_DEPTH_TEST ); 

6. Confirm that the following methods are in addons/ofxFFGLPlugin/src/ofxFFGLWindow.cpp.
int ofFFGLWindow::getHeight() { return (int)windowSize.y; }

int ofFFGLWindow::getWidth() { return (int)windowSize.x; } 

7. Ensure that the following declarations are in the header of addons/ofxFFGLPlugin/src/ofxFFGLWindow.h.
int getHeight(); int getWidth(); `

8. The project should now build with no issues!

After you build, the YourProject.bundle should be copied to Arena vfx plugins dir. You can now launch Arena. The plugin should be visible in the list (Name corresponds to the name listed in src/main.cpp. Select it and check that sample parameters are present and info is correct. Try to apply it to the webcam, it should work (try changing the repetitions parameter). If the plugin does not show up, copy it from bin directory of your project and check that you added the copy command (cp -rf "$TARGET_BUILD_DIR/$PRODUCT_NAME.bundle" /Applications/Resolume\ Arena\ 4.2.0/plugins/vfx) in the Run Script area of Build Phases.
----------------------------------------------------------------------------------

Dependencies





Tips



For FFGL development, it's important to have some understanding of GLSL shader language. A good book to get started with is OpenGL Shading Language, Second Edition, but there are several other sources on the Internet. The OpenGL SuperBible is helpful for understanding the whole OpenGL context.

Resources



  • Open Frameworks Documentation <http://openframeworks.cc/documentation/>
  • Some awesome Open Frameworks Tutorials by Lewis Lepton <https://www.youtube.com/playlist?list=PL4neAtv21WOmrV8z9rSzL20QpdLU1zJLr>
  • Forum post ofxFFGL with Xcode5 and OF080 on <forum.openframeworks.cc>. - This is basically where most of the project came from. Thanks should go to davidemania.
  • FFGL SDK - The SDK includes 4 demo plugins, but don't expect to be able to compile them. I didn't have any luck.
  • The Resolume forum has a pretty good list of 3rd-party FFGL plugins and some links to GLSL shaders.
  • Matias Wilkman has some nice examples at assembla.com.
  • Mastering openFrameworks: Creative Coding Demystified
  • vvffgl - Framework for working with FreeFrame and FreeFrame 1.5 (FFGL) plugins on OS X.

My System



All of the testing that I've completed is done on a 2014 Macbook Pro Retina running the latest version of Mavericks. I'm also using Xcode 6.3. As a host I'm testing the plugins with Resolume Arena 4.2.0.

Revisions



Version 1.0.1

Version 1.0

Get this addon

HTTPS
SSH
View on GitHub · Open with Github Desktop · Download ZIP