Describes the drawing style for a stamp image over aGMSStyleSpan.
Note
Only supports transparent background. If any color is set to theGMSStyleSpanit will
only be treated as a fallback.
Note
Use ofGMSSpriteStylerequires Metal rendering framework. SeeGMSServices::setMetalRendererEnabled:(BOOL)to learn how to enable Metal. IfGMSStyleSpanis
added to a map without Metal being enabled, the stamp will not render and instead the polyline
span will attempt to fallback to any set color. If no color is set, it will fallback to the
default polyline color, [UIColor blueColor].
Note
UseGMSMapView::mapCapabilitiesproperty to query if aGMSMapViewsupportsGMSSpriteStyle.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-27 UTC."],[[["\u003cp\u003e\u003ccode\u003eGMSSpriteStyle\u003c/code\u003e defines how stamp images are drawn over \u003ccode\u003eGMSStyleSpan\u003c/code\u003e on a map, using transparent backgrounds.\u003c/p\u003e\n"],["\u003cp\u003eIt requires enabling Metal rendering framework through \u003ccode\u003eGMSServices::setMetalRendererEnabled:(BOOL)\u003c/code\u003e for proper functionality.\u003c/p\u003e\n"],["\u003cp\u003eIf Metal is not enabled, the stamp might not render and the \u003ccode\u003eGMSStyleSpan\u003c/code\u003e will fallback to its color or a default color.\u003c/p\u003e\n"],["\u003cp\u003eYou can create a \u003ccode\u003eGMSSpriteStyle\u003c/code\u003e instance using \u003ccode\u003espriteStyleWithImage:\u003c/code\u003e or \u003ccode\u003einitWithImage:\u003c/code\u003e by providing a \u003ccode\u003eUIImage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGMSMapView::mapCapabilities\u003c/code\u003e can be used to check if a \u003ccode\u003eGMSMapView\u003c/code\u003e supports \u003ccode\u003eGMSSpriteStyle\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# GoogleMaps Framework Reference\n\nGMSSpriteStyle\n==============\n\n @interface GMSSpriteStyle : ../Classes/GMSStampStyle.html\n\nDescribes the drawing style for a stamp image over a [GMSStyleSpan](../Classes/GMSStyleSpan.html). \nNote\n\nOnly supports transparent background. If any color is set to the [GMSStyleSpan](../Classes/GMSStyleSpan.html) it will\nonly be treated as a fallback. \nNote\n\nUse of `GMSSpriteStyle` requires Metal rendering framework. See\n`GMSServices::setMetalRendererEnabled:(BOOL)` to learn how to enable Metal. If [GMSStyleSpan](../Classes/GMSStyleSpan.html) is\nadded to a map without Metal being enabled, the stamp will not render and instead the polyline\nspan will attempt to fallback to any set color. If no color is set, it will fallback to the\ndefault polyline color, \\[UIColor blueColor\\]. \nNote\n\nUse `GMSMapView::mapCapabilities` property to query if a [GMSMapView](../Classes/GMSMapView.html) supports\n`GMSSpriteStyle`.\n- `\n ``\n ``\n `\n\n ### [+spriteStyleWithImage:](#/c:objc(cs)GMSSpriteStyle(cm)spriteStyleWithImage:)\n\n `\n ` \n Returns a sprite stamp style with the given image. \n\n #### Declaration\n\n Objective-C \n\n + (nonnull instancetype)spriteStyleWithImage:(nonnull UIImage *)image;\n\n #### Parameters\n\n |---------------|-----------------------------------------------|\n | ` `*image*` ` | A `UIImage` object to use as the stamp image. |\n\n #### Return Value\n\n An initialized sprite stamp style.\n- `\n ``\n ``\n `\n\n ### [-initWithImage:](#/c:objc(cs)GMSSpriteStyle(im)initWithImage:)\n\n `\n ` \n Returns an initialized sprite stamp style with the given image. \n\n #### Declaration\n\n Swift \n\n init(image: UIImage)\n\n Objective-C \n\n - (nonnull instancetype)initWithImage:(nonnull UIImage *)image;\n\n #### Parameters\n\n |---------------|-----------------------------------------------|\n | ` `*image*` ` | A `UIImage` object to use as the stamp image. |\n\n #### Return Value\n\n An initialized sprite stamp style."]]
