Blender V5.3
bpy_rna.hh File Reference
#include <Python.h>
#include <optional>
#include "intern/rna_internal_types.hh"

Go to the source code of this file.

Classes

struct  blender::BPy_DummyPointerRNA
struct  blender::BPy_StructRNA
struct  blender::BPy_PropertyRNA
struct  blender::BPy_PropertyArrayRNA
struct  blender::BPy_PropertyCollectionIterRNA
struct  blender::BPy_FunctionRNA
struct  blender::BPy_StructRNA_Parse

Namespaces

namespace  blender
 BMesh Iterators.

Macros

#define USE_PYRNA_ITER
#define BPy_StructRNA_Check(v)
#define BPy_StructRNA_CheckExact(v)
#define BPy_PropertyRNA_Check(v)
#define BPy_PropertyRNA_CheckExact(v)
#define PYRNA_STRUCT_CHECK_OBJ(obj)
#define PYRNA_STRUCT_CHECK_INT(obj)
#define PYRNA_PROP_CHECK_OBJ(obj)
#define PYRNA_PROP_CHECK_INT(obj)
#define PYRNA_STRUCT_CHECK_OBJ_UNLESS(obj, unless)
#define PYRNA_STRUCT_IS_VALID(pysrna)
#define PYRNA_PROP_IS_VALID(pysrna)

Functions

void blender::BPY_rna_init ()
void blender::BPY_rna_exit ()
PyObject * blender::BPY_rna_module ()
void blender::BPY_update_rna_module ()
void blender::BPY_rna_types_dict_set (PyObject *dict)
PyObject * blender::pyrna_struct_CreatePyObject_with_primitive_support (PointerRNA *ptr)
PyObject * blender::pyrna_struct_CreatePyObject (PointerRNA *ptr)
PyObject * blender::pyrna_prop_CreatePyObject (PointerRNA *ptr, PropertyRNA *prop)
PyObject * blender::pyrna_id_CreatePyObject (ID *id)
bool blender::pyrna_id_FromPyObject (PyObject *obj, ID **id)
bool blender::pyrna_id_CheckPyObject (PyObject *obj)
int blender::pyrna_pydict_to_props (PointerRNA *ptr, PyObject *kw, const bool all_args, const char *error_prefix)
PyObject * blender::pyrna_prop_to_py (PointerRNA *ptr, PropertyRNA *prop)
int blender::pyrna_py_to_array (PointerRNA *ptr, PropertyRNA *prop, char *param_data, PyObject *py, const char *error_prefix)
int blender::pyrna_py_to_array_index (PointerRNA *ptr, PropertyRNA *prop, int arraydim, int arrayoffset, int index, PyObject *py, const char *error_prefix)
PyObject * blender::pyrna_array_index (PointerRNA *ptr, PropertyRNA *prop, int index)
PyObject * blender::pyrna_py_from_array (PointerRNA *ptr, PropertyRNA *prop)
PyObject * blender::pyrna_py_from_array_index (BPy_PropertyArrayRNA *self, PointerRNA *ptr, PropertyRNA *prop, int index)
PyObject * blender::pyrna_math_object_from_array (PointerRNA *ptr, PropertyRNA *prop)
int blender::pyrna_array_contains_py (PointerRNA *ptr, PropertyRNA *prop, PyObject *value)
bool blender::pyrna_write_check ()
void blender::pyrna_write_set (bool val)
void blender::pyrna_context_init (bContext *C)
void blender::pyrna_context_clear (bContext *C)
void blender::pyrna_invalidate (BPy_DummyPointerRNA *self)
int blender::pyrna_struct_validity_check_only (const BPy_StructRNA *pysrna)
void blender::pyrna_struct_validity_exception_only (const BPy_StructRNA *pysrna)
int blender::pyrna_struct_validity_check (const BPy_StructRNA *pysrna)
int blender::pyrna_prop_validity_check (const BPy_PropertyRNA *self)
RNA Struct Access: #StructRNA

Utilities for accessing & creating StructRNA on demand.

