omni.kit.capture.viewport Classes#

Classes Summary:

CaptureDebugMaterialType

Enum representing the debug material type for capture workflows.

CaptureExtension

CaptureExtension provides a capture framework that manages the lifecycle of capturing viewport or application content. This extension is responsible for initializing capture options, preparing the capture environment, including folder structures and rendering configurations, and controlling the overall capture process from startup to shutdown. It supports various capture modes, such as single frame, sequence, and video capture, and it integrates with the rendering subsystem and timeline management to accurately record frame data. The extension can handle different rendering presets and dynamically adjust settings based on the capture configuration while ensuring that previous state settings are restored once the capture is complete.

CaptureMovieType

An enumeration for movie capture types.

CaptureOptions

All Capture options that will be used when capturing.

CaptureRangeType

An enumeration that defines the method for specifying a capture range. Use FRAMES when the capture range is determined by frame numbers, and use SECONDS when it is determined by time in seconds.

CaptureRenderPreset

A set of render presets for capture operations.

CaptureStatus

An enumeration that defines the possible statuses of a capture process in an Omni UI application.