<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <!-- header_tag --> <html lang="en"> <head> <title>Internal backend properties - LilyPond program-reference</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="description" content="LilyPond program-reference"> <meta name="generator" content="makeinfo 4.11"> <link title="Top" rel="start" href="index.html#Top"> <link rel="up" href="Backend.html#Backend" title="Backend"> <link rel="prev" href="User-backend-properties.html#User-backend-properties" title="User backend properties"> <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> <meta http-equiv="Content-Style-Type" content="text/css"> <style type="text/css"><!-- pre.display { font-family:inherit } pre.format { font-family:inherit } pre.smalldisplay { font-family:inherit; font-size:smaller } pre.smallformat { font-family:inherit; font-size:smaller } pre.smallexample { font-size:smaller } pre.smalllisp { font-size:smaller } span.sc { font-variant:small-caps } span.roman { font-family:serif; font-weight:normal; } span.sansserif { font-family:sans-serif; font-weight:normal; } hr { border:0; height:1; color: #000000; background-color: #000000; } /* hr { border: none; height: 1px; color: #666666; background-color: #666666; } body { border-left: 1px solid #666666; border-right: 1px solid #666666; color: #332d28; margin-right: auto; margin-left: auto; width: 60em; list-style-type: square; font-family: Arial,Helvetica,sans-serif; padding-right: 1em; padding-left: 1em; } a { border-bottom: 1px dashed #344242; text-decoration: none; color: #344242; } a:link { text-decoration: none; } a:visited { border-bottom: 1px dashed #666666; color: #666666; } a:active { border-bottom: 1px solid #00cccc; color: #00cccc; } a:hover { border-bottom: 1px solid #1d7b85; color: #1d7b85; } blockquote { border: 1px solid #cccccc; padding: 3px; width: 40em; } .node { border-left: 1px solid #666666; margin: -0.5em 0px 1em; padding: 2px 1px 0px; font-style: italic; } .node a { border: none; text-decoration: underline; font-style: normal; font-weight: bold; } .verbatim { font-family: "Courier New",Courier,monospace; } .unnumberedsubsubsec { font-size: large; color: #1d7b85; } .subsubheading { font-size: large; color: #3b220d; } .contents { border: 1px dashed #339999; margin: 3px 2em; list-style-type: square; padding-right: 1em; width: 40em; background-color: #fcfff9; } .contents a { border-bottom: 1px dashed #423d34; text-decoration: none; color: #423d34; } .contents a:visited { border-bottom: 1px dashed #666666; color: #666666; } .contents a:active { border-bottom: 1px solid #f0d86d; color: #f0d86d; } .contents a:hover { border-bottom: 1px solid #3b220d; color: #3b220d; } .menu { border-left: 1px dashed #339999; margin: 3px 2em 1em; list-style-type: square; padding-left: 1.4em; width: 40em; } .unnumbered { } h2 { font-size: x-large; color: #1d7b85; } */ --></style> </head> <BODY BGCOLOR=WHITE TEXT=BLACK> <div class="node"> <p> <a name="Internal-backend-properties"></a> Previous: <a rel="previous" accesskey="p" href="User-backend-properties.html#User-backend-properties">User backend properties</a>, Up: <a rel="up" accesskey="u" href="Backend.html#Backend">Backend</a> <hr> </div> <h3 class="unnumberedsec">Internal backend properties</h3> <dl> <dt><code>X-common</code> (layout object)<dd>Common reference point for axis group. <br><dt><code>Y-common</code> (layout object)<dd>See <code>X-common</code>. <br><dt><code>accidental-grob</code> (layout object)<dd>The accidental for this note. <br><dt><code>accidental-grobs</code> (list)<dd>An alist with <code>(</code><var>notename</var><code> . </code><var>groblist</var><code>)</code> entries. <br><dt><code>add-cauda</code> (boolean)<dd>Does this flexa require an additional cauda on the left side? <br><dt><code>add-join</code> (boolean)<dd>Is this ligature head-joined with the next one by a vertical line? <br><dt><code>add-stem</code> (boolean)<dd>Is this ligature head a virga and therefore needs an additional stem on the right side? <br><dt><code>adjacent-hairpins</code> (unknown)<dd>A list of directly neighboring hairpins. <br><dt><code>adjacent-pure-heights</code> (vector)<dd>Used by a <code>VerticalAxisGroup</code> to cache the <code>Y-extent</code>s of different column ranges. <br><dt><code>all-elements</code> (unknown)<dd>A list of all grobs in this line. Its function is to protect objects from being garbage collected. <br><dt><code>arpeggio</code> (layout object)<dd>A pointer to an <code>Arpeggio</code> object. <br><dt><code>ascendens</code> (boolean)<dd>Is this neume of ascending type? <br><dt><code>auctum</code> (boolean)<dd>Is this neume liquescentically augmented? <br><dt><code>axis-group-parent-X</code> (layout object)<dd>Containing X axis group. <br><dt><code>axis-group-parent-Y</code> (layout object)<dd>Containing Y axis group. <br><dt><code>bar-extent</code> (pair of numbers)<dd>The Y-extent of the actual bar line. This may differ from <code>Y-extent</code> because it does not include the dots in a repeat bar line. <br><dt><code>bars</code> (unknown)<dd>A list of bar line pointers. <br><dt><code>beam</code> (layout object)<dd>A pointer to the beam, if applicable. <br><dt><code>begin-of-line-visible</code> (boolean)<dd>Used for marking <code>ChordNames</code> that should only show changes. <br><dt><code>bounded-by-me</code> (unknown)<dd>A list of spanners that have this column as start/begin point. Only columns that have grobs or act as bounds are spaced. <br><dt><code>bracket</code> (layout object)<dd>The bracket for a number. <br><dt><code>cause</code> (any type)<dd>Any kind of causation objects (i.e., music, or perhaps translator) that was the cause for this grob. <br><dt><code>cavum</code> (boolean)<dd>Is this neume outlined? <br><dt><code>circled-tip</code> (boolean)<dd>Put a circle at start/end of hairpins (al/del niente). <br><dt><code>columns</code> (unknown)<dd>A list of grobs, typically containing <code>PaperColumn</code> or <code>NoteColumn</code> objects. <br><dt><code>conditional-elements</code> (unknown)<dd>Internal use only. <br><dt><code>context-info</code> (integer)<dd>Within a ligature, the final glyph or shape of a head may be affected by the left and/or right neighbour head. <code>context-info</code> holds for each head such information about the left and right neighbour, encoded as a bit mask. <br><dt><code>cross-staff</code> (boolean)<dd>For a beam or a stem, this is true if we depend on inter-staff spacing. <br><dt><code>delta-position</code> (number)<dd>The vertical position difference. <br><dt><code>deminutum</code> (boolean)<dd>Is this neume deminished? <br><dt><code>descendens</code> (boolean)<dd>Is this neume of descendent type? <br><dt><code>details</code> (list)<dd>Alist of parameters for detailed grob behavior. <p>More information on the allowed parameters can be found by inspecting <samp><span class="file">lily/slur-scoring.cc</span></samp>, <samp><span class="file">lily/beam-quanting.cc</span></samp>, and <samp><span class="file">lily/tie-formatting-problem.cc</span></samp>. Setting <code>debug-tie-scoring</code>, <code>debug-beam-scoring</code> or <code>debug-slur-scoring</code> also provides useful clues. <br><dt><code>direction-source</code> (layout object)<dd>In case <code>side-relative-direction</code> is set, which grob to get the direction from. <br><dt><code>dot</code> (layout object)<dd>A reference to a <code>Dots</code> object. <br><dt><code>dots</code> (unknown)<dd>Multiple <code>Dots</code> objects. <br><dt><code>elements</code> (unknown)<dd>A list of grobs; the type is depending on the grob where this is set in. <br><dt><code>encompass-objects</code> (unknown)<dd>Objects that a slur should avoid in addition to notes and stems. <br><dt><code>figures</code> (unknown)<dd>Figured bass objects for continuation line. <br><dt><code>flexa-height</code> (dimension, in staff space)<dd>The height of a flexa shape in a ligature grob (in <code>staff-space</code> units). <br><dt><code>flexa-width</code> (dimension, in staff space)<dd>The width of a flexa shape in a ligature grob in (in <code>staff-space</code> units). <br><dt><code>font</code> (font metric)<dd>A cached font metric object. <br><dt><code>glyph-name</code> (string)<dd>The glyph name within the font. <br><dt><code>grace-spacing</code> (layout object)<dd>A run of grace notes. <br><dt><code>head-width</code> (dimension, in staff space)<dd>The width of this ligature head. <br><dt><code>heads</code> (unknown)<dd>A list of note heads. <br><dt><code>ideal-distances</code> (list)<dd><code>(</code><var>obj</var><code> . (</code><var>dist</var><code> . </code><var>strength</var><code>))</code> pairs. <br><dt><code>important-column-ranks</code> (vector)<dd>A cache of columns that contain <code>items-worth-living</code> data. <br><dt><code>inclinatum</code> (boolean)<dd>Is this neume an inclinatum? <br><dt><code>interfaces</code> (list)<dd>A list of symbols indicating the interfaces supported by this object. It is initialized from the <code>meta</code> field. <br><dt><code>items-worth-living</code> (unknown)<dd>A list of interesting items. If empty in a particular staff, then that staff is erased. <br><dt><code>join-heads</code> (boolean)<dd>Whether to join the note heads of an ambitus grob with a vertical line. <br><dt><code>join-right-amount</code> (number)<dd>DOCME <br><dt><code>least-squares-dy</code> (number)<dd>The ideal beam slope, without damping. <br><dt><code>left-items</code> (unknown)<dd>DOCME <br><dt><code>left-neighbors</code> (unknown)<dd>A list of <code>spacing-wishes</code> grobs that are close to the current column. <p>The closest <code>spacing-wishes</code> determine the actual distances between the columns. <br><dt><code>linea</code> (boolean)<dd>Attach vertical lines to this neume? <br><dt><code>meta</code> (list)<dd>Provide meta information. It is an alist with the entries <code>name</code> and <code>interfaces</code>. <br><dt><code>minimum-distances</code> (list)<dd>A list of rods that have the format <code>(</code><var>obj</var><code> . </code><var>dist</var><code>)</code>. <br><dt><code>normal-stems</code> (unknown)<dd>An array of visible stems. <br><dt><code>note-columns</code> (pair)<dd>A list of <code>NoteColumn</code> grobs. <br><dt><code>note-head</code> (layout object)<dd>A single note head. <br><dt><code>note-heads</code> (unknown)<dd>A list of note head grobs. <br><dt><code>oriscus</code> (boolean)<dd>Is this neume an oriscus? <br><dt><code>padding-pairs</code> (list)<dd>An alist mapping <code>(</code><var>name</var><code> . </code><var>name</var><code>)</code> to distances. <br><dt><code>pedal-text</code> (layout object)<dd>A pointer to the text of a mixed-style piano pedal. <br><dt><code>pes-or-flexa</code> (boolean)<dd>Shall this neume be joined with the previous head? <br><dt><code>positioning-done</code> (boolean)<dd>Used to signal that a positioning element did its job. This ensures that a positioning is only done once. <br><dt><code>prefix-set</code> (number)<dd>A bit mask that holds all Gregorian head prefixes, such as <code>\virga</code> or <code>\quilisma</code>. <br><dt><code>primitive</code> (integer)<dd>A pointer to a ligature primitive, i.e., an item similar to a note head that is part of a ligature. <br><dt><code>pure-Y-common</code> (layout object)<dd>A cache of the <code>common_refpoint_of_array</code> of the <code>elements</code> grob set. <br><dt><code>pure-Y-extent</code> (pair of numbers)<dd>The estimated height of a system. <br><dt><code>pure-Y-offset-in-progress</code> (boolean)<dd>A debugging aid for catching cyclic dependencies. <br><dt><code>pure-relevant-items</code> (unknown)<dd>A subset of elements that are relevant for finding the <code>pure-Y-extent</code>. <br><dt><code>pure-relevant-spanners</code> (unknown)<dd>A subset of elements that are relevant for finding the <code>pure-Y-extent</code>. <br><dt><code>quant-score</code> (string)<dd>The beam quanting score; stored for debugging. <br><dt><code>quantize-position</code> (boolean)<dd>If set, a vertical alignment is aligned to be within staff spaces. <br><dt><code>quantized-positions</code> (pair of numbers)<dd>The beam positions after quanting. <br><dt><code>quilisma</code> (boolean)<dd>Is this neume a quilisma? <br><dt><code>rest</code> (layout object)<dd>A pointer to a <code>Rest</code> object. <br><dt><code>rest-collision</code> (layout object)<dd>A rest collision that a rest is in. <br><dt><code>rests</code> (unknown)<dd>A list of rest objects. <br><dt><code>right-items</code> (unknown)<dd>DOCME <br><dt><code>right-neighbors</code> (unknown)<dd>See <code>left-neighbors</code>. <br><dt><code>script-stencil</code> (pair)<dd>A pair <code>(</code><var>type</var><code> . </code><var>arg</var><code>)</code> which acts as an index for looking up a <code>Stencil</code> object. <br><dt><code>separation-item</code> (layout object)<dd>A separation item. <br><dt><code>shorten</code> (dimension, in staff space)<dd>The amount of space that a stem is shortened. Internally used to distribute beam shortening over stems. <br><dt><code>side-support-elements</code> (unknown)<dd>The side support, a list of grobs. <br><dt><code>skyline-distance</code> (number)<dd>The distance between this staff and the next one, as determined by a skyline algorithm. <br><dt><code>skyline-horizontal-padding</code> (number)<dd>For determining the vertical distance between two staves, it is possible to have a configuration which would result in a tight interleaving of grobs from the top staff and the bottom staff. The larger this parameter is, the farther apart the staves are placed in such a configuration. <br><dt><code>slur</code> (layout object)<dd>A pointer to a <code>Slur</code> object. <br><dt><code>spaceable-staves</code> (unknown)<dd>Objects to be spaced during page layout. <br><dt><code>spacing</code> (layout object)<dd>The spacing spanner governing this section. <br><dt><code>spacing-wishes</code> (unknown)<dd>List of note spacing or staff spacing objects. <br><dt><code>staff-symbol</code> (layout object)<dd>The staff symbol grob that we are in. <br><dt><code>stem</code> (layout object)<dd>A pointer to a <code>Stem</code> object. <br><dt><code>stem-info</code> (pair)<dd>A cache of stem parameters. <br><dt><code>stems</code> (unknown)<dd>A list of stem objects, corresponding to the notes that the arpeggio has to be before. <br><dt><code>stropha</code> (boolean)<dd>Is this neume a stropha? <br><dt><code>tie</code> (layout object)<dd>A pointer to a <code>Tie</code> object. <br><dt><code>tremolo-flag</code> (layout object)<dd>The tremolo object on a stem. <br><dt><code>tuplet-number</code> (layout object)<dd>The number for a bracket. <br><dt><code>tuplets</code> (unknown)<dd>A list of smaller tuplet brackets. <br><dt><code>use-breve-rest</code> (boolean)<dd>Use breve rests for measures longer than a whole rest. <br><dt><code>virga</code> (boolean)<dd>Is this neume a virga? <br><dt><code>x-offset</code> (dimension, in staff space)<dd>Extra horizontal offset for ligature heads. </dl> <!-- footer_tag --><br><hr> <div class="node"> <p> Previous: <a rel="previous" accesskey="p" href="User-backend-properties.html#User-backend-properties">User backend properties</a>, Up: <a rel="up" accesskey="u" href="Backend.html#Backend">Backend</a> </div> <div style="background-color: #e8ffe8; padding: 2; border: #c0ffc0 1px solid;"> <p> <font size="-1"> This page is for LilyPond-2.11.57 (development-branch). <br> <address> Report errors to <a href="http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs">http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs</a>. </address> <br> Your <a href="http://lilypond.org/web/devel/participating/documentation-adding">suggestions for the documentation</a> are welcome. </font> </p> </div> </BODY></html>