Layer Management Callbacks

These are various "bookkeeping" callbacks that your map layer can receive (if you provide the callback in your XPLMCreateMapLayer_t). They allow you to manage the lifecycle of your layer, as well as cache any computationally-intensive preparation you might need for drawing.

XPLMMapPrepareCacheCallback_f

callback

A callback used to allow you to cache whatever information your layer needs to draw in the current map area.

This is called each time the map's total bounds change. This is typically triggered by new DSFs being loaded, such that X-Plane discards old, now-distant DSFs and pulls in new ones. At that point, the available bounds of the map also change to match the new DSF area.

By caching just the information you need to draw in this area, your future draw calls can be made faster, since you'll be able to simply "splat" your precomputed information each frame.

We guarantee that the map projection will not change between successive prepare cache calls, nor will any draw call give you bounds outside these total map bounds. So, if you cache the projected map coordinates of all the items you might want to draw in the total map area, you can be guaranteed that no draw call will be asked to do any new work.

typedef void (* XPLMMapPrepareCacheCallback_f)(
                         XPLMMapLayerID       inLayer,
                         const float *        inTotalMapBoundsLeftTopRightBottom,
                         XPLMMapProjectionID  projection,
                         void *               inRefcon
                    );

XPLMMapWillBeDeletedCallback_f

callback

Called just before your map layer gets deleted. Because SDK-created map layers have the same lifetime as the X-Plane map that contains them, if the map gets unloaded from memory, your layer will too.

typedef void (* XPLMMapWillBeDeletedCallback_f)(
                         XPLMMapLayerID       inLayer,
                         void *               inRefcon
                    );