The 3b-bmfont Reference Manual

Table of Contents

The 3b-bmfont Reference Manual

This is the 3b-bmfont Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 13:56:54 2021 GMT+0.

1 Introduction

readers/writers for bmfont metadata file formats

currently reads/writes text and xml formats, and bmfont-like json format used by some js libs. Tries to handle some extensions, including distanceField used by msdf-bmfont-xml.

API will probably change, file an issue or tell me on IRC if you want a stable API sooner.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 3b-bmfont

Author

Bart Botta

License

MIT

Description

BMFont file format readers/writers

Version

0.0.1

Dependency

3b-bmfont/text (system)

Source

3b-bmfont.asd (file)

Components

• package.lisp (file)
• bmfont.lisp (file)

2.2 3b-bmfont/text

Author

Bart Botta

License

MIT

Description

Load/Save BMFont text format

Dependency

3b-bmfont/common (system)

Source

3b-bmfont.asd (file)

Components

• package.lisp (file)
• bmfont-text.lisp (file)

2.3 3b-bmfont/common

Author

Bart Botta

License

MIT

Dependencies

• alexandria
• split-sequence

Source

3b-bmfont.asd (file)

Components

• package.lisp (file)
• common.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 3b-bmfont.asd

Location

3b-bmfont.asd

Systems

• 3b-bmfont (system)
• 3b-bmfont/text (system)
• 3b-bmfont/common (system)

3.1.2 3b-bmfont/package.lisp

Parent

3b-bmfont (system)

Location

package.lisp

Packages

• 3b-bmfont-common
• 3b-bmfont-text
• 3b-bmfont-json
• 3b-bmfont
• 3b-bmfont-xml

3.1.3 3b-bmfont/bmfont.lisp

Parent

3b-bmfont (system)

Location

bmfont.lisp

Exported Definitions

• map-glyphs (function)
• measure-glyphs (function)
• read-bmfont (function)
• write-bmfont (function)

Internal Definitions

• char-data (function)
• fs (function)
• space-size (function)

3.1.4 3b-bmfont/text/package.lisp

Parent

3b-bmfont/text (system)

Location

package.lisp

Packages

• 3b-bmfont-common
• 3b-bmfont-text
• 3b-bmfont-json
• 3b-bmfont
• 3b-bmfont-xml

3.1.5 3b-bmfont/text/bmfont-text.lisp

Parent

3b-bmfont/text (system)

Location

bmfont-text.lisp

Exported Definitions

• read-bmfont-text (function)
• write-bmfont-text (function)

Internal Definitions

• *font* (special variable)
• add-line (function)
• tokenize-line (function)

3.1.6 3b-bmfont/common/package.lisp

Parent

3b-bmfont/common (system)

Location

package.lisp

Packages

• 3b-bmfont-common
• 3b-bmfont-text
• 3b-bmfont-json
• 3b-bmfont
• 3b-bmfont-xml

3.1.7 3b-bmfont/common/common.lisp

Parent

3b-bmfont/common (system)

Location

common.lisp

Exported Definitions

• *filters* (special variable)
• aa (method)
• (setf aa) (method)
• alpha-chnl (method)
• (setf alpha-chnl) (method)
• base (method)
• (setf base) (method)
• blue-chnl (method)
• (setf blue-chnl) (method)
• bmfont (class)
• bold (method)
• (setf bold) (method)
• char-id (function)
• chars (method)
• (setf chars) (method)
• charset (method)
• (setf charset) (method)
• distance-field (method)
• (setf distance-field) (method)
• face (method)
• (setf face) (method)
• filter-plist (function)
• green-chnl (method)
• (setf green-chnl) (method)
• italic (method)
• (setf italic) (method)
• kernings (method)
• (setf kernings) (method)
• line-height (method)
• (setf line-height) (method)
• make-chars-hash (function)
• make-kerning-hash (function)
• make-keyword (function)
• packed (method)
• (setf packed) (method)
• padding (method)
• (setf padding) (method)
• pages (method)
• (setf pages) (method)
• red-chnl (method)
• (setf red-chnl) (method)
• remap-char (function)
• scale-h (method)
• (setf scale-h) (method)
• scale-w (method)
• (setf scale-w) (method)
• size (method)
• (setf size) (method)
• smooth (method)
• (setf smooth) (method)
• spacing (method)
• (setf spacing) (method)
• stretch-h (method)
• (setf stretch-h) (method)
• unicode (method)
• (setf unicode) (method)

Internal Definitions

