Capturing Image Frames

You can capture image frames using render output, a capture track, or console variables.

Topics

Capturing Image Frames with Render Output

You can use the Render Output tool in the Track View to capture image frames.

To capture image frames using Render Output

  1. In O3DE Editor, choose Tools, Track View.

  2. In the Track View, click Tools, Render Output.

  3. In Render Output, set the input and out properties, and then click Add. You will see the capture added under Batch.

  4. Click Start to start the capture.

    Note:
    You may need to adjust the aspect ratio for captured image frames.

To change the aspect ratio for image frame captures

  1. In O3DE Editor, choose Edit, Editor Settings, Global Preferences.

  2. In Preferences, click Viewports.

  3. Under General Viewport Settings, change the value for Perspective View Aspect Ratio. The default value is 1.3333.

Capturing Image Frames using a Capture Track

You can capture image frames when a sequence is played in game mode.

To capture image frames using a capture track

  1. In O3DE Editor, choose Tools, Track View.

  2. In the Track View, right-click the Director node and choose Add Track, Capture.

  3. Double-click the created track to add a capture keyframe. You can set the following key properties:


  1. Set up a Script Canvas graph to play the sequence on game start.

Capturing Image Frames with Console Variables

Capture image frames with the following console variables. For more information, see Using the Console Window .

Capture Image Frames Console Variables

Console VariableDescription
fixed_time_stepLowers the game speed to achieve a constant frame rate throughout the sequence. For example, a time step value of 0.04 specifies a 25 fps gameplay speed. Default value: 0.0
capture_framesEnables frame capture, if the value is set to 1.
capture_file_formatSets the output format for the images. Valid values: .jpg, .tga, .tif
capture_file_prefixSets a file name prefix to use for captured frames. Default: Frame
capture_bufferSets the type of buffer to capture. Valid values: 0 = Color (RGB pixels) 1 = Color with Alpha (RGBA pixels where the alpha channel is set to 255 where geometry exists)

Copyright © 2022 Open 3D Engine Contributors

Documentation Distributed under CC BY 4.0.
For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see https://www.lfprojects.org.


The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.