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



bool fsMapViewSetWeatherRadarMode(
    FsContext ctx,
    FsTextureId id,
    FsMapViewWeatherRadarMode eMode



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 The weather radar mode. See the Remarks for possible modes.



Return Values

Returns false if:

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

Otherwise it will return true.




The table below shows the available modes for the MapView when showing the weather radar:

eModes Description
FS_MAP_VIEW_WEATHER_RADAR_MODE_TOPVIEW Will be displayed over a 2D map
FS_MAP_VIEW_WEATHER_RADAR_MODE_HORIZONTAL Will be displayed instead of a 2D map
FS_MAP_VIEW_WEATHER_RADAR_MODE_VERTICAL Will be displayed instead of a 2D map



See Also