Class ComputeTaskDecorator

Computes task decorator class.

Inheritance
object
BaseMaterialDecorator
ComputeTaskDecorator
AtmosphereCompute
AutoDepthBounds
DragCompute
Histogram
IrradianceCompute
LuminanceAvg
MorphingCompute
ParticleCompute
PointAttractorCompute
RadianceCompute
SkinningCompute
WindCompute
Inherited Members
Namespace: Evergine.Framework.Graphics
Assembly: Evergine.Framework.dll
Syntax
public abstract class ComputeTaskDecorator : BaseMaterialDecorator

Constructors

ComputeTaskDecorator(ComputeTask)

Initializes a new instance of the ComputeTaskDecorator class.

Declaration
public ComputeTaskDecorator(ComputeTask computeTask)
Parameters
Type Name Description
ComputeTask computeTask

An instance of ComputeTask.

ComputeTaskDecorator(Effect)

Initializes a new instance of the ComputeTaskDecorator class.

Declaration
public ComputeTaskDecorator(Effect effect)
Parameters
Type Name Description
Effect effect

Compute effect.

Properties

ComputeTask

Gets the material.

Declaration
public ComputeTask ComputeTask { get; }
Property Value
Type Description
ComputeTask

Methods

Run(CommandBuffer, uint, uint, uint, string)

Executes the compute effect (dispatch).

Declaration
public void Run(CommandBuffer computeCommandBuffer, uint groupCountX, uint groupCountY, uint groupCountZ, string pass = "Default")
Parameters
Type Name Description
CommandBuffer computeCommandBuffer

The CommandBuffer instance.
uint groupCountX

The number of groups dispatched in the x direction. ThreadGroupCountX must be less than or equal to 65535.
uint groupCountY

The number of groups dispatched in the y direction. ThreadGroupCountY must be less than or equal to 65535.
uint groupCountZ

The number of groups dispatched in the z direction. ThreadGroupCountZ must be less than or equal to 65535.
string pass

The pass name.

Run(uint, uint, uint, string)

Executes compute effect (dispatch).

Declaration
public void Run(uint groupCountX, uint groupCountY, uint groupCountZ, string pass = "Default")
Parameters
Type Name Description
uint groupCountX

The number of groups dispatched in the x direction. ThreadGroupCountX must be less than or equal to 65535.
uint groupCountY

The number of groups dispatched in the y direction. ThreadGroupCountY must be less than or equal to 65535.
uint groupCountZ

The number of groups dispatched in the z direction. ThreadGroupCountZ must be less than or equal to 65535.
string pass

The pass name.

Run1D(CommandBuffer, uint, uint, string)

Executes a 1D compute effect.

Declaration
public void Run1D(CommandBuffer computeCommandBuffer, uint threadCountX, uint groupSizeX = 64, string pass = "Default")
Parameters
Type Name Description
CommandBuffer computeCommandBuffer

The command buffer.
uint threadCountX

The size of the problem.
uint groupSizeX

The group size, 64 by default.
string pass

The pass name.

Run1D(uint, uint, string)

Executes a 1D compute effect.

Declaration
public void Run1D(uint threadCountX, uint groupSizeX = 64, string pass = "Default")
Parameters
Type Name Description
uint threadCountX

The size of the problem.
uint groupSizeX

The group size, 64 by default.
string pass

The pass name.

Run2D(CommandBuffer, uint, uint, uint, uint, string)

Executes a 2D compute effect.

Declaration
public void Run2D(CommandBuffer computeCommandBuffer, uint threadCountX, uint threadCountY, uint groupSizeX = 8, uint groupSizeY = 8, string pass = "Default")
Parameters
Type Name Description
CommandBuffer computeCommandBuffer

The compute CommandBuffer.
uint threadCountX

The x size of the problem.
uint threadCountY

The y size of the problem.
uint groupSizeX

The group size x, 8 by default.
uint groupSizeY

The group size y, 8 by default.
string pass

The pass name.

Run2D(uint, uint, uint, uint, string)

Executes a 2D compute effect.

Declaration
public void Run2D(uint threadCountX, uint threadCountY, uint groupSizeX = 8, uint groupSizeY = 8, string pass = "Default")
Parameters
Type Name Description
uint threadCountX

The x-size of the problem.
uint threadCountY

The y-size of the problem.
uint groupSizeX

The group size x, 8 by default.
uint groupSizeY

The group size y, 8 by default.
string pass

The pass name.

Run3D(CommandBuffer, uint, uint, uint, uint, uint, uint, string)

Execute a 3D compute effect.

Declaration
public void Run3D(CommandBuffer computeCommandBuffer, uint threadCountX, uint threadCountY, uint threadCountZ, uint groupSizeX, uint groupSizeY, uint groupSizeZ, string pass = "Default")
Parameters
Type Name Description
CommandBuffer computeCommandBuffer

The compute CommandBuffer.
uint threadCountX

The x-size of the problem.
uint threadCountY

The y-size of the problem.
uint threadCountZ

The z-size of the problem.
uint groupSizeX

The group size in the x-dimension.
uint groupSizeY

The group size in the y-dimension.
uint groupSizeZ

The group size in the z-dimension.
string pass

The pass name.

Run3D(uint, uint, uint, uint, uint, uint, string)

Executes a 3D compute effect.

Declaration
public void Run3D(uint threadCountX, uint threadCountY, uint threadCountZ, uint groupSizeX, uint groupSizeY, uint groupSizeZ, string pass = "Default")
Parameters
Type Name Description
uint threadCountX

The x size of the problem.
uint threadCountY

The y size of the problem.
uint threadCountZ

The z size of the problem.
uint groupSizeX

The group size for x.
uint groupSizeY

The group size for y.
uint groupSizeZ

The group size for z.
string pass

The pass name.

Extension Methods