RealDocs

UKismetMathLibrary::Matrix_GetFrustumRightPlane

function Engine Blueprint Since 4.0
#include "Kismet/KismetMathLibrary.h"
Access: public Specifiers: staticBlueprintPure

Description

Extracts the right clipping plane from a view-projection matrix. Returns false if extraction fails.

Caveats & Gotchas

  • The plane normal points inward (toward the interior of the frustum), not outward — this is the opposite convention from some other engines.
  • For asymmetric frustums (e.g. VR or off-axis projections) the right and left plane distances will differ; don't assume symmetry.

Signature

static UE_INL_API bool Matrix_GetFrustumRightPlane(const FMatrix& M, FPlane& OutPlane)

Parameters

Name Type Description Default
M const FMatrix& The view-projection matrix to extract the right frustum plane from.
OutPlane FPlane& The extracted right plane of the frustum.

Return Type

bool

Example

Test if a point is inside the right frustum boundary C++
FPlane RightPlane;
if (UKismetMathLibrary::Matrix_GetFrustumRightPlane(ViewProjMatrix, RightPlane))
{
    bool bInsideRight = RightPlane.PlaneDot(TestPoint) >= 0.0f;
}

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.