• char0 (function)
• int (function)
• int-bool (function)
• int-chnl (function)
• int-list (function)

4 Packages

Packages are listed by definition order.

4.1 3b-bmfont-common

Source

package.lisp (file)

Use List

common-lisp

Used By List

• 3b-bmfont
• 3b-bmfont-json
• 3b-bmfont-text
• 3b-bmfont-xml

Exported Definitions

• *filters* (special variable)
• aa (generic function)
• aa (method)
• (setf aa) (method)
• (setf aa) (generic function)
• alpha-chnl (generic function)
• alpha-chnl (method)
• (setf alpha-chnl) (method)
• (setf alpha-chnl) (generic function)
• base (generic function)
• base (method)
• (setf base) (method)
• (setf base) (generic function)
• blue-chnl (generic function)
• blue-chnl (method)
• (setf blue-chnl) (method)
• (setf blue-chnl) (generic function)
• bmfont (class)
• bold (generic function)
• bold (method)
• (setf bold) (method)
• (setf bold) (generic function)
• char-id (function)
• chars (generic function)
• chars (method)
• (setf chars) (method)
• (setf chars) (generic function)
• charset (generic function)
• charset (method)
• (setf charset) (method)
• (setf charset) (generic function)
• distance-field (generic function)
• distance-field (method)
• (setf distance-field) (method)
• (setf distance-field) (generic function)
• face (generic function)
• face (method)
• (setf face) (method)
• (setf face) (generic function)
• filter-plist (function)
• green-chnl (generic function)
• green-chnl (method)
• (setf green-chnl) (method)
• (setf green-chnl) (generic function)
• italic (generic function)
• italic (method)
• (setf italic) (method)
• (setf italic) (generic function)
• kernings (generic function)
• kernings (method)
• (setf kernings) (method)
• (setf kernings) (generic function)
• line-height (generic function)
• line-height (method)
• (setf line-height) (method)
• (setf line-height) (generic function)
• make-chars-hash (function)
• make-kerning-hash (function)
• make-keyword (function)
• packed (generic function)
• packed (method)
• (setf packed) (method)
• (setf packed) (generic function)
• padding (generic function)
• padding (method)
• (setf padding) (method)
• (setf padding) (generic function)
• pages (generic function)
• pages (method)
• (setf pages) (method)
• (setf pages) (generic function)
• red-chnl (generic function)
• red-chnl (method)
• (setf red-chnl) (method)
• (setf red-chnl) (generic function)
• remap-char (function)
• scale-h (generic function)
• scale-h (method)
• (setf scale-h) (method)
• (setf scale-h) (generic function)
• scale-w (generic function)
• scale-w (method)
• (setf scale-w) (method)
• (setf scale-w) (generic function)
• size (generic function)
• size (method)
• (setf size) (method)
• (setf size) (generic function)
• smooth (generic function)
• smooth (method)
• (setf smooth) (method)
• (setf smooth) (generic function)
• spacing (generic function)
• spacing (method)
• (setf spacing) (method)
• (setf spacing) (generic function)
• stretch-h (generic function)
• stretch-h (method)
• (setf stretch-h) (method)
• (setf stretch-h) (generic function)
• unicode (generic function)
• unicode (method)
• (setf unicode) (method)
• (setf unicode) (generic function)

Internal Definitions

• char0 (function)
• int (function)
• int-bool (function)
• int-chnl (function)
• int-list (function)

4.2 3b-bmfont-text

Source

package.lisp (file)

Use List

• 3b-bmfont-common
• common-lisp

Exported Definitions

• read-bmfont-text (function)
• write-bmfont-text (function)

Internal Definitions

• *font* (special variable)
• add-line (function)
• tokenize-line (function)

4.3 3b-bmfont-json

Source

package.lisp (file)

Use List

• 3b-bmfont-common
• common-lisp

4.4 3b-bmfont

Source

package.lisp (file)

Use List

• 3b-bmfont-common
• common-lisp

Exported Definitions

• map-glyphs (function)
• measure-glyphs (function)
• read-bmfont (function)
• write-bmfont (function)

Internal Definitions

• char-data (function)
• fs (function)
• space-size (function)

4.5 3b-bmfont-xml

Source

package.lisp (file)

Use List

• 3b-bmfont-common
• common-lisp

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *filters*

Package

3b-bmfont-common

Source

common.lisp (file)

5.1.2 Functions

Function: char-id C &optional CC

Package

3b-bmfont-common

Source

common.lisp (file)

Function: filter-plist PLIST MAPPING

Package

