Interface IImageryLayer
Inherited Members
Namespace:Mapbox.Unity.Map
Assembly:cs.temp.dll.dll
Syntax
public interface IImageryLayer : ILayerProperties
LayerSource
Gets the Data Source for the IMAGE component.
Declaration
ImagerySourceType LayerSource { get; }Property Value
| Type | Description |
|---|---|
| ImagerySourceType |
Methods
SetLayerSource(ImagerySourceType)
Sets the Data Source for the IMAGE component. This can be one of the
Mapbox default styles,
or a custom style. The style url is set as the Tileset ID.
Declaration
void SetLayerSource(ImagerySourceType imageSource)Parameters
| Type | Name | Description |
|---|---|---|
| ImagerySourceType | imageSource | Source of imagery for map. Can be a Mapbox default, or custom style. |
SetProperties(ImagerySourceType, Boolean, Boolean, Boolean)
Changes the settings for the IMAGE component.
Declaration
void SetProperties(ImagerySourceType imageSource, bool useRetina, bool useCompression, bool useMipMap)Parameters
| Type | Name | Description |
|---|---|---|
| ImagerySourceType | imageSource |
|
| System.Boolean | useRetina | Enables or disables high quality imagery. |
| System.Boolean | useCompression | Enables or disables Unity Texture2D compression. |
| System.Boolean | useMipMap | Enables or disables Unity Texture2D image mipmapping. |
UseCompression(Boolean)
Enables or disables Unity Texture2D compression for IMAGE outputs.
Enable this if you need performance rather than a high resolution image.
Declaration
void UseCompression(bool useCompression)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | useCompression | Boolean to toggle |
UseMipMap(Boolean)
Enables or disables Unity Texture2D Mipmap for IMAGE outputs.
Mipmaps are lists of progressively smaller versions of an image, used
to optimize performance. Enabling mipmaps consumes more memory, but
provides improved performance.
Declaration
void UseMipMap(bool useMipMap)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | useMipMap | Boolean to toggle |
UseRetina(Boolean)
Enables or disables high quality images for the specified Data Source. resoluion when enabled is 1024px, and 512px when disabled. Satellite imagery is 512px when enabled, and 256 px when disabled. Changes to this may not take effect until the cache is cleared.
Declaration
void UseRetina(bool useRetina)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | useRetina | Boolean to toggle |