Edit

IDirectDrawSurface7::GetLOD method (ddraw.h)

  • Article

Retrieves the maximum level of detail (LOD) currently set for a managed mipmap surface. This method succeeds only on managed textures.

Syntax

HRESULT GetLOD(
  [out] LPDWORD unnamedParam1
);

Parameters

[out] unnamedParam1

A pointer to a variable that receives the maximum LOD value if the call succeeds.

Return value

If the method succeeds, the return value is DD_OK.

If it fails, the method can return one of the following error values:

  • DDERR_INVALIDOBJECT
  • DDERR_INVALIDPARAMS

Remarks

Applications can call this method only for managed textures (those surfaces that were created with the DDSCAPS2_TEXTUREMANAGE flag). If you call GetLOD on a nonmanaged texture, GetLOD fails and returns DDERR_INVALIDOBJECT.

GetLOD communicates to the Direct3D texture manager the most detailed mipmap in this chain that it should load into local video memory. For example, in a five-level mipmap chain, a value of 2 in the variable at lpdwMaxLOD indicates that the texture manager loads only mipmap levels 2 through 4 into local video memory at any given time. Likewise, if the most detailed mipmap in the chain has the dimensions 256×256, a value of 2 in lpdwMaxLOD means that the largest mipmap ever present in video memory has dimensions 64×64.

Requirements

Requirement Value
Target Platform Windows
Header ddraw.h
Library Ddraw.lib
DLL Ddraw.dll

See also

IDirectDrawSurface7