Skip to content

publish_plugins

ExtractConvertToEXRModel

Bases: BaseSettingsModel

WARNING: This plugin does not work on MacOS (using OIIO tool).

Source code in server/settings/publish_plugins.py
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
class ExtractConvertToEXRModel(BaseSettingsModel):
    """WARNING: This plugin does not work on MacOS (using OIIO tool)."""
    enabled: bool = False
    replace_pngs: bool = SettingsField(
        True,
        title="Replace original PNG files",
        description="Remove original PNG files after transcoding to EXR",
    )
    auto_trim: bool = SettingsField(
        True,
        title="Auto Trim",
    )
    exr_compression: str = SettingsField(
        "ZIP",
        enum_resolver=compression_enum,
        title="EXR Compression"
    )
    multichannel_exr: bool = SettingsField(
        False,
        title="Create multichannel EXR",
        description="Merge render passes into a render layer EXR files",
    )
    keep_passes: bool = SettingsField(
        False,
        title="Keep render passes",
        description=(
            "Keep render passes even though multichannel EXR is enabled"
        ),
    )
    user_overrides: list[str] = SettingsField(
        default_factory=list,
        title="User overrides",
        description="Allow user to change the plugin functionality",
        enum_resolver=user_exr_choices,
    )

ExtractSequenceModel

Bases: BaseSettingsModel

Review BG color is used for whole scene review and for thumbnails.

Source code in server/settings/publish_plugins.py
11
12
13
14
15
class ExtractSequenceModel(BaseSettingsModel):
    """Review BG color is used for whole scene review and for thumbnails."""
    review_bg: ColorRGBA_uint8 = SettingsField(
        (255, 255, 255, 1.0),
        title="Review BG color")