Table of Contents

1. Introduction

2. Installing Bugle

2.1. Requirements

2.2. SCons

2.3. Cross-compilation

2.4. Compiling on Windows

3. Using bugle with OpenGL ES

3.1. Introduction

3.2. Building

3.3. Windows specifics

4. Extending bugle

4.1. Introduction

4.2. API and ABI compatibility

4.3. Guidelines

4.3.1. Coding style

4.3.2. OpenGL contexts and threads

4.3.3. OpenGL extensions

4.4. Compiling an external filter-set library

4.5. Concepts

4.5.1. Callbacks, filter-sets, filters and libraries

4.5.2. Loading and activation

4.5.3. Budgie

4.5.4. Functions and groups

4.6. Basic filter-set API

4.6.1. Library initialisation

4.6.2. Filter-set variables

4.6.3. Filter-set initialisation and destruction

4.6.4. Writing callbacks

4.7. Object shadowing

4.7.1. Concepts

4.7.2. Class management functions

4.7.3. Object management functions

4.7.4. Thread safety

4.8. Utility functions and filter-sets

4.8.1. Begin/end checking

4.8.2. Error checking

4.8.3. Making calls to OpenGL

4.8.4. Checking for OpenGL extensions

5. Hacking bugle

5.1. Porting

5.1.1. Introduction

5.1.2. Binary format

5.1.3. Operating system API

5.1.4. Windowing system

5.1.5. GL-Windowing integration

5.1.6. Filesystem layout

5.1.7. Platforms

A. Bugle debugger protocol

A.1. Introduction

A.2. Basics

A.2.1. Types

A.2.2. States

A.3. Requests

A.3.1. Run

A.3.2. Continue

A.3.3. Step

A.3.4. Break on function

A.3.5. Break on event

A.3.6. Break on error

A.3.7. Stop

A.3.8. Quit

A.3.9. Filter-set activation and deactivation

A.3.10. State requests

A.3.11. Data requests

A.4. Synchronous responses

A.4.1. Error

A.4.2. Answer

A.4.3. Running

A.4.4. Binary state dumps

A.4.5. Textual state dumps

A.4.6. Data responses

A.5. Asynchronous responses

A.5.1. Break

A.5.2. Break on event

A.6. Protocol definition

B. FAQ

B.1. Compiling

B.2. Running

B.3. Miscellaneous

C. Bugle manual pages

bugle — An OpenGL debugging library

bugle-statistics — specify formulae and metadata for bugle statistics

gldb-gui — graphical OpenGL debugger

bugle-camera — allow the camera to be manipulated

bugle-checks — check for errors that OpenGL defines as undefined behaviour

bugle-contextattribs — override attributes during context creation

bugle-eps — captures vector graphics representatios of scenes

bugle-error — detect errors in OpenGL calls

bugle-exe — record a compilable log of OpenGL calls made

bugle-extoverride — hide OpenGL extensions from an application

bugle-frontbuffer — force rendering to the front buffer

bugle-log — configure logging output from other filter-sets

bugle-logdebug — send GL debug log to bugle log

bugle-logstats — log statistics to file

bugle-screenshot — takes screenshots and captures video

bugle-showerror — reports errors in OpenGL calls

bugle-showextensions — show which extensions are used by an OpenGL application

bugle-showstats — render statistics over the display

bugle-stats_basic — gather frame rate statistics

bugle-stats_calls — gather call frequency count

bugle-stats_calltimes — gather call timing

bugle-stats_fragments — gather fragment counts

bugle-stats_nv — gather performance data from NVPerfSDK

bugle-stats_primitives — gather triangle and batch counts

bugle-trace — record a log of OpenGL calls made

bugle-unwindstack — recover a stack trace after a segmentation fault

bugle-wireframe — force rendering in wireframe mode

D. Release notes

E. Change Log