MapLibre Native Core
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
mbgl Namespace Reference

Namespaces

 actor
 
 debug
 
 detail
 
 gfx
 
 gl
 
 platform
 
 shaders
 
 style
 
 util
 

Classes

class  Actor
 
class  ActorRef
 
class  EstablishedActor
 
class  AspiringActor
 
class  Mailbox
 
class  Message
 
class  MessageImpl
 
class  AskMessageImpl
 
class  AskMessageImpl< void, Object, MemberFn, ArgsTuple >
 
class  Scheduler
 
class  SymbolAnnotation
 
class  LineAnnotation
 
class  FillAnnotation
 
class  CustomLayerFactory
 
class  BackgroundLayerFactory
 
class  CircleLayerFactory
 
class  FillExtrusionLayerFactory
 
class  FillLayerFactory
 
class  HeatmapLayerFactory
 
class  HillshadeLayerFactory
 
class  LayerFactory
 The LayerFactory abstract class. More...
 
class  LayerManager
 A singleton class responsible for creating layer instances. More...
 
class  LineLayerFactory
 
class  LocationIndicatorLayerFactory
 
class  RasterLayerFactory
 
class  SymbolLayerFactory
 
struct  BoundOptions
 Holds options to limit what parts of a map are visible. All fields are optional. More...
 
struct  CameraOptions
 
struct  AnimationOptions
 
struct  FreeCameraOptions
 
class  Map
 
class  MapObserver
 
class  MapOptions
 Holds values for Map options. More...
 
class  MapProjection
 
struct  ProjectionMode
 Holds values for Axonometric rendering. All fields are optional. More...
 
class  RenderedQueryOptions
 
class  SourceQueryOptions
 
struct  PlacedSymbolData
 
class  Renderer
 
class  RendererFrontend
 
class  RendererObserver
 
class  RendererState
 
class  DatabaseFileSource
 
class  FileSource
 
class  FileSourceManager
 A singleton class responsible for managing file sources. More...
 
class  NetworkStatus
 
class  OfflineTilePyramidRegionDefinition
 
class  OfflineGeometryRegionDefinition
 
class  OfflineRegionStatus
 
class  OfflineRegionObserver
 
class  OfflineRegion
 
class  OnlineFileSource
 
class  Resource
 
class  ResourceOptions
 Holds values for resource options. More...
 
class  ResourceTransform
 
class  Response
 
class  CanonicalTileID
 
class  OverscaledTileID
 
class  UnwrappedTileID
 
class  AsyncRequest
 
class  ClientOptions
 Holds values for client options. More...
 
class  Color
 
class  Enum
 
struct  EventPermutation
 
class  Feature
 
struct  FontStackHasher
 
class  LatLng
 
class  LatLngBounds
 
class  EdgeInsets
 The distance on each side between a rectangle and a rectangle within. More...
 
struct  LatLngAltitude
 
struct  ToFeatureType
 
class  Image
 
class  Mutable
 
class  Immutable
 
struct  TypeIndex
 
struct  TypeIndex< T, T, Ts... >
 
struct  TypeIndex< T, U, Ts... >
 
class  IndexedTuple
 
class  IndexedTuple< TypeList< Is... >, TypeList< Ts... > >
 
class  Log
 
class  ProjectedMeters
 
class  Projection
 
class  Range
 
class  Size
 
class  TileServerOptions
 Holds values for tile server options. More...
 
class  Tileset
 
struct  is_utf16char_like
 
struct  is_utf16char_like< const T >
 
struct  is_utf16char_like< char16_t >
 
struct  is_utf16char_like< wchar_t >
 
struct  is_utf16char_like< uint16_t >
 
struct  is_linear_container
 
struct  is_linear_container< std::array< T, N > >
 
struct  is_linear_container< std::vector< Ts... > >
 
struct  TypeList
 
class  WorkRequest
 
class  WorkTask
 
class  WorkTaskImpl
 

Typedefs

using AnnotationID = uint64_t
 
using AnnotationIDs = std::vector< AnnotationID >
 
using ShapeAnnotationGeometry = variant< LineString< double >, Polygon< double >, MultiLineString< double >, MultiPolygon< double > >
 
using Annotation = variant< SymbolAnnotation, LineAnnotation, FillAnnotation >
 
using EnumType = uint32_t
 
