get_viewport_from_window_name

omni.kit.viewport.utility.get_viewport_from_window_name(window_name: str = None)

Retrieves the first viewport API instance from a specified window name.

If a window name is not provided or is None, it defaults to the viewport window name defined in the settings (‘/exts/omni.kit.viewport.window/startup/windowName’) or ‘Viewport’.

Parameters:

window_name (str, optional) – The name of the window from which to retrieve the viewport API.

Returns:

An instance of the viewport API or None if no viewport was found.

Return type:

Optional[ViewportAPI]