A job barrier keeps track of a number of jobs and allows waiting until they are all completed. More...

#include <JobSystem.h>

Inheritance diagram for JobSystem::Barrier:

Public Member Functions
virtual JPH_OVERRIDE_NEW_DELETE void	AddJob (const JobHandle &inJob)=0

virtual void	AddJobs (const JobHandle *inHandles, uint inNumHandles)=0

Public Member Functions inherited from NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

void	operator= (const NonCopyable &)=delete

Protected Member Functions
virtual	~Barrier ()=default
	Destructor, you should call JobSystem::DestroyBarrier instead of destructing this object directly.

virtual void	OnJobFinished (Job *inJob)=0
	Called by a Job to mark that it is finished.

Friends
class	Job
	Job needs to be able to call OnJobFinished.

Detailed Description

A job barrier keeps track of a number of jobs and allows waiting until they are all completed.

Constructor & Destructor Documentation

virtual JobSystem::Barrier::~Barrier ( )

protectedvirtualdefault

Destructor, you should call JobSystem::DestroyBarrier instead of destructing this object directly.

virtual JPH_OVERRIDE_NEW_DELETE void JobSystem::Barrier::AddJob ( const JobHandle & inJob )

pure virtual

Add a job to this barrier Note that jobs can keep being added to the barrier while waiting for the barrier

virtual void JobSystem::Barrier::AddJobs	(	const JobHandle *	inHandles,
		uint	inNumHandles
	)

pure virtual

Add multiple jobs to this barrier Note that jobs can keep being added to the barrier while waiting for the barrier

virtual void JobSystem::Barrier::OnJobFinished ( Job * inJob )

protectedpure virtual

Called by a Job to mark that it is finished.

friend class Job

friend

Job needs to be able to call OnJobFinished.

The documentation for this class was generated from the following file: