D3DXSaveSurfaceToFile Function

Saves a surface to a file.

Syntax

HRESULT D3DXSaveSurfaceToFile(      

    LPCTSTR pDestFile,
    D3DXIMAGE_FILEFORMAT DestFormat,
    LPDIRECT3DSURFACE9 pSrcSurface,
    const PALETTEENTRY *pSrcPalette,
    const RECT *pSrcRect
);

Parameters

pDestFile

[in] Pointer to a string that specifies the file name of the source image. If the compiler settings require Unicode, the data type LPCTSTR resolves to LPCWSTR. Otherwise, the string data type resolves to LPCSTR. See Remarks.

DestFormat

[in] D3DXIMAGE_FILEFORMAT specifying file format to use when saving.

pSrcSurface

[in] Pointer to IDirect3DSurface9 interface, containing the image to be saved.

pSrcPalette

[in] Pointer to a PALETTEENTRY structure containing a palette of 256 colors. This parameter can be NULL.

pSrcRect

[in] Pointer to a RECT structure. Specifies the source rectangle. Set this parameter to NULL to specify the entire image.

Return Value

If the function succeeds, the return value is D3D_OK.

If the function fails, the return value can be the following.

D3DERR_INVALIDCALL

The method call is invalid. For example, a method's parameter may have an invalid value.

Remarks

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

This function supports the following file formats: .bmp and .dds.

This function handles conversion to and from compressed texture formats.

Function Information

Header	d3dx9tex.h
Import library	d3dx9.lib
Minimum operating systems	Windows 98

See Also

D3DXSaveTextureToFile, D3DXSaveVolumeToFile