diff options
Diffstat (limited to 'platform/darwin/src/MGLSource_Private.h')
| -rw-r--r-- | platform/darwin/src/MGLSource_Private.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/platform/darwin/src/MGLSource_Private.h b/platform/darwin/src/MGLSource_Private.h index 6e1d2e379c..acb325e2f3 100644 --- a/platform/darwin/src/MGLSource_Private.h +++ b/platform/darwin/src/MGLSource_Private.h @@ -18,29 +18,29 @@ namespace mbgl { - (instancetype)initWithRawSource:(mbgl::style::Source *)rawSource; /** - A raw pointer to the mbgl object, which is always initialized, either to the + A raw pointer to the mbgl object, which is always initialized, either to the value returned by `mbgl::Map getSource`, or for independently created objects, to the pointer value held in `pendingSource`. In the latter case, this raw - pointer value stays even after ownership of the object is transferred via + pointer value stays even after ownership of the object is transferred via `mbgl::Map addSource`. */ @property (nonatomic) mbgl::style::Source *rawSource; /** Adds the mbgl source that this object represents to the mbgl map. - + Once a mbgl source is added, ownership of the object is transferred to the `mbgl::Map` and this object no longer has an active unique_ptr reference to the - `mbgl::Source`. If this object's mbgl source is in that state, the mbgl source - can still be changed but the changes will not be visible until the `MGLSource` - is added back to the map via `-[MGLStyle addSource:]` and styled with a + `mbgl::Source`. If this object's mbgl source is in that state, the mbgl source + can still be changed but the changes will not be visible until the `MGLSource` + is added back to the map via `-[MGLStyle addSource:]` and styled with a `MGLLayer`. */ - (void)addToMapView:(MGLMapView *)mapView; /** Removes the mbgl source that this object represents from the mbgl map. - + When a mbgl source is removed, ownership of the object is transferred back to the `MGLSource` instance and the unique_ptr reference is valid again. It is safe to add the source back to the style after it is removed. |