Skip to main content

A framework for compositional procedural generation

Project description

ProcFunc: Function-Oriented Abstractions for Procedural 3D Generation in Python

Documentation | Research Paper | Documentation | Transpiling | Experiments | Contributing

This repository contains only the Primitives API, Transpiler and Tracer from our research paper.

The pre-made procedural generators are coming soon as part of infinigen.

Installation

Use uv or your favorite package manager to install procfunc via pip:

uv pip install procfunc

Note: ProcFunc depends on bpy==4.2.0 which then requires Python==3.11.x. Other version are not yet supported.

Since we have not yet reached semver 1.0.0 we have not yet finalized procfunc's interface. In the meantime, each 0.X.0 may introduce interface changes. Please pin uv add procfunc<0.XX where X is the current version.

Usage

See procfunc.readthedocs.io for available functions

Please create Github Issues for any bugs or unclear interfaces!

Transpile a blender file to ProcFunc code

Convert a Blender geometry node tree into procfunc Python code by downloading our example blend and executing the transpiler:

wget https://raw.githubusercontent.com/princeton-vl/procfunc/main/examples/transpile_simple_chair/simple_chair.blend
uv run python -m procfunc.transpiler.main simple_chair.blend --node_trees simple_chair --output transpiled_code.py

See the expected output in examples/transpile_simple_chair/transpiled_code.py. To use the code, you can add pf.ops.file.save_blend("test.blend") to the end of it, then open the generated blender file. You can also open and edit the blender geonodes prior to transpiling in order to generate different procfunc code.

Paper

If you find procfunc useful, please cite our paper:

@misc{raistrick2026procfunc,
      title={ProcFunc: Function-Oriented Abstractions for Procedural 3D Generation in Python}, 
      author={Alexander Raistrick and Karhan Kayan and Jack Nugent and David Yan and Lingjie Mei and Meenal Parakh and Hongyu Wen and Dylan Li and Yiming Zuo and Erich Liang and Jia Deng},
      year={2026},
      eprint={2604.26943},
      archivePrefix={arXiv},
      primaryClass={cs.CV},
      url={https://arxiv.org/abs/2604.26943}, 
}

Experiments

See experiments/EXPERIMENTS.md

NOTE: experiments are only intended to be correct when using the experiments branch, which will not see major updates.

Contributing

Please create an issue for any proposed features to discuss them before implementing.

Developer Installation
git clone git@github.com:princeton-vl/procfunc.git
cd procfunc
uv venv
uv pip install -e ".[dev]"
Tools
uv run ruff format
uv run ruff check --fix
uv run pytest
make docs
Todos / Sharp Edges

Add optional support for bpy==4.x and 5.x and maybe 3.6, all under the same procfunc interface.

pf.ops is missing some blender functions and arguments, especially returning "selection" masks for some cases.

Assets like pf.MeshObject and pf.Material are not currently cleaned up upon going out of scope

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

procfunc-0.30.0.tar.gz (272.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

procfunc-0.30.0-py3-none-any.whl (290.3 kB view details)

Uploaded Python 3

File details

Details for the file procfunc-0.30.0.tar.gz.

File metadata

  • Download URL: procfunc-0.30.0.tar.gz
  • Upload date:
  • Size: 272.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for procfunc-0.30.0.tar.gz
Algorithm Hash digest
SHA256 0454b2d8d91bd77a1ede41032959e3cb1ab41656ed037c7ae9509862d1107968
MD5 4a000c9aa866d32e1cb73e7848960563
BLAKE2b-256 10c02150e0b63b8b9839fa9113f70276ba725d7510784eedca3fff127b545fd5

See more details on using hashes here.

File details

Details for the file procfunc-0.30.0-py3-none-any.whl.

File metadata

  • Download URL: procfunc-0.30.0-py3-none-any.whl
  • Upload date:
  • Size: 290.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for procfunc-0.30.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb5c278c8c33bda88c2c3b2f6a4e3f191a8429b6c3dc0611059cb86020c07f6d
MD5 24d606209935104df6e74d58168b0c84
BLAKE2b-256 c7778fe5b64bb1145e1bafec46bb3ac74bde9a81524f2027521d2a749948d50b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page