Skip to content

Commit 0ecffad

Browse files
committed
Add a comment about hue bitmap descriptor
1 parent 005785f commit 0ecffad

File tree

1 file changed

+5
-0
lines changed
  • packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/types

1 file changed

+5
-0
lines changed

packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/types/bitmap.dart

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ const double _naturalPixelRatio = 1.0;
5555
/// a default marker icon.
5656
/// Use the [BitmapDescriptor.defaultMarkerWithHue] to create a
5757
/// [BitmapDescriptor] for a default marker icon with a hue value.
58+
/// Use the [BitmapDescriptor.pinConfig] to create a custom icon for
59+
/// [AdvancedMarker].
5860
abstract class BitmapDescriptor {
5961
const BitmapDescriptor._();
6062

@@ -211,6 +213,9 @@ abstract class BitmapDescriptor {
211213
/// Creates a BitmapDescriptor that refers to a colorization of the default
212214
/// marker image. For convenience, there is a predefined set of hue values.
213215
/// See e.g. [hueYellow].
216+
///
217+
/// Doesn't work with [AdvancedMarker]s, [BitmapDescriptor.pinConfig] should
218+
/// be used instead.
214219
static BitmapDescriptor defaultMarkerWithHue(double hue) {
215220
assert(0.0 <= hue && hue < 360.0);
216221
return DefaultMarker(hue: hue);

0 commit comments

Comments
 (0)