JobSystemSingleThreaded.h

Go to the documentation of this file.

// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
// SPDX-FileCopyrightText: 2023 Jorrit Rouwe
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <Jolt/Core/JobSystem.h>
#include <Jolt/Core/FixedSizeFreeList.h>
 
JPH_NAMESPACE_BEGIN
 
class JPH_EXPORT JobSystemSingleThreaded final : public JobSystem
{
public:
    JPH_OVERRIDE_NEW_DELETE
 
                            JobSystemSingleThreaded() = default;
    explicit                JobSystemSingleThreaded(uint inMaxJobs)         { Init(inMaxJobs); }
 
    void                    Init(uint inMaxJobs);
 
    // See JobSystem
    virtual int             GetMaxConcurrency() const override              { return 1; }
    virtual JobHandle       CreateJob(const char *inName, ColorArg inColor, const JobFunction &inJobFunction, uint32 inNumDependencies = 0) override;
    virtual Barrier *       CreateBarrier() override;
    virtual void            DestroyBarrier(Barrier *inBarrier) override;
    virtual void            WaitForJobs(Barrier *inBarrier) override;
 
protected:
    // Dummy implementation of Barrier, all jobs are executed immediately
    class BarrierImpl : public Barrier
    {
    public:
        JPH_OVERRIDE_NEW_DELETE
 
        // See Barrier
        virtual void        AddJob(const JobHandle &inJob) override         { /* We don't need to track jobs */ }
        virtual void        AddJobs(const JobHandle *inHandles, uint inNumHandles) override { /* We don't need to track jobs */ }
 
    protected:
        virtual void        OnJobFinished(Job *inJob) override              { /* We don't need to track jobs */ }
    };
 
    // See JobSystem
    virtual void            QueueJob(Job *inJob) override;
    virtual void            QueueJobs(Job **inJobs, uint inNumJobs) override;
    virtual void            FreeJob(Job *inJob) override;
 
    BarrierImpl             mDummyBarrier;
 
    using AvailableJobs = FixedSizeFreeList<Job>;
    AvailableJobs           mJobs;
};
 
JPH_NAMESPACE_END