Latest revision as of 23:42, 5 February 2017

Why build in Eclipse?

Building JOGL inside Eclipse lets you use the Eclipse debugger, profiler, and unit test framework. It also gives you useful editing features like auto-complete and red underlines for syntax errors.

Prerequisites

Before you can build JOGL in Eclipse, make sure you can build it from the command line. Then double-check these things:

to have at least Eclipse Neon 2, that comes with Ant 1.9.6 (jogl requires 1.8+)
to have a JDK installed and set up properly.
- JAVA_HOME is set to your JDK directory. You must use a JDK, not a JRE, because Ant needs $JAVA_HOME/lib/tools.jar (on Windows and Linux).
- $JAVA_HOME/bin directory is on your PATH. You must use a JDK bin directory, not a JRE bin directory, because Ant needs $JAVA_HOME/bin/javac.
to delete the CLASSPATH variable from your system environment variables, .cshrc, .bash_profile or other location.
- having this set with random old JARs on it is one of the leading causes of build problems.

Overview

To build JOGL in Eclipse, we'll set up Eclipse's JRE and Ant version, create Eclipse projects for the gluegen and jogl projects, then add Ant builders to those projects to invoke the JOGL command-line Ant build.

Set up Eclipse's workbench VM

The workbench VM is the version of Java that Eclipse uses to launch itself. Eclipse can find a Java VM on its own by looking in your system's default locations, but we don't want that, because it might pick a JRE instead of a JDK, which won't work with the JOGL Ant build.

