procfunc
========

.. automodule:: procfunc
   :no-members:

Subpackages
-----------

The following submodules are accessible as attributes of ``procfunc``
(e.g. ``pf.nodes``, ``pf.tracer``):

* ``pf.compute_graph`` — :doc:`compute_graph`
* ``pf.control`` — :mod:`procfunc.control`
* ``pf.context`` — :mod:`procfunc.context`
* ``pf.color`` — :mod:`procfunc.color`
* ``pf.nodes`` — :doc:`nodes`
* ``pf.ops`` — :doc:`ops`
* ``pf.random`` — :mod:`procfunc.random`
* ``pf.tracer`` — :doc:`tracer`
* ``pf.transforms`` — :doc:`transforms`
* ``pf.util`` — :mod:`procfunc.util`

Types
-----

The following types are importable directly from ``procfunc``.
Internal types link to their canonical subpage; Blender/numpy
aliases link to upstream docs.

* :class:`pf.ArmatureObject <procfunc.types.ArmatureObject>`
* :class:`pf.Asset <procfunc.types.Asset>`
* ``pf.BVHTree`` — alias of `mathutils.bvhtree.BVHTree <https://docs.blender.org/api/current/mathutils.bvhtree.html#mathutils.bvhtree.BVHTree>`_
* :class:`pf.CameraObject <procfunc.types.CameraObject>`
* :class:`pf.Collection <procfunc.types.Collection>`
* ``pf.Color`` — alias of `mathutils.Color <https://docs.blender.org/api/current/mathutils.html#mathutils.Color>`_
* :class:`pf.CurveObject <procfunc.types.CurveObject>`
* :class:`pf.EmptyObject <procfunc.types.EmptyObject>`
* ``pf.Euler`` — alias of `mathutils.Euler <https://docs.blender.org/api/current/mathutils.html#mathutils.Euler>`_
* :class:`pf.HairObject <procfunc.types.HairObject>`
* :class:`pf.Image <procfunc.types.Image>`
* :class:`pf.LatticeObject <procfunc.types.LatticeObject>`
* :class:`pf.LightObject <procfunc.types.LightObject>`
* :class:`pf.LightProbeObject <procfunc.types.LightProbeObject>`
* :class:`pf.Material <procfunc.types.Material>`
* ``pf.Matrix`` — alias of `mathutils.Matrix <https://docs.blender.org/api/current/mathutils.html#mathutils.Matrix>`_
* :class:`pf.MeshObject <procfunc.types.MeshObject>`
* :class:`pf.MetaObject <procfunc.types.MetaObject>`
* :class:`pf.NodeDataType <procfunc.nodes.NodeDataType>`
* :class:`pf.Object <procfunc.types.Object>`
* :class:`pf.ProcNode <procfunc.nodes.ProcNode>`
* ``pf.Quaternion`` — alias of `mathutils.Quaternion <https://docs.blender.org/api/current/mathutils.html#mathutils.Quaternion>`_
* ``pf.RNG`` — alias of :class:`numpy.random.Generator`
* :class:`pf.Shader <procfunc.nodes.Shader>`
* :class:`pf.Texture <procfunc.types.Texture>`
* ``pf.Vector`` — alias of `mathutils.Vector <https://docs.blender.org/api/current/mathutils.html#mathutils.Vector>`_
* ``pf.ViewLayer`` — alias of `bpy.types.ViewLayer <https://docs.blender.org/api/current/bpy.types.ViewLayer.html>`_
* :class:`pf.VolumeObject <procfunc.types.VolumeObject>`
* :class:`pf.World <procfunc.types.World>`

Functions
---------

The following functions are importable directly from ``procfunc``.

* :func:`pf.add_search_scope <procfunc.tracer.add_search_scope>`
* :func:`pf.autowrap_module <procfunc.tracer.autowrap_module>`
* :func:`pf.module_path <procfunc.util.module_path>`
* :func:`pf.trace <procfunc.tracer.trace>`