Export (0) Print
Expand All
Expand Minimize
5 out of 7 rated this helpful - Rate this topic

IDirect3DDevice9::CreateOffscreenPlainSurface method

Create an off-screen surface.

Syntax


HRESULT CreateOffscreenPlainSurface(
  [in]           UINT Width,
  [in]           UINT Height,
  [in]           D3DFORMAT Format,
  [in]           D3DPOOL Pool,
  [out, retval]  IDirect3DSurface9 **ppSurface,
  [in]           HANDLE *pSharedHandle
);

Parameters

Width [in]

Type: UINT

Width of the surface.

Height [in]

Type: UINT

Height of the surface.

Format [in]

Type: D3DFORMAT

Format of the surface. See D3DFORMAT.

Pool [in]

Type: D3DPOOL

Surface pool type. See D3DPOOL.

ppSurface [out, retval]

Type: IDirect3DSurface9**

Pointer to the IDirect3DSurface9 interface created.

pSharedHandle [in]

Type: HANDLE*

Reserved. Set this parameter to NULL. This parameter can be used in Direct3D 9 for Windows Vista to share resources.

Return value

Type: HRESULT

If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be the following: D3DERR_INVALIDCALL.

Remarks

D3DPOOL_SCRATCH will return a surface that has identical characteristics to a surface created by the DirectX 8.x method CreateImageSurface.

D3DPOOL_DEFAULT is the appropriate pool for use with the IDirect3DDevice9::StretchRect and IDirect3DDevice9::ColorFill.

D3DPOOL_MANAGED is not allowed when creating an offscreen plain surface. For more information about memory pools, see D3DPOOL.

Off-screen plain surfaces are always lockable, regardless of their pool types.

Requirements

Header

D3D9.h

Library

D3D9.lib

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.