D3DX10GetImageInfoFromResource function

Retrieves information about a given image in a resource.

Syntax

HRESULT D3DX10GetImageInfoFromResource(
  _In_  HMODULE           hSrcModule,
  _In_  LPCTSTR           pSrcResource,
  _In_  ID3DX10ThreadPump *pPump,
  _In_  D3DX10_IMAGE_INFO *pSrcInfo,
  _Out_ HRESULT           *pHResult
);

Parameters

hSrcModule [in]

Type: HMODULE

Module where the resource is loaded. Set this parameter to NULL to specify the module associated with the image that the operating system used to create the current process.

pSrcResource [in]

Type: LPCTSTR

Pointer to a string that specifies the filename. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the data type resolves to LPCSTR. See Remarks.

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

The compiler setting also determines the function version. If Unicode is defined, the function call resolves to D3DX10GetImageInfoFromResourceW. Otherwise, the function call resolves to D3DX10GetImageInfoFromResourceA because ANSI strings are being used.

Requirements

Requirement Value
Header
D3DX10Tex.h
Library
D3DX10.lib

See also

Texture Functions in D3DX 10