CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
OdTrRndSgSceneGraphTaskScheduler Class Reference

#include <TrRndSgTaskScheduler.h>

Inheritance diagram for OdTrRndSgSceneGraphTaskScheduler:
OdRxObject

Public Types

enum  TaskType { kGenericTask = 0 , kAuxiliaryTask , kMiscellaneousTask }
 
enum  ProcessType { kProcessTask = 0 , kInformCompletion , kSkipTask , kBreakProcess }
 

Public Member Functions

 OdTrRndSgSceneGraphTaskScheduler ()
 
virtual bool beginQueueProcessing ()
 
virtual void endQueueProcessing ()
 
virtual ProcessType beginTaskProcessing (TaskType)
 
virtual void endTaskProcessing (TaskType, bool)
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

External Scene Graph tasks scheduler. <group ExRender_Windows_Classes>

Definition at line 36 of file TrRndSgTaskScheduler.h.

Member Enumeration Documentation

◆ ProcessType

Enumerator
kProcessTask 
kInformCompletion 
kSkipTask 
kBreakProcess 

Definition at line 45 of file TrRndSgTaskScheduler.h.

◆ TaskType

Enumerator
kGenericTask 
kAuxiliaryTask 
kMiscellaneousTask 

Definition at line 39 of file TrRndSgTaskScheduler.h.

Constructor & Destructor Documentation

◆ OdTrRndSgSceneGraphTaskScheduler()

OdTrRndSgSceneGraphTaskScheduler::OdTrRndSgSceneGraphTaskScheduler ( )
inline

Definition at line 53 of file TrRndSgTaskScheduler.h.

Member Function Documentation

◆ beginQueueProcessing()

virtual bool OdTrRndSgSceneGraphTaskScheduler::beginQueueProcessing ( )
inlinevirtual

Called before starting of Scene Graph tasks queue processing.

Returns
Return true if callback implementor allows task queue processing.

Definition at line 60 of file TrRndSgTaskScheduler.h.

◆ beginTaskProcessing()

virtual ProcessType OdTrRndSgSceneGraphTaskScheduler::beginTaskProcessing ( TaskType  )
inlinevirtual

Called before Scene Graph task processing.

Parameters
taskType[in] Type of queue task.
Returns
Return type of task processing.

Definition at line 72 of file TrRndSgTaskScheduler.h.

◆ endQueueProcessing()

virtual void OdTrRndSgSceneGraphTaskScheduler::endQueueProcessing ( )
inlinevirtual

Called on completion of Scene Graph tasks queue processing if it is allowed by callbck implementor.

Definition at line 64 of file TrRndSgTaskScheduler.h.

◆ endTaskProcessing()

virtual void OdTrRndSgSceneGraphTaskScheduler::endTaskProcessing ( TaskType  ,
bool   
)
inlinevirtual

Called after Scene Graph task processing if callback implementor allows it.

Parameters
taskType[in] Type of queue task.
bStatus[in] 'true' if task processing completed correctly and 'false' if it is canceled.

Definition at line 78 of file TrRndSgTaskScheduler.h.


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