fsMapViewSetViewMode

This function can be used to select a specific view mode for the given MapView.

 

 

Syntax
bool fsMapViewSetViewMode(
    FsContext ctx,
    FsTextureId id,
    FsMapViewMode eMode
    )

 

 

Members
Parameters Description
ctx A value of type FsContext provided as an argument of the gauge callback.
id The MapView render ID as returned by the function fsMapViewCreate.
eMode Sets the mode that is to be used to display the MapView. See the Remarks below for details.

 

 

Return Values

Returns false if:

  • no texture matches the given MapView ID
  • the ctx is invalid
  • the eMode input is incorrect

Otherwise it will return true.

 

 

Remarks

The table below shows the available render modes for the MapView:

eModes Description
FS_MAP_VIEW_MODE_AERIAL The MapView will be shown as an aerial view of the landscape.
FS_MAP_VIEW_MODE_ALTITUDE The MapView will be colored according to altitude (See fsMapViewSetAltitudeColorList for more details).

Examples Of The Different Map Views

 

 

See Also