StructRNA * blender::srna_from_self (PyObject *self, const char *error_prefix)
StructRNA * blender::pyrna_struct_as_srna (PyObject *self, const bool parent, const char *error_prefix)
const PointerRNA * blender::pyrna_struct_as_ptr (PyObject *py_obj, const StructRNA *srna)
const PointerRNA * blender::pyrna_struct_as_ptr_or_null (PyObject *py_obj, const StructRNA *srna)
int blender::pyrna_struct_as_ptr_parse (PyObject *o, void *p)
int blender::pyrna_struct_as_ptr_or_null_parse (PyObject *o, void *p)
RNA Types Module <tt>bpy.types</tt>
PyObject * blender::BPY_rna_types ()
void blender::BPY_rna_types_finalize_external_types (PyObject *submodule)
RNA Class Registration: Deferred
int blender::pyrna_deferred_register_class (StructRNA *srna, PyTypeObject *py_class)
RNA Support for extended via the C-API
void blender::pyrna_struct_type_extend_capi (StructRNA *srna, PyMethodDef *method, PyGetSetDef *getset)
RNA Class Registration: Utilities

Mainly helpers for register_class & unregister_class.

void blender::pyrna_alloc_types ()

Macro Definition Documentation

◆ BPy_PropertyRNA_Check

#define BPy_PropertyRNA_Check ( v)

◆ BPy_PropertyRNA_CheckExact

#define BPy_PropertyRNA_CheckExact ( v)
Value:
(Py_TYPE(v) == &pyrna_prop_Type)

Definition at line 79 of file bpy_rna.hh.

Referenced by blender::pyrna_prop_dir().

◆ BPy_StructRNA_Check

◆ BPy_StructRNA_CheckExact

#define BPy_StructRNA_CheckExact ( v)
Value:
(Py_TYPE(v) == &pyrna_struct_Type)

Definition at line 77 of file bpy_rna.hh.

Referenced by blender::pyrna_struct_dir().

◆ PYRNA_PROP_CHECK_INT

◆ PYRNA_PROP_CHECK_OBJ

◆ PYRNA_PROP_IS_VALID

#define PYRNA_PROP_IS_VALID ( pysrna)
Value:
(LIKELY(((BPy_PropertyRNA *)(pysrna))->ptr->has_type()))
#define LIKELY(x)

Definition at line 114 of file bpy_rna.hh.

◆ PYRNA_STRUCT_CHECK_INT

#define PYRNA_STRUCT_CHECK_INT ( obj)
Value:
if (pyrna_struct_validity_check(obj) == -1) [[unlikely]] { \
return -1; \
} \
(void)0

Definition at line 86 of file bpy_rna.hh.

Referenced by blender::py_msgbus_rna_key_from_py(), blender::pyrna_struct_ass_subscript(), blender::pyrna_struct_contains(), and blender::pyrna_struct_setattro().

◆ PYRNA_STRUCT_CHECK_OBJ

◆ PYRNA_STRUCT_CHECK_OBJ_UNLESS

#define PYRNA_STRUCT_CHECK_OBJ_UNLESS ( obj,
unless )
Value:
{ \
const BPy_StructRNA *_obj = obj; \
if (UNLIKELY(pyrna_struct_validity_check_only(_obj) == -1) && !(unless)) { \
pyrna_struct_validity_exception_only(_obj); \
return NULL; \
} \
} \
(void)0
#define UNLIKELY(x)

Definition at line 103 of file bpy_rna.hh.

Referenced by blender::pyrna_struct_getattro().

◆ PYRNA_STRUCT_IS_VALID

#define PYRNA_STRUCT_IS_VALID ( pysrna)
Value:
(LIKELY(((BPy_StructRNA *)(pysrna))->ptr->has_type()))

Definition at line 113 of file bpy_rna.hh.

Referenced by blender::pyrna_struct_repr(), and blender::pyrna_struct_str().

◆ USE_PYRNA_ITER

#define USE_PYRNA_ITER

Definition at line 59 of file bpy_rna.hh.