From d2beb38ea9fb39dbfb8667784bd248b32d171cbf Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Thu, 15 Apr 2010 13:55:32 +0000 Subject: [PATCH] Add a couple of bits of documentation. git-svn-id: svn://localhost/ardour2/branches/3.0@6908 d708f5d6-7413-0410-9779-e7cbd77b26cf --- doc/canvas.svg | 1215 ++++++++++++++++++++++++++++++++++++++++++++++ doc/mainpage.txt | 13 + 2 files changed, 1228 insertions(+) create mode 100755 doc/canvas.svg create mode 100755 doc/mainpage.txt diff --git a/doc/canvas.svg b/doc/canvas.svg new file mode 100755 index 0000000000..bff9315abd --- /dev/null +++ b/doc/canvas.svg @@ -0,0 +1,1215 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + WORLD + (0, 0) world + + + VIEWPORT + + CANVAS + + x: pixels or frames (frames = pixels * Editor::frames_per_unit) + + y: pixels + "units" == pixels in Ardour + Carl's handy cut-out-and-keep guide to the Ardour canvas + master_group + + + time_line_group + + + trackview_group + + + + Editor::canvas_timebars_vsize + + Clicks are delivered in pixels relative to the viewport.Since the viewport is always at (0,0) in world coordinates,trackview_group->w2i() will convert a click to a trackview coordinate.Editor::event_frame() will do this and also convert x pixels to frames.y scrolling moves the trackview_group. + + + + + + + + WORLD + (0, 0) world + + + VIEWPORT + CANVAS + + master_group + + + + + + + time_line_group + + + + trackview_group + + + + + + + + + + WORLD + (0, 0) world + + + VIEWPORT + + CANVAS + master_group + + + time_line_group + + + trackview_group + + + + + x scrolling: move master group + + + diff --git a/doc/mainpage.txt b/doc/mainpage.txt new file mode 100755 index 0000000000..5834a9f63a --- /dev/null +++ b/doc/mainpage.txt @@ -0,0 +1,13 @@ +/** \mainpage Ardour + * + * Welcome to the in-code documentation for Ardour. + * + * The main components of Ardour are as follows: + * - A GTK2 front-end, in \c gtk2_ardour. + * - libardour, the audio-processing back-end, in \c libs/ardour. + * - libpbd, a utility library, in \c libs/pbd. + * + * There are other assorted component libraries: + * - gtkmm2ext, an library of extensions to gtkmm2, in \c libs/gtkmm2ext. + * - and others... + */