ID2D1ComputeTransform::CalculateThreadgroups method (d2d1effectauthor.h)

This method allows a compute-shader–based transform to select the number of thread groups to execute based on the number of output pixels it needs to fill.

Syntax

HRESULT CalculateThreadgroups(
  [in]  const D2D1_RECT_L *outputRect,
  [out] UINT32            *dimensionX,
  [out] UINT32            *dimensionY,
  [out] UINT32            *dimensionZ
);

Parameters

[in] outputRect

Type: const D2D1_RECT_L*

The output rectangle that will be filled by the compute transform.

[out] dimensionX

Type: UINT32*

The number of threads in the x dimension.

[out] dimensionY

Type: UINT32*

The number of threads in the y dimension.

[out] dimensionZ

Type: UINT32*

The number of threads in the z dimension.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Remarks

If this call fails, the corresponding ID2D1Effect instance is placed into an error state and fails to draw.

Requirements

See also

ID2D1ComputeTransform

ID2D1EffectContext::LoadComputeShader