Home > Working with SGWorld > Window (IWindow6) > SetHUDLayer

SetHUDLayer

This method displays a complete Head Up Display in a graphic form. It accepts a serialized meta DC that is saved into a stream, and draws it on top of the 3D Window.

Note:    To constantly update the HUD, call this method on each OnDrawHUD event. If the HUD layer is permanent, call this method once. TerraExplorer maintains the HUD layer until another call to the method is performed.

 

JavaScript

 

SetHUDLayer(

      pIStream,

      Index,

      MapMode)

 

C#

 

void SetHUDLayer(

      object pIStream,

      int Index = 0,

      int MapMode = 0)

 

C++

 

HRESULT SetHUDLayer(

      IUnknown *  pIStream,

      long  Index,

      long  MapMode) 

Parameters

pIStream

Meta DC saved as a stream. Passing Null clears the current HUD layer.

Index

Reserved. Currently not used. Should be set to zero.

MapMode 

Reserved. Currently not used.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.