Difference between revisions of "VOGL"

From ArchWiki
Jump to: navigation, search
(Updated for new location of libvogltrace64.so binary)
(update Pkg/AUR templates)
(Tag: wiki-scripts)
 
(11 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
[[Category:Development]]
 
[[Category:Development]]
 
[[Category:Graphics]]
 
[[Category:Graphics]]
 +
[[ja:VOGL]]
 
{{Related articles start}}
 
{{Related articles start}}
{{Related|Step By Step Debugging Guide}}
+
{{Related|Step-by-step debugging guide}}
 
{{Related|Debug - Getting Traces}}
 
{{Related|Debug - Getting Traces}}
 
{{Related articles end}}
 
{{Related articles end}}
Line 10: Line 11:
 
==Installation==
 
==Installation==
  
The development version {{AUR|vogl-git}} is available on the [[AUR]].
+
The development version {{AUR|vogl-git}} is available on the [[AUR]]
 +
 
 +
To capture and debug 32-Bit applications you need libvogltrace32.so, voglreplay32 and vogleditor32 from {{AUR|lib32-vogl-git}}{{Broken package link|package not found}}.
  
 
==Capturing a tracefile==
 
==Capturing a tracefile==
 
To obtain a tracefile run the following command.     
 
To obtain a tracefile run the following command.     
{{bc|1=$ VOGL_CMD_LINE="--vogl_tracefile /tmp/vogltrace.bin" LD_PRELOAD=/usr/lib/libvogltrace64.so <command>}}     
+
{{bc|1=$ VOGL_CMD_LINE="--vogl_debug --vogl_dump_stats --vogl_tracefile /tmp/vogltrace.bin" LD_PRELOAD=/usr/lib/libvogltrace64.so <command>}}     
 
Where <command> is the command to launch your OpenGL application. Your tracefile will be created in your /tmp directory.   
 
Where <command> is the command to launch your OpenGL application. Your tracefile will be created in your /tmp directory.   
 
{{Warning| These files get big very fast! 1-2 minutes result in about 1GB of captured calls.  }}
 
{{Warning| These files get big very fast! 1-2 minutes result in about 1GB of captured calls.  }}
  
 
VOGL ships with various OpenGL samples that can be used for testing in its sources. These are not part of the package but they can be built manually. You can also grab the latest OpenGL samples from the [http://ogl-samples.g-truc.net/ OpenGL Samples Pack] or from [http://www.openglsuperbible.com/ OpenGL SuperBible].
 
VOGL ships with various OpenGL samples that can be used for testing in its sources. These are not part of the package but they can be built manually. You can also grab the latest OpenGL samples from the [http://ogl-samples.g-truc.net/ OpenGL Samples Pack] or from [http://www.openglsuperbible.com/ OpenGL SuperBible].
 +
 +
==Trimming the tracefile==
 +
 +
If you want to create a smaller tracefile from your captured trace containing X amount of frames starting at frame Y use:
 +
 +
{{bc|$ voglreplay64 original_trace.bin --trim_file trimmed_trace.bin --trim_len X --trim_frame Y}}
  
 
==Replaying the tracefile==
 
==Replaying the tracefile==
Line 25: Line 34:
  
 
{{bc|$ voglreplay64 /tmp/vogltrace.bin}}
 
{{bc|$ voglreplay64 /tmp/vogltrace.bin}}
 +
 +
To get verbose debugging output for your trace:
 +
 +
{{bc|$ voglreplay64 --debug --verbose vogltrace.bin}}
 +
 +
To get GL call and extension statistics:
 +
 +
{{bc|$ voglreplay64 --info vogltrace.bin}}
  
 
==Inspecting the tracefile==
 
==Inspecting the tracefile==

Latest revision as of 07:28, 30 October 2017

VOGL is a tool created by Valve Software and RAD Game Tools for OpenGL debugging. It is able to capture, replay and inspect OpenGL call tracefiles.

Installation

The development version vogl-gitAUR is available on the AUR.

To capture and debug 32-Bit applications you need libvogltrace32.so, voglreplay32 and vogleditor32 from lib32-vogl-gitAUR[broken link: package not found].

Capturing a tracefile

To obtain a tracefile run the following command.

$ VOGL_CMD_LINE="--vogl_debug --vogl_dump_stats --vogl_tracefile /tmp/vogltrace.bin" LD_PRELOAD=/usr/lib/libvogltrace64.so <command>

Where <command> is the command to launch your OpenGL application. Your tracefile will be created in your /tmp directory.

Warning: These files get big very fast! 1-2 minutes result in about 1GB of captured calls.

VOGL ships with various OpenGL samples that can be used for testing in its sources. These are not part of the package but they can be built manually. You can also grab the latest OpenGL samples from the OpenGL Samples Pack or from OpenGL SuperBible.

Trimming the tracefile

If you want to create a smaller tracefile from your captured trace containing X amount of frames starting at frame Y use:

$ voglreplay64 original_trace.bin --trim_file trimmed_trace.bin --trim_len X --trim_frame Y

Replaying the tracefile

To replay your trace launch the voglreplayer from within your vogl directory.

$ voglreplay64 /tmp/vogltrace.bin

To get verbose debugging output for your trace:

$ voglreplay64 --debug --verbose vogltrace.bin

To get GL call and extension statistics:

$ voglreplay64 --info vogltrace.bin

Inspecting the tracefile

Launch the vogleditor binary and open the tracefile.bin with the "File - Open Trace" menu.

$ vogleditor64

Limitations

Read about the limitations on this blog post.