post_viewport_message

omni.kit.viewport.utility.post_viewport_message(viewport_api_or_window, message: str, message_id: Optional[str] = None)

Posts a message as a toast notification to the viewport or viewport window.

Parameters
  • viewport_api_or_window – The viewport API instance or viewport window to which the message will be posted.

  • message (str) – The content of the message to post.

  • message_id (str, optional) – A unique identifier for the message. Defaults to None.