XGTextureAddressComputer::GetTexelElementOffsetBytes Method

Computes the offset in bytes of the given texel element, from the base address of the resource.

Syntax

public:
UINT64 GetTexelElementOffsetBytes(
         UINT32 Plane,
         UINT32 MipLevel,
         UINT64 X,
         UINT32 Y,
         UINT32 ZOrSlice,
         UINT32 Sample
)  

Parameters

Plane
Type: UINT32 

[in] The plane.

MipLevel
Type: UINT32 

[in] The mip level.

X
Type: UINT64 

[in] The X-coordinate of the texel element.

Y
Type: UINT32 

[in] The Y-coordinate of the texel element.

ZOrSlice
Type: UINT32 

[in] The Z OR slice.

Sample
Type: UINT32 

[in] The index of the sample to start copying from. Usually this should be zero. This function returns an error if this parameter is greater than or equal to the sample count.

Return value

Type: UINT64 

If the call is successful, the return value is the offset in bytes of the given texel element, from the base address of the resource.

The following cases cause an error, and the value of -1 (0xffffffffffffffff, the max value of UINT64) will be returned:

• If the plane parameter is greater than or equal to the plane count computed by the texture computer.
• If the sample count is greater than or equal to the number of samples computed by the texture computer.
• If the plane usage flag computed by the texture computer is XG_PLANE_USAGE_COLOR_MASK, XG_PLANE_USAGE_FRAGMENT_MASK, GX_PLANE_USAGE_HTILE, or XG_PLANE_USAGE_UNUSED.

Requirements

Header: Declared in xg.h.

Library: Use xg_x.lib.

See also

XGTextureAddressComputer

XGTextureAddressComputer Members