git.cworth.org Git - scherzo/blob - score.h

   1 /* scherzo - Music notation training
   2  *
   3  *      score - Utilities for drawing (simple) musical scores
   4  *
   5  * Copyright © 2010 Carl Worth
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see http://www.gnu.org/licenses/ .
  19  */
  20
  21 #ifndef SCORE_H
  22 #define SCORE_H
  23
  24 #include <talloc.h>
  25 #include <cairo.h>
  26
  27 typedef struct score score_t;
  28
  29 /* Allocate a new, empty score object, (with optional ctx as talloc
  30  * owner). If ctx is NULL, the caller should call talloc_free on the
  31  * score_t* when done with it. Otherwise, the object will be freed
  32  * when ctx is freed. */
  33 score_t *
  34 score_create (void *ctx);
  35
  36 /* Set an (approximate) staff height. The actual staff height may
  37  * differ due to rounding to achieve evenly spaced, sharply rendered
  38  * lines. the actual staff height is returned. */
  39 int
  40 score_set_staff_height (score_t *score, int height);
  41
  42 /* Set the total width available for drawing the score. */
  43 void
  44 score_set_width (score_t *score, int width);
  45
  46 /* Draw the given score_t onto the given cairo_t.
  47  *
  48  * The caller can call cairo_translate before calling score_draw to
  49  * position the result as desired, (and can call cairo_clip to clip it
  50  * if desired). */
  51 void
  52 score_draw (score_t *score, cairo_t *cr);
  53
  54 #endif