BlendGen
Generated modules

renderers.base

Generated Python API reference for blendgen.renderers.base.

blendgen.renderers.base

Renderer backend contracts and shared render-pass semantics.

RenderPassKind

Class source

class RenderPassKind(Enum)

Semantic passes exposed by BlendGen, independent of Blender sockets.

Values

COLOR = 'color'
ALPHA = 'alpha'
DEPTH = 'depth'
NORMAL = 'normal'
OPTICAL_FLOW = 'optical_flow'
MATERIAL_INDEX = 'material_index'

UnsupportedRenderPassError

Class source

class UnsupportedRenderPassError(ValueError)

Raised when a backend cannot reliably produce a requested pass.

RenderBackend

Class source

class RenderBackend(Protocol)

The small interface used by :class:blendgen.renderer.Renderer.

RenderBackend.name

Property source

def name(self) -> str

Return the Blender engine identifier.

RenderBackend.validate_passes

Method source

def validate_passes(self, pass_kinds) -> None

Reject semantic passes unsupported by this backend.

RenderBackend.configure_scene

Method source

def configure_scene(self, scene, blender) -> None

Apply this backend's settings to one Blender scene.

RenderBackend.bind_pass

Method source

def bind_pass(self, pass_kind, view_layer, render_layers)

Enable and return the compositor source for a semantic pass.

resolve_socket

Function source

def resolve_socket(render_layers, pass_kind)

Resolve a compositor socket with compatibility aliases.

validate_known_passes

Function source

def validate_known_passes(pass_kinds)

Raise when a backend receives a pass outside BlendGen's semantics.

On this page