Hello!
I’ve been working on swapping from using Movie Render Queue to Movie Render Graphs, I’ve managed to get everything working as expected so far.
I noticed a difference in rendering locally through the editor UI and from command line via scripting (editor mode).
When rendering through the UI I’m not getting display messages in my rendered frames, such as video memory low warnings, however when I render using the same graph through command line I’m getting display messages in the rendered frames.
I’m using a Set Start/End Console Commands node, with “DisableAllScreenMessages” as an “Add Start Commands”.
and the resulting renders come with these messages being displayed
![image|585x122](upload://uv6KUqtX4MFyU69kNOQ4pe802S8.jpeg
I’m using the following command to run the render via command line:
“<UE_INSTALL>/UnrealEditor-Cmd.exe” “<PROJECT_ROOT>\project_build.uproject” /Game/cinematics/episodes/level_sequences/my_level_sequence -ExecutePythonScript=“<RENDER_SCRIPT_DIR>/render_graph.py” -Map=/Game/cinematics/episodes/maps/my_map -LevelSequence=/Game/cinematics/episodes/level_sequences/my_level_sequence -FileNamePrefix=“my_rendered_frame” -OutputDir=“<RENDER_FOLDER>” -CustomStartFrame=0 -CustomEndFrame=10 -MovieRenderGraph=/Game/rendering/mrg_configs/my_render_graph -windowed -unattended -log
The script being used to render using the Movie Render Graph is attached below.
import typing
import traceback
import unreal
"""
Python Globals to keep the UObjects alive through garbage collection.
Must be deleted by hand on completion.
"""
subsystem = None
executor = None
@staticmethod
def on_queue_finished_callback(
executor: unreal.MoviePipelineExecutorBase, success: bool
):
unreal.log("Render completed. Success: " + str(success))
unreal.SystemLibrary.quit_editor()
def render(
graph_package_path: str,
sequence_package_path: str,
map_package_path: str,
file_name_prefix: str,
output_directory: str,
custom_start_frame: int,
custom_end_frame: int,
):
pipeline_queue_subsystem = unreal.get_editor_subsystem(
unreal.MoviePipelineQueueSubsystem
)
pipeline_queue = pipeline_queue_subsystem.get_queue()
render_job = pipeline_queue.allocate_new_job(unreal.MoviePipelineExecutorJob)
# Get the Movie Render Graph config from the package path and set it on the Render Job.
movie_render_graph_asset = unreal.load_asset(graph_package_path)
render_job.set_graph_preset(movie_render_graph_asset)
# Setting basics like Sequence and Map to render.
set_editor_properties_on_job(
job=render_job,
sequence_package_path=sequence_package_path,
map_package_path=map_package_path,
)
# Set the File Name prefix.
set_user_exposed_variables(
job=render_job,
variable_name="FileNameFormat",
value=f"{file_name_prefix}_" + "{frame_number_shot}",
)
# Set the Output Directory.
set_user_exposed_variables(
job=render_job,
variable_name="OutputDirectory",
value=unreal.DirectoryPath(output_directory).export_text(),
is_path=True,
)
# Set custom frame range if passed by submitter.
if custom_start_frame is not None:
# Set the Output Directory.
set_user_exposed_variables(
job=render_job,
variable_name="CustomPlaybackRangeStartFrame",
value=int(custom_start_frame),
)
if custom_end_frame is not None:
set_user_exposed_variables(
job=render_job,
variable_name="CustomPlaybackRangeEndFrame",
value=int(custom_end_frame),
)
set_user_exposed_variables(job=render_job, variable_name="NumWarmUpFrames", value=3)
# We are using the globals keyword to indicate that the executor belongs to the
# global scope to avoid it being garbage collected after the job is finished rendering.
# If we don't do this then the callback will not run and the editor will be stuck open.
global executor
executor = unreal.MoviePipelinePIEExecutor(pipeline_queue_subsystem)
executor.on_executor_finished_delegate.add_callable_unique(
on_queue_finished_callback
)
pipeline_queue_subsystem.render_queue_with_executor_instance(executor=executor)
def set_editor_properties_on_job(
job: unreal.MoviePipelineExecutorJob,
sequence_package_path: str,
map_package_path: str,
):
job.set_editor_property("Sequence", unreal.SoftObjectPath(sequence_package_path))
job.set_editor_property("Map", unreal.SoftObjectPath(map_package_path))
def set_user_exposed_variables(
job: unreal.MoviePipelineExecutorJob,
variable_name: str,
value: typing.Any,
is_path: bool = False,
):
"""
Finds the output on the Movie Render Graph set on the job
passed and sets the frame in/out as an override.
Args:
job (unreal.MoviePipelineExecutorJob): A render job.
variable_name (str): The internal name of a variable on the Movie Render Graph
being used by the render job passed.
value (typing.Any): The value to set on the variable override.
"""
graph = job.get_graph_preset()
variables = graph.get_variables()
if not variables:
unreal.log(f"No variables are exposed on the passed graph.")
for variable in variables:
if variable.get_member_name() == variable_name:
unreal.log(f"Found variable of name: {variable_name}")
variable_assignment = job.get_or_create_variable_overrides(graph)
unreal.log(f"Got variable assignment: {variable_assignment}")
if is_path:
variable_assignment.set_value_serialized_string(variable, value)
elif type(value) == str:
variable_assignment.set_value_text(variable, value)
elif type(value) == int:
variable_assignment.set_value_int32(variable, value)
elif type(value) == bool:
variable_assignment.set_value_bool(variable, value)
unreal.log(
f"Set value: {value} on variable assignment: {variable_assignment}"
)
variable_assignment.set_variable_assignment_enable_state(variable, True)
unreal.log(f"Successfully set value: {value} on {variable_name}")
return
unreal.log(
f"Could not find variable: {variable_name} so could not set value: {value}"
)
def flag_missing_parameter(missing_parameter_name: str):
message = f"Required Parameter: '{missing_parameter_name}' is missing from the render command!"
unreal.log(message)
raise ValueError(message)
if __name__ == "__main__":
_, _, cmd_parameters = unreal.SystemLibrary.parse_command_line(
unreal.SystemLibrary.get_command_line()
)
unreal.EditorPythonScripting.set_keep_python_script_alive(True)
try:
sequence_package_path = cmd_parameters.get(
"LevelSequence", None
) or flag_missing_parameter("LevelSequence")
map_package_path = cmd_parameters.get("Map", None) or flag_missing_parameter(
"Map"
)
graph_package_path = cmd_parameters.get(
"MovieRenderGraph", None
) or flag_missing_parameter("MovieRenderGraph")
output_directory = cmd_parameters.get(
"OutputDir", None
) or flag_missing_parameter("OutputDir")
file_name_prefix = cmd_parameters.get(
"FileNamePrefix", None
) or flag_missing_parameter("FileNamePrefix")
custom_start_frame = cmd_parameters.get("CustomStartFrame", None)
custom_end_frame = cmd_parameters.get("CustomEndFrame", None)
render(
graph_package_path=graph_package_path,
sequence_package_path=sequence_package_path,
map_package_path=map_package_path,
file_name_prefix=file_name_prefix,
output_directory=output_directory.replace("\\", "/"),
custom_start_frame=custom_start_frame,
custom_end_frame=custom_end_frame,
)
except:
# Exit the Engine if *any* Exception is raised to avoid the render server
# sitting stuck on an Editor instance.
unreal.log_error(
f"Encountered an unexpected error, shutting down Unreal...\n{traceback.format_exc()}"
)
unreal.SystemLibrary.quit_editor()
Is there any form of workaround, or am I misunderstanding how this is supposed to work?
I am seeing in the log that it is indeed disabling screen messages in both the command-line render and in the editor UI render.