blendersynth.blender.compositor.render_result

class blendersynth.blender.compositor.render_result.RenderResult(render_paths)

Result of any form of render.

Treated as a series of paths to the output files. Handles different output types, cameras, and frame counts.

property camera_names: list[str]

List of camera names.

property frames: list[int]

List of frame numbers.

get_render_path(output_type, camera_name=None, frame_number=None)

Get the path to a specific render output.

Parameters:

• output_type (str) – Type of output - name returned from define_output().

• camera_name (str) – Name of camera to get render for. Only required if multiple cameras used.

• frame_number (int) – Frame number to get render for. Only required if multiple frames used.

Return type:

str

Returns:

Path to the render output.

property num_cameras: int

Number of cameras in the render.

property num_frames: int

Number of frames in the render.

property num_output_types: int

Number of output types in the render.

property output_types: list[str]

List of output types.

save_all(output_directory, suppress_camera_name=True, suppress_frame_number=True)

Save all the files to a directory.

By default, saves files in format {data_type}_{camera_name}_{frame_number}.{ext}.

Parameters:

• output_directory (str) – Directory to save files to.

• suppress_camera_name (bool) – If True, suppress camera name in filename (only works if single camera).

• suppress_frame_number (bool) – If True, suppress frame number in filename (only works if single frame).

save_file(output_path, output_type, camera_name=None, frame_number=None)

Save a single file to a path.

Parameters:

• output_path (str) – Path to save file to.

• output_type (str) – Type of output - name returned from define_output().

• camera_name (str) – Name of camera to get render for. Only required if multiple cameras used.

• frame_number (int) – Frame number to get render for. Only required if multiple frames used.