using OfflineRegionDefinition = variant< OfflineTilePyramidRegionDefinition, OfflineGeometryRegionDefinition >
 
using OfflineRegionMetadata = std::vector< uint8_t >
 
using OfflineRegions = std::vector< OfflineRegion >
 
using Clock = std::chrono::steady_clock
 
using Seconds = std::chrono::seconds
 
using Milliseconds = std::chrono::milliseconds
 
using TimePoint = Clock::time_point
 
using Duration = Clock::duration
 
using Timestamp = std::chrono::time_point< std::chrono::system_clock, Seconds >
 
template<class T , class E >
using expected = nonstd::expected< T, E >
 
template<class E >
using unexpected = nonstd::unexpected_type< E >
 
using Value = mapbox::base::Value
 
using NullValue = mapbox::base::NullValue
 
using PropertyMap = mapbox::base::ValueObject
 
using FeatureIdentifier = mapbox::feature::identifier
 
using GeoJSONFeature = mapbox::feature::feature< double >
 
using FeatureState = mapbox::base::ValueObject
 
using FeatureStates = std::unordered_map< std::string, FeatureState >
 
using LayerFeatureStates = std::unordered_map< std::string, FeatureStates >
 
using FontStack = std::vector< std::string >
 
using FontStackHash = std::size_t
 
using ScreenCoordinate = mapbox::geometry::point< double >
 
using ScreenLineString = mapbox::geometry::line_string< double >
 
using ScreenBox = mapbox::geometry::box< double >
 
using GeoJSON = mapbox::geojson::geojson
 
using FeatureCollection = mapbox::geojson::feature_collection
 
using FeatureExtensionValue = mapbox::util::variant< Value, FeatureCollection >
 
using EmptyGeometry = mapbox::geometry::empty
 
template<class T >
using Point = mapbox::geometry::point< T >
 
template<class T >
using LineString = mapbox::geometry::line_string< T >
 
template<class T >
using Polygon = mapbox::geometry::polygon< T >
 
template<class T >
using MultiPoint = mapbox::geometry::multi_point< T >
 
template<class T >
using MultiLineString = mapbox::geometry::multi_line_string< T >
 
template<class T >
using MultiPolygon = mapbox::geometry::multi_polygon< T >
 
template<class T >
using LinearRing = mapbox::geometry::linear_ring< T >
 
template<class T >
using Geometry = mapbox::geometry::geometry< T >
 
using UnassociatedImage = Image< ImageAlphaMode::Unassociated >
 
using PremultipliedImage = Image< ImageAlphaMode::Premultiplied >
 
using AlphaImage = Image< ImageAlphaMode::Exclusive >
 
template<class , class T >
using ExpandToType = T
 
template<typename T >
using is_utf16char_like_pointer = std::integral_constant< bool, std::is_pointer_v< T > &&is_utf16char_like< typename std::remove_pointer< T >::type >::value >
 
template<class TypeList , template< class > class Predicate>
using FilteredTypeList = typename detail::TypeFilter< TypeList, Predicate >::Type
 
template<class... Ts>
using TypeListConcat = typename detail::TypeListConcat< Ts... >::Type
 
template<typename... T>
using variant = mapbox::util::variant< T... >
 
using vec2 = std::array< double, 2 >
 
using vec3 = std::array< double, 3 >
 
using vec3f = std::array< float, 3 >
 
using vec3i = std::array< int, 3 >
 
using vec4 = std::array< double, 4 >
 

Enumerations

enum  MapChange : uint8_t {
  MapChangeRegionWillChange = 0 , MapChangeRegionWillChangeAnimated = 1 , MapChangeRegionIsChanging = 2 , MapChangeRegionDidChange = 3 ,
  MapChangeRegionDidChangeAnimated = 4 , MapChangeWillStartLoadingMap = 5 , MapChangeDidFinishLoadingMap = 6 , MapChangeDidFailLoadingMap = 7 ,
  MapChangeWillStartRenderingFrame = 8 , MapChangeDidFinishRenderingFrame = 9 , MapChangeDidFinishRenderingFrameFullyRendered = 10 , MapChangeWillStartRenderingMap = 11 ,
  MapChangeDidFinishRenderingMap = 12 , MapChangeDidFinishRenderingMapFullyRendered = 13 , MapChangeDidFinishLoadingStyle = 14 , MapChangeSourceDidChange = 15
}
 
