D3DXCreateRenderToEnvMap function

Creates a render environment map.

Syntax

HRESULT D3DXCreateRenderToEnvMap(
  _In_  LPDIRECT3DDEVICE9    pDevice,
  _In_  UINT                 Size,
  _In_  UINT                 MipLevels,
  _In_  D3DFORMAT            Format,
  _In_  BOOL                 DepthStencil,
  _In_  D3DFORMAT            DepthStencilFormat,
  _Out_ LPD3DXRENDERTOENVMAP *ppRenderToEnvMap
);

Parameters

pDevice [in]

Type: LPDIRECT3DDEVICE9

Pointer to an IDirect3DDevice9 interface, which is the device to associate with the render surface.

Size [in]

Type: UINT

Size of the render surface.

MipLevels [in]

Type: UINT

The number of mipmap levels.

Format [in]

Type: D3DFORMAT

Member of the D3DFORMAT enumerated type that describes the pixel format of the environment map.

DepthStencil [in]

Type: BOOL

If TRUE, the render surface supports a depth-stencil surface. Otherwise, this member is set to FALSE.

DepthStencilFormat [in]

Type: D3DFORMAT

If DepthStencil is set to TRUE, this parameter is a member of the D3DFORMAT enumerated type that describes the depth-stencil format of the environment map.

ppRenderToEnvMap [out]

Type: LPD3DXRENDERTOENVMAP*

Address of a pointer to an ID3DXRenderToEnvMap interface that represents the created render environment map.

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, E_OUTOFMEMORY.

Requirements

Requirement	Value
Header	D3dx9core.h
Library	D3dx9.lib

See also

General Purpose Functions