D3DX10GetImageInfoFromFile function

Retrieves information about a given image file.

Syntax

HRESULT D3DX10GetImageInfoFromFile(
  _In_  LPCTSTR           pSrcFile,
  _In_  ID3DX10ThreadPump *pPump,
  _In_  D3DX10_IMAGE_INFO *pSrcInfo,
  _Out_ HRESULT           *pHResult
);

Parameters

pSrcFile [in]

Type: LPCTSTR

File name of image to retrieve information about. If UNICODE or _UNICODE are defined, this parameter type is LPCWSTR, otherwise, the type is LPCSTR.

pPump [in]

Type: ID3DX10ThreadPump*

Optional thread pump that can be used to load the info asynchronously. Can be NULL. See ID3DX10ThreadPump.

pSrcInfo [in]

Type: D3DX10_IMAGE_INFO*

Pointer to a D3DX10_IMAGE_INFO structure to be filled with the description of the data in the source file.

pHResult [out]

Type: HRESULT*

A pointer to the return value. May be NULL. If pPump is not NULL, then pHResult must be a valid memory location until the asynchronous execution completes.

Return value

Type: HRESULT

If the function succeeds, the return value is D3D_OK. If the function fails, the return value can be the following: D3DERR_INVALIDCALL

Remarks

This function supports both Unicode and ANSI strings.

Requirements

See also

Texture Functions in D3DX 10