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)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class PFont.Glyph
A single character, and its visage.

Nested Classes
Modifier and Type	Class and Description
`class`	`PFont.Glyph` A single character, and its visage.

Field Summary

Fields
Modifier and Type Field and Description

static char[] CHARSET
The default Processing character set.
- Fields inherited from interface processing.core.PConstants
  ADD, ALPHA, ALT, AMBIENT, ARC, ARGB, ARROW, BACKSPACE, BASELINE, BEVEL, BEZIER_VERTEX, BLEND, BLUR, BOTTOM, BOX, BREAK, BURN, CENTER, CHATTER, CHORD, CLAMP, CLOSE, CODED, COMPLAINT, CONTROL, CORNER, CORNERS, CROSS, CURVE_VERTEX, CUSTOM, DARKEST, DEG_TO_RAD, DELETE, DIAMETER, DIFFERENCE, DILATE, DIRECTIONAL, DISABLE_DEPTH_MASK, DISABLE_DEPTH_SORT, DISABLE_DEPTH_TEST, DISABLE_NATIVE_FONTS, DISABLE_OPENGL_ERRORS, DISABLE_OPTIMIZED_STROKE, DISABLE_STROKE_PERSPECTIVE, DISABLE_STROKE_PURE, DISABLE_TEXTURE_MIPMAPS, DODGE, DOWN, DXF, ELLIPSE, ENABLE_DEPTH_MASK, ENABLE_DEPTH_SORT, ENABLE_DEPTH_TEST, ENABLE_NATIVE_FONTS, ENABLE_OPENGL_ERRORS, ENABLE_OPTIMIZED_STROKE, ENABLE_STROKE_PERSPECTIVE, ENABLE_STROKE_PURE, ENABLE_TEXTURE_MIPMAPS, ENTER, EPSILON, ERODE, ERROR_BACKGROUND_IMAGE_FORMAT, ERROR_BACKGROUND_IMAGE_SIZE, ERROR_PUSHMATRIX_OVERFLOW, ERROR_PUSHMATRIX_UNDERFLOW, ERROR_TEXTFONT_NULL_PFONT, ESC, EXCLUSION, GIF, GRAY, GROUP, HALF_PI, HAND, HARD_LIGHT, HINT_COUNT, HSB, IMAGE, INVERT, JAVA2D, JPEG, LANDSCAPE, LEFT, LIGHTEST, LINE, LINE_LOOP, LINE_STRIP, LINES, LINUX, MACOSX, MAX_FLOAT, MAX_INT, MIN_FLOAT, MIN_INT, MITER, MODEL, MODELVIEW, MOVE, MULTIPLY, NORMAL, OPAQUE, OPEN, OPENGL, ORTHOGRAPHIC, OTHER, OVERLAY, P2D, P3D, PATH, PDF, PERSPECTIVE, PI, PIE, platformNames, POINT, POINTS, POLYGON, PORTRAIT, POSTERIZE, PROBLEM, PROJECT, PROJECTION, QUAD, QUAD_BEZIER_VERTEX, QUAD_STRIP, QUADS, QUARTER_PI, RAD_TO_DEG, RADIUS, RECT, REPEAT, REPLACE, RETURN, RGB, RIGHT, ROUND, SCREEN, SHAPE, SHIFT, SOFT_LIGHT, SPHERE, SPOT, SQUARE, SUBTRACT, TAB, TARGA, TEXT, THIRD_PI, THRESHOLD, TIFF, TOP, TRIANGLE, TRIANGLE_FAN, TRIANGLE_STRIP, TRIANGLES, TWO_PI, UP, VERTEX, WAIT, WHITESPACE, WINDOWS, X, Y, Z

Fields
Modifier and Type	Field and Description
`static char[]`	`CHARSET` The default Processing character set.

Constructor Summary

Constructors
Constructor and Description
`PFont()` for subclasses that need to store metadata about the font
`PFont(java.awt.Font font, boolean smooth)` ( begin auto-generated from PFont.xml ) PFont is the font class for Processing.
`PFont(java.awt.Font font, boolean smooth, char[] charset)` Create a new image-based font on the fly.
`PFont(java.awt.Font font, boolean smooth, char[] charset, boolean stream)` Adds an additional parameter that indicates the font came from a file, not a built-in OS font.
`PFont(java.io.InputStream input)`

Method Summary