enum class  MapLoadError { StyleParseError , StyleLoadError , NotFoundError , UnknownError }
 
enum class  MapMode : EnumType { Continuous , Static , Tile }
 
enum class  ConstrainMode : EnumType { None , HeightOnly , WidthAndHeight }
 
enum class  ViewportMode : EnumType { Default , FlippedY }
 
enum class  MapDebugOptions : EnumType {
  NoDebug = 0 , TileBorders = 1 << 1 , ParseStatus = 1 << 2 , Timestamps = 1 << 3 ,
  Collision = 1 << 4 , Overdraw = 1 << 5 , StencilClip = 1 << 6 , DepthBuffer = 1 << 7
}
 
enum  FileSourceType : uint8_t {
  Asset , Database , FileSystem , Network ,
  Mbtiles , ResourceLoader
}
 
enum class  OfflineRegionDownloadState { Inactive , Active }
 
enum class  TileNecessity : bool { Optional = false , Required = true }
 
enum class  EventSeverity : uint8_t { Debug , Info , Warning , Error }
 
enum class  Event : uint8_t {
  General , Setup , Shader , ParseStyle ,
  ParseTile , Render , Style , Database ,
  HttpRequest , Sprite , Image , OpenGL ,
  JNI , Android , Crash , Glyph ,
  Timing
}
 
enum class  NorthOrientation : uint8_t { Upwards , Rightwards , Downwards , Leftwards }
 
enum class  FeatureType : uint8_t { Unknown = 0 , Point = 1 , LineString = 2 , Polygon = 3 }
 
enum class  ImageAlphaMode { Unassociated , Premultiplied , Exclusive }
 

Functions

constexpr bool operator== (const CameraOptions &a, const CameraOptions &b)
 
constexpr bool operator!= (const CameraOptions &a, const CameraOptions &b)
 
MBGL_CONSTEXPR MapDebugOptions operator| (MapDebugOptions lhs, MapDebugOptions rhs)
 
MBGL_CONSTEXPR MapDebugOptionsoperator|= (MapDebugOptions &lhs, MapDebugOptions rhs)
 
MBGL_CONSTEXPR bool operator& (MapDebugOptions lhs, MapDebugOptions rhs)
 
MBGL_CONSTEXPR MapDebugOptionsoperator&= (MapDebugOptions &lhs, MapDebugOptions rhs)
 
MBGL_CONSTEXPR MapDebugOptions operator~ (MapDebugOptions value)
 
std::string encodeOfflineRegionDefinition (const OfflineRegionDefinition &)
 
OfflineRegionDefinition decodeOfflineRegionDefinition (const std::string &)
 
::std::ostream & operator<< (::std::ostream &os, const CanonicalTileID &rhs)
 
::std::ostream & operator<< (::std::ostream &os, const OverscaledTileID &rhs)
 
::std::ostream & operator<< (::std::ostream &os, const UnwrappedTileID &rhs)
 
template<typename Enum >
MBGL_CONSTEXPR Enum operator| (Enum a, Enum b)
 
template<typename Enum >
MBGL_CONSTEXPR Enumoperator|= (Enum &a, Enum b)
 
template<typename Enum >
MBGL_CONSTEXPR bool operator& (Enum a, Enum b)
 
template<typename Enum >
MBGL_CONSTEXPR Enum operator~ (Enum value)
 
bool operator== (const Color &colorA, const Color &colorB)
 
bool operator!= (const Color &colorA, const Color &colorB)
 
Color operator* (const Color &color, float alpha)
 
template<class T >
std::optional< T > numericValue (const Value &value)
 
std::optional< std::string > featureIDtoString (const FeatureIdentifier &id)
 
std::string fontStackToString (const FontStack &)
 
std::set< FontStackfontStacks (const std::vector< Immutable< style::Layer::Impl >> &)
 
template<class S , class T >
Point< S > convertPoint (const Point< T > &p)
 
template<class T , typename F >
auto forEachPoint (const Geometry< T > &g, F f)
 
PremultipliedImage decodeImage (const std::string &)
 
std::string encodePNG (const PremultipliedImage &)
 
template<class T , class... Args>
Mutable< T > makeMutable (Args &&... args)
 
template<class S , class U >
Mutable< S > staticMutableCast (const Mutable< U > &u)
 
