Microsoft DirectX 8.1 (C++)

IDirect3DDevice8::CreateImageSurface

Creates an image surface.

HRESULT CreateImageSurface(
  UINT Width,
  UINT Height,
  D3DFORMAT Format,
  IDirect3DSurface8** ppSurface
);

Parameters

Width
[in] Width of the image surface, in pixels.
Height
[in] Height of the image surface, in pixels.
Format
[in] Member of the D3DFORMAT enumerated type, describing the format of the image surface.
ppSurface
[out, retval] Address of a pointer to an IDirect3DSurface8 interface, representing the created image surface.

Return Values

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value can be one of the following values.

D3DERR_INVALIDCALL
D3DERR_OUTOFVIDEOMEMORY
E_OUTOFMEMORY

Remarks

Image surfaces are place holders, they are surfaces that cannot be used in any Microsoft® Direct3D® operations except locking and IDirect3DDevice8::CopyRects.

Image surfaces are placed in the D3DPOOL_SYSTEMMEM memory class.

Requirements

  Header: Declared in D3d8.h.
  Import Library: Use D3d8.lib.