Class Painter

constructor

• new Painter(
      gl: WebGLRenderingContext | WebGL2RenderingContext,
      transform: IReadonlyTransform,
  ): Painter

  Parameters

  • gl: WebGLRenderingContext | WebGL2RenderingContext
  • transform: IReadonlyTransform

  Returns Painter

cache

context

crossTileSymbolIndex

currentLayer

currentStencilSource

debugBuffer

debugOverlayCanvas

debugOverlayTexture

debugSegments

depthEpsilon

depthRangeFor3D

drawFunctions

emptyProgramConfiguration

glyphManager

height

id

imageManager

lineAtlas

nextStencilID

numSublayers

opaquePassCutoff

options

pixelRatio

quadTriangleIndexBuffer

rasterBoundsBuffer

rasterBoundsBufferPosOnly

rasterBoundsSegments

rasterBoundsSegmentsPosOnly

renderPass

renderToTexture

stencilClearMode

style

symbolFadeChange

terrainFacilitator

tileBorderIndexBuffer

tileExtentBuffer

tileExtentMesh

tileExtentSegments

transform

viewportBuffer

viewportSegments

width

Static ReadonlyMAX_TEXTURE_POOL_SIZE_PER_BUCKET

clearStencil

• clearStencil(): void

  Returns void

colorModeForRenderPass

• colorModeForRenderPass(): Readonly<ColorMode>

  Returns Readonly<ColorMode>

destroy

• destroy(): void

  Returns void

getDepthModeFor3D

• getDepthModeFor3D(): Readonly<DepthMode>

  Returns Readonly<DepthMode>

getDepthModeForSublayer

• getDepthModeForSublayer(
      n: number,
      mask: boolean,
      func?: CompareFuncType | null,
  ): Readonly<DepthMode>

  Parameters

  • n: number
  • mask: boolean
  • Optionalfunc: CompareFuncType | null

  Returns Readonly<DepthMode>

getStencilConfigForOverlapAndUpdateStencilID

• getStencilConfigForOverlapAndUpdateStencilID(
      tileIDs: OverscaledTileID[],
  ): [{ [_: number]: Readonly<StencilMode> }, OverscaledTileID[]]

  Parameters

  • tileIDs: OverscaledTileID[]

  Returns [{ [_: number]: Readonly<StencilMode> }, OverscaledTileID[]]

getTileTexture

• getTileTexture(size: number): Texture

  Parameters

  • size: number

  Returns Texture

initDebugOverlayCanvas

• initDebugOverlayCanvas(): void

  Returns void

isPatternMissing

• isPatternMissing(image?: CrossFaded<ResolvedImage> | null): boolean

  Checks whether a pattern image is needed, and if it is, whether it is not loaded.

  Parameters

  • Optionalimage: CrossFaded<ResolvedImage> | null

  Returns boolean

  true if a needed image is missing and rendering needs to be skipped.

maybeDrawCoords

• maybeDrawCoords(): void

  Render the coords framebuffer if it is coordsDirty

  Returns void

maybeDrawDepth

• maybeDrawDepth(requireExact: boolean): void

  Update the depth framebuffer if the camera has moved or tiles have reloaded. Marks coords as depthDirty so they are re-rendered on next demand.

  Parameters

  • requireExact: boolean

  Returns void

opaquePassEnabledForLayer

• opaquePassEnabledForLayer(): boolean

  Returns boolean

overLimit

• overLimit(): boolean

  Returns boolean

render

• render(style: Style, options: PainterOptions): void

  Parameters

  • style: Style
  • options: PainterOptions

  Returns void

renderLayer

• renderLayer(
      painter: Painter,
      tileManager: TileManager,
      layer: StyleLayer,
      coords: OverscaledTileID[],
      renderOptions: RenderOptions,
  ): void

  Parameters

  • painter: Painter
  • tileManager: TileManager
  • layer: StyleLayer
  • coords: OverscaledTileID[]
  • renderOptions: RenderOptions

  Returns void

resize

• resize(width: number, height: number, pixelRatio: number): void

  Parameters

  • width: number
  • height: number
  • pixelRatio: number

  Returns void

saveTileTexture

• saveTileTexture(texture: Texture): void

  Parameters

  • texture: Texture

  Returns void

setBaseState

• setBaseState(): void

  Returns void

setCustomLayerDefaults

• setCustomLayerDefaults(): void

  Returns void

setup

• setup(): void

  Returns void

stencilConfigForOverlapTwoPass

• stencilConfigForOverlapTwoPass(
      tileIDs: OverscaledTileID[],
  ): [
      { [_: number]: Readonly<StencilMode> },
      { [_: number]: Readonly<StencilMode> },
      OverscaledTileID[],
  ]

  Parameters

  • tileIDs: OverscaledTileID[]

  Returns [
      { [_: number]: Readonly<StencilMode> },
      { [_: number]: Readonly<StencilMode> },
      OverscaledTileID[],
  ]

stencilModeFor3D

• stencilModeFor3D(): StencilMode

  Returns StencilMode

stencilModeForClipping

• stencilModeForClipping(tileID: OverscaledTileID): StencilMode

  Parameters

  • tileID: OverscaledTileID

  Returns StencilMode

useProgram

• useProgram(
      name: string,
      programConfiguration?: ProgramConfiguration | null,
      forceSimpleProjection?: boolean,
      defines?: string[],
  ): Program<any>

  Finds the required shader and its variant (base/terrain/globe, etc.) and binds it, compiling a new shader if required.

  Parameters

  • name: string

    Name of the desired shader.

  • OptionalprogramConfiguration: ProgramConfiguration | null

    Configuration of shader's inputs.

  • OptionalforceSimpleProjection: boolean

    Whether to force the use of a shader variant with simple mercator projection vertex shader.

  • Optionaldefines: string[]

    Additional macros to be injected at the beginning of the shader. Expected format is ['#define XYZ'], etc. False by default. Use true when drawing with a simple projection matrix is desired, eg. when drawing a fullscreen quad.

  Returns Program<any>