Safe Haskell	None

HGamer3D.Bindings.CEGUI.ClassFont

Synopsis

Documentation

delete Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance which is going to be deleted.
-> IO ()

Destructor.

getName Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO String

Return the string holding the font name.

getTypeName Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO String

Return the type of the font.

isCodepointAvailable Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Int	cp - utf32 code point that is the subject of the query.
-> IO Bool	return value - true if the font contains a mapping for code point

Return whether this Font

setAutoScaled Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	auto_scaled -
-> IO ()

Return whether this Font

Enable or disable auto-scaling for this Font

isAutoScaled Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool

getLineSpacing Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	y_scale - Scaling factor to be applied to the line spacing, where 1.0f is considered to be `normal`.
-> IO Float	return value - Number of pixels between vertical base lines, i.e. The minimum pixel space between two lines of text.

Return the pixel line spacing value for.

getFontHeight Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	y_scale - Scaling factor to be applied to the height, where 1.0f is considered to be `normal`.
-> IO Float	return value - float value describing the pixel height of the font without any additional padding.

return the exact pixel height of the font.

getBaseline Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	y_scale - Scaling factor to be applied to the baseline distance, where 1.0f is considered to be `normal`.
-> IO Float	return value - pixel spacing from top of front glyphs to baseline

Return the number of pixels from the top of the highest glyph to the baseline.

getTextExtent Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	text - String object containing the text to return the rendered pixel width for.
-> Float	x_scale - Scaling factor to be applied to each glyph's x axis when measuring the extent, where 1.0f is considered to be `normal`.
-> IO Float	return value - Number of pixels that

Return the pixel width of the specified text if rendered with this Font

getCharAtPixel Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	text - String object containing the text.
-> Float	pixel - Specifies the (horizontal) pixel offset to return the character index for.
-> Float	x_scale - Scaling factor to be applied to each glyph's x axis when measuring the text extent, where 1.0f is considered to be `normal`.
-> IO Int	return value - Returns a character index into String

Return the index of the closest text character in String textpixel

getCharAtPixel2 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	text - String object containing the text.
-> Int	start_char - index of the first character to consider. This is the lowest value that will be returned from the call.
-> Float	pixel - Specifies the (horizontal) pixel offset to return the character index for.
-> Float	x_scale - Scaling factor to be applied to each glyph's x axis when measuring the text extent, where 1.0f is considered to be `normal`.
-> IO Int	return value - Returns a character index into String