3b-bmfont-common

Source

common.lisp (file)

Function: make-chars-hash INFO CHARS

Package

3b-bmfont-common

Source

common.lisp (file)

Function: make-kerning-hash INFO CHARS KERNINGS

Package

3b-bmfont-common

Source

common.lisp (file)

Function: make-keyword X

Package

3b-bmfont-common

Source

common.lisp (file)

Function: map-glyphs FONT FUNCTION STRING &key MODEL-Y-UP TEXTURE-Y-UP START END

Package

3b-bmfont

Source

bmfont.lisp (file)

Function: measure-glyphs FONT STRING &key START END

Package

3b-bmfont

Source

bmfont.lisp (file)

Function: read-bmfont FILENAME

Package

3b-bmfont

Source

bmfont.lisp (file)

Function: read-bmfont-text STREAM

Package

3b-bmfont-text

Source

bmfont-text.lisp (file)

Function: remap-char C

Package

3b-bmfont-common

Source

common.lisp (file)

Function: write-bmfont FONT FILENAME &key TYPE

Package

3b-bmfont

Source

bmfont.lisp (file)

Function: write-bmfont-text F STREAM

Package

3b-bmfont-text

Source

bmfont-text.lisp (file)

5.1.3 Generic functions

Generic Function: aa OBJECT

Generic Function: (setf aa) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: aa (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf aa) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: alpha-chnl OBJECT

Generic Function: (setf alpha-chnl) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: alpha-chnl (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf alpha-chnl) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: base OBJECT

Generic Function: (setf base) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: base (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf base) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: blue-chnl OBJECT

Generic Function: (setf blue-chnl) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: blue-chnl (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf blue-chnl) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: bold OBJECT

Generic Function: (setf bold) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: bold (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf bold) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: chars OBJECT

Generic Function: (setf chars) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: chars (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf chars) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: charset OBJECT

Generic Function: (setf charset) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: charset (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf charset) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: distance-field OBJECT

Generic Function: (setf distance-field) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: distance-field (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf distance-field) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: face OBJECT

Generic Function: (setf face) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: face (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf face) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: green-chnl OBJECT

Generic Function: (setf green-chnl) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: green-chnl (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf green-chnl) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: italic OBJECT

Generic Function: (setf italic) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: italic (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf italic) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: kernings OBJECT

Generic Function: (setf kernings) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: kernings (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf kernings) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: line-height OBJECT

Generic Function: (setf line-height) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: line-height (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf line-height) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: packed OBJECT

Generic Function: (setf packed) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: packed (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf packed) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: padding OBJECT

Generic Function: (setf padding) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: padding (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf padding) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: pages OBJECT

Generic Function: (setf pages) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: pages (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf pages) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: red-chnl OBJECT

Generic Function: (setf red-chnl) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: red-chnl (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf red-chnl) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: scale-h OBJECT

Generic Function: (setf scale-h) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: scale-h (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf scale-h) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: scale-w OBJECT

Generic Function: (setf scale-w) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: scale-w (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf scale-w) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: size OBJECT

Generic Function: (setf size) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: size (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf size) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: smooth OBJECT

Generic Function: (setf smooth) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: smooth (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf smooth) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: spacing OBJECT

Generic Function: (setf spacing) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: spacing (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf spacing) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: stretch-h OBJECT

Generic Function: (setf stretch-h) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: stretch-h (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf stretch-h) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

Generic Function: unicode OBJECT

Generic Function: (setf unicode) NEW-VALUE OBJECT

Package

3b-bmfont-common

Methods

Method: unicode (BMFONT bmfont)

automatically generated reader method

Source

common.lisp (file)

Method: (setf unicode) NEW-VALUE (BMFONT bmfont)

automatically generated writer method

Source

common.lisp (file)

5.1.4 Classes

Class: bmfont ()

Package

3b-bmfont-common

Source

common.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• distance-field (method)
• distance-field (method)
• kernings (method)
• kernings (method)
• pages (method)
• pages (method)
• chars (method)
• chars (method)
• blue-chnl (method)
• blue-chnl (method)
• green-chnl (method)
• green-chnl (method)
• red-chnl (method)
• red-chnl (method)
• alpha-chnl (method)
• alpha-chnl (method)
• packed (method)
• packed (method)
• scale-h (method)
• scale-h (method)
• scale-w (method)
• scale-w (method)
• base (method)
• base (method)
• line-height (method)
• line-height (method)
• spacing (method)
• spacing (method)
• padding (method)
• padding (method)
• aa (method)
• aa (method)
• smooth (method)
• smooth (method)
• stretch-h (method)
• stretch-h (method)
• charset (method)
• charset (method)
• unicode (method)
• unicode (method)
• italic (method)
• italic (method)
• bold (method)
• bold (method)
• size (method)
• size (method)
• face (method)
• face (method)

