Blender V5.3
blf_py_api.cc File Reference

Go to the source code of this file.

Classes

struct  blender::BPyBLFImBufContext

Namespaces

namespace  blender
 BMesh Iterators.

Macros

#define PY_SSIZE_T_CLEAN

Functions

 blender::PyDoc_STRVAR (py_blf_position_doc, ".. function:: position(fontid, x, y, z)\n" "\n" " Set the position for drawing text.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param x: X axis position to draw the text.\n" " :type x: float\n" " :param y: Y axis position to draw the text.\n" " :type y: float\n" " :param z: Z axis position to draw the text (typically 0).\n" " :type z: float\n")
static PyObject * blender::py_blf_position (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_size_doc, ".. function:: size(fontid, size)\n" "\n" " Set the size for drawing text.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param size: Point size of the font.\n" " :type size: float\n")
static PyObject * blender::py_blf_size (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_aspect_doc, ".. function:: aspect(fontid, aspect)\n" "\n" " Set the aspect for drawing text.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param aspect: The aspect ratio for non-uniform scaling of text.\n" " :type aspect: float\n")
static PyObject * blender::py_blf_aspect (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_color_doc, ".. function:: color(fontid, r, g, b, a)\n" "\n" " Set the color for drawing text.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param r: Red channel 0.0 - 1.0.\n" " :type r: float\n" " :param g: Green channel 0.0 - 1.0.\n" " :type g: float\n" " :param b: Blue channel 0.0 - 1.0.\n" " :type b: float\n" " :param a: Alpha channel 0.0 - 1.0.\n" " :type a: float\n")
static PyObject * blender::py_blf_color (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_draw_doc, ".. function:: draw(fontid, text)\n" "\n" " Draw text in the current context.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param text: The text to draw.\n" " :type text: str\n")
static PyObject * blender::py_blf_draw (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_draw_buffer_doc, ".. function:: draw_buffer(fontid, text)\n" "\n" " Draw text into the image buffer bound via :func:`blf.bind_imbuf`.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param text: The text to draw into the bound image buffer.\n" " :type text: str\n")
static PyObject * blender::py_blf_draw_buffer (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_dimensions_doc, ".. function:: dimensions(fontid, text)\n" "\n" " Return the width and height of the text.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param text: The text to measure.\n" " :type text: str\n" " :return: The width and height of the text.\n" " :rtype: tuple[float, float]\n")
static PyObject * blender::py_blf_dimensions (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_clipping_doc, ".. function:: clipping(fontid, xmin, ymin, xmax, ymax)\n" "\n" " Set the clipping, enable/disable using :data:`CLIPPING`.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param xmin: Left edge of the clipping rectangle.\n" " :type xmin: float\n" " :param ymin: Bottom edge of the clipping rectangle.\n" " :type ymin: float\n" " :param xmax: Right edge of the clipping rectangle.\n" " :type xmax: float\n" " :param ymax: Top edge of the clipping rectangle.\n" " :type ymax: float\n")
static PyObject * blender::py_blf_clipping (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_word_wrap_doc, ".. function:: word_wrap(fontid, wrap_width)\n" "\n" " Set the wrap width, enable/disable using :data:`WORD_WRAP`.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param wrap_width: The width (in pixels) to wrap words at.\n" " :type wrap_width: int\n")
static PyObject * blender::py_blf_word_wrap (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_disable_doc, ".. function:: disable(fontid, option)\n" "\n" " Disable a font drawing option.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param option: One of :data:`ROTATION`, :data:`CLIPPING`, " ":data:`SHADOW`, :data:`MONOCHROME` or :data:`WORD_WRAP`.\n" " :type option: int\n")
static PyObject * blender::py_blf_disable (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_enable_doc, ".. function:: enable(fontid, option)\n" "\n" " Enable a font drawing option.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param option: One of :data:`ROTATION`, :data:`CLIPPING`, " ":data:`SHADOW`, :data:`MONOCHROME` or :data:`WORD_WRAP`.\n" " :type option: int\n")
static PyObject * blender::py_blf_enable (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_rotation_doc, ".. function:: rotation(fontid, angle)\n" "\n" " Set the text rotation angle, enable/disable using :data:`ROTATION`.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param angle: The angle for text drawing to use (in radians).\n" " :type angle: float\n")
static PyObject * blender::py_blf_rotation (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_shadow_doc, ".. function:: shadow(fontid, level, r, g, b, a)\n" "\n" " Shadow options, enable/disable using :data:`SHADOW`.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param level: The shadow type: 0 for none, 3 for 3x3 blur, 5 for 5x5 blur " "or 6 for outline. Other values raise a :exc:`TypeError`.\n" " :type level: int\n" " :param r: Shadow color (red channel 0.0 - 1.0).\n" " :type r: float\n" " :param g: Shadow color (green channel 0.0 - 1.0).\n" " :type g: float\n" " :param b: Shadow color (blue channel 0.0 - 1.0).\n" " :type b: float\n" " :param a: Shadow color (alpha channel 0.0 - 1.0).\n" " :type a: float\n")
static PyObject * blender::py_blf_shadow (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_shadow_offset_doc, ".. function:: shadow_offset(fontid, x, y)\n" "\n" " Set the offset for shadow text, enable/disable using :data:`SHADOW`.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param x: Horizontal shadow offset value in pixels.\n" " :type x: int\n" " :param y: Vertical shadow offset value in pixels.\n" " :type y: int\n")
static PyObject * blender::py_blf_shadow_offset (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_load_doc, ".. function:: load(filepath)\n" "\n" " Load a new font.\n" "\n" " :param filepath: The filepath of the font.\n" " :type filepath: str | bytes\n" " :return: The new font's fontid or -1 if there was an error.\n" " :rtype: int\n")
static PyObject * blender::py_blf_load (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (py_blf_unload_doc, ".. function:: unload(filepath)\n" "\n" " Unload an existing font.\n" "\n" " :param filepath: The filepath of the font.\n" " :type filepath: str | bytes\n")
static PyObject * blender::py_blf_unload (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (BLF_doc, "This module provides access to Blender's text drawing functions.")
PyObject * blender::BPyInit_blf ()

Variables

static PyMethodDef blender::BLF_methods []
static PyModuleDef blender::BLF_module_def

Image Buffer Access

Context manager for #ImBuf.

static PyMethodDef blender::py_blf_bind_imbuf_methods []
static PyTypeObject blender::BPyBLFImBufContext_Type
static PyObject * blender::py_blf_bind_imbuf_enter (BPyBLFImBufContext *self)
static PyObject * blender::py_blf_bind_imbuf_exit (BPyBLFImBufContext *self, PyObject *)
static void blender::py_blf_bind_imbuf_dealloc (BPyBLFImBufContext *self)
static int blender::py_blf_bind_imbuf_traverse (BPyBLFImBufContext *self, visitproc visit, void *arg)
static int blender::py_blf_bind_imbuf_clear (BPyBLFImBufContext *self)
 blender::PyDoc_STRVAR (BPyBLFImBufContext_Type_doc, "Context manager returned by :func:`blf.bind_imbuf` that binds an image buffer\n" "as the destination for text drawing.")
 blender::PyDoc_STRVAR (py_blf_bind_imbuf_doc, ".. function:: bind_imbuf(fontid, imbuf, *, display_name=None)\n" "\n" " Context manager to draw text into an image buffer instead of the GPU's context.\n" "\n" " :param fontid: The id of the typeface as returned by :func:`blf.load`, for default " "font use 0.\n" " :type fontid: int\n" " :param imbuf: The image to draw into.\n" " :type imbuf: :class:`imbuf.types.ImBuf`\n" " :param display_name: Ignored (formerly a color-space transform name), " "kept for backwards compatibility.\n" " :type display_name: str | None\n" " :return: The BLF ImBuf context manager.\n" " :rtype: :class:`blf.types.BLFImBufContext`\n")
static PyObject * blender::py_blf_bind_imbuf (PyObject *, PyObject *args, PyObject *kwds)

Module Definition (<tt>blf.types</tt>)

static PyModuleDef blender::BLF_types_module_def
 blender::PyDoc_STRVAR (BLF_types_doc, "This module provides access to font drawing types.")
static PyObject * blender::BPyInit_blf_types ()

Detailed Description

This file defines the BlenFont module, used for drawing text to the GPU or image buffers.

Definition in file blf_py_api.cc.

Macro Definition Documentation

◆ PY_SSIZE_T_CLEAN

#define PY_SSIZE_T_CLEAN

Definition at line 12 of file blf_py_api.cc.