template<class S , class U >
Immutable< S > staticImmutableCast (const Immutable< U > &u)
 
template<class T , class Fn >
void mutate (Immutable< T > &immutable, Fn &&fn)
 
template<class T >
bool operator== (const Range< T > &a, const Range< T > &b)
 
template<class T >
bool operator!= (const Range< T > &a, const Range< T > &b)
 
constexpr bool operator== (const Size &a, const Size &b)
 
constexpr bool operator!= (const Size &a, const Size &b)
 
template<typename T >
constexpr auto underlying_type (T t) -> typename std::underlying_type_t< T >
 
template<class OutPointer , class InChar >
std::enable_if< is_utf16char_like< InChar >::value &&is_utf16char_like_pointer< OutPointer >::value, OutPointer >::type utf16char_cast (InChar *in)
 

Variables

constexpr const char * API_KEY_KEY = "api-tkey"
 
constexpr const char * API_BASE_URL_KEY = "api-base-url"
 
constexpr const char * MAX_CONCURRENT_REQUESTS_KEY = "max-concurrent-requests"
 
constexpr const char * READ_ONLY_MODE_KEY = "read-only-mode"
 
constexpr EventSeverity disabledEventSeverities []
 
constexpr Event disabledEvents []
 
constexpr EventPermutation disabledEventPermutations []
 

Typedef Documentation

◆ AlphaImage

Definition at line 160 of file image.hpp.

◆ Annotation

Definition at line 65 of file annotation.hpp.

◆ AnnotationID

using mbgl::AnnotationID = typedef uint64_t

Definition at line 14 of file annotation.hpp.

◆ AnnotationIDs

using mbgl::AnnotationIDs = typedef std::vector<AnnotationID>

Definition at line 15 of file annotation.hpp.

◆ Clock

using mbgl::Clock = typedef std::chrono::steady_clock

Definition at line 12 of file chrono.hpp.

◆ Duration

using mbgl::Duration = typedef Clock::duration

Definition at line 18 of file chrono.hpp.

◆ EmptyGeometry

using mbgl::EmptyGeometry = typedef mapbox::geometry::empty

Definition at line 18 of file geometry.hpp.

◆ EnumType

using mbgl::EnumType = typedef uint32_t

Definition at line 14 of file mode.hpp.

◆ ExpandToType

template<class , class T >
using mbgl::ExpandToType = typedef T

Definition at line 63 of file indexed_tuple.hpp.

◆ expected

template<class T , class E >
using mbgl::expected = typedef nonstd::expected<T, E>

Definition at line 8 of file expected.hpp.

◆ FeatureCollection

using mbgl::FeatureCollection = typedef mapbox::geojson::feature_collection

Definition at line 9 of file geojson.hpp.

◆ FeatureExtensionValue

using mbgl::FeatureExtensionValue = typedef mapbox::util::variant<Value, FeatureCollection>

Definition at line 10 of file geojson.hpp.

◆ FeatureIdentifier

using mbgl::FeatureIdentifier = typedef mapbox::feature::identifier

Definition at line 14 of file feature.hpp.

◆ FeatureState

using mbgl::FeatureState = typedef mapbox::base::ValueObject

Definition at line 16 of file feature.hpp.

◆ FeatureStates

using mbgl::FeatureStates = typedef std::unordered_map<std::string, FeatureState>

Definition at line 17 of file feature.hpp.

◆ FilteredTypeList

template<class TypeList , template< class > class Predicate>
using mbgl::FilteredTypeList = typedef typename detail::TypeFilter<TypeList, Predicate>::Type

Definition at line 59 of file type_list.hpp.

◆ FontStack

using mbgl::FontStack = typedef std::vector<std::string>

Definition at line 13 of file font_stack.hpp.

◆ FontStackHash

using mbgl::FontStackHash = typedef std::size_t

Definition at line 14 of file font_stack.hpp.

◆ GeoJSON

using mbgl::GeoJSON = typedef mapbox::geojson::geojson

Definition at line 8 of file geojson.hpp.

◆ GeoJSONFeature

using mbgl::GeoJSONFeature = typedef mapbox::feature::feature<double>

Definition at line 15 of file feature.hpp.

◆ Geometry

template<class T >
using mbgl::Geometry = typedef mapbox::geometry::geometry<T>

Definition at line 42 of file geometry.hpp.

◆ is_utf16char_like_pointer

