D3DXSaveSurfaceToFile 関数

  • [アーティクル]

サーフェスをファイルに保存します。

構文

HRESULT D3DXSaveSurfaceToFile(
  _In_       LPCTSTR              pDestFile,
  _In_       D3DXIMAGE_FILEFORMAT DestFormat,
  _In_       LPDIRECT3DSURFACE9   pSrcSurface,
  _In_ const PALETTEENTRY         *pSrcPalette,
  _In_ const RECT                 *pSrcRect
);

パラメーター

pDestFile [in]

型: LPCTSTR

コピー先イメージのファイル名を指定する文字列へのポインター。 コンパイラ設定で Unicode が必要な場合、データ型 LPCTSTR は LPCWSTR に解決されます。 それ以外の場合、文字列データ型は LPCSTR に解決されます。 「解説」を参照してください。

DestFormat [in]

種類: D3DXIMAGE_FILEFORMAT

D3DXIMAGE_FILEFORMAT 保存時に使用するファイル形式を指定します。 この関数では、ポータブル Pixmap (.ppm) と Targa/Truevision Graphics Adapter (.tga) を除 くすべてのD3DXIMAGE_FILEFORMAT 形式への保存がサポートされています。

pSrcSurface [in]

種類: LPDIRECT3DSURFACE9

保存するイメージを含む IDirect3DSurface9 インターフェイスへのポインター。

pSrcPalette [in]

型: const PALETTEENTRY*

256 色のパレットを含む PALETTEENTRY 構造体へのポインター。 このパラメーターは、NULL でもかまいません。

pSrcRect [in]

型: const RECT*

RECT 構造体へのポインター。 ソースの四角形が指定されます。 イメージ全体を指定するには、このパラメーターを NULL に設定します。

戻り値

種類: HRESULT

関数が成功した場合、戻り値はD3D_OK。 関数が失敗した場合、戻り値は次のようになります:D3DERR_INVALIDCALL

解説

コンパイラ設定によって、関数のバージョンも決定されます。 Unicode が定義されている場合、関数呼び出しは D3DXSaveSurfaceToFileW に解決されます。 それ以外の場合、ANSI 文字列が使用されているため、関数呼び出しは D3DXSaveSurfaceToFileA に解決されます。

この関数は、圧縮テクスチャ形式との間の変換を処理します。

必要条件

要件 値
ヘッダー
D3dx9tex.h
ライブラリ
D3dx9.lib

関連項目

D3DX 9 のテクスチャ関数

D3DXSaveTextureToFile

D3DXSaveVolumeToFile