processing.core
Class PFont

java.lang.Object
  processing.core.PFont

All Implemented Interfaces:

PConstants

public class PFont
extends java.lang.Object
implements PConstants

Grayscale bitmap font class used by Processing.

Awful (and by that, I mean awesome) ascii (non)art for how this works:

   |
   |                   height is the full used height of the image
   |
   |   ..XX..       }
   |   ..XX..       }
   |   ......       }
   |   XXXX..       }  topExtent (top y is baseline - topExtent)
   |   ..XX..       }
   |   ..XX..       }  dotted areas are where the image data
   |   ..XX..       }  is actually located for the character
   +---XXXXXX----   }  (it extends to the right and down
   |                   for power of two texture sizes)
   ^^^^ leftExtent (amount to move over before drawing the image

   ^^^^^^^^^^^^^^ setWidth (width displaced by char)
 

charCount

public int charCount

images

public PImage[] images

name

public java.lang.String name

Name of the font as seen by Java when it was created. If the font is available, the native version will be used.

psname

public java.lang.String psname

Postscript name of the font that this bitmap was created from.

size

public int size

"natural" size of the font (most often 48)

smooth

public boolean smooth

true if smoothing was enabled for this font, used for native impl

mbox2

public int mbox2

next power of 2 over the max image size (usually 64)

twidth

public int twidth

texture width, same as mbox2, but reserved for future use

theight

public int theight

texture height, same as mbox2, but reserved for future use

value

public int[] value

height

public int[] height

width

public int[] width

setWidth

public int[] setWidth

topExtent

public int[] topExtent

leftExtent

public int[] leftExtent

ascent

public int ascent

descent

public int descent

DEFAULT_CHARSET

public static char[] DEFAULT_CHARSET

The default Processing character set.

This is the union of the Mac Roman and Windows ANSI (CP1250) character sets. ISO 8859-1 Latin 1 is Unicode characters 0x80 -> 0xFF, and would seem a good standard, but in practice, most P5 users would rather have characters that they expect from their platform's fonts.

This is more of an interim solution until a much better font solution can be determined. (i.e. create fonts on the fly from some sort of vector format).

Not that I expect that to happen.

PFont

public PFont()

PFont

public PFont(java.io.InputStream input)
      throws java.io.IOException

Throws:

java.io.IOException

PFont

public PFont(java.awt.Font font,
             boolean smooth,
             char[] charset)

Create a new image-based font on the fly.

Parameters:

font - the font object to create from

charset - array of all unicode chars that should be included

smooth - true to enable smoothing/anti-aliasing

setFont

public void setFont(java.awt.Font font)

Set the native complement of this font.

getFont

public java.awt.Font getFont()

Return the native java.awt.Font associated with this PFont (if any).

findFont

public java.awt.Font findFont()

Attempt to find the native version of this font. (Public so that it can be used by OpenGL or other renderers.)

save

public void save(java.io.OutputStream output)
          throws java.io.IOException

Write this PFont to an OutputStream.

This is used by the Create Font tool, or whatever anyone else dreams up for messing with fonts themselves.

It is assumed that the calling class will handle closing the stream when finished.

Throws:

java.io.IOException

index

public int index(char c)

Get index for the char (convert from unicode to bagel charset).

Returns:

index into arrays or -1 if not found

kern

public float kern(char a,
                  char b)

Currently un-implemented for .vlw fonts, but honored for layout in case subclasses use it.

ascent

public float ascent()

Returns the ascent of this font from the baseline. The value is based on a font of size 1.

descent

public float descent()

Returns how far this font descends from the baseline. The value is based on a font size of 1.

width

public float width(char c)

Width of this character for a font of size 1.

list

public static java.lang.String[] list()

Get a list of the fonts installed on the system that can be used by Java. Not all fonts can be used in Java, in fact it's mostly only TrueType fonts. OpenType fonts with CFF data such as Adobe's OpenType fonts seem to have trouble (even though they're sort of TrueType fonts as well, or may have a .ttf extension). Regular PostScript fonts seem to work OK, however.

Not recommended for use in applets, but this is implemented in PFont because the Java methods to access this information have changed between 1.1 and 1.4, and the 1.4 method is typical of the sort of undergraduate-level over-abstraction that the seems to have made its way into the Java API after 1.1.

loadFonts

public static void loadFonts()

findFont

public static java.awt.Font findFont(java.lang.String name)

Starting with Java 1.5, Apple broke the ability to specify most fonts. This has been filed as bug #4769141 at bugreporter.apple.com. More info at Bug 407.