About DataFlowGraph | Data Flow Graph | 0.15.0-preview.5
docs.unity3d.com

    About DataFlowGraph

    DataFlowGraph is a framework which provides a toolbox of runtime APIs for authoring and composing nodes that form a processing graph in DOTS.

    DataFlowGraph can be broken up into various modules:

    • Topology database APIs
    • Traversal cache APIs
    • Graph scheduling and execution
    • Data flow management
    • Compositable node & connection system
    • Messaging / events
    • Strongly typed port I/O system

    Installing DataFlowGraph Package

    To install this package, follow the instructions in the Package Manager documentation.

    Using DataFlowGraph

    Technical details

    Requirements

    This version of DataFlowGraph package is compatible with the following versions of the Unity Editor:

    • 2019.3 and later

    Known limitations

    DataFlowGraph version 0.15 includes the following known limitations:

    • The DataFlowGraph package is an experimental feature
    • This version of DataFlowGraph consists of features that mainly cater to the needs of DOTS Animation
    • GetNodeData for incompatibly typed node handles may return incorrect results
    • There is currently no support for port forwarding to multiple nodes

    Scripting defines

    • DFG_PER_NODE_PROFILING: Enables profiler markers for individual kernel rendering invocations. This has a non-trivial performance penalty on the order of many milliseconds per 100k nodes, but it is more efficient than explicit profile markers in GraphKernel code. May also lead to more indeterministic runtime.
    • DFG_ASSERTIONS: Enable additional internal confidence / consistency checks. High performance penalty.

    Package contents

    Location Description
    <folder> Contains <describe what the folder contains>.
    <file> Contains <describe what the file represents or implements>.
    Folder Location Description

    Document revision history

    Date Reason
    May 29, 2020 Updated known limitations.
    February 13, 2020 Added scripting define usages, updated known limitations.
    August 30, 2019 Unedited. Published to package.
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023