RenderPass

pydantic model xrfeitoria.data_structure.models.RenderPass

Render pass model contains render layer and image format.

Supported render layer and image format:

RenderLayerBlenderRenderLayerUnrealImageFormat

RenderOutputEnumBlender:

• img

• mask

• depth

• flow

• normal

• diffuse

• denoising_depth

Used in:

• RenderJobBlender

• RenderJobUnreal

• Renderer.add_job

• Sequence.add_to_renderer

• …

Examples

defineRenderJobBlenderRenderJobUnrealseq.add_to_renderer

from xrfeitoria.data_structure.models import RenderPass
RenderPass('img', 'png')
RenderPass('mask', 'exr')
RenderPass('normal', 'jpg')
...

Show JSON schema

{
   "title": "RenderPass",
   "description": "Render pass model contains render layer and image format.\n\nSupported render layer and image format:\n\n    .. tabs::\n        .. tab:: RenderLayerBlender\n\n            :class:`~xrfeitoria.data_structure.constants.RenderOutputEnumBlender`:\n\n                - img\n                - mask\n                - depth\n                - flow\n                - normal\n                - diffuse\n                - denoising_depth\n\n        .. tab:: RenderLayerUnreal\n\n            :class:`~xrfeitoria.data_structure.constants.RenderOutputEnumUnreal`:\n\n                - img\n                - mask\n                - depth\n                - flow\n                - normal\n                - diffuse\n                - metallic\n                - roughness\n                - specular\n                - tangent\n                - basecolor\n\n        .. tab:: ImageFormat\n\n            :class:`~xrfeitoria.data_structure.constants.ImageFileFormatEnum`:\n\n                - png\n                - bmp\n                - jpg\n                - exr\n\nUsed in:\n    - :class:`~xrfeitoria.data_structure.models.RenderJobBlender`\n    - :class:`~xrfeitoria.data_structure.models.RenderJobUnreal`\n    - :meth:`Renderer.add_job <xrfeitoria.renderer.renderer_base.RendererBase.add_job>`\n    - :meth:`Sequence.add_to_renderer <xrfeitoria.sequence.sequence_base.SequenceBase.add_to_renderer>`\n    - ...\n\nExamples:\n\n    .. tabs::\n        .. tab:: define\n\n            .. code-block:: python\n                :linenos:\n\n                from xrfeitoria.data_structure.models import RenderPass\n                RenderPass('img', 'png')\n                RenderPass('mask', 'exr')\n                RenderPass('normal', 'jpg')\n                ...\n\n        .. tab:: RenderJobBlender\n\n            .. code-block:: python\n                :linenos:\n                :emphasize-lines: 6\n\n                from xrfeitoria.data_structure.models import RenderJobBlender, RenderPass\n                RenderJobBlender(\n                    sequence_name=...,\n                    output_path=...,\n                    resolution=...,\n                    render_passes=[RenderPass('img', 'png')],\n                )\n\n        .. tab:: RenderJobUnreal\n\n            .. code-block:: python\n                :linenos:\n                :emphasize-lines: 7\n\n                from xrfeitoria.data_structure.models import RenderJobUnreal, RenderPass\n                RenderJobUnreal(\n                    map_path=...,\n                    sequence_path=...,\n                    output_path=...,\n                    resolution=...,\n                    render_passes=[RenderPass('img', 'png')],\n                )\n\n        .. tab:: seq.add_to_renderer\n\n            .. code-block:: python\n                :linenos:\n                :emphasize-lines: 9\n\n                import xrfeitoria as xf\n                from xrfeitoria.data_structure.models import RenderPass\n\n                with xf.init_blender() as xf_runner:\n                    seq = xf_runner.Sequence.new(seq_name='test'):\n                        seq.add_to_renderer(\n                            output_path=...,\n                            resolution=...,\n                            render_passes=[RenderPass('img', 'png')],\n                        )\n\n                    xf_runner.render()",
   "type": "object",
   "properties": {
      "render_layer": {
         "anyOf": [
            {
               "$ref": "#/$defs/RenderOutputEnumBlender"
            },
            {
               "$ref": "#/$defs/RenderOutputEnumUnreal"
            }
         ],
         "description": "Render layer of the render pass.",
         "title": "Render Layer"
      },
      "image_format": {
         "allOf": [
            {
               "$ref": "#/$defs/ImageFileFormatEnum"
            }
         ],
         "description": "Image format of the render pass."
      }
   },
   "$defs": {
      "ImageFileFormatEnum": {
         "description": "Image file format enum.",
         "enum": [
            "PNG",
            "BMP",
            "JPEG",
            "JPEG",
            "OPEN_EXR"
         ],
         "title": "ImageFileFormatEnum",
         "type": "string"
      },
      "RenderOutputEnumBlender": {
         "description": "Render layer enum of Blender.",
         "enum": [
            "Image",
            "IndexOB",
            "Depth",
            "Denoising Depth",
            "Vector",
            "Normal",
            "DiffCol",
            "actor_infos.json",
            "camera_params"
         ],
         "title": "RenderOutputEnumBlender",
         "type": "string"
      },
      "RenderOutputEnumUnreal": {
         "description": "Render layer enum of Unreal.",
         "enum": [
            "img",
            "mask",
            "depth",
            "flow",
            "normal",
            "diffuse",
            "metallic",
            "roughness",
            "specular",
            "tangent",
            "basecolor",
            "lineart",
            "vertices",
            "skeleton",
            "actor_infos",
            "camera_params",
            "Audio"
         ],
         "title": "RenderOutputEnumUnreal",
         "type": "string"
      }
   },
   "required": [
      "render_layer",
      "image_format"
   ]
}

Fields:

• image_format (xrfeitoria.data_structure.constants.ImageFileFormatEnum)

• render_layer (xrfeitoria.data_structure.constants.RenderOutputEnumBlender | xrfeitoria.data_structure.constants.RenderOutputEnumUnreal)

field image_format: ImageFileFormatEnum [Required]

Image format of the render pass.

field render_layer: RenderOutputEnumBlender | RenderOutputEnumUnreal [Required]

Render layer of the render pass.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.