bitmap-font

(bitmap-font)
(bitmap-font "default.fnt")

Options

:dispose

Disposes the texture used by this BitmapFont's region IF this BitmapFont created the texture.

:draw^Batch batch, ^CharSequence str, ^float x, ^float y

Draws text at the specified position.

:draw^Batch batch, ^CharSequence str, ^float x, ^float y, ^float target-width, ^int halign, ^boolean wrap

Draws text at the specified position.

:draw^Batch batch, ^CharSequence str, ^float x, ^float y, ^int start, ^int end, ^float target-width, ^int halign, ^boolean wrap

Draws text at the specified position.

:draw^Batch batch, ^CharSequence str, ^float x, ^float y, ^int start, ^int end, ^float target-width, ^int halign, ^boolean wrap, ^String truncate

Draws text at the specified position.

:draw^Batch batch, ^GlyphLayout layout, ^float x, ^float y

Draws text at the specified position.

:get-ascent

Returns the ascent, which is the distance from the cap height to the top of the tallest glyph.

:get-cache

For expert usage -- returns the BitmapFontCache used by this font, for rendering to a sprite batch. This can be used, for example, to manipulate glyph colors within a specific index.

:get-cap-height

Returns the cap height, which is the distance from the top of most uppercase characters to the baseline. Since the drawing position is the cap height of the first line, the cap height can be used to get the location of the baseline.

:get-color

Returns the color of text drawn with this font.

:get-data

Gets the underlying {@link BitmapFontData} for this BitmapFont.

:get-descent

Returns the descent, which is the distance from the bottom of the glyph that extends the lowest to the baseline. This number is negative.

:get-line-height

Returns the line height, which is the distance from one line of text to the next.

:get-region

Returns the first texture region. This is included for backwards compatibility, and for convenience since most fonts only use one texture page. For multi-page fonts, use {@link #getRegions()}.

:get-region^int index

Returns the texture page at the given index.

:get-regions

Returns the array of TextureRegions that represents each texture page of glyphs.

:get-scale-x

:get-scale-y

:get-space-width

Returns the width of the space character.

:get-x-height

Returns the x-height, which is the distance from the top of most lowercase characters to the baseline.

:is-flipped

Returns true if this BitmapFont has been flipped for use with a y-down coordinate system.

:new-font-cache

Creates a new BitmapFontCache for this font. Using this method allows the font to provide the BitmapFontCache implementation to customize rendering.

Note this method is called by the BitmapFont constructors. If a subclass overrides this method, it will be called before the subclass constructors.

:owns-texture

:set-color^Color color

A convenience method for setting the font color. The color can also be set by modifying {@link #getColor()}.

:set-color^float r, ^float g, ^float b, ^float a

A convenience method for setting the font color. The color can also be set by modifying {@link #getColor()}.

:set-fixed-width-glyphs^CharSequence glyphs

Makes the specified glyphs fixed width. This can be useful to make the numbers in a font fixed width. Eg, when horizontally centering a score or loading percentage text, it will not jump around as different numbers are shown.

:set-owns-texture^boolean owns-texture

Sets whether the font owns the texture. In case it does, the font will also dispose of the texture when {@link #dispose()} is called. Use with care!

:set-use-integer-positions^boolean integer

Specifies whether to use integer positions. Default is to use them so filtering doesn't kick in as badly.

:to-string

:uses-integer-positions

Checks whether this font uses integer positions for drawing.

Source

(defn bitmap-font*
  [^String path]
  (if (nil? path)
    (BitmapFont.)
    (or (u/load-asset path BitmapFont)
        (BitmapFont. (.internal (Gdx/files) path)))))

(defmacro bitmap-font
  [& [path & options]]
  `(let [^BitmapFont object# (bitmap-font* ~path)]
     (u/calls! object# ~@options)))