Blender V5.3
bpy_utils_previews.cc File Reference
#include <Python.h>
#include <structmember.h>
#include "RNA_access.hh"
#include "RNA_prototypes.hh"
#include "bpy_rna.hh"
#include "bpy_utils_previews.hh"
#include "../generic/py_capi_utils.hh"
#include "IMB_thumbs.hh"
#include "BKE_preview_image.hh"

Go to the source code of this file.

Namespaces

namespace  blender
 BMesh Iterators.

Macros

#define PYDOC_SOURCE_TYPES_LITERAL   "Literal['IMAGE', 'MOVIE', 'BLEND', 'FONT', 'OBJECT_IO']"

Functions

 blender::PyDoc_STRVAR (bpy_utils_previews_new_doc, ".. method:: new(name)\n" "\n" " Generate a new empty preview.\n" "\n" " :param name: The name (unique id) identifying the preview.\n" " :type name: str\n" " :return: The Preview matching given name, or a new empty one.\n" " :rtype: :class:`bpy.types.ImagePreview`\n" " :raises KeyError: if ``name`` already exists.\n")
static PyObject * blender::bpy_utils_previews_new (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (bpy_utils_previews_load_doc, ".. method:: load(name, filepath, file_type, force_reload=False)\n" "\n" " Generate a new preview from given file path.\n" "\n" " :param name: The name (unique id) identifying the preview.\n" " :type name: str\n" " :param filepath: The file path to generate the preview from.\n" " :type filepath: str | bytes\n" " :param file_type: The type of file, needed to generate the preview.\n" " :type file_type: " PYDOC_SOURCE_TYPES_LITERAL "\n" " :param force_reload: If True, force running thumbnail manager even if preview already " "exists in cache.\n" " :type force_reload: bool\n" " :return: The Preview matching given name, or a new empty one.\n" " :rtype: :class:`bpy.types.ImagePreview`\n" " :raises KeyError: if ``name`` already exists.\n")
static PyObject * blender::bpy_utils_previews_load (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (bpy_utils_previews_release_doc, ".. method:: release(name)\n" "\n" " Release (free) a previously created preview.\n" "\n" "\n" " :param name: The name (unique id) identifying the preview.\n" " :type name: str\n")
static PyObject * blender::bpy_utils_previews_release (PyObject *, PyObject *args)
 blender::PyDoc_STRVAR (bpy_utils_previews_doc, "This object contains basic static methods to handle cached (non-ID) previews in Blender\n" "(low-level API, not exposed to final users).\n")
PyObject * blender::BPY_utils_previews_module ()

Variables

static PyMethodDef blender::bpy_utils_previews_methods []
static PyModuleDef blender::bpy_utils_previews_module

Detailed Description

This file defines a singleton py object accessed via 'bpy.utils.previews', which exposes low-level API for custom previews/icons. It is replaced in final API by an higher-level python wrapper, that handles previews by addon, and automatically release them on deletion.

Definition in file bpy_utils_previews.cc.

Macro Definition Documentation

◆ PYDOC_SOURCE_TYPES_LITERAL

#define PYDOC_SOURCE_TYPES_LITERAL   "Literal['IMAGE', 'MOVIE', 'BLEND', 'FONT', 'OBJECT_IO']"

Definition at line 31 of file bpy_utils_previews.cc.

Referenced by blender::PyDoc_STRVAR().