Skip to content
Snippets Groups Projects
Commit 46c7d1bd authored by Ju Hee Son's avatar Ju Hee Son
Browse files

Add new file

parent bd64bf5b
No related branches found
No related tags found
No related merge requests found
Font Drawing (blf)
This module provides access to Blender’s text drawing functions.
Hello World Text Example
Example of using the blf module. For this module to work we need to use the OpenGL wrapper bgl as well.
blf.dimensions(fontid, text)
Return the width and height of the text.
Parameters
fontid (int) – The id of the typeface as returned by blf.load(), for default font use 0.
text (string) – the text to draw.
Returns
the width and height of the text.
Return type
tuple of 2 floats
blf.disable(fontid, option)
Disable option.
Parameters
fontid (int) – The id of the typeface as returned by blf.load(), for default font use 0.
option (int) – One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT.
blf.draw(fontid, text)
Draw text in the current context.
Parameters
fontid (int) – The id of the typeface as returned by blf.load(), for default font use 0.
text (string) – the text to draw.
blf.enable(fontid, option)
Enable option.
Parameters
fontid (int) – The id of the typeface as returned by blf.load(), for default font use 0.
option (int) – One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT.
blf.load(filepath)
Load a new font.
Parameters
filepath (string) – the filepath of the font.
Returns
the new font’s fontid or -1 if there was an error.
Return type
integer
blf.position(fontid, x, y, z)
Set the position for drawing text.
Parameters
fontid (int) – The id of the typeface as returned by blf.load(), for default font use 0.
x (float) – X axis position to draw the text.
y (float) – Y axis position to draw the text.
z (float) – Z axis position to draw the text.
blf.rotation(fontid, angle)
Set the text rotation angle, enable/disable using ROTATION.
Parameters
fontid (int) – The id of the typeface as returned by blf.load(), for default font use 0.
angle (float) – The angle for text drawing to use.
blf.shadow(fontid, level, r, g, b, a)
Shadow options, enable/disable using SHADOW .
Parameters
fontid (int) – The id of the typeface as returned by blf.load(), for default font use 0.
level (int) – The blur level, can be 3, 5 or 0.
r (float) – Shadow color (red channel 0.0 - 1.0).
g (float) – Shadow color (green channel 0.0 - 1.0).
b (float) – Shadow color (blue channel 0.0 - 1.0).
a (float) – Shadow color (alpha channel 0.0 - 1.0).
blf.shadow_offset(fontid, x, y)
Set the offset for shadow text.
Parameters
fontid (int) – The id of the typeface as returned by blf.load(), for default font use 0.
x (float) – Vertical shadow offset value in pixels.
y (float) – Horizontal shadow offset value in pixels.
blf.size(fontid, size, dpi=72)
Set the size for drawing text.
Parameters
fontid (int) – The id of the typeface as returned by blf.load(), for default font use 0.
size (float) – Point size of the font.
dpi (int) – DEPRECATED: Defaults to 72 when omitted.
blf.unload(filepath)
Unload an existing font.
Parameters
filepath (string) – the filepath of the font.
blf.word_wrap(fontid, wrap_width)
Set the wrap width, enable/disable using WORD_WRAP.
Parameters
fontid (int) – The id of the typeface as returned by blf.load(), for default font use 0.
wrap_width (int) – The width (in pixels) to wrap words at.
blf.CLIPPING
Constant value 2
blf.MONOCHROME
Constant value 128
blf.ROTATION
Constant value 1
blf.SHADOW
Constant value 4
blf.WORD_WRAP
Constant value 64
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment