Class RenderSessionHandle

java.lang.Object

org.maplibre.nativejni.render.RenderSessionHandle

All Implemented Interfaces:

AutoCloseable

public final class RenderSessionHandle
extends Object
implements AutoCloseable

Owned native render session handle. Close it on the map owner thread.

Method Summary

Modifier and Type	Method	Description
MetalOwnedTextureFrameHandle	acquireMetalOwnedTextureFrame()	Acquires an explicit Metal session-owned texture frame handle.
OpenGLOwnedTextureFrameHandle	acquireOpenGLOwnedTextureFrame()	Acquires an explicit OpenGL session-owned texture frame handle.
VulkanOwnedTextureFrameHandle	acquireVulkanOwnedTextureFrame()	Acquires an explicit Vulkan session-owned texture frame handle.
static RenderSessionHandle	attachMetalBorrowedTexture(MapHandle map, MetalBorrowedTextureDescriptor descriptor)
static RenderSessionHandle	attachMetalOwnedTexture(MapHandle map, MetalOwnedTextureDescriptor descriptor)
static RenderSessionHandle	attachMetalSurface(MapHandle map, MetalSurfaceDescriptor descriptor)
static RenderSessionHandle	attachOpenGLBorrowedTexture(MapHandle map, OpenGLBorrowedTextureDescriptor descriptor)
static RenderSessionHandle	attachOpenGLOwnedTexture(MapHandle map, OpenGLOwnedTextureDescriptor descriptor)
static RenderSessionHandle	attachOpenGLSurface(MapHandle map, OpenGLSurfaceDescriptor descriptor)
static RenderSessionHandle	attachVulkanBorrowedTexture(MapHandle map, VulkanBorrowedTextureDescriptor descriptor)
static RenderSessionHandle	attachVulkanOwnedTexture(MapHandle map, VulkanOwnedTextureDescriptor descriptor)
static RenderSessionHandle	attachVulkanSurface(MapHandle map, VulkanSurfaceDescriptor descriptor)
void	clearData()
void	close()
void	detach()
void	dumpDebugLogs()
JsonValue	getFeatureState(FeatureStateSelector selector)
boolean	isClosed()
MapHandle	map()
FeatureExtensionResult	queryFeatureExtension(String sourceId, Feature feature, String extension, String extensionField)
FeatureExtensionResult	queryFeatureExtension(String sourceId, Feature feature, String extension, String extensionField, JsonValue arguments)
List<QueriedFeature>	queryRenderedFeatures(RenderedQueryGeometry geometry)
List<QueriedFeature>	queryRenderedFeatures(RenderedQueryGeometry geometry, RenderedFeatureQueryOptions options)
List<QueriedFeature>	querySourceFeatures(String sourceId)
List<QueriedFeature>	querySourceFeatures(String sourceId, SourceFeatureQueryOptions options)
TextureImageInfo	readPremultipliedRgba8(NativeBuffer buffer)	Reads into a caller-owned buffer.
void	reduceMemoryUse()
void	removeFeatureState(FeatureStateSelector selector)
void	renderUpdate()
void	resize(int width, int height, double scaleFactor)
void	setFeatureState(FeatureStateSelector selector, JsonValue value)
TextureImageInfo	textureImageInfo()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

attachMetalOwnedTexture

public static RenderSessionHandle attachMetalOwnedTexture(MapHandle map,
 MetalOwnedTextureDescriptor descriptor)

attachMetalBorrowedTexture

public static RenderSessionHandle attachMetalBorrowedTexture(MapHandle map,
 MetalBorrowedTextureDescriptor descriptor)

attachVulkanOwnedTexture

public static RenderSessionHandle attachVulkanOwnedTexture(MapHandle map,
 VulkanOwnedTextureDescriptor descriptor)

attachVulkanBorrowedTexture

public static RenderSessionHandle attachVulkanBorrowedTexture(MapHandle map,
 VulkanBorrowedTextureDescriptor descriptor)

attachOpenGLOwnedTexture

