docs.unity3d.com
    Show / Hide Table of Contents

    Interface ISimulation

    Interface for simulations.

    Inherited Members
    IDisposable.Dispose()
    Namespace: Unity.Physics
    Syntax
    public interface ISimulation : IDisposable

    Properties

    FinalJobHandle

    The final scheduled job, including all simulation and cleanup. The end of each step should depend on this.

    Declaration
    JobHandle FinalJobHandle { get; }
    Property Value
    Type Description
    JobHandle

    The final job handle.

    FinalSimulationJobHandle

    The final scheduled simulation job. Jobs which use the simulation results should depend on this.

    Declaration
    JobHandle FinalSimulationJobHandle { get; }
    Property Value
    Type Description
    JobHandle

    The final simulation job handle.

    Type

    The implementation type.

    Declaration
    SimulationType Type { get; }
    Property Value
    Type Description
    SimulationType

    The type.

    Methods

    ScheduleStepJobs(SimulationStepInput, JobHandle, Boolean)

    Schedule a set of jobs to step the simulation.

    Declaration
    SimulationJobHandles ScheduleStepJobs(SimulationStepInput input, JobHandle inputDeps, bool multiThreaded = true)
    Parameters
    Type Name Description
    SimulationStepInput input

    The input.

    JobHandle inputDeps

    The input deps.

    Boolean multiThreaded

    (Optional) True if multi threaded.

    Returns
    Type Description
    SimulationJobHandles

    The SimulationJobHandles.

    Step(SimulationStepInput)

    Step the simulation.

    Declaration
    void Step(SimulationStepInput input)
    Parameters
    Type Name Description
    SimulationStepInput input

    The input.

    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