template<typename T >
using mbgl::is_utf16char_like_pointer = typedef std::integral_constant<bool, std::is_pointer_v<T> && is_utf16char_like<typename std::remove_pointer<T>::type>::value>

Definition at line 21 of file traits.hpp.

◆ LayerFeatureStates

using mbgl::LayerFeatureStates = typedef std::unordered_map<std::string, FeatureStates>

Definition at line 18 of file feature.hpp.

◆ LinearRing

template<class T >
using mbgl::LinearRing = typedef mapbox::geometry::linear_ring<T>

Definition at line 39 of file geometry.hpp.

◆ LineString

template<class T >
using mbgl::LineString = typedef mapbox::geometry::line_string<T>

Definition at line 24 of file geometry.hpp.

◆ Milliseconds

using mbgl::Milliseconds = typedef std::chrono::milliseconds

Definition at line 15 of file chrono.hpp.

◆ MultiLineString

template<class T >
using mbgl::MultiLineString = typedef mapbox::geometry::multi_line_string<T>

Definition at line 33 of file geometry.hpp.

◆ MultiPoint

template<class T >
using mbgl::MultiPoint = typedef mapbox::geometry::multi_point<T>

Definition at line 30 of file geometry.hpp.

◆ MultiPolygon

template<class T >
using mbgl::MultiPolygon = typedef mapbox::geometry::multi_polygon<T>

Definition at line 36 of file geometry.hpp.

◆ NullValue

using mbgl::NullValue = typedef mapbox::base::NullValue

Definition at line 12 of file feature.hpp.

◆ OfflineRegionDefinition

◆ OfflineRegionMetadata

using mbgl::OfflineRegionMetadata = typedef std::vector<uint8_t>

Definition at line 84 of file offline.hpp.

◆ OfflineRegions

using mbgl::OfflineRegions = typedef std::vector<OfflineRegion>

Definition at line 232 of file offline.hpp.

◆ Point

template<class T >
using mbgl::Point = typedef mapbox::geometry::point<T>

Definition at line 21 of file geometry.hpp.

◆ Polygon

template<class T >
using mbgl::Polygon = typedef mapbox::geometry::polygon<T>

Definition at line 27 of file geometry.hpp.

◆ PremultipliedImage

Definition at line 159 of file image.hpp.

◆ PropertyMap

using mbgl::PropertyMap = typedef mapbox::base::ValueObject

Definition at line 13 of file feature.hpp.

◆ ScreenBox

using mbgl::ScreenBox = typedef mapbox::geometry::box<double>

Definition at line 22 of file geo.hpp.

◆ ScreenCoordinate

using mbgl::ScreenCoordinate = typedef mapbox::geometry::point<double>

Definition at line 20 of file geo.hpp.

◆ ScreenLineString

using mbgl::ScreenLineString = typedef mapbox::geometry::line_string<double>

Definition at line 21 of file geo.hpp.

◆ Seconds

using mbgl::Seconds = typedef std::chrono::seconds

Definition at line 14 of file chrono.hpp.

◆ ShapeAnnotationGeometry

using mbgl::ShapeAnnotationGeometry = typedef variant< LineString<double>, Polygon<double>, MultiLineString<double>, MultiPolygon<double> >

Definition at line 25 of file annotation.hpp.

◆ TimePoint

using mbgl::TimePoint = typedef Clock::time_point

Definition at line 17 of file chrono.hpp.

◆ Timestamp

using mbgl::Timestamp = typedef std::chrono::time_point<std::chrono::system_clock, Seconds>

Definition at line 21 of file chrono.hpp.

◆ TypeListConcat

template<class... Ts>
using mbgl::TypeListConcat = typedef typename detail::TypeListConcat<Ts...>::Type

Definition at line 62 of file type_list.hpp.

◆ UnassociatedImage

Definition at line 158 of file image.hpp.

◆ unexpected

template<class E >
using mbgl::unexpected = typedef nonstd::unexpected_type<E>

Definition at line 11 of file expected.hpp.

◆ Value

using mbgl::Value = typedef mapbox::base::Value

Definition at line 11 of file feature.hpp.

◆ variant

template<typename... T>
using mbgl::variant = typedef mapbox::util::variant<T...>

Definition at line 17 of file variant.hpp.

◆ vec2

using mbgl::vec2 = typedef std::array<double, 2>

