D3DXCreateRenderToEnvMap Function

Creates a render environment map.

Syntax

HRESULT D3DXCreateRenderToEnvMap(      

    LPDIRECT3DDEVICE9 pDevice,
    UINT Size,
    UINT MipLevels,
    D3DFORMAT Format,
    BOOL DepthStencil,
    D3DFORMAT DepthStencilFormat,
    LPD3DXRENDERTOENVMAP *ppRenderToEnvMap
);

Parameters

pDevice

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

Size

[in] Size of the render surface.

MipLevels

[in] The number of mipmap levels.

Format

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

DepthStencil

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

DepthStencilFormat

[in] 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, retval] Address of a pointer to an ID3DXRenderToEnvMap interface that represents the created render environment map.

Return Value

If the function succeeds, the return value is D3D_OK.

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

D3DERR_INVALIDCALL	The method call is invalid. For example, a method's parameter may have an invalid value.
E_OUTOFMEMORY	Microsoft?Direct3D?could not allocate sufficient memory to complete the call.

Function Information

Header	d3dx9core.h
Import library	d3dx9.lib
Minimum operating systems	Windows 98