ezEngine Release 26.3
Loading...
Searching...
No Matches
ezAssetProcessorThread Class Reference

Thread used by ezAssetProcessor to schedule work items on the ezEditorProcessorProcess instances. More...

#include <AssetProcessor.h>

Inheritance diagram for ezAssetProcessorThread:

Public Member Functions

virtual ezUInt32 Run () override
 Pure virtual function that contains the thread's main execution logic.
 
- Public Member Functions inherited from ezThread
 ezThread (ezStringView sName="ezThread", ezUInt32 uiStackSize=128 *1024)
 Creates a new thread with specified name and stack size.
 
virtual ~ezThread ()
 Destructor checks if the thread is deleted while still running, which is not allowed as this is a data hazard.
 
ezThreadStatus GetThreadStatus () const
 Returns the thread status.
 
bool IsRunning () const
 Helper function to determine if the thread is running.
 
const char * GetThreadName () const
 Returns the thread name.
 
- Public Member Functions inherited from ezOSThread
 ezOSThread (ezOSThreadEntryPoint threadEntryPoint, void *pUserData=nullptr, ezStringView sName="ezOSThread", ezUInt32 uiStackSize=128 *1024)
 Initializes the thread instance (e.g. thread creation etc.)
 
virtual ~ezOSThread ()
 Destructor.
 
void Start ()
 Starts the thread.
 
void Join ()
 Waits in the calling thread until the thread has finished execution (e.g. returned from the thread function)
 
const ezThreadID & GetThreadID () const
 Returns the thread ID of the thread object, may be used in comparison operations with ezThreadUtils::GetCurrentThreadID() for example.
 

Additional Inherited Members

- Public Types inherited from ezThread
enum  ezThreadStatus { Created = 0 , Running , Finished }
 Thread execution state. More...
 
- Static Public Member Functions inherited from ezThread
static const ezThreadGetCurrentThread ()
 Returns the current ezThread if the current platform thread is an ezThread. Returns nullptr otherwise.
 
- Static Public Member Functions inherited from ezOSThread
static ezInt32 GetThreadCount ()
 Returns how many ezOSThreads are currently active.
 
- Static Public Attributes inherited from ezThread
static ezEvent< const ezThreadEvent &, ezMutexs_ThreadEvents
 Global events for thread lifecycle monitoring.
 
- Protected Attributes inherited from ezOSThread
ezThreadHandle m_hHandle
 
ezThreadID m_ThreadID
 
ezOSThreadEntryPoint m_EntryPoint
 
void * m_pUserData
 
ezString m_sName
 
ezUInt32 m_uiStackSize
 

Detailed Description

Thread used by ezAssetProcessor to schedule work items on the ezEditorProcessorProcess instances.

Member Function Documentation

◆ Run()

ezUInt32 ezAssetProcessorThread::Run ( )
overridevirtual

Pure virtual function that contains the thread's main execution logic.

Override this method to implement the work that the thread should perform. The return value is passed as the thread exit code and can be retrieved after the thread finishes.

Implements ezThread.


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