Go to your Eclipse installation directory, and edit the eclipse.ini file (on Mac OS X, it's at <eclipse installation directory>/Eclipse.app/Contents/MacOS/eclipse.ini).
If they don't exist already, add these lines before the -vmargs line.

Windows:

-vm
<your JAVA_HOME directory>\jre\bin\javaw.exe

Linux and Mac OS X:

-vm
<your JAVA_HOME directory>/jre/bin/java

Save and close the file.
If Eclipse is running, you must restart it for the setting to take effect.

If you haven't done this step, the javah task may fail in the Ant build.

Switch workspace to the parent of gluegen and jogl

If you have already the usual configuration:

  /eclipse/workpace/
                    gluegen/
                    jogl/

Then you are fine. If not, you need to set your Eclipse workspace to the parent directory of the gluegen and jogl projects. This tells Eclipse where to create its .metadata directory, where it will store your settings for this group of projects.

Click File > Switch Workspace > Other... and then Browse...
Navigate to the parent directory of the gluegen and jogl projects, select it, and click OK
Click OK to dismiss the Workspace Launcher dialog

Set up Eclipse's project JRE

This is the version of Java that Eclipse runs and debugs your projects with. Eclipse will already have some project JRE installed, but we need to make sure that it's set up properly.

Click Window > Preferences (it's Eclipse > Preferences... on Mac OS X), then Java > Installed JREs on the left
Select the checked JRE on the right, then click Edit...
Make sure the JRE home is set to the same directory that you've got JAVA_HOME set to in your environment. If it's not, click Directory... to change it
- This should be a JDK directory
- The list of JRE system libraries should show a list of $JAVA_HOME/jre/lib/*.jar entries (on Windows and Linux) or a list of $JAVA_HOME/../Contents/Classes/*.jar entries (on Mac OS X)
Click Finish to close the Edit JRE dialog, and OK to close the Preferences dialog

Create an Ant user library

JOGL contains code that uses classes in the Ant JARs. So we need a way to tell our projects where those JARs are.

we need to know where the Ant bundled with Eclipse is, click Window > Preferences (it's Eclipse > Preferences... on Mac OS X) > Ant > runtime. In Classpath tab, expand Ant Home Entries and annotate down its path, this is your antHome
Select Java > Build Path > User Libraries on the left
Click New..., type Ant for the library name, and click OK
Click Add JARs..., navigate to your antHome/lib directory, select all the JARs inside, and click Open
Click OK to exit Preferences dialog

Create an SWT user library

To build the SWT tests in JOGL, Eclipse needs to know where the SWT JAR files are.

Click Window > Preferences (it's Eclipse > Preferences... on Mac OS X), then Java > Build Path > User Libraries on the left
Click New..., type SWT for the library name, and click OK
Click Add External JARs... button, navigate to your jogl\make\lib\swt\your-platform directory, select swt-debug.jar, and click Open
Click OK to exit Preferences dialog

Import the gluegen and jogl projects

The Eclipse project files for gluegen and jogl should have been checked out along with the source code, so you should be able to import the two projects.

Click File > Import..., then select General > Existing Projects into Workspace
Click Next and Browse, then select your workspace directory and click OK
Uncheck any projects in the list except gluegen and jogl and click Finish

Create the gluegen project (optional)

Since the gluegen project files are checked out along with the code, you shouldn't have to create them yourself. But just for reference, if you did have to create them for some reason, here's how to do it.

First we create the new gluegen project with default settings.

Select File > New > Java Project...
Set gluegen as the project name and click the Next
Click Finish. This creates the .project and .classpath files in the gluegen directory

Next we set up the source paths for the project so Eclipse knows which Java files to build. When we created the project, Eclipse automatically found these, but it doesn't have all the properties set like we want them.

Right-click the gluegen project and select Properties
Select Java Build Path, then click the Source tab and remove any entry you find
At the bottom, click Allow output folders for source folders. This allows the Java files in each source folder to be compiled to a different output folder, which we need to match the Ant build
Set the Default output folder to gluegen/build/classes
For each entry in this table, click Link Source, browser to the right location as the Source folder location field in the table below, choose a proper name (you may want to substitute / with _) then Finish. Set also Output folder, Excluded and Native library location accordingly

Pay attention of empty spaces if you copy/paste from the table!

Source folder location	Native library location	Output folder	Excluded
build/gensrc/java	gluegen/build/obj	(Default output folder)
build/test/build/gensrc/classes	gluegen/build/obj	build/test/build/classes
src/java	gluegen/build/obj	(Default output folder)	com/jogamp/gluegen/runtime/BufferFactoryInternal.java
src/junit	gluegen/build/obj	build/test/build/classes
test/junit	gluegen/build/obj	build/test/build/classes	com/jogamp/gluegen/StructValidator.java

Now we set up the libraries that are needed to build the project.

Click the Libraries tab and remove all the JARs except "JRE System Library" from the list.
Click Add Library..., select JUnit, click Next, select JUnit 4 and then click Finish
Click OK to dismiss the Properties dialog

Finally we can set up the Ant builder. This lets Eclipse invoke our command-line Ant build.

Right-click the gluegen project, select Properties and click the Builders tab on the left
Uncheck the Java Builder. Click OK when it asks you to confirm. This is needed to prevent Eclipse from rebuilding class files that the Ant builder is responsible for
Click New..., select Ant Builder and click OK
Type gluegen builder as the name, then set the Buildfile to /gluegen/make/build.xml and the Base Directory to /gluegen/make
Click Refresh tab, check Refresh resources upon completion, click The project containing the selected resource
Click Targets tab
Click Set Targets... to the right of Auto Build and control all is checked
Click Set Targets... to the right of During a "Clean". Then uncheck all, check clean and click OK
Click OK to dismiss the Edit Configuration dialog
Click OK to save and dismiss the Properties dialog. This creates the .externalToolBuilders directory in the glugen project

Create the jogl project (optional)

Since the jogl project files are checked out along with the code, you shouldn't have to create them yourself. But just for reference, if you did have to create them for some reason, here's how to do it.

To create the jogl project, we do exactly what we did to create the gluegen project, but with different names and paths substituted. First we create the new jogl project with default settings.

Select File > New > Java Project...
Set jogl as the project name, click Next and then Finish

Next we set up the source directories for the project.

Right-click the jogl project and select Properties
Select Java Build Path, then click Source tab and remove any entry you find
At the bottom, click Allow output folders for source folders and set Default output folder to jogl/build/jogl/classes
For each entry in this table, click Link Source, browser to the right location as the Source folder location field in the table below, choose a proper name (you may want to substitute / with _) then Finish. Set also Output folder, Excluded and Native library location accordingly

Pay attention of empty spaces if you copy/paste from the table!

Source folder location	Native library location	Output folder	Excluded
build/jogl/gensrc/classes	jogl/build/jogl/obj	(Default output folder)
build/nativewindow/gensrc/classes	jogl/build/nativewindow/obj	build/nativewindow/classes
src/jogl/classes	jogl/build/jogl/obj	(Default output folder)	com/jogamp/audio/windows/waveout/TestSpatialization.java, jogamp/opengl/gl2/fixme/
src/nativewindow/classes	jogl/build/nativewindow/obj	build/nativewindow/classes
src/newt/classes	jogl/build/newt/obj	build/newt/classes
src/test		build/test/build/classes

The jogl project depends on the gluegen project being built first, so we need to set the dependency between them.

Click the Projects tab, Add..., check gluegen and click OK

Now we set up the libraries that are needed to build the project:

Click Libraries tab and remove all the JARs from the list except "JRE System Library"
Click Add Library..., select JUnit, click Next, select JUnit 4 and click Finish
Click Add Library..., select User Library, click Next, check Ant and SWT and click Finish
Click OK to dismiss the Properties dialog

Finally we can set up the Ant builder.

Right-click the jogl project, select Properties and click the Builders tab on the left
Uncheck the Java Builder and click OK when it asks you to confirm. This is needed to prevent Eclipse from rebuilding class files that the Ant builder is responsible for
Click New... button, select Ant Builder and click OK
Type jogl builder as the name and set Buildfile to jogl/make/build.xml and Base Directory to jogl/make
Click Refresh tab, check Refresh resources upon completion, click The project containing the selected resource
Click Targets tab
For the first three elements (After a "Clean", Manual Build and Auto Build) now uncheck everything and check all.ide as target
Click Set Targets... to the right of During a "Clean", uncheck all, check clean and click OK
Click OK to dismiss the Edit Configuration dialog and again OK to save and dismiss the Properties dialog

Now we can clean and build both projects in Eclipse.

Select Project > Clean, click Clean all projects and click OK

Install EGit in Eclipse (Eclipse 3.6 and earlier)

After the build works we can install EGit in Eclipse. This lets you perform Git source control operations from inside Eclipse, though it doesn't yet support every feature of the command line version. EGit is pre-installed in Eclipse 3.7 and later, so check your Eclipse version before doing this.

Click "Help > Install New Software...".
Type http://download.eclipse.org/egit/updates in the "Work with" box and press enter.
Check "Eclipse Git Team Provider" and "Eclipse JGit" and install them.

Associate Eclipse projects with Git

After we install EGit, we have to tell Eclipse that gluegen and jogl are Git projects.

Right-click "gluegen", select "Team > Share Project...", select "Git", click "Next", select the .git repository, and click "Finish".
Do the same thing for the "jogl" project.

Now when you right-click projects or files in the Package Explorer, you can see the Git operations in the "Team" menu.

Building JOGL in Eclipse: Difference between revisions

Latest revision as of 23:42, 5 February 2017

Contents

Why build in Eclipse?

Prerequisites

Overview

Set up Eclipse's workbench VM

Switch workspace to the parent of gluegen and jogl

Set up Eclipse's project JRE

Create an Ant user library

Create an SWT user library

Import the gluegen and jogl projects

Create the gluegen project (optional)

Create the jogl project (optional)

Install EGit in Eclipse (Eclipse 3.6 and earlier)

Associate Eclipse projects with Git

Navigation menu

@@ Line 5: / Line 5: @@
 = Prerequisites =
-Before you can build it in Eclipse, you'll need to have JOGL building from the command line.
+Before you can build JOGL in Eclipse, make sure you can [[Building JOGL on the command line|build it from the command line]]. Then double-check these things:
+* to have at least Eclipse Neon 2, that comes with Ant 1.9.6 (jogl requires 1.8+)
+* to have a JDK installed and set up properly.
+** <tt>JAVA_HOME</tt> is set to your JDK directory. You must use a JDK, not a JRE, because Ant needs <tt>$JAVA_HOME/lib/tools.jar</tt> (on Windows and Linux).
+** <tt>$JAVA_HOME/bin</tt> directory is on your PATH. You must use a JDK bin directory, not a JRE bin directory, because Ant needs <tt>$JAVA_HOME/bin/javac</tt>.
+* to delete the CLASSPATH variable from your system environment variables, <tt>.cshrc</tt>, <tt>.bash_profile</tt> or other location.
+** having this set with random old JARs on it is one of the leading causes of build problems.
 = Overview =
-To build JOGL in Eclipse, we'll create Eclipse projects for the gluegen and jogl projects, then add Ant builders to those projects to invoke the JOGL command-line Ant build.
+To build JOGL in Eclipse, we'll set up Eclipse's JRE and Ant version, create Eclipse projects for the gluegen and jogl projects, then add Ant builders to those projects to invoke the JOGL command-line Ant build.
+= Set up Eclipse's workbench VM =
+The workbench VM is the version of Java that Eclipse uses to launch itself. Eclipse can find a Java VM on its own by looking in your system's default locations, but we don't want that, because it might pick a JRE instead of a JDK, which won't work with the JOGL Ant build.
+* Go to your Eclipse installation directory, and edit the <tt>eclipse.ini</tt> file (on Mac OS X, it's at <tt>&lt;eclipse installation directory&gt;/Eclipse.app/Contents/MacOS/eclipse.ini</tt>).
+* If they don't exist already, add these lines before the <tt>-vmargs</tt> line.
+Windows:
+<pre>
+-vm
+<your JAVA_HOME directory>\jre\bin\javaw.exe
+</pre>
+Linux and Mac OS X:
+<pre>
+-vm
+<your JAVA_HOME directory>/jre/bin/java
+</pre>
+* Save and close the file.
+* If Eclipse is running, you must restart it for the setting to take effect.
+If you haven't done this step, the <tt>javah</tt> task may fail in the Ant build.
+= Switch workspace to the parent of gluegen and jogl =
+If you have already the usual configuration:
+   /eclipse/workpace/
+                     gluegen/
+                     jogl/
+Then you are fine. If not, you need to set your Eclipse workspace to the parent directory of the gluegen and jogl projects. This tells Eclipse where to create its <tt>.metadata</tt> directory, where it will store your settings for this group of projects.
+* Click '''File''' > '''Switch Workspace''' > '''Other...''' and then '''Browse...'''
+* Navigate to the parent directory of the gluegen and jogl projects, select it, and click '''OK'''
+* Click '''OK''' to dismiss the Workspace Launcher dialog
+= Set up Eclipse's project JRE =
+This is the version of Java that Eclipse runs and debugs your projects with. Eclipse will already have some project JRE installed, but we need to make sure that it's set up properly.
+* Click '''Window''' > '''Preferences''' (it's '''Eclipse''' > '''Preferences...''' on Mac OS X), then '''Java''' > '''Installed JREs''' on the left
+* Select the checked JRE on the right, then click '''Edit...'''
+* Make sure the JRE home is set to the same directory that you've got <tt>JAVA_HOME</tt> set to in your environment. If it's not, click '''Directory...''' to change it
+** This should be a JDK directory
+** The list of JRE system libraries should show a list of <tt>$JAVA_HOME/jre/lib/*.jar</tt> entries (on Windows and Linux) or a list of <tt>$JAVA_HOME/../Contents/Classes/*.jar</tt> entries (on Mac OS X)
+* Click '''Finish''' to close the Edit JRE dialog, and '''OK''' to close the Preferences dialog
+= Create an Ant user library =
+JOGL contains code that uses classes in the Ant JARs. So we need a way to tell our projects where those JARs are.
+* we need to know where the Ant bundled with Eclipse is, click '''Window''' > '''Preferences''' (it's '''Eclipse''' > '''Preferences...''' on Mac OS X) > '''Ant''' > '''runtime'''. In '''Classpath''' tab, expand '''Ant Home Entries''' and annotate down its path, this is your ''antHome''
+* Select '''Java''' > '''Build Path''' > '''User Libraries''' on the left
+* Click '''New...''', type ''Ant'' for the library name, and click '''OK'''
+* Click '''Add JARs...''', navigate to your <tt>''antHome''/lib</tt> directory, select all the JARs inside, and click '''Open'''
+* Click '''OK''' to exit Preferences dialog
-= Update Eclipse's Ant installation =
+= Create an SWT user library =
-Ant comes bundled in Eclipse, but to build JOGL we need Ant 1.8 or later, and Eclipse 3.6 still uses Ant 1.7. So we'll tell Eclipse to point at your local Ant installation.
+To build the SWT tests in JOGL, Eclipse needs to know where the SWT JAR files are.
-* On "Classpath" tab, click Window > Preferences, select Ant > Runtime, click "Ant Home..." button, select your Ant home dir and click "Open"
+* Click '''Window''' > '''Preferences''' (it's '''Eclipse''' > '''Preferences...''' on Mac OS X), then '''Java''' > '''Build Path''' > '''User Libraries''' on the left
-* Click "Properties" tab, click "Add Property...", set name to java.home, set value to JDK jre dir
+* Click '''New...''', type ''SWT'' for the library name, and click '''OK'''
-* Click "OK" to exit Preferences dialog
+* Click '''Add External JARs...''' button, navigate to your <tt>jogl\make\lib\swt\your-platform</tt> directory, select <tt>swt-debug.jar</tt>, and click '''Open'''
+* Click '''OK''' to exit Preferences dialog
-= Create gluegen project =
+= Import the gluegen and jogl projects =
-* Create new project
+The Eclipse project files for gluegen and jogl should have been checked out along with the source code, so you should be able to import the two projects.
-** Select "File > New > Project..."
-** Expand "Java", click "Java Project", click the "Next" button
-** Put "gluegen" in project name, click the "Next" button
-** To "Remove all generated resources" dialog, click "Yes"
-** Click "Finish"
-* Set up source directories
+* Click '''File''' > '''Import...''', then select '''General''' > '''Existing Projects into Workspace'''
-** Right-click "gluegen" project, select "Properties"
+* Click '''Next''' and '''Browse''', then select your workspace directory and click '''OK'''
-** Select "Java Build Path", click "Source" tab
+* Uncheck any projects in the list except gluegen and jogl and click '''Finish'''
-** Click "Allow output folders for source folders"
-** Set default output folder to "gluegen\build\classes"
+= Create the gluegen project (optional) =
-** Set output folder, excluded pattern, and native library location to these. Remove any not in this list.
+Since the gluegen project files are checked out along with the code, you shouldn't have to create them yourself. But just for reference, if you did have to create them for some reason, here's how to do it.
+First we create the new gluegen project with default settings.
+* Select '''File''' > '''New''' > '''Java Project...'''
+* Set ''gluegen'' as the project name and click the '''Next'''
+* Click '''Finish'''. This creates the <tt>.project</tt> and <tt>.classpath</tt> files in the <tt>gluegen</tt> directory
+Next we set up the source paths for the project so Eclipse knows which Java files to build. When we created the project, Eclipse automatically found these, but it doesn't have all the properties set like we want them.
+* Right-click the ''gluegen'' project and select '''Properties'''
+* Select '''Java Build Path''', then click the '''Source''' tab and remove any entry you find
+* At the bottom, click '''Allow output folders for source folders'''. This allows the Java files in each source folder to be compiled to a different output folder, which we need to match the Ant build
+* Set the '''Default output folder''' to <tt>gluegen/build/classes</tt>
+* For each entry in this table, click '''Link Source''', browser to the right location as the ''Source folder location'' field in the table below, choose a proper name (you may want to substitute <tt>/</tt> with <tt>_</tt>) then '''Finish'''. Set also ''Output folder'', ''Excluded'' and ''Native library location'' accordingly
+Pay attention of empty spaces if you copy/paste from the table!
 {| border="1"
-! source
+! Source folder location
-! native
+! Native library location
-! output
+! Output folder
-! excluding
+! Excluded
 |-
 | build/gensrc/java
 | gluegen/build/obj
-| build/classes
+| (Default output folder)
 |
 |-
@@ Line 53: / Line 129: @@
 | src/java
 | gluegen/build/obj
-| build/classes
+| (Default output folder)
 | com/jogamp/gluegen/runtime/BufferFactoryInternal.java
 |-
@@ Line 67: / Line 143: @@
 |}
-* Set up libraries
+Now we set up the libraries that are needed to build the project.
-** Click Libraries tab
-** Remove all JARs except gluegen/make/lib/antlr.jar
+* Click the '''Libraries''' tab and remove all the JARs except <tt>"JRE System Library"</tt> from the list.
-** Click "Add Library...", select "JUnit", click "Next", select "JUnit 4", click "Finish"
+* Click '''Add Library...''', select '''JUnit''', click '''Next''', select '''JUnit 4''' and then click '''Finish'''
-** Click "Add External JARs...", select ant.jar from your Ant installation's lib dir, click "Open"
+* Click '''OK''' to dismiss the Properties dialog
-** Click "Add External JARs...", select tools.jar from your JDK installation's lib dir, click "Open"
-** Click "OK" to dismiss the Properties dialog
+Finally we can set up the Ant builder. This lets Eclipse invoke our command-line Ant build.
+* Right-click the ''gluegen'' project, select '''Properties''' and click the '''Builders''' tab on the left
+* Uncheck the '''Java Builder'''. Click '''OK''' when it asks you to confirm. This is needed to prevent Eclipse from rebuilding class files that the Ant builder is responsible for
+* Click '''New...''', select '''Ant Builder''' and click '''OK'''
+* Type ''gluegen builder'' as the name, then set the ''Buildfile'' to <tt>/gluegen/make/build.xml</tt> and the ''Base Directory'' to <tt>/gluegen/make</tt>
+* Click '''Refresh''' tab, check '''Refresh resources upon completion''', click '''The project containing the selected resource'''
+* Click '''Targets''' tab
+* Click '''Set Targets...''' to the right of ''Auto Build'' and control '''all''' is checked
+* Click '''Set Targets...''' to the right of ''During a "Clean"''. Then uncheck '''all''', check '''clean''' and click '''OK'''
+* Click '''OK''' to dismiss the Edit Configuration dialog
+* Click '''OK''' to save and dismiss the Properties dialog. This creates the <tt>.externalToolBuilders</tt> directory in the glugen project
-* Set up the Ant builder
+= Create the jogl project (optional) =
-** Right-click "gluegen" project, select "Properties"
-** Click "Builders" tab on left
-** Click "New...", select "Ant Builder", and click "OK"
-** Type "gluegen builder" as the name
-** Set buildfile to ${workspace_loc:/gluegen/make/build.xml}
-** Set base directory to ${workspace_loc:/gluegen/make}
-** Click Refresh tab, check "Refresh resources upon completion", click "The project containing the selected resource"
-** Click Targets tab, click "Set Targets..." button to the right of "During a "Clean""
-** Uncheck "all", check "clean", click "OK"
-** Click "OK" to dismiss Edit Configuration dialog
-** Select "gluegen builder" and click the "Up" button
-** Click "OK" to save and dismiss the Properties dialog
-= Create jogl project =
+Since the jogl project files are checked out along with the code, you shouldn't have to create them yourself. But just for reference, if you did have to create them for some reason, here's how to do it.
-To create the jogl project, we do exactly what we did to create the gluegen project, but with different names and paths substituted.
+To create the jogl project, we do exactly what we did to create the gluegen project, but with different names and paths substituted. First we create the new jogl project with default settings.
-* Create new project
+* Select '''File''' > '''New''' > '''Java Project...'''
-** Same, but use "jogl" for the new project name
+* Set ''jogl'' as the project name, click '''Next''' and then '''Finish'''
-* Set up source directories
+Next we set up the source directories for the project.
-** Same, but use the default source directory jogl/build/jogl/classes, and set the source paths up as shown in this table.
+* Right-click the ''jogl'' project and select '''Properties'''
+* Select '''Java Build Path''', then click '''Source''' tab and remove any entry you find
+* At the bottom, click '''Allow output folders for source folders''' and set '''Default output folder''' to <tt>jogl/build/jogl/classes</tt>
+* For each entry in this table, click '''Link Source''', browser to the right location as the ''Source folder location'' field in the table below, choose a proper name (you may want to substitute <tt>/</tt> with <tt>_</tt>) then '''Finish'''. Set also ''Output folder'', ''Excluded'' and ''Native library location'' accordingly
+Pay attention of empty spaces if you copy/paste from the table!
 {| border="1"
-! source
+! Source folder location
-! native
+! Native library location
-! output
+! Output folder
-! excluding
+! Excluded
 |-
 | build/jogl/gensrc/classes
-| jogl/build/lib
+| jogl/build/jogl/obj
-| build/jogl/classes
+| (Default output folder)
-| none
+|
 |-
 | build/nativewindow/gensrc/classes
-| jogl/build/lib
+| jogl/build/nativewindow/obj
 | build/nativewindow/classes
-| none
+|
 |-
 | src/jogl/classes
-| jogl/build/lib
+| jogl/build/jogl/obj
-| build/jogl/classes
+| (Default output folder)
-| com/jogamp/audio/windows/waveout/TestSpatialization.java, com/jogamp/opengl/impl/gl2/fixme/**
+| com/jogamp/audio/windows/waveout/TestSpatialization.java, jogamp/opengl/gl2/fixme/
 |-
 | src/nativewindow/classes
-| jogl/build/lib
+| jogl/build/nativewindow/obj
 | build/nativewindow/classes
-| none
+|
 |-
 | src/newt/classes
-| jogl/build/lib
+| jogl/build/newt/obj
 | build/newt/classes
-| none
+|
 |-
 | src/test
-| jogl/build/lib
+|
 | build/test/build/classes
-| none
+|
 |}
-* Set up project dependency
+The jogl project depends on the gluegen project being built first, so we need to set the dependency between them.
-** Click "Projects" tab, click "Add...", check "gluegen", click "OK"
+* Click the '''Projects''' tab, '''Add...''', check ''gluegen'' and click '''OK'''
+Now we set up the libraries that are needed to build the project:
+* Click '''Libraries''' tab and remove all the JARs from the list except <tt>"JRE System Library"</tt>
+* Click '''Add Library...''', select '''JUnit''', click '''Next''', select '''JUnit 4''' and click '''Finish'''
+* Click '''Add Library...''', select '''User Library''', click '''Next''', check '''Ant''' and '''SWT''' and click '''Finish'''
+* Click '''OK''' to dismiss the Properties dialog
+Finally we can set up the Ant builder.
+* Right-click the ''jogl'' project, select '''Properties''' and click the '''Builders''' tab on the left
+* Uncheck the '''Java Builder''' and click '''OK''' when it asks you to confirm. This is needed to prevent Eclipse from rebuilding class files that the Ant builder is responsible for
+* Click '''New...''' button, select '''Ant Builder''' and click '''OK'''
+* Type ''jogl builder'' as the name and set ''Buildfile'' to <tt>jogl/make/build.xml</tt> and ''Base Directory'' to <tt>jogl/make</tt>
+* Click '''Refresh''' tab, check '''Refresh resources upon completion''', click '''The project containing the selected resource'''
+* Click '''Targets''' tab
+* For the first three elements (''After a "Clean"'', ''Manual Build'' and ''Auto Build'') now uncheck everything and check '''all.ide''' as target
+* Click '''Set Targets...''' to the right of ''During a "Clean"'', uncheck '''all''', check '''clean''' and click '''OK'''
+* Click '''OK''' to dismiss the Edit Configuration dialog and again '''OK''' to save and dismiss the Properties dialog
+Now we can clean and build both projects in Eclipse.
-* Set up libraries
+* Select '''Project''' > '''Clean''', click '''Clean all projects''' and click '''OK'''
-** Click Libraries tab
-** Remove all JARs except gluegen/make/lib/antlr.jar
-** Click "Add Library...", select "JUnit", click "Next", select "JUnit 4", click "Finish"
-** Click "Add External JARs...", select ant.jar from your Ant installation's lib dir, click "Open"
-** Click "Add External JARs...", select ant-junit.jar from your Ant installation's lib dir, click "Open"
-** Click "OK" to dismiss the Properties dialog
-* Set up the Ant builder
+= Install EGit in Eclipse (Eclipse 3.6 and earlier) =
-** Just like last time, except set the buildfile to ${workspace_loc:/gluegen/make/build.xml} and set the base directory to ${workspace_loc:/gluegen/make}
-* Building
+After the build works we can install EGit in Eclipse. This lets you perform Git source control operations from inside Eclipse, though it doesn't yet support every feature of the command line version. EGit is pre-installed in Eclipse 3.7 and later, so check your Eclipse version before doing this.
-To build gluegen and jogl, select "Project > Clean", click "Clean all projects" and click "OK"
+* Click "Help > Install New Software...".
+* Type <tt>http://download.eclipse.org/egit/updates</tt> in the "Work with" box and press enter.
+* Check "Eclipse Git Team Provider" and "Eclipse JGit" and install them.
-= Install EGit in Eclipse =
+= Associate Eclipse projects with Git =
-Finally, install EGit in Eclipse so you can perform Git source control operations from inside Eclipse.
+After we install EGit, we have to tell Eclipse that gluegen and jogl are Git projects.
-* Click "Help > Install New Software..."
+* Right-click "gluegen", select "Team > Share Project...", select "Git", click "Next", select the .git repository, and click "Finish".
-* Type "http://download.eclipse.org/egit/updates" in the "Work with" box and press enter
+* Do the same thing for the "jogl" project.
-* Check "Eclipse EGit" and "Eclipse JGit" and install
-= Associate Eclipse projects with git =
+Now when you right-click projects or files in the Package Explorer, you can see the Git operations in the "Team" menu.
-* Right-click "gluegen", select "Team > Share Project...", select "Git", click "Next", select the .git repository, click "Finish"
-* Do the same thing for the "jogl" project

Building JOGL in Eclipse: Difference between revisions

Latest revision as of 23:42, 5 February 2017

Why build in Eclipse?

Prerequisites

Overview

Set up Eclipse's workbench VM

Switch workspace to the parent of gluegen and jogl

Set up Eclipse's project JRE

Create an Ant user library

Create an SWT user library

Import the gluegen and jogl projects

Create the gluegen project (optional)

Create the jogl project (optional)

Install EGit in Eclipse (Eclipse 3.6 and earlier)

Associate Eclipse projects with Git

Navigation menu

Search