tcube-gatheralpha-s-float-uint-.md

title	description	ms.assetid	keywords	topic_type	api_name	api_type	ms.topic	ms.date	api_location
TextureCube::GatherAlpha(S,float,uint) function	Returns the alpha components of the four texel values that would be used in a bi-linear filtering operation, along with tile-mapping status. | TextureCube::GatherAlpha(S,float,uint) function	19BD3024-D3E5-4AEA-8C8E-510A4EB527B5	GatherAlpha function HLSL	apiref	GatherAlpha	NA	reference	05/31/2018

TextureCube::GatherAlpha(S,float,uint) function

Returns the alpha components of the four texel values that would be used in a bi-linear filtering operation, along with tile-mapping status.

Syntax

TemplateType GatherAlpha(
  in  SamplerState S,
  in  float3       Location,
  out uint         Status
);

Parameters

S [in]

Type: SamplerState

The zero-based sampler index.

Location [in]

Type: float

The sample coordinates (u,v).

Status [out]

Type: uint

The status of the operation. You can't access the status directly; instead, pass the status to the CheckAccessFullyMapped intrinsic function. CheckAccessFullyMapped returns TRUE if all values from the corresponding Sample, Gather, or Load operation accessed mapped tiles in a tiled resource. If any values were taken from an unmapped tile, CheckAccessFullyMapped returns FALSE.

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

GatherAlpha methods

TextureCube