Method

MaplibreNativeFfiMapattach_vulkan_borrowed_texture

Declaration [src]

MaplibreNativeFfiRenderSession*
maplibre_native_ffi_map_attach_vulkan_borrowed_texture (
  MaplibreNativeFfiMap* self,
  MaplibreNativeFfiVulkanBorrowedTextureDescriptor* descriptor,
  MaplibreNativeFfiRenderSessionAttachOptions* options,
  GError** error
)

Description [src]

Creates a session that renders the map into a ring of your Vulkan images.

The object is ready once maplibre_native_ffi_render_session_ready_async finishes, which fails with the errors that the completion reports.

See mln_map_attach_vulkan_borrowed_texture in the C API reference.

It fails with these errors:

MAPLIBRE_NATIVE_FFI_ERROR_UNSUPPORTED when maplibre_native_ffi_supported_render_backend_mask() lacks MAPLIBRE_NATIVE_FFI_RENDER_BACKEND_FLAG_VULKAN, or when the target supports none of the producer_sync_kinds in options.

Parameters

descriptor

Type: MaplibreNativeFfiVulkanBorrowedTextureDescriptor

No description available.

The data is owned by the caller of the method.

options

Type: MaplibreNativeFfiRenderSessionAttachOptions

No description available.

The data is owned by the caller of the method.

error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.

If the return location is not NULL, then you must initialize it to a NULL GError*.

The argument will be left initialized to NULL by the method if there are no errors.

In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: MaplibreNativeFfiRenderSession

The new object, or NULL with error set.

The caller of the method takes ownership of the returned data, and is responsible for freeing it.