Definition at line 7 of file vectors.hpp.

◆ vec3

using mbgl::vec3 = typedef std::array<double, 3>

Definition at line 8 of file vectors.hpp.

◆ vec3f

using mbgl::vec3f = typedef std::array<float, 3>

Definition at line 9 of file vectors.hpp.

◆ vec3i

using mbgl::vec3i = typedef std::array<int, 3>

Definition at line 10 of file vectors.hpp.

◆ vec4

using mbgl::vec4 = typedef std::array<double, 4>

Definition at line 11 of file vectors.hpp.

Enumeration Type Documentation

◆ ConstrainMode

We can choose to constrain the map both horizontally or vertically, or only vertically e.g. while panning.

Enumerator
None 
HeightOnly 
WidthAndHeight 

Definition at line 24 of file mode.hpp.

◆ Event

enum mbgl::Event : uint8_t
strong
Enumerator
General 
Setup 
Shader 
ParseStyle 
ParseTile 
Render 
Style 
Database 
HttpRequest 
Sprite 
Image 
OpenGL 
JNI 
Android 
Crash 
Glyph 
Timing 

Definition at line 14 of file event.hpp.

◆ EventSeverity

enum mbgl::EventSeverity : uint8_t
strong
Enumerator
Debug 
Info 
Warning 
Error 

Definition at line 7 of file event.hpp.

◆ FeatureType

enum mbgl::FeatureType : uint8_t
strong
Enumerator
Unknown 
Point 
LineString 
Polygon 

Definition at line 11 of file geometry.hpp.

◆ FileSourceType

enum mbgl::FileSourceType : uint8_t
Enumerator
Asset 
Database 
FileSystem 
Network 
Mbtiles 
ResourceLoader 

Resource loader acts as a proxy and has logic for request delegation to Asset, Cache, and other file sources.

Definition at line 19 of file file_source.hpp.

◆ ImageAlphaMode

enum mbgl::ImageAlphaMode
strong
Enumerator
Unassociated 
Premultiplied 
Exclusive 

Alpha-channel only.

Definition at line 14 of file image.hpp.

◆ MapChange

enum mbgl::MapChange : uint8_t
Enumerator
MapChangeRegionWillChange 
MapChangeRegionWillChangeAnimated 
MapChangeRegionIsChanging 
MapChangeRegionDidChange 
MapChangeRegionDidChangeAnimated 
MapChangeWillStartLoadingMap 
MapChangeDidFinishLoadingMap 
MapChangeDidFailLoadingMap 
MapChangeWillStartRenderingFrame 
MapChangeDidFinishRenderingFrame 
MapChangeDidFinishRenderingFrameFullyRendered 
MapChangeWillStartRenderingMap 
MapChangeDidFinishRenderingMap 
MapChangeDidFinishRenderingMapFullyRendered 
MapChangeDidFinishLoadingStyle 
MapChangeSourceDidChange 

Definition at line 7 of file change.hpp.

◆ MapDebugOptions

Enumerator
NoDebug 
TileBorders 
ParseStatus 
Timestamps 
Collision 
Overdraw 
StencilClip 
DepthBuffer 

Definition at line 37 of file mode.hpp.

◆ MapLoadError

enum mbgl::MapLoadError
strong
Enumerator
StyleParseError 
StyleLoadError 
NotFoundError 
UnknownError 

Definition at line 15 of file map_observer.hpp.

◆ MapMode

enum mbgl::MapMode : EnumType
strong
Enumerator
Continuous 

continually updating map

Static 

a once-off still image of an arbitrary viewport

Tile 

a once-off still image of a single tile

Definition at line 16 of file mode.hpp.

◆ NorthOrientation

enum mbgl::NorthOrientation : uint8_t
strong
Enumerator
Upwards 
Rightwards 
Downwards 
Leftwards 

Definition at line 179 of file geo.hpp.

◆ OfflineRegionDownloadState

Enumerator
Inactive 
Active 

Definition at line 95 of file offline.hpp.

◆ TileNecessity

enum mbgl::TileNecessity : bool
strong
Enumerator
Optional 
Required 

Definition at line 10 of file tile_necessity.hpp.

◆ ViewportMode

Satisfies embedding platforms that requires the viewport coordinate systems to be set according to its standards.

Enumerator
Default 
FlippedY 

Definition at line 32 of file mode.hpp.

