Class MemoryInputSystem<TTag, TBufferToMove> | Data Flow Graph | 0.11.10-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class MemoryInputSystem<TTag, TBufferToMove>

    Abstract base for a system that ticks a NodeSet by calling its Update() in OnUpdate(JobHandle). If a conjunction of NodeMemoryInput<TTag> and exists on an entity, it will specify a shallow buffer memory mapping from ECS to the NodeSet. Thus, every frame this holds the ECS buffer will be directly available on the input port specified in NodeMemoryInput<TTag>.

    The system will verify that target node input ports are of type of Buffer<T> of (see NativeAllowReinterpretationAttribute).

    To provide memory mappings for different node sets in a pipeline, subclass this system with different concrete types of .

    Inheritance
    Object
    MemoryInputSystem<TTag, TBufferToMove>
    Namespace: Unity.DataFlowGraph
    Syntax
    public abstract class MemoryInputSystem<TTag, TBufferToMove> : JobComponentSystem where TTag : INodeMemoryInputTag where TBufferToMove : struct, IBufferElementData
    Type Parameters
    Name Description
    TTag

    A unique type tag used with NodeMemoryInput<TTag> to define the concrete component type picked up by this system.

    TBufferToMove

    An type that this system should move to any node/port pair specified in NodeMemoryInput<TTag>.

    Remarks

    Remember to call base functions of any functions you override. Any logical errors you make are notified as log errors every frame.

    Properties

    UnownedSet

    Assign a unique set here, which will be updated in OnUpdate(JobHandle). The set will not be disposed or cleaned up, accordingly, care must be taken to ensure that this system is no longer running once external code has disposed the set.

    Declaration
    protected NodeSet UnownedSet { get; set; }
    Property Value
    Type Description
    NodeSet

    Methods

    OnCreate()

    Declaration
    protected override void OnCreate()

    OnDestroy()

    Declaration
    protected override void OnDestroy()

    OnUpdate(JobHandle)

    Declaration
    protected override JobHandle OnUpdate(JobHandle inputDeps)
    Parameters
    Type Name Description
    JobHandle inputDeps
    Returns
    Type Description
    JobHandle
    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