Edit

Share via

Texture2D::GatherCmpAlpha(S,float,float,int2,int2,int2,int2) function

  • Article

For four texel values that would be used in a bi-linear filtering operation, returns a comparison of their alpha component against a compare value.

Syntax

TemplateType GatherCmpAlpha(
  in SamplerState S,
  in float        Location,
  in float        CompareValue,
  in int2         Offset1,
  in int2         Offset2,
  in int2         Offset3,
  in int2         Offset4
);

Parameters

S [in]

Type: SamplerState

The zero-based sampler index.

Location [in]

Type: float

The sample coordinates (u,v).

CompareValue [in]

Type: float

A value to compare each against each sampled value.

Offset1 [in]

Type: int2

The first offset component applied to the texture coordinates before sampling.

Offset2 [in]

Type: int2

The second offset component applied to the texture coordinates before sampling.

Offset3 [in]

Type: int2

The third offset component applied to the texture coordinates before sampling.

Offset4 [in]

Type: int2

The fourth offset component applied to the texture coordinates before sampling.

Return value

Type: TemplateType

A four-component value whose type is the same as the template type.

Remarks

The texture samples can be used for bilinear interpolation.

This function is supported for the following types of shaders:

Vertex Hull Domain Geometry Pixel Compute
x x x x x x

 

See also

GatherCmpAlpha methods