Direct slots

Slot: face

Initargs

:face

Readers

face (generic function)

Writers

(setf face) (generic function)

Slot: size

Initargs

:size

Readers

size (generic function)

Writers

(setf size) (generic function)

Slot: bold

Initargs

:bold

Readers

bold (generic function)

Writers

(setf bold) (generic function)

Slot: italic

Initargs

:italic

Readers

italic (generic function)

Writers

(setf italic) (generic function)

Slot: unicode

Initargs

:unicode

Initform

t

Readers

unicode (generic function)

Writers

(setf unicode) (generic function)

Slot: charset

Initargs

:charset

Initform

""

Readers

charset (generic function)

Writers

(setf charset) (generic function)

Slot: stretch-h

Initargs

:stretch-h

Initform

100

Readers

stretch-h (generic function)

Writers

(setf stretch-h) (generic function)

Slot: smooth

Initargs

:smooth

Readers

smooth (generic function)

Writers

(setf smooth) (generic function)

Slot: aa

Initargs

:aa

Readers

aa (generic function)

Writers

(setf aa) (generic function)

Slot: padding

Initargs

:padding

Initform

(quote (0 0 0 0))

Readers

padding (generic function)

Writers

(setf padding) (generic function)

Slot: spacing

Initargs

:spacing

Initform

(quote (0 0))

Readers

spacing (generic function)

Writers

(setf spacing) (generic function)

Slot: line-height

Initargs

:line-height

Readers

line-height (generic function)

Writers

(setf line-height) (generic function)

Slot: base

Initargs

:base

Readers

base (generic function)

Writers

(setf base) (generic function)

Slot: scale-w

Initargs

:scale-w

Readers

scale-w (generic function)

Writers

(setf scale-w) (generic function)

Slot: scale-h

Initargs

:scale-h

Readers

scale-h (generic function)

Writers

(setf scale-h) (generic function)

Slot: packed

Initargs

:packed

Readers

packed (generic function)

Writers

(setf packed) (generic function)

Slot: alpha-chnl

Initargs

:alpha-chnl

Initform

:glyph

Readers

alpha-chnl (generic function)

Writers

(setf alpha-chnl) (generic function)

Slot: red-chnl

Initargs

:red-chnl

Initform

:glyph

Readers

red-chnl (generic function)

Writers

(setf red-chnl) (generic function)

Slot: green-chnl

Initargs

:green-chnl

Initform

:glyph

Readers

green-chnl (generic function)

Writers

(setf green-chnl) (generic function)

Slot: blue-chnl

Initargs

:blue-chnl

Initform

:glyph

Readers

blue-chnl (generic function)

Writers

(setf blue-chnl) (generic function)

Slot: chars

Initargs

:chars

Readers

chars (generic function)

Writers

(setf chars) (generic function)

Slot: pages

Initargs

:pages

Readers

pages (generic function)

Writers

(setf pages) (generic function)

Slot: kernings

Initargs

:kernings

Initform

(make-hash-table :test (quote equal))

Readers

kernings (generic function)

Writers

(setf kernings) (generic function)

Slot: distance-field

Initargs

:distance-field

Readers

distance-field (generic function)

Writers

(setf distance-field) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *font*

Package

3b-bmfont-text

Source

bmfont-text.lisp (file)

5.2.2 Functions

Function: add-line TAG VALUES

Package

3b-bmfont-text

Source

bmfont-text.lisp (file)

Function: char-data CHAR FONT

Package

3b-bmfont

Source

bmfont.lisp (file)

Function: char0 X

Package

3b-bmfont-common

Source

common.lisp (file)

Function: fs F P

Package

3b-bmfont

Source

bmfont.lisp (file)

Function: int X

Package

3b-bmfont-common

Source

common.lisp (file)

Function: int-bool X

Package

3b-bmfont-common

Source

common.lisp (file)

Function: int-chnl X

Package

3b-bmfont-common

Source

common.lisp (file)

Function: int-list X

Package

3b-bmfont-common

Source

common.lisp (file)

Function: space-size FONT

Package

3b-bmfont

Source

bmfont.lisp (file)

Function: tokenize-line LINE

Package

3b-bmfont-text

Source

bmfont-text.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types