.. _omni_graph_ui_nodes_ReadWindowSize_1:

.. _omni_graph_ui_nodes_ReadWindowSize:

.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================

:orphan:

.. meta::
    :title: Read Window Size (BETA)
    :keywords: lang-en omnigraph node ui ReadOnly ui_nodes read-window-size


Read Window Size (BETA)
=======================

.. <description>

Outputs the size of a UI window.

.. </description>


Installation
------------

To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.


Inputs
------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "Is Viewport? (*inputs:isViewport*)", "``bool``", "If true then only viewport windows will be considered.", "False"
    "Name (*inputs:name*)", "``token``", "Name of the window. If there are multiple windows with the same name the first one found will be used.", "None"
    "Widget Path (*inputs:widgetPath*)", "``token``", "Full path to a widget in the window. If specified then 'name' will be ignored and the window containing the widget will be used.", "None"


Outputs
-------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "Height (*outputs:height*)", "``float``", "Height of the window in pixels.", "None"
    "Width (*outputs:width*)", "``float``", "Width of the window in pixels.", "None"


Metadata
--------
.. csv-table::
    :header: "Name", "Value"
    :widths: 30,70

    "Unique ID", "omni.graph.ui_nodes.ReadWindowSize"
    "Version", "1"
    "Extension", "omni.graph.ui_nodes"
    "Has State?", "False"
    "Implementation Language", "Python"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "tests"
    "uiName", "Read Window Size (BETA)"
    "Categories", "ui"
    "Generated Class Name", "OgnReadWindowSizeDatabase"
    "Python Module", "omni.graph.ui_nodes"

