.. _isaacsim_ucx_nodes_UCXPublishImage_1:

.. _isaacsim_ucx_nodes_UCXPublishImage:

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

:orphan:

.. meta::
    :title: UCX Publish Image
    :keywords: lang-en omnigraph node isaacUcx nodes u-c-x-publish-image


UCX Publish Image
=================

.. <description>

This node publishes camera images via UCX communication

.. </description>


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

To use this node enable :ref:`isaacsim.ucx.nodes<ext_isaacsim_ucx_nodes>` in the Extension Manager.


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

    "Buffer Size (*inputs:bufferSize*)", "``uint``", "Size (in bytes) of the buffer (0 if the input is a texture)", "0"
    "Cuda Device Index (*inputs:cudaDeviceIndex*)", "``int``", "Index of the device where the data lives (-1 for host data)", "-1"
    "Data (*inputs:data*)", "``uchar[]``", "Buffer array data", "[]"
    "Data Ptr (*inputs:dataPtr*)", "``uint64``", "Pointer to the raw image array data", "0"
    "Encoding (*inputs:encoding*)", "``token``", "Image encoding format", "rgb8"
    "", "Metadata", "*allowedTokens* = rgb8,rgba8,bgra8,32FC1", ""
    "Exec In (*inputs:execIn*)", "``execution``", "The input execution port", "None"
    "Format (*inputs:format*)", "``uint64``", "Format", "0"
    "Height (*inputs:height*)", "``uint``", "Image height in pixels", "0"
    "Port (*inputs:port*)", "``uint``", "Port number for UCX communication", "13337"
    "Send Cuda Buffer (*inputs:sendCudaBuffer*)", "``bool``", "When true, passes the raw CUDA buffer pointer to UCX and sends a two-message protocol (metadata FlatBuffer + raw GPU tensor). UCX selects the transport \u2014 GPU-direct RDMA, NVLink, or TCP with host staging. Receiver must set tensor_buffer_size. When false, copies frame data into the FlatBuffer on the CPU.", "True"
    "Tag (*inputs:tag*)", "``uint64``", "UCX tag for message identification", "10"
    "Timestamp (*inputs:timeStamp*)", "``double``", "Timestamp in seconds", "0.0"
    "Width (*inputs:width*)", "``uint``", "Image width in pixels", "0"


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

    "Unique ID", "isaacsim.ucx.nodes.UCXPublishImage"
    "Version", "1"
    "Extension", "isaacsim.ucx.nodes"
    "Icon", "ogn/icons/isaacsim.ucx.nodes.UCXPublishImage.svg"
    "Has State?", "False"
    "Implementation Language", "C++"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "UCX Publish Image"
    "Categories", "isaacUcx"
    "Generated Class Name", "OgnUCXPublishImageDatabase"
    "Python Module", "isaacsim.ucx.nodes"