Function Documentation

◆ convertPoint()

template<class S , class T >
Point<S> mbgl::convertPoint ( const Point< T > &  p)

Definition at line 45 of file geometry.hpp.

◆ decodeImage()

PremultipliedImage mbgl::decodeImage ( const std::string &  )

◆ decodeOfflineRegionDefinition()

OfflineRegionDefinition mbgl::decodeOfflineRegionDefinition ( const std::string &  )

◆ encodeOfflineRegionDefinition()

std::string mbgl::encodeOfflineRegionDefinition ( const OfflineRegionDefinition )

◆ encodePNG()

std::string mbgl::encodePNG ( const PremultipliedImage )

◆ featureIDtoString()

std::optional<std::string> mbgl::featureIDtoString ( const FeatureIdentifier id)
inline

Definition at line 42 of file feature.hpp.

◆ fontStacks()

std::set<FontStack> mbgl::fontStacks ( const std::vector< Immutable< style::Layer::Impl >> &  )

◆ fontStackToString()

std::string mbgl::fontStackToString ( const FontStack )

◆ forEachPoint()

template<class T , typename F >
auto mbgl::forEachPoint ( const Geometry< T > &  g,
f 
)

Definition at line 68 of file geometry.hpp.

◆ makeMutable()

template<class T , class... Args>
Mutable<T> mbgl::makeMutable ( Args &&...  args)

Definition at line 48 of file immutable.hpp.

◆ mutate()

template<class T , class Fn >
void mbgl::mutate ( Immutable< T > &  immutable,
Fn &&  fn 
)

Constrained mutation of an immutable reference. Makes a temporarily-mutable copy of the input Immutable using the inner type's copy constructor, runs the given callable on the mutable copy, and then freezes the copy and reassigns it to the input reference.

Note that other Immutables referring to the same inner instance are not affected; they continue to referencing the original immutable instance.

Definition at line 127 of file immutable.hpp.

◆ numericValue()

template<class T >
std::optional<T> mbgl::numericValue ( const Value value)

Definition at line 35 of file feature.hpp.

◆ operator!=() [1/4]

constexpr bool mbgl::operator!= ( const CameraOptions a,
const CameraOptions b 
)
constexpr

Definition at line 59 of file camera.hpp.

◆ operator!=() [2/4]

bool mbgl::operator!= ( const Color colorA,
const Color colorB 
)
inline

Definition at line 51 of file color.hpp.

◆ operator!=() [3/4]

template<class T >
bool mbgl::operator!= ( const Range< T > &  a,
const Range< T > &  b 
)

Definition at line 23 of file range.hpp.

◆ operator!=() [4/4]

constexpr bool mbgl::operator!= ( const Size a,
const Size b 
)
inlineconstexpr

Definition at line 34 of file size.hpp.

◆ operator&() [1/2]

template<typename Enum >
MBGL_CONSTEXPR bool mbgl::operator& ( Enum  a,
Enum  b 
)

Definition at line 21 of file bitmask_operations.hpp.

◆ operator&() [2/2]

MBGL_CONSTEXPR bool mbgl::operator& ( MapDebugOptions  lhs,
MapDebugOptions  rhs 
)

Definition at line 56 of file mode.hpp.

◆ operator&=()

MBGL_CONSTEXPR MapDebugOptions& mbgl::operator&= ( MapDebugOptions lhs,
MapDebugOptions  rhs 
)

Definition at line 60 of file mode.hpp.

◆ operator*()

Color mbgl::operator* ( const Color color,
float  alpha 
)
inline

Definition at line 55 of file color.hpp.

◆ operator<<() [1/3]

::std::ostream& mbgl::operator<< ( ::std::ostream &  os,
const CanonicalTileID rhs 
)

◆ operator<<() [2/3]

::std::ostream& mbgl::operator<< ( ::std::ostream &  os,
const OverscaledTileID rhs 
)

◆ operator<<() [3/3]

::std::ostream& mbgl::operator<< ( ::std::ostream &  os,
const UnwrappedTileID rhs 
)

◆ operator==() [1/4]

constexpr bool mbgl::operator== ( const CameraOptions a,
const CameraOptions b 
)
constexpr

Definition at line 50 of file camera.hpp.

◆ operator==() [2/4]

bool mbgl::operator== ( const Color colorA,
const Color colorB 
)
inline

