Edit

clip

  • Article

Discards the current pixel if the specified value is less than zero.

clip(x)

Parameters

Item Description
x
 [in] The specified value.

Return Value

None.

Remarks

Use the clip HLSL intrinsic function to simulate clipping planes if each component of the x parameter represents the distance from a plane.

Also, use the clip function to test for alpha behavior, as shown in the following example:

clip( Input.Color.A < 0.1f ? -1:1 );

Type Description

Name Template Type Component Type Size
x scalar, vector, or matrix float any

Minimum Shader Model

This function is supported in the following shader models.

Shader Model Supported
Shader Model 4 yes (pixel shader only)
Shader Model 3 (DirectX HLSL) yes (pixel shader only)
Shader Model 2 (DirectX HLSL) yes (pixel shader only)
Shader Model 1 (DirectX HLSL) yes (pixel shader only)

See also

Intrinsic Functions (DirectX HLSL)