D3DX11GetImageInfoFromFile function
Note
The D3DX (D3DX 9, D3DX 10, and D3DX 11) utility library is deprecated for Windows 8 and is not supported for Windows Store apps.
Note
Instead of using this function, we recommend that you use the DirectXTex library, GetMetadataFromXXXFile (where XXX is WIC, DDS, or TGA; WIC doesn't support DDS and TGA; D3DX 9 supported TGA as a common art source format for games).
Retrieves information about a given image file.
Syntax
HRESULT D3DX11GetImageInfoFromFile(
_In_ LPCTSTR pSrcFile,
_In_ ID3DX11ThreadPump *pPump,
_In_ D3DX11_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: ID3DX11ThreadPump*
Optional thread pump that can be used to load the info asynchronously. Can be NULL. See ID3DX11ThreadPump Interface.
-
pSrcInfo [in]
-
Type: D3DX11_IMAGE_INFO*
Pointer to a D3DX11_IMAGE_INFO 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
| Requirement | Value |
|---|---|
| Header |
|
| Library |
|