D3DX10CreateTextureFromFile function

Create a texture resource from a file.

Syntax

HRESULT D3DX10CreateTextureFromFile(
  _In_  ID3D10Device           *pDevice,
  _In_  LPCTSTR                pSrcFile,
  _In_  D3DX10_IMAGE_LOAD_INFO *pLoadInfo,
  _In_  ID3DX10ThreadPump      *pPump,
  _Out_ ID3D10Resource         **ppTexture,
  _Out_ HRESULT                *pHResult
);

Parameters

pDevice [in]

Type: ID3D10Device*

A pointer to the device (see ID3D10Device Interface) that will use the resource.

pSrcFile [in]

Type: LPCTSTR

The name of the file containing the resource. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the data type resolves to LPCSTR. See D3DX10_IMAGE_FILE_FORMAT enumeration for a list of the supported image file formats.

pLoadInfo [in]

Type: D3DX10_IMAGE_LOAD_INFO*

Optional. Identifies the characteristics of a texture (see D3DX10_IMAGE_LOAD_INFO) when the data processor is created; set this to NULL to read the characteristics of a texture when the texture is loaded.

pPump [in]

Type: ID3DX10ThreadPump*

A pointer to a thread pump interface (see ID3DX10ThreadPump Interface). If NULL is specified, this function will behave synchronously and will not return until it is finished.

ppTexture [out]

Type: ID3D10Resource**

The address of a pointer to the texture resource (see ID3D10Resource Interface).

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

The return value is one of the values listed in Direct3D 10 Return Codes.

Remarks

For a list of supported image formats see D3DX10_IMAGE_FILE_FORMAT.

Requirements

Requirement Value
Header
D3DX10.h
Library
D3DX10.lib

See also

Texture Functions in D3DX 10

General Purpose Functions