XMMatrixShadow function (directxmath.h)

Article
02/22/2024

Builds a transformation matrix that flattens geometry into a plane.

Syntax

XMMATRIX XM_CALLCONV XMMatrixShadow(
  [in] FXMVECTOR ShadowPlane,
  [in] FXMVECTOR LightPosition
) noexcept;

Parameters

[in] ShadowPlane

Reference plane.

[in] LightPosition

4D vector describing the light's position. If the light's w-component is 0.0f, the ray from the origin to the light represents a directional light. If it is 1.0f, the light is a point light.

Return value

Returns the transformation matrix that flattens the geometry into the plane ShadowPlane.

Remarks

This function is useful for forming planar-projected shadows from a light source.

Platform Requirements

Microsoft Visual Studio 2010 or Microsoft Visual Studio 2012 with the Windows SDK for Windows 8. Supported for Win32 desktop apps, Windows Store apps, and Windows Phone 8 apps.

Requirements

Requirement	Value
Target Platform	Windows
Header	directxmath.h

Share via