public static RenderSessionHandle attachOpenGLOwnedTexture(MapHandle map,
 OpenGLOwnedTextureDescriptor descriptor)

attachOpenGLBorrowedTexture

public static RenderSessionHandle attachOpenGLBorrowedTexture(MapHandle map,
 OpenGLBorrowedTextureDescriptor descriptor)

attachMetalSurface

public static RenderSessionHandle attachMetalSurface(MapHandle map,
 MetalSurfaceDescriptor descriptor)

attachVulkanSurface

public static RenderSessionHandle attachVulkanSurface(MapHandle map,
 VulkanSurfaceDescriptor descriptor)

attachOpenGLSurface

public static RenderSessionHandle attachOpenGLSurface(MapHandle map,
 OpenGLSurfaceDescriptor descriptor)

resize

public void resize(int width,
 int height,
 double scaleFactor)

renderUpdate

public void renderUpdate()

detach

public void detach()

reduceMemoryUse

public void reduceMemoryUse()

clearData

public void clearData()

dumpDebugLogs

public void dumpDebugLogs()

setFeatureState

public void setFeatureState(FeatureStateSelector selector,
 JsonValue value)

getFeatureState

public JsonValue getFeatureState(FeatureStateSelector selector)

removeFeatureState

public void removeFeatureState(FeatureStateSelector selector)

queryRenderedFeatures

public List<QueriedFeature> queryRenderedFeatures(RenderedQueryGeometry geometry)

queryRenderedFeatures

public List<QueriedFeature> queryRenderedFeatures(RenderedQueryGeometry geometry,
 RenderedFeatureQueryOptions options)

querySourceFeatures

public List<QueriedFeature> querySourceFeatures(String sourceId)

querySourceFeatures

public List<QueriedFeature> querySourceFeatures(String sourceId,
 SourceFeatureQueryOptions options)

queryFeatureExtension

public FeatureExtensionResult queryFeatureExtension(String sourceId,
 Feature feature,
 String extension,
 String extensionField)

queryFeatureExtension

public FeatureExtensionResult queryFeatureExtension(String sourceId,
 Feature feature,
 String extension,
 String extensionField,
 JsonValue arguments)

textureImageInfo

public TextureImageInfo textureImageInfo()

readPremultipliedRgba8

public TextureImageInfo readPremultipliedRgba8(NativeBuffer buffer)

Reads into a caller-owned buffer.

Use textureImageInfo() first when sizing reusable buffers; undersized buffers throw InvalidArgumentException after native reports the required layout.

acquireMetalOwnedTextureFrame

public MetalOwnedTextureFrameHandle acquireMetalOwnedTextureFrame()

Acquires an explicit Metal session-owned texture frame handle.

This advanced API is intended for integrations that submit GPU work using the returned texture and need to release it after that work completes. The returned handle must be closed on the render session owner thread after GPU work using MetalOwnedTextureFrame.texture() has completed. While the handle is open, the native session rejects resize, render, detach, destroy, and second-acquire operations.

acquireVulkanOwnedTextureFrame

public VulkanOwnedTextureFrameHandle acquireVulkanOwnedTextureFrame()

Acquires an explicit Vulkan session-owned texture frame handle.

This advanced API is intended for integrations that submit GPU work using the returned image and need to release it after an external fence signals. The returned handle must be closed on the render session owner thread after GPU work using VulkanOwnedTextureFrame.image() or VulkanOwnedTextureFrame.imageView() has completed. While the handle is open, the native session rejects resize, render, detach, destroy, and second-acquire operations.

acquireOpenGLOwnedTextureFrame

public OpenGLOwnedTextureFrameHandle acquireOpenGLOwnedTextureFrame()

Acquires an explicit OpenGL session-owned texture frame handle.

This advanced API is intended for integrations that submit GPU work using the returned texture and need to release it after that work completes. The returned handle must be closed on the render session owner thread after GPU work using OpenGLOwnedTextureFrame.texture() has completed. While the handle is open, the native session rejects resize, render, detach, destroy, and second-acquire operations.

close

public void close()

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

map

public MapHandle map()