Methods
Modifier and Type	Method and Description
`float`	`ascent()` Returns the ascent of this font from the baseline.
`float`	`descent()` Returns how far this font descends from the baseline.
`static java.awt.Font`	`findFont(java.lang.String name)` Starting with Java 1.5, Apple broke the ability to specify most fonts.
`java.lang.Object`	`findNative()` Attempt to find the native version of this font.
`java.awt.Font`	`getFont()` Deprecated.
`PFont.Glyph`	`getGlyph(char c)`
`PFont.Glyph`	`getGlyph(int i)`
`int`	`getGlyphCount()`
`java.lang.String`	`getName()`
`java.lang.Object`	`getNative()` Return the native java.awt.Font associated with this PFont (if any).
`java.lang.String`	`getPostScriptName()`
`int`	`getSize()` Return size of this font.
`boolean`	`isStream()`
`float`	`kern(char a, char b)` Currently un-implemented for .vlw fonts, but honored for layout in case subclasses use it.
`static java.lang.String[]`	`list()` ( begin auto-generated from PFont_list.xml ) Gets a list of the fonts installed on the system.
`static void`	`loadFonts()`
`void`	`save(java.io.OutputStream output)` Write this PFont to an OutputStream.
`void`	`setNative(java.lang.Object font)` Set the native complement of this font.
`void`	`setSubsetting()`
`float`	`width(char c)` Width of this character for a font of size 1.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CHARSET
```
public static char[] 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.
- Constructor Detail
  - PFont
```
public PFont()
```
    for subclasses that need to store metadata about the font
  - PFont
```
public PFont(java.awt.Font font,
     boolean smooth)
```
    ( begin auto-generated from PFont.xml ) PFont is the font class for Processing. To create a font to use with Processing, select "Create Font..." from the Tools menu. This will create a font in the format Processing requires and also adds it to the current sketch's data directory. Processing displays fonts using the .vlw font format, which uses images for each letter, rather than defining them through vector data. The loadFont() function constructs a new font and textFont() makes a font active. The list() method creates a list of the fonts installed on the computer, which is useful information to use with the createFont() function for dynamically converting fonts into a format to use with Processing. ( end auto-generated )
    
    Parameters:
    font -
    smooth -
    See Also:
    PApplet.loadFont(String), PGraphics.textFont(PFont, float), PGraphics.text(String, float, float)
  - PFont
```
public PFont(java.awt.Font font,
     boolean smooth,
     char[] charset)
```
    Create a new image-based font on the fly. If charset is set to null, the characters will only be created as bitmaps when they're drawn.
    
    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
  - PFont
```
public PFont(java.awt.Font font,
     boolean smooth,
     char[] charset,
     boolean stream)
```
    Adds an additional parameter that indicates the font came from a file, not a built-in OS font.
  - PFont
```
public PFont(java.io.InputStream input)
      throws java.io.IOException
```
    Parameters:
    input - InputStream
    
    Throws:
    
    java.io.IOException
- Method Detail
  - 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
  - getName
```
public java.lang.String getName()
```
  - getPostScriptName
```
public java.lang.String getPostScriptName()
```
  - setNative
```
public void setNative(java.lang.Object font)
```
    Set the native complement of this font. Might be set internally via the findFont() function, or externally by a deriveFont() call if the font is resized by PGraphicsJava2D.
  - getFont
```
@Deprecated
public java.awt.Font getFont()
```
    Deprecated.
    
    Use the getNative() method instead, which allows library interfaces to be written in a cross-platform fashion for desktop, Android, and others.
  - getNative
```
public java.lang.Object getNative()
```
    Return the native java.awt.Font associated with this PFont (if any).
  - getSize
```
public int getSize()
```
    Return size of this font.
  - isStream
```
public boolean isStream()
```
  - setSubsetting
```
public void setSubsetting()
```
  - findNative
```
public java.lang.Object findNative()
```
    Attempt to find the native version of this font. (Public so that it can be used by OpenGL or other renderers.)
  - getGlyph
```
public PFont.Glyph getGlyph(char c)
```
  - 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.
  - getGlyphCount
```
public int getGlyphCount()
```
  - getGlyph
```
public PFont.Glyph getGlyph(int i)
```
  - list
```
public static java.lang.String[] list()
```
    ( begin auto-generated from PFont_list.xml ) Gets a list of the fonts installed on the system. The data is returned as a String array. This list provides the names of each font for input into createFont(), which allows Processing to dynamically format fonts. This function is meant as a tool for programming local applications and is not recommended for use in applets. ( end auto-generated )
  - 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 bug was filed years ago as #4769141 at bugreporter.apple.com. More: Bug 407.

Class PFont

Nested Class Summary

Field Summary

Fields inherited from interface processing.core.PConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CHARSET

Constructor Detail

PFont

PFont

PFont

PFont

PFont

Method Detail

save

getName

getPostScriptName

setNative

getFont

getNative

getSize

isStream

setSubsetting

findNative

getGlyph

kern

ascent

descent

width

getGlyphCount

getGlyph

list

loadFonts

findFont