Open 3D Engine AzCore API Reference 25.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Protected Member Functions | List of all members
AZ::JobEmpty Class Reference

#include <JobEmpty.h>

Inherits AZ::Job.

Inherited by AZ::Internal::ParallelForEachForwardFinishJob< ForwardIterator, Function, Partition >, AZ::Internal::ParallelForEachRandomFinishJob< RandomIterator, Function, Partition >, and AZ::Internal::ParallelForFinishJob< Function, Partition >.

Public Member Functions

 AZ_CLASS_ALLOCATOR (JobEmpty, ThreadPoolAllocator)
 
 JobEmpty (bool isAutoDelete, JobContext *context=nullptr)
 
- Public Member Functions inherited from AZ::Job
 Job (bool isAutoDelete, JobContext *context, bool isCompletion=false, AZ::s8 priority=0)
 
void Start ()
 
virtual void Reset (bool isClearDependent)
 
void SetDependent (Job *dependent)
 
void SetDependentStarted (Job *dependent)
 
void SetContinuation (Job *continuationJob)
 
void StartAsChild (Job *childJob)
 
void WaitForChildren ()
 
bool IsCancelled () const
 
bool IsAutoDelete () const
 
bool IsCompletion () const
 
void StartAndAssistUntilComplete ()
 
void StartAndWaitForCompletion ()
 
JobContext * GetContext () const
 
Job * GetDependent () const
 
unsigned int GetDependentCount () const
 
void IncrementDependentCount ()
 
void DecrementDependentCount ()
 
AZ::s8 GetPriority () const
 

Protected Member Functions

virtual void Process ()
 Override to implement your processing.
 
- Protected Member Functions inherited from AZ::Job
void StoreDependent (Job *job)
 
void SetDependentChild (Job *dependent)
 
void IncrementDependentCountAndSetChildFlag ()
 
void SetDependentCountAndFlags (unsigned int countAndFlags)
 
unsigned int GetDependentCountAndFlags () const
 

Additional Inherited Members

- Public Types inherited from AZ::Job
enum  State {
  STATE_SETUP , STATE_STARTED , STATE_PENDING , STATE_PROCESSING ,
  STATE_SUSPENDED
}
 
- Protected Attributes inherited from AZ::Job
JobContext *volatile m_context
 
AZStd::atomic< unsigned int > m_dependentCountAndFlags
 
AZStd::atomic< Job * > m_dependent
 
int m_state
 

Detailed Description

An empty job which performs no processing. This can be useful in setting up some kinds of dependency chains, and is used internally by the job system for that purpose.

Member Function Documentation

◆ Process()

virtual void AZ::JobEmpty::Process ( )
inlineprotectedvirtual

Override to implement your processing.

Implements AZ::Job.

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