getAmigaBitmapFont: Extract a specific AmigaBitmapFont from a AmigaBitmapFontSet

View source: R/bitmapfont.r

getAmigaBitmapFontR Documentation

Extract a specific AmigaBitmapFont from a AmigaBitmapFontSet

Description

Extract a specific AmigaBitmapFont from a AmigaBitmapFontSet.

Usage

getAmigaBitmapFont(x, size)

Arguments

x

An AmigaBitmapFontSet object, from which the specific AmigaBitmapFont object needs to be extracted.

size

A single numeric value specifying the desired font size in pixels. Use availableFontSizes to get available sizes.

Details

An AmigaBitmapFontSet object can hold one or more bitmaps for specific font sizes (heights). Use this function to obtain such a specific AmigaBitmapFont.

Value

Returns an AmigaBitmapFont of the requested size. An error is thrown when the requested size is not available.

Author(s)

Pepijn de Vries

See Also

Other AmigaBitmapFont.operations: AmigaBitmapFont, availableFontSizes(), c(), fontName(), font_example, rasterToAmigaBitmapFont(), rawToAmigaBitmapFontSet(), rawToAmigaBitmapFont(), read.AmigaBitmapFontSet(), read.AmigaBitmapFont(), write.AmigaBitmapFont()

Examples

## Not run: 
data(font_example)

## get the font object for the first available size:
font <- getAmigaBitmapFont(font_example,
                           availableFontSizes(font_example)[1])

## End(Not run)

AmigaFFH documentation built on Aug. 27, 2023, 9:07 a.m.