.. _omni_graph_examples_cpp_GpuInteropCpuToDisk_1:

.. _omni_graph_examples_cpp_GpuInteropCpuToDisk:

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

:orphan:

.. meta::
    :title: Example Node: Cpu To Disk
    :keywords: lang-en omnigraph node examples cpp gpu-interop-cpu-to-disk


Example Node: Cpu To Disk
=========================

.. <description>

Saves specified CPU buffer to disk

.. </description>


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

To use this node enable :ref:`omni.graph.examples.cpp<ext_omni_graph_examples_cpp>` in the Extension Manager.


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

    "activeReset (*inputs:active*)", "``bool``", "Alternative to frameCount/startFrame, does a single frame then autoResets to false", "False"
    "aovCpu (*inputs:aovCpu*)", "``string``", "Name of AOV representing CPU buffer of GPU resource", ""
    "aovGpu (*inputs:aovGpu*)", "``string``", "Name of AOV representing GPU resource, used for querying format + properties", ""
    "autoFileNumber (*inputs:autoFileNumber*)", "``int``", "If non zero, this number will be the starting number for export. Each invocation of this node increases the number by 1.", "-1"
    "fileName (*inputs:fileName*)", "``string``", "Optional, if specified the output filename will be fileName_{aovGpu}.{fileType}", ""
    "fileNumber (*inputs:fileNumber*)", "``int``", "Number that will be appended to the exported filename. If -1 then the render product's frame number will be used.", "-1"
    "fileType (*inputs:fileType*)", "``string``", "bmp,png,exr", "png"
    "frameCount (*inputs:frameCount*)", "``int64``", "Number of frames to capture (-1 means never stop)", "-1"
    "gpuFoundations (*inputs:gpu*)", "``uint64``", "Pointer to shared context containing gpu foundations", "0"
    "maxInflightWrites (*inputs:maxInflightWrites*)", "``int``", "Maximum number of in-flight file write operations before blocking on file i/o", "2"
    "renderProduct (*inputs:rp*)", "``uint64``", "Pointer to render product for this view", "0"
    "saveFlags (*inputs:saveFlags*)", "``uint64``", "Flags that will be passed to carb::imaging::IImaging for file saving.", "0"
    "saveLocation (*inputs:saveLocation*)", "``string``", "Folder to save AOVs as AOV_FrameNumber.{exr,png}", ""
    "startFrame (*inputs:startFrame*)", "``uint64``", "Frame to begin saving to disk", "0"


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

    "gpuFoundations (*outputs:gpu*)", "``uint64``", "Pointer to shared context containing gpu foundations", "None"
    "renderProduct (*outputs:rp*)", "``uint64``", "Pointer to render product for this view", "None"


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

    "Unique ID", "omni.graph.examples.cpp.GpuInteropCpuToDisk"
    "Version", "1"
    "Extension", "omni.graph.examples.cpp"
    "Has State?", "False"
    "Implementation Language", "C++"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "None"
    "uiName", "Example Node: Cpu To Disk"
    "Categories", "examples"
    "Generated Class Name", "OgnGpuInteropCpuToDiskDatabase"
    "Python Module", "omni.graph.examples.cpp"

