IPixEngine5::ReadTexelValueAsync method

Reads a texel value and returns the result to the host asynchronously.

Syntax

HRESULT ReadTexelValueAsync(
   UINT                       textureId,
   PixEngineTextureSliceIndex sliceIndex,
   int                        x,
   int                        y,
   int                        formatOverride,
   IPixEngine5Callbacks*      callbacks,
   DWORD                      requestCookie,
   DWORD                      progressIntervalMsecs
);

Parameters

textureId
The ID of the texture to read the texel value from.

sliceIndex
The index of the slice within the texture to read the texel value from.

x
The x texel coordinate to read.

y
The y texel coordinate to read.

formatOverride
The color format override.

callbacks
The address of an object that provides the IPixEngine5 callbacks interface.

requestCookie
A cookie that uniquely identifies the request, and can be used to signal for it to be cancelled.

progressIntervalMsecs
Not used.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

See also

IPixEngine5