D3DXSaveSurfaceToFileInMemory function

Saves a surface to an image file.

Syntax


HRESULT D3DXSaveSurfaceToFileInMemory(
  _Out_       LPD3DXBUFFER         *ppDestBuf,
  _In_        D3DXIMAGE_FILEFORMAT DestFormat,
  _In_        LPDIRECT3DSURFACE9   pSrcSurface,
  _In_  const PALETTEENTRY         *pSrcPalette,
  _In_  const RECT                 *pSrcRect
);

Parameters

ppDestBuf [out]

Type: LPD3DXBUFFER*

Address of a pointer to an ID3DXBuffer that will store the image.

DestFormat [in]

Type: D3DXIMAGE_FILEFORMAT

D3DXIMAGE_FILEFORMAT specifying the file format to use when saving. This function supports saving to all D3DXIMAGE_FILEFORMAT formats except Portable Pixmap (.ppm) and Targa/Truevision Graphics Adapter (.tga).

pSrcSurface [in]

Type: LPDIRECT3DSURFACE9

Pointer to IDirect3DSurface9 interface containing the image to be saved.

pSrcPalette [in]

Type: const PALETTEENTRY*

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

pSrcRect [in]

Type: const RECT*

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

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 handles conversion to and from compressed texture formats.

Requirements

Header

D3dx9tex.h

Library

D3dx9.lib

See also

Texture Functions in D3DX 9
D3DXSaveVolumeToFileInMemory

 

 

Show: