Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.84 KB

hydra-text.md

File metadata and controls

52 lines (34 loc) · 1.84 KB

hydra-text

A text source for Hydra

hydraText

hydraText are the default settings for hydra-text, which you can change:

hydraText.font = "serif";

// these are the defaults:
window.hydraText = {
        font: "sans-serif",     // the font-family
        fontStyle: "normal",    // normal, bold, etc
        fontSize: "auto",       // must be either "auto", a percentage like "90%", or pixels like "100px" 
        textAlign: "center",    // center, left or right
        fillStyle: "white",     // a css color, CanvasGradient or CanvasPattern
        strokeStyle: "white",   // a css color, CanvasGradient or CanvasPattern
        lineWidth: "2%",        // a percentage of the final fontSize
        lineJoin: "miter",      // miter, bevel or round
        canvasResize: 2,        // a factor by which to resize the canvas that displays the text
        interpolation: "linear",// linear or nearest. represents the interpolation used inside hydra for the text's canvas
    };

Settings are set to a CanvasRenderingContext2D, find more about it here. However note that the hydra-text font setting doesn't work the same as the context's font property. On hydra-text, font should only specify the font-family. This is because it needs to do some resizing and measurements of the text before writing it while the context's font property allows you to resize it.

text

text( str, config )

  • str: the text you want to write
  • config: either an object with the properties you want to set, or a string with the font you want

strokeText

strokeText( str, config )

Same as text but draws the outline of the text instead

strokeFillText

strokeFillText( str, config )

Fill over stroke

fillStrokeText

fillStrokeText( str, config )

Stroke over fill