fsMapViewSetMapHillShadeVerticalExaggeration
This function can be used to set the amount of vertical exaggeration for hill shading on 2D maps. This does not apply to aerial maps (FS_MAP_VIEW_MODE_AERIAL). Vertical exaggeration (VE) is the amplification of terrain slopes (relief) in order to increase contrast. Exaggeration is specified as a power law of the form VE = fExaggeration * x^fExaggerationExponent, where x is the number of meters per rendered pixel. This allows for increasing VE at higher map ranges where less terrain resolution is provided. The exaggeration exponent can be used to make the increase sublinear or superlinear. If a constant exaggeration is desired, set the exponent to 0.
Syntax
bool fsMapViewSetMapHillShadeVerticalExaggeration(
FsContext ctx,
FsTextureId id,
float fExaggeration,
float fExaggerationExponent
);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. |
fExaggeration | The base vertical exaggeration factor. Must be greater than or equal to 0. Defaults to 1 on map creation. |
fExaggerationExponent | The vertical exaggeration exponent. Defaults to 0 (constant exaggeration) on map creation. |
Return Values
Returns false if:
- no texture matches the given MapView ID
- the
ctxis invalid
Otherwise it will return true.
Remarks
N/A