despiker 0.1.3

Real-time frame-based profiler for D


To use this package, put the following dependency into your project's dependencies section:

dub.json
dub.sdl

<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="generator" content="Docutils 0.11: http://docutils.sourceforge.net/" /> <title>Despiker 0.1</title> <style type="text/css">

/* :Author: David Goodger (goodger@python.org) :Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $ :Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to customize this style sheet. */

/ used to remove borders from tables and images / .borderless, table.borderless td, table.borderless th { border: 0 }

table.borderless td, table.borderless th { /* Override padding for "table.docutils td" with "! important".

 The right padding separates the table cells. */

padding: 0 0.5em 0 0 ! important }

.first { / Override more specific margin styles with "! important". / margin-top: 0 ! important }

.last, .with-subtitle { margin-bottom: 0 ! important }

.hidden { display: none }

a.toc-backref { text-decoration: none ; color: black }

blockquote.epigraph { margin: 2em 5em ; }

dl.docutils dd { margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] { overflow: hidden; }

/ Uncomment (and remove this text!) to get bold-faced definition list terms dl.docutils dt { font-weight: bold } /

div.abstract { margin: 2em 5em }

div.abstract p.topic-title { font-weight: bold ; text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error, div.hint, div.important, div.note, div.tip, div.warning { margin: 2em ; border: medium outset ; padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title, div.important p.admonition-title, div.note p.admonition-title, div.tip p.admonition-title { font-weight: bold ; font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title, div.danger p.admonition-title, div.error p.admonition-title, div.warning p.admonition-title, .code .error { color: red ; font-weight: bold ; font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in compound paragraphs. div.compound .compound-first, div.compound .compound-middle { margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle { margin-top: 0.5em } */

div.dedication { margin: 2em 5em ; text-align: center ; font-style: italic }

div.dedication p.topic-title { font-weight: bold ; font-style: normal }

div.figure { margin-left: 2em ; margin-right: 2em }

div.footer, div.header { clear: both; font-size: smaller }

div.line-block { display: block ; margin-top: 1em ; margin-bottom: 1em }

div.line-block div.line-block { margin-top: 0 ; margin-bottom: 0 ; margin-left: 1.5em }

div.sidebar { margin: 0 0 0.5em 1em ; border: medium outset ; padding: 1em ; background-color: #ffffee ; width: 40% ; float: right ; clear: right }

div.sidebar p.rubric { font-family: sans-serif ; font-size: medium }

div.system-messages { margin: 5em }

div.system-messages h1 { color: red }

div.system-message { border: medium outset ; padding: 1em }

div.system-message p.system-message-title { color: red ; font-weight: bold }

div.topic { margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { margin-top: 0.4em }

h1.title { text-align: center }

h2.subtitle { text-align: center }

hr.docutils { width: 75% }

img.align-left, .figure.align-left, object.align-left { clear: left ; float: left ; margin-right: 1em }

img.align-right, .figure.align-right, object.align-right { clear: right ; float: right ; margin-left: 1em }

img.align-center, .figure.align-center, object.align-center { display: block; margin-left: auto; margin-right: auto; }

.align-left { text-align: left }

.align-center { clear: both ; text-align: center }

.align-right { text-align: right }

/ reset inner alignment in figures / div.align-right { text-align: inherit }

/ div.align-center { / / text-align: left } */

ol.simple, ul.simple { margin-bottom: 1em }

ol.arabic { list-style: decimal }

ol.loweralpha { list-style: lower-alpha }

ol.upperalpha { list-style: upper-alpha }

ol.lowerroman { list-style: lower-roman }

ol.upperroman { list-style: upper-roman }

p.attribution { text-align: right ; margin-left: 50% }

p.caption { font-style: italic }

p.credits { font-style: italic ; font-size: smaller }

p.label { white-space: nowrap }

p.rubric { font-weight: bold ; font-size: larger ; color: maroon ; text-align: center }

p.sidebar-title { font-family: sans-serif ; font-weight: bold ; font-size: larger }

p.sidebar-subtitle { font-family: sans-serif ; font-weight: bold }

p.topic-title { font-weight: bold }

pre.address { margin-bottom: 0 ; margin-top: 0 ; font: inherit }

pre.literal-block, pre.doctest-block, pre.math, pre.code { margin-left: 2em ; margin-right: 2em }

pre.code .ln { color: grey; } / line numbers / pre.code, code { background-color: #eeeeee } pre.code .comment, code .comment { color: #5C6576 } pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } pre.code .literal.string, code .literal.string { color: #0C5404 } pre.code .name.builtin, code .name.builtin { color: #352B84 } pre.code .deleted, code .deleted { background-color: #DEB0A1} pre.code .inserted, code .inserted { background-color: #A3D289}

span.classifier { font-family: sans-serif ; font-style: oblique }

span.classifier-delimiter { font-family: sans-serif ; font-weight: bold }

span.interpreted { font-family: sans-serif }

span.option { white-space: nowrap }

span.pre { white-space: pre }

span.problematic { color: red }

span.section-subtitle { / font-size relative to parent (h1..h6 element) / font-size: 80% }

table.citation { border-left: solid 1px gray; margin-left: 1px }

table.docinfo { margin: 2em 4em }

table.docutils { margin-top: 0.5em ; margin-bottom: 0.5em }

table.footnote { border-left: solid 1px black; margin-left: 1px }

table.docutils td, table.docutils th, table.docinfo td, table.docinfo th { padding-left: 0.5em ; padding-right: 0.5em ; vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name { font-weight: bold ; text-align: left ; white-space: nowrap ; padding-left: 0 }

/ "booktabs" style (no vertical lines) / table.docutils.booktabs { border: 0px; border-top: 2px solid; border-bottom: 2px solid; border-collapse: collapse; } table.docutils.booktabs * { border: 0px; } table.docutils.booktabs th { border-bottom: thin solid; text-align: left; }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { font-size: 100% }

ul.auto-toc { list-style-type: none }

</style> </head> <body> <div class="document" id="despiker-0-1"> <h1 class="title">Despiker 0.1</h1>

<p><strong>Note</strong>: while somewhat usable, Despiker is extremely experimental and unstable. For example, at the moment Despiker <em>does not</em> handle invalid profiling data and will crash with an assertion failure if it receives such data. Also, Despiker is likely to see only sporadic development until second half of 2015.</p> <div class="section" id="introduction"> <h1>Introduction</h1> <img alt="despiker-screen.png" src="despiker-screen.png" /> <p>Despiker (<a class="reference external" href="http://defenestrate.eu/docs/despiker/static/despiker.webm">video</a>) is a graphical real-time frame-based profiler for the <a class="reference external" href="http://dlang.org">D programming language</a> based on the <a class="reference external" href="https://github.com/kiith-sa/tharsis.prof">Tharsis.prof</a> library.</p> <p>A frame-based profiler is a specialized profiling tool for interactive programs such as games, hence <em>frame</em> - an iteration of an event loop. Unlike a traditional profiler, which aggregates time spent in various parts of code, a frame-based profiler keeps track of time spent in each individual frame separately.</p> <p>This allows to find not only <em>where</em> overhead occurs, but <em>when</em> it occurs. A frame-based profiler can find the exact frame when overhead was unexpectedly high (manifesting in a sharp FPS decrease, or lag), which would get averaged out with a normal profiler. It also allows to view how overhead in various parts of code evolves over time as the program (game) runs.</p> <p>Note that to use Despiker, you need to instrument parts of your code with <a class="reference external" href="https://github.com/kiith-sa/tharsis.prof">Tharsis.prof</a>. This is explained in detail in the <a class="reference external" href="http://defenestrate.eu/docs/despiker/tutorials/gettingstarted.html">tutorial</a>.</p> <p>For more in-depth background on frame-based profiling, see blog posts about development of Tharsis.prof, the base library behind Despiker:</p> <ul class="simple"> <li><a class="reference external" href="http://defenestrate.eu/2014/09/05/framebasedgameprofiling.html">Frame-based game profiling</a></li> <li><a class="reference external" href="http://defenestrate.eu/2014/09/05/optimizingmemoryusageofaframebasedprofiler.html">Optimizing memory usage of a frame-based profiler</a></li> <li><a class="reference external" href="http://defenestrate.eu/2014/09/05/framebasedprofilingwithdranges.html">Frame-based profiling with D ranges</a></li> </ul> <p>Despiker is a work in progress and <em>will</em> see interface and compatibility breaking changes in future.</p> </div> <div class="section" id="getting-started"> <h1>Getting started</h1> <p>See the <a class="reference external" href="http://defenestrate.eu/docs/despiker/tutorials/gettingstarted.html">tutorial</a>.</p> </div> <div class="section" id="requirements"> <h1>Requirements</h1> <p>Despiker should run on any platform with <em>OpenGL 3.3</em> or newer, as long as there is a D compiler and a version of <a class="reference external" href="libsdl.org">SDL</a> for that platform. Despiker has only been tested on x86-64 Linux so far, and there are no official builds for other platforms yet.</p> <p>If you encounter a problem getting Despiker to compile or run (see <a class="reference external" href="http://defenestrate.eu/docs/despiker/tutorials/gettingstarted.html">tutorial</a>) on Windows, OSX or another platform, you are welcome to <a class="reference external" href="https://github.com/kiith-sa/despiker/issues/new">report a bug</a>. You and even more welcome to <a class="reference external" href="https://github.com/kiith-sa/despiker/fork">fork</a> Despiker and create a pull request, especially if you want that problem solved <em>now</em> instead of <em>in a few months</em>.</p> </div> <div class="section" id="features"> <h1>Features</h1> <ul class="simple"> <li><a class="reference external" href="http://defenestrate.eu/docs/despiker/tutorials/gettingstarted.html">Tutorial</a>.</li> <li>(Somewhat, see above) cross-platform. Should work at least on Linux, Windows and OSX.</li> <li>Can profile a game in real-time as it runs, or afterwards, using dumped profiling data.</li> <li>Allows the user to move forward and backward between frames</li> <li>Can be used to profile multi-threaded code (using one Tharsis.prof <a class="reference external" href="http://defenestrate.eu/docs/tharsis.prof/tharsis.prof.profiler.html">Profiler</a> per thread, as long as frames are consistent in all profiled threads.</li> <li>Can view variable values recorded by Tharsis.prof.</li> <li>Quick button to find the slowest frame (yes, not very sophisticated for now).</li> <li>GUI and main functionality are separate to make it easy to write new GUI frontends.</li> <li>GUI can be controlled almost fully from keyboard.</li> </ul> </div> <div class="section" id="controls"> <h1>Controls</h1> <table border="1" class="docutils"> <colgroup> <col width="37%" /> <col width="63%" /> </colgroup> <thead valign="bottom"> <tr><th class="head">Control</th> <th class="head">Action</th> </tr> </thead> <tbody valign="top"> <tr><td><tt class="docutils literal">Space</tt></td> <td>Pause/resume current (real-time) frame view</td> </tr> <tr><td><tt class="docutils literal">H</tt>/<tt class="docutils literal">L</tt></td> <td>Previous/next frame</td> </tr> <tr><td><tt class="docutils literal">W</tt>/<tt class="docutils literal">D</tt>, <tt class="docutils literal">RMB</tt> drag</td> <td>Panning</td> </tr> <tr><td><tt class="docutils literal">-</tt>/<tt class="docutils literal">+</tt>, mouse wheel</td> <td>Zooming</td> </tr> <tr><td><tt class="docutils literal">1</tt></td> <td>Jump to the worst/slowest frame</td> </tr> </tbody> </table> </div> <div class="section" id="directory-structure"> <h1>Directory structure</h1> <table border="1" class="docutils"> <colgroup> <col width="17%" /> <col width="83%" /> </colgroup> <thead valign="bottom"> <tr><th class="head">Directory</th> <th class="head">Contents</th> </tr> </thead> <tbody valign="top"> <tr><td><tt class="docutils literal">./</tt></td> <td>This README, utility scripts.</td> </tr> <tr><td><tt class="docutils literal">./doc</tt></td> <td>Documentation.</td> </tr> <tr><td><tt class="docutils literal">./docsrc</tt></td> <td>Documentation sources.</td> </tr> <tr><td><tt class="docutils literal">./source</tt></td> <td>Source code.</td> </tr> </tbody> </table> </div> <div class="section" id="license"> <h1>License</h1> <p>Despiker is released under the terms of the <a class="reference external" href="http://www.boost.org/LICENSE10.txt">Boost Software License 1.0</a>. This license allows you to use the source code in your own projects, open source or proprietary, and to modify it to suit your needs. However, in source distributions, you have to preserve the license headers in the source code and the accompanying license file.</p> <p>Full text of the license can be found in file <tt class="docutils literal">LICENSE10.txt</tt> and is also displayed here:</p> <pre class="literal-block"> Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the software and accompanying documentation covered by this license (the "Software") to use, reproduce, display, distribute, execute, and transmit the Software, and to prepare derivative works of the Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the following:

The copyright notices in the Software and this entire statement, including the above license grant, this restriction and the following disclaimer, must be included in all copies of the Software, in whole or in part, and all derivative works of the Software, unless such copies or derivative works are solely in the form of machine-executable object code generated by a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </pre> </div> <div class="section" id="credits"> <h1>Credits</h1> <p>Despiker was created by Ferdinand Majerech aka Kiith-Sa kiithsacmp[AT]gmail.com .</p> <p>Parts of code based on <a class="reference external" href="https://github.com/d-gamedev-team/gfm">gfm</a> created by Games from Mars.</p> <p>Despiker was created using Vim and DMD on Linux Mint as a real-time game profiler for <a class="reference external" href="http://www.dlang.org">D</a>. See more D projects at <a class="reference external" href="http://code.dlang.org">code.dlang.org</a>.</p> </div> </div> </body> </html>

Authors:
  • Ferdinand Majerech
Dependencies:
tharsis-prof, dyaml, gfm:math, tharsis-dimgui, gl3n, derelict-gl3, logger, derelict-sdl2
Versions:
0.1.3 2014-Nov-30
0.1.2 2014-Nov-29
0.1.1 2014-Oct-13
0.1.0 2014-Oct-10
~master 2015-Aug-29
Show all 5 versions
Download Stats:
  • 0 downloads today

  • 0 downloads this week

  • 1 downloads this month

  • 267 downloads total

Score:
0.0
Short URL:
despiker.dub.pm