Clarify sprite limits (addImage)

[pathmapper]

mapbox-gl-js version: v1.11.1

Question

From the docs for addImage:

A Map.event:error event will be fired if there is not enough space in the sprite to add this image.

Could you please clarify "not enough space in the sprite"?

Links to related documentation

• https://docs.mapbox.com/mapbox-gl-js/style-spec/sprite/

• https://docs.mapbox.com/help/glossary/sprite/

[mourner]

We should document this better, but basically this is bounded by WebGL MAX_TEXTURE_SIZE, which depends on the user's GPU. Most of the time it's at least 4096x4096, and many modern GPUs have 8192x8192 or 16384x16384. You can check yours through map.painter.context.maxTextureSize.

[pathmapper]

Thanks @mourner, map.painter.context.maxTextureSize worked (with main, #9694 didn't make it into a release until now).

Is there a way to get the current sprite size to find out how much space is left until maxTextureSize is reached?

[pathmapper]

The use case is to add several images with addImage and make sure that it's working for most users, so 4096x4096 seems to be an appropriate maximum sprite size.