surface.h

Go to the documentation of this file.

 
#ifndef MAPLIBRE_NATIVE_C_SURFACE_H
#define MAPLIBRE_NATIVE_C_SURFACE_H
 
#include <stdint.h>
 
#include "base.h"
#include "completion.h"
#include "render_target.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct mln_metal_surface_descriptor {
  uint32_t size;
  mln_logical_extent extent;
  mln_metal_context_descriptor context;
  void* layer;
} mln_metal_surface_descriptor;

typedef struct mln_vulkan_surface_descriptor {
  uint32_t size;
  mln_logical_extent extent;
  mln_vulkan_context_descriptor context;
  mln_vulkan_non_dispatchable_handle surface;
} mln_vulkan_surface_descriptor;

typedef struct mln_webgpu_surface_descriptor {
  uint32_t size;
  mln_logical_extent extent;
  mln_webgpu_context_descriptor context;
  void* surface;
  uint32_t format;
} mln_webgpu_surface_descriptor;

typedef struct mln_opengl_surface_descriptor {
  uint32_t size;
  mln_logical_extent extent;
  mln_opengl_context_descriptor context;
  void* surface;
} mln_opengl_surface_descriptor;

MLN_API mln_metal_surface_descriptor
mln_metal_surface_descriptor_default(void) MLN_NOEXCEPT;

MLN_API mln_vulkan_surface_descriptor
mln_vulkan_surface_descriptor_default(void) MLN_NOEXCEPT;

MLN_API mln_opengl_surface_descriptor
mln_opengl_surface_descriptor_default(void) MLN_NOEXCEPT;

MLN_API mln_webgpu_surface_descriptor
mln_webgpu_surface_descriptor_default(void) MLN_NOEXCEPT;

MLN_BINDING("execution=lifecycle")
MLN_API mln_status mln_map_attach_metal_surface(
  mln_map map, const mln_metal_surface_descriptor* descriptor,
  const mln_render_session_attach_options* options,
  mln_render_session* out_session MLN_BINDING("direction=out"),
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=lifecycle")
MLN_API mln_status mln_map_attach_vulkan_surface(
  mln_map map, const mln_vulkan_surface_descriptor* descriptor,
  const mln_render_session_attach_options* options,
  mln_render_session* out_session MLN_BINDING("direction=out"),
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=lifecycle")
MLN_API mln_status mln_map_attach_opengl_surface(
  mln_map map, const mln_opengl_surface_descriptor* descriptor,
  const mln_render_session_attach_options* options,
  mln_render_session* out_session MLN_BINDING("direction=out"),
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=lifecycle")
MLN_API mln_status mln_map_attach_webgpu_surface(
  mln_map map, const mln_webgpu_surface_descriptor* descriptor,
  const mln_render_session_attach_options* options,
  mln_render_session* out_session MLN_BINDING("direction=out"),
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=operation")
MLN_API mln_status mln_render_session_set_metal_surface_target(
  mln_render_session session, const mln_metal_surface_descriptor* descriptor,
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=operation")
MLN_API mln_status mln_render_session_set_vulkan_surface_target(
  mln_render_session session, const mln_vulkan_surface_descriptor* descriptor,
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=operation")
MLN_API mln_status mln_render_session_set_opengl_surface_target(
  mln_render_session session, const mln_opengl_surface_descriptor* descriptor,
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=operation")
MLN_API mln_status mln_render_session_set_webgpu_surface_target(
  mln_render_session session, const mln_webgpu_surface_descriptor* descriptor,
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_SURFACE_H