Skip to content

API Reference

This section documents the C++ and Python API surface that Industrial CG Platform adds to or modifies in Blender and Cycles.

Scope

The API reference covers extensions in five areas:

AreaDescriptionPage
Cycles KernelNew kernel film fields, pass types, integrator extensionsCycles Kernel Extensions
RNA PropertiesNew ViewLayer, Light, and World properties exposed to the UI and PythonRNA Properties
Python OperatorsNew Blender operators and the shared Qt runtime APIPython Operators
bQt IntegrationIntegration architecture, packaging layout rules, and advanced Qt-Blender design patternsbQt Usage Guide
Pass & AOV SystemNew pass type registration, naming conventions, and readback architecturePass & AOV System

Conventions

  • C++ API references include the source file path where the change lives.
  • Python API references show both the bpy access path and the operator ID.
  • All API surface in this branch is prefixed or namespaced to avoid collision with upstream Blender changes.

Upstream Compatibility

These API additions are designed to be forward-compatible with Blender upstream:

  • New RNA properties use standard Blender property registration patterns.
  • New pass types extend the existing Cycles pass enumeration without breaking existing passes.
  • The PROP_SEARCH_KEEP_ORDER flag is a minimal Blender core extension that does not affect existing search behavior.

Released under the Blender License (GNU GPL v3 or later).