Definition at line 47 of file color.hpp.

◆ operator==() [3/4]

template<class T >
bool mbgl::operator== ( const Range< T > &  a,
const Range< T > &  b 
)

Definition at line 18 of file range.hpp.

◆ operator==() [4/4]

constexpr bool mbgl::operator== ( const Size a,
const Size b 
)
inlineconstexpr

Definition at line 30 of file size.hpp.

◆ operator|() [1/2]

template<typename Enum >
MBGL_CONSTEXPR Enum mbgl::operator| ( Enum  a,
Enum  b 
)

Definition at line 9 of file bitmask_operations.hpp.

◆ operator|() [2/2]

MBGL_CONSTEXPR MapDebugOptions mbgl::operator| ( MapDebugOptions  lhs,
MapDebugOptions  rhs 
)

Definition at line 48 of file mode.hpp.

◆ operator|=() [1/2]

template<typename Enum >
MBGL_CONSTEXPR Enum& mbgl::operator|= ( Enum a,
Enum  b 
)

Definition at line 15 of file bitmask_operations.hpp.

◆ operator|=() [2/2]

MBGL_CONSTEXPR MapDebugOptions& mbgl::operator|= ( MapDebugOptions lhs,
MapDebugOptions  rhs 
)

Definition at line 52 of file mode.hpp.

◆ operator~() [1/2]

template<typename Enum >
MBGL_CONSTEXPR Enum mbgl::operator~ ( Enum  value)

Definition at line 27 of file bitmask_operations.hpp.

◆ operator~() [2/2]

MBGL_CONSTEXPR MapDebugOptions mbgl::operator~ ( MapDebugOptions  value)

Definition at line 64 of file mode.hpp.

◆ staticImmutableCast()

template<class S , class U >
Immutable<S> mbgl::staticImmutableCast ( const Immutable< U > &  u)

Definition at line 114 of file immutable.hpp.

◆ staticMutableCast()

template<class S , class U >
Mutable<S> mbgl::staticMutableCast ( const Mutable< U > &  u)

Definition at line 53 of file immutable.hpp.

◆ underlying_type()

template<typename T >
constexpr auto mbgl::underlying_type ( t) -> typename std::underlying_type_t<T>
constexpr

Definition at line 11 of file traits.hpp.

◆ utf16char_cast()

template<class OutPointer , class InChar >
std::enable_if<is_utf16char_like<InChar>::value && is_utf16char_like_pointer<OutPointer>::value, OutPointer>::type mbgl::utf16char_cast ( InChar *  in)

Definition at line 25 of file traits.hpp.

Variable Documentation

◆ API_BASE_URL_KEY

constexpr const char* mbgl::API_BASE_URL_KEY = "api-base-url"
constexpr

Property name to set / get base url. type: std::string

Definition at line 107 of file file_source.hpp.

◆ API_KEY_KEY

constexpr const char* mbgl::API_KEY_KEY = "api-tkey"
constexpr

Property name to set / get an access token. type: std::string

Definition at line 103 of file file_source.hpp.

◆ disabledEventPermutations

constexpr EventPermutation mbgl::disabledEventPermutations[]
constexpr
Initial value:
= {
{ EventSeverity::Debug, Event::Shader }
}

Definition at line 55 of file event.hpp.

◆ disabledEvents

constexpr Event mbgl::disabledEvents[]
constexpr
Initial value:
= {
Event(-1)
}
Event
Definition: event.hpp:14

Definition at line 51 of file event.hpp.

◆ disabledEventSeverities

constexpr EventSeverity mbgl::disabledEventSeverities[]
constexpr
Initial value:
= {
}
EventSeverity
Definition: event.hpp:7

Definition at line 43 of file event.hpp.

◆ MAX_CONCURRENT_REQUESTS_KEY

constexpr const char* mbgl::MAX_CONCURRENT_REQUESTS_KEY = "max-concurrent-requests"
constexpr

Property name to set / get maximum number of concurrent requests. type: unsigned

Definition at line 111 of file file_source.hpp.

◆ READ_ONLY_MODE_KEY

constexpr const char* mbgl::READ_ONLY_MODE_KEY = "read-only-mode"
constexpr

Property to set database mode. When set, database opens in read-only mode; database opens in read-write-create mode otherwise. type: bool

Definition at line 117 of file file_source.hpp.