D3DXLoadSurfaceFromSurface function

Article
11/19/2022

Loads a surface from another surface with color conversion.

Syntax

HRESULT D3DXLoadSurfaceFromSurface(
  _In_       LPDIRECT3DSURFACE9 pDestSurface,
  _In_ const PALETTEENTRY       *pDestPalette,
  _In_ const RECT               *pDestRect,
  _In_       LPDIRECT3DSURFACE9 pSrcSurface,
  _In_ const PALETTEENTRY       *pSrcPalette,
  _In_ const RECT               *pSrcRect,
  _In_       DWORD              Filter,
  _In_       D3DCOLOR           ColorKey
);

Parameters

pDestSurface [in]

Type: LPDIRECT3DSURFACE9

Pointer to an IDirect3DSurface9 interface. Specifies the destination surface, which receives the image.

pDestPalette [in]

Type: const PALETTEENTRY*

Pointer to a PALETTEENTRY structure, the destination palette of 256 colors or NULL.

pDestRect [in]

Type: const RECT*

Pointer to a RECT structure. Specifies the destination rectangle. Set this parameter to NULL to specify the entire surface.

pSrcSurface [in]

Type: LPDIRECT3DSURFACE9

Pointer to an IDirect3DSurface9 interface, representing the source surface.

pSrcPalette [in]

Type: const PALETTEENTRY*

Pointer to a PALETTEENTRY structure, the source palette of 256 colors or NULL.

pSrcRect [in]

Type: const RECT*

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

Filter [in]

Type: DWORD

A combination of one or more D3DX_FILTER, controlling how the image is filtered. Specifying D3DX_DEFAULT for this parameter is the equivalent of specifying D3DX_FILTER_TRIANGLE | D3DX_FILTER_DITHER.

ColorKey [in]

Type: D3DCOLOR

D3DCOLOR value to replace with transparent black, or 0 to disable the colorkey. This is always a 32-bit ARGB color, independent of the source image format. Alpha is significant and should usually be set to FF for opaque color keys. Thus, for opaque black, the value would be equal to 0xFF000000.

Return value

Type: HRESULT

If the function succeeds, the return value is D3D_OK. If the function fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DXERR_INVALIDDATA.

Remarks

This function handles conversion to and from compressed texture formats.

Writing to a non-level-zero surface will not cause the dirty rectangle to be updated. If D3DXLoadSurfaceFromSurface is called and the surface was not already dirty (this is unlikely under normal usage scenarios), the application needs to explicitly call AddDirtyRect on the surface.

Requirements

Requirement	Value
Header	D3dx9tex.h
Library	D3dx9.lib