vogl

vogl

NOTE

April 16, 2014: Vogl history has been completely and utterly trounced. The original repository had an entire chroot build system that most folks weren't interested in. A few contributors (thanks Carl & Sir Anthony) took the time to build a much smaller source only vogl repository which we've replaced the original one with.

A separate chroot repository (which will build this source repository) is now here:

https://bitbucket.org/raddebugger/vogl_chroot

Warning

This project is alpha^2. If you are up for suffering through a bit of pain with early releases, please jump in - we'd love to have your help...

Dependencies

The chroot configuration script should be a good reference for vogl dependencies. It is located here:

https://bitbucket.org/raddebugger/vogl_chroot/src/master/bin/chroot_configure.sh?at=master

The build dependencies for ubuntu (14.04) can be installed using the following:

sudo apt-get install build-essential pkg-config cmake libx11-dev \
                     zip wget libtinyxml-dev liblzma-dev libunwind8-dev \
                     libturbojpeg libdwarf-dev mesa-common-dev qt5-qmake\
                     freeglut3-dev qt5-default libqt5x11extras5-dev git \
                     libsdl2-gfx-dev libsdl2-image-dev libsdl2-ttf-dev libjpeg-turbo8-dev

Get Source and Build

Linux

git clone https://github.com/ValveSoftware/vogl.git  
mkdir -p vogl/vogl_build/release64 && cd $_  
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_X64=On ../..
make -j 10

The binaries are placed in the vogl/vogl_build directory.

For debug builds, use "-DCMAKE_BUILD_TYPE=Debug"
For 32-bit builds, use "-DBUILD_X64=Off"

Windows

git clone https://github.com/ValveSoftware/vogl.git
mkdir -p vogl\vogl_build\x64
cd vogl\vogl_build\x64
cmake -DQt5_DIR="C:\Qt\5.3\msvc2013_64_opengl\lib\cmake\Qt5" -G "Visual Studio 12 2013 Win64" ..\..
cd ..\..\..\
mkdir -p vogl\vogl_build\win32
cd vogl\vogl_build\win32
cmake -DQt5_DIR="C:\Qt\5.3\msvc2013_opengl\lib\cmake\Qt5" -G "Visual Studio 12 2013" ..\..

Note: The path to Qt5 might need to be adjusted depending on your install location. After compiling with Visual Studio, the binaries are placed in the vogl\vogl_build\Release (or Debug) directory.

Mac OS X

Install the required build dependencies using Homebrew:

brew install pkg-config cmake sdl2 qt5 xz jpeg-turbo tinyxml

Then build with:

git clone https://github.com/ValveSoftware/vogl.git

mkdir -p vogl/vogl_build/mac
cd       vogl/vogl_build/mac

cmake ../.. -DCMAKE_PREFIX_PATH=/usr/local/Cellar/qt5/5.3.2/
make

Note: the Mac port is not yet functional.

Capturing

cd vogl_build
VOGL_CMD_LINE="--vogl_tracefile vogltrace.glxspheres64.bin" LD_PRELOAD=$(readlink -f libvogltrace64.so) ./glxspheres64  

For capturing Steam games, please see the vogl_trace.sh script in the chroot repository:

https://bitbucket.org/raddebugger/vogl_chroot/src/master/bin/src/sl.cpp?at=master

We are currently working on making it much easier to launch and profile Steam apps.

Replay

./voglreplay64 play vogltrace.glxspheres64.bin

or launch vogleditor64 and open trace file.

QtCreator tagging and building

See qtcreator/qtcreator.md file: qtcreator.md

Vogl Dev List

http://lists.voglproj.com/listinfo.cgi/dev-voglproj.com

Useful Links

Vogl Wiki

• https://github.com/ValveSoftware/vogl/wiki

OpenGL documentation/references

• 4.x: http://www.opengl.org/sdk/docs/man/
• 3.3: http://www.opengl.org/sdk/docs/man3/
• 2.1: http://www.opengl.org/sdk/docs/man2/

Specifications

• 4.0: http://www.opengl.org/registry/doc/glspec40.core.20100311.pdf
• 3.3: http://www.opengl.org/registry/doc/glspec33.core.20100311.withchanges.pdf
• 2.1: http://www.opengl.org/documentation/specs/version2.1/glspec21.pdf

License and Credits

Vogl code is MIT licensed.

…

libbacktrace is BSD licensed. Libbacktrace license.

apitrace is MIT licensed: Apitrace license.

Loki is MIT licensed: Loki license.

Valgrind header files are BSD-style licensed: Valgrind header files.

GL header files are MIT licensed: GL header files.

glxspheres (from VirtualGL) is wxWindows Library licensed: wxWindows Library License.

SDL is zlib licensed: zlib license.

stb files (from Sean Barrett) are public domain.

TinyXML-2 is zlib licensed: zlib license.