Class JobsUtility

Inheritance

Object

JobsUtility

Namespace: Unity.Jobs.LowLevel.Unsafe

Syntax

public static class JobsUtility

Fields

CacheLineSize

Declaration

public const int CacheLineSize = 64

Field Value

Type	Description
Int32

MaxJobThreadCount

Declaration

public const int MaxJobThreadCount = 128

Field Value

Type	Description
Int32

Properties

IsExecutingJob

Declaration

public static bool IsExecutingJob { get; }

Property Value

Type	Description
Boolean

JobCompilerEnabled

Declaration

public static bool JobCompilerEnabled { get; }

Property Value

Type	Description
Boolean

JobDebuggerEnabled

Declaration

public static bool JobDebuggerEnabled { get; }

Property Value

Type	Description
Boolean

JobWorkerCount

Declaration

public static int JobWorkerCount { get; }

Property Value

Type	Description
Int32

Methods

CheckFenceIsDependencyOrDidSyncFence(ref JobHandle, ref JobHandle)

Declaration

public static bool CheckFenceIsDependencyOrDidSyncFence(ref JobHandle dependency, ref JobHandle dependsOn)

Parameters

Type	Name	Description
JobHandle	dependency
JobHandle	dependsOn

Returns

Type	Description
Boolean

CreateJobReflectionData(Type, Delegate, Delegate, JobsUtility.ManagedJobForEachDelegate, JobsUtility.ManagedJobDelegate, Int32, JobsUtility.ManagedJobMarshalDelegate)

Declaration

public static IntPtr CreateJobReflectionData(Type type, Delegate executeDelegate, Delegate cleanupDelegate = null, JobsUtility.ManagedJobForEachDelegate codegenExecuteDelegate = null, JobsUtility.ManagedJobDelegate codegenCleanupDelegate = null, int codegenUnmanagedJobSize = -1, JobsUtility.ManagedJobMarshalDelegate codegenMarshalToBurstDelegate = null)

Parameters

Type	Name	Description
Type	type
Delegate	executeDelegate
Delegate	cleanupDelegate
JobsUtility.ManagedJobForEachDelegate	codegenExecuteDelegate
JobsUtility.ManagedJobDelegate	codegenCleanupDelegate
Int32	codegenUnmanagedJobSize
JobsUtility.ManagedJobMarshalDelegate	codegenMarshalToBurstDelegate

Returns

Type	Description
IntPtr

CreateJobReflectionData(Type, Type, Delegate, Delegate, JobsUtility.ManagedJobForEachDelegate, JobsUtility.ManagedJobDelegate, Int32, JobsUtility.ManagedJobMarshalDelegate)

Declaration

public static IntPtr CreateJobReflectionData(Type type, Type _, Delegate executeDelegate, Delegate cleanupDelegate = null, JobsUtility.ManagedJobForEachDelegate codegenExecuteDelegate = null, JobsUtility.ManagedJobDelegate codegenCleanupDelegate = null, int codegenUnmanagedJobSize = -1, JobsUtility.ManagedJobMarshalDelegate codegenMarshalToBurstDelegate = null)

Parameters

Type	Name	Description
Type	type
Type	_
Delegate	executeDelegate
Delegate	cleanupDelegate
JobsUtility.ManagedJobForEachDelegate	codegenExecuteDelegate
JobsUtility.ManagedJobDelegate	codegenCleanupDelegate
Int32	codegenUnmanagedJobSize
JobsUtility.ManagedJobMarshalDelegate	codegenMarshalToBurstDelegate

Returns

Type	Description
IntPtr

CreateJobReflectionData(Type, Type, JobType, Delegate, Delegate, JobsUtility.ManagedJobForEachDelegate, JobsUtility.ManagedJobDelegate, Int32, JobsUtility.ManagedJobMarshalDelegate)

Declaration

public static IntPtr CreateJobReflectionData(Type type, Type _, JobType jobType, Delegate executeDelegate, Delegate cleanupDelegate = null, JobsUtility.ManagedJobForEachDelegate codegenExecuteDelegate = null, JobsUtility.ManagedJobDelegate codegenCleanupDelegate = null, int codegenUnmanagedJobSize = -1, JobsUtility.ManagedJobMarshalDelegate codegenMarshalToBurstDelegate = null)

Parameters

Type	Name	Description
Type	type
Type	_
JobType	jobType
Delegate	executeDelegate
Delegate	cleanupDelegate
JobsUtility.ManagedJobForEachDelegate	codegenExecuteDelegate
JobsUtility.ManagedJobDelegate	codegenCleanupDelegate
Int32	codegenUnmanagedJobSize
JobsUtility.ManagedJobMarshalDelegate	codegenMarshalToBurstDelegate

Returns

Type	Description
IntPtr

GetDefaultIndicesPerPhase(Int32)

Declaration

public static int GetDefaultIndicesPerPhase(int arrayLength)

Parameters

Type	Name	Description
Int32	arrayLength

Returns

Type	Description
Int32

GetWorkStealingRange(ref JobRanges, Int32, out Int32, out Int32)

Declaration

public static bool GetWorkStealingRange(ref JobRanges ranges, int jobIndex, out int begin, out int end)

Parameters

Type	Name	Description
JobRanges	ranges
Int32	jobIndex
Int32	begin
Int32	end

Returns

Type	Description
Boolean

Initialize()

Declaration

public static void Initialize()

IsCompleted(ref JobHandle)

Declaration

public static bool IsCompleted(ref JobHandle jobHandle)

Parameters

Type	Name	Description
JobHandle	jobHandle

Returns

Type	Description
Boolean

IsMainThread()

Declaration

public static bool IsMainThread()

Returns

Type	Description
Boolean

PatchBufferMinMaxRanges(IntPtr, Void*, Int32, Int32)

Declaration

public static JobsUtility.MinMax PatchBufferMinMaxRanges(IntPtr bufferRangePatchData, void *jobdata, int startIndex, int rangeSize)

Parameters

Type	Name	Description
IntPtr	bufferRangePatchData
Void*	jobdata
Int32	startIndex
Int32	rangeSize

Returns

Type	Description
JobsUtility.MinMax

Schedule(ref JobsUtility.JobScheduleParameters)

Declaration

public static JobHandle Schedule(ref JobsUtility.JobScheduleParameters parameters)

Parameters

Type	Name	Description
JobsUtility.JobScheduleParameters	parameters

Returns

Type	Description
JobHandle

ScheduleBatchedJobsAndComplete(ref JobHandle)

Declaration

public static void ScheduleBatchedJobsAndComplete(ref JobHandle jobHandle)

Parameters

Type	Name	Description
JobHandle	jobHandle

ScheduleJob(IntPtr, JobMetaData*, JobHandle)

Declaration

public static JobHandle ScheduleJob(IntPtr jobFuncPtr, JobMetaData*jobDataPtr, JobHandle dependsOn)

Parameters

Type	Name	Description
IntPtr	jobFuncPtr
JobMetaData*	jobDataPtr
JobHandle	dependsOn

Returns

Type	Description
JobHandle

ScheduleJobParallelFor(IntPtr, IntPtr, JobMetaData*, Int32, Int32, JobHandle)

Declaration

public static JobHandle ScheduleJobParallelFor(IntPtr jobFuncPtr, IntPtr jobCompletionFuncPtr, JobMetaData*jobDataPtr, int arrayLength, int innerloopBatchCount, JobHandle dependsOn)

Parameters

Type	Name	Description
IntPtr	jobFuncPtr
IntPtr	jobCompletionFuncPtr
JobMetaData*	jobDataPtr
Int32	arrayLength
Int32	innerloopBatchCount
JobHandle	dependsOn

Returns

Type	Description
JobHandle

ScheduleParallelFor(ref JobsUtility.JobScheduleParameters, Int32, Int32)

Declaration

public static JobHandle ScheduleParallelFor(ref JobsUtility.JobScheduleParameters parameters, int arrayLength, int innerloopBatchCount)

Parameters

Type	Name	Description
JobsUtility.JobScheduleParameters	parameters
Int32	arrayLength
Int32	innerloopBatchCount

Returns

Type	Description
JobHandle

ScheduleParallelForDeferArraySize(ref JobsUtility.JobScheduleParameters, Int32, Void*, Void*)

Declaration

public static JobHandle ScheduleParallelForDeferArraySize(ref JobsUtility.JobScheduleParameters parameters, int innerloopBatchCount, void *getInternalListDataPtrUnchecked, void *atomicSafetyHandlePtr)

Parameters

Type	Name	Description
JobsUtility.JobScheduleParameters	parameters
Int32	innerloopBatchCount
Void*	getInternalListDataPtrUnchecked
Void*	atomicSafetyHandlePtr

Returns

Type	Description
JobHandle

Shutdown()

Declaration

public static void Shutdown()