render_target.h

Go to the documentation of this file.

 
#ifndef MAPLIBRE_NATIVE_C_RENDER_TARGET_H
#define MAPLIBRE_NATIVE_C_RENDER_TARGET_H
 
#include <stdint.h>
 
#include "base.h"
#include "map.h"
#include "wake.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef uint64_t mln_vulkan_non_dispatchable_handle;

#define MLN_VULKAN_NON_DISPATCHABLE_HANDLE_NULL UINT64_C(0)

#define MLN_TEXTURE_RING_MAX_DEPTH 8

typedef enum mln_render_driver_kind : uint32_t {
  MLN_RENDER_DRIVER_CORE_WORKER = 1U,
  MLN_RENDER_DRIVER_CALLER_GRAPHICS_THREAD = 2U,
} mln_render_driver_kind;

typedef enum MLN_BINDING(
  "kind=bitmask"
) mln_render_session_capability_flag : uint32_t {
  MLN_RENDER_SESSION_CAPABILITY_FRAME_ACQUISITION = 1U << 0U,
  MLN_RENDER_SESSION_CAPABILITY_READBACK = 1U << 1U,
  MLN_RENDER_SESSION_CAPABILITY_CONSUMER_SYNC = 1U << 2U,
  MLN_RENDER_SESSION_CAPABILITY_PRESENTATION = 1U << 3U,
} mln_render_session_capability_flag;

MLN_BINDING("synchronous=true")
typedef void (*mln_queue_lock_callback)(void* user_data);

typedef struct mln_queue_lock {
  mln_queue_lock_callback lock MLN_BINDING("nullable=true");
  mln_queue_lock_callback unlock MLN_BINDING("nullable=true");
  void* user_data MLN_BINDING("kind=context");
  mln_user_data_release release_user_data;
} mln_queue_lock MLN_BINDING(
  "kind=callback_registration;release=release_user_data"
);

typedef struct mln_render_session_attach_options {
  uint32_t size;
  uint32_t driver MLN_BINDING("enum=mln_render_driver_kind");
  uint32_t requested_texture_ring_depth;
  uint32_t producer_sync_kind MLN_BINDING("enum=mln_gpu_sync_kind");
  mln_wake frame_wake;
  mln_wake driver_work_wake;
  mln_queue_lock queue_lock;
} mln_render_session_attach_options;

typedef struct mln_render_session_capabilities {
  uint32_t size;
  uint32_t driver MLN_BINDING("enum=mln_render_driver_kind");
  uint32_t texture_ring_depth;
  uint32_t flags MLN_BINDING("enum=mln_render_session_capability_flag");
} mln_render_session_capabilities;

typedef enum mln_gpu_sync_kind : uint32_t {
  MLN_GPU_SYNC_CPU_COMPLETE = 0U,
  MLN_GPU_SYNC_OPENGL_FENCE = 3U,
} mln_gpu_sync_kind;

typedef struct mln_gpu_sync {
  uint32_t size;
  uint32_t kind MLN_BINDING("enum=mln_gpu_sync_kind");
  uint64_t object;
} mln_gpu_sync;

MLN_API mln_gpu_sync mln_gpu_sync_default(void) MLN_NOEXCEPT;

typedef struct mln_metal_context_descriptor {
  void* device;
} mln_metal_context_descriptor;

typedef struct mln_vulkan_context_descriptor {
  void* instance;
  void* physical_device;
  void* device;
  void* graphics_queue;
  uint32_t graphics_queue_family_index;
  void* get_instance_proc_addr;
  void* get_device_proc_addr;
} mln_vulkan_context_descriptor;

typedef struct mln_webgpu_context_descriptor {
  void* instance;
  void* device;
  void* queue;
} mln_webgpu_context_descriptor;

typedef enum MLN_BINDING(
  "kind=bitmask"
) mln_opengl_context_provider_flag : uint32_t {
  MLN_OPENGL_CONTEXT_PROVIDER_FLAG_WGL = 1u << 0u,
  MLN_OPENGL_CONTEXT_PROVIDER_FLAG_EGL = 1u << 1u,
  MLN_OPENGL_CONTEXT_PROVIDER_FLAG_WEBGL = 1u << 2u,
} mln_opengl_context_provider_flag;

typedef enum mln_opengl_context_platform : uint32_t {
  MLN_OPENGL_CONTEXT_PLATFORM_UNSPECIFIED = 0u,
  MLN_OPENGL_CONTEXT_PLATFORM_WGL = 1u,
  MLN_OPENGL_CONTEXT_PLATFORM_EGL = 2u,
  MLN_OPENGL_CONTEXT_PLATFORM_WEBGL = 3u,
} mln_opengl_context_platform;

typedef enum mln_opengl_context_ownership : uint32_t {
  MLN_OPENGL_CONTEXT_OWNERSHIP_SHARED = 0u,
  MLN_OPENGL_CONTEXT_OWNERSHIP_DEDICATED = 1u,
} mln_opengl_context_ownership;

typedef enum mln_opengl_client_api : uint32_t {
  MLN_OPENGL_CLIENT_API_UNSPECIFIED = 0u,
  MLN_OPENGL_CLIENT_API_GL = 1u,
  MLN_OPENGL_CLIENT_API_GLES = 2u,
} mln_opengl_client_api;

typedef struct mln_wgl_context_descriptor {
  void* device_context;
  void* share_context;
  void* get_proc_address;
} mln_wgl_context_descriptor;

typedef struct mln_egl_context_descriptor {
  void* display;
  void* config;
  void* share_context;
  uint32_t client_api MLN_BINDING("enum=mln_opengl_client_api");
  void* get_proc_address;
} mln_egl_context_descriptor;

typedef enum mln_webgl_context_kind : uint32_t {
  MLN_WEBGL_CONTEXT_EXISTING = 0U,
  MLN_WEBGL_CONTEXT_TRANSFERRED_CANVAS = 1U,
} mln_webgl_context_kind;

typedef struct mln_webgl_context_descriptor {
  uint32_t kind MLN_BINDING("enum=mln_webgl_context_kind");
  int32_t context;
  mln_buffer_view canvas_selector;
} mln_webgl_context_descriptor;

typedef union mln_opengl_context_descriptor_data {
  mln_wgl_context_descriptor wgl
    MLN_BINDING("variant=MLN_OPENGL_CONTEXT_PLATFORM_WGL");
  mln_egl_context_descriptor egl
    MLN_BINDING("variant=MLN_OPENGL_CONTEXT_PLATFORM_EGL");
  mln_webgl_context_descriptor webgl
    MLN_BINDING("variant=MLN_OPENGL_CONTEXT_PLATFORM_WEBGL");
} mln_opengl_context_descriptor_data;

typedef struct mln_opengl_context_descriptor {
  uint32_t platform MLN_BINDING("enum=mln_opengl_context_platform");
  uint32_t ownership MLN_BINDING("enum=mln_opengl_context_ownership");
  mln_opengl_context_descriptor_data data MLN_BINDING("tag=platform");
} mln_opengl_context_descriptor;

MLN_API mln_render_session_attach_options
mln_render_session_attach_options_default(void) MLN_NOEXCEPT;

MLN_API mln_status mln_logical_extent_physical_size(
  mln_logical_extent extent, uint32_t* out_width MLN_BINDING("direction=out"),
  uint32_t* out_height MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("enum=mln_opengl_context_provider_flag")
MLN_API uint32_t mln_opengl_supported_context_provider_mask(void) MLN_NOEXCEPT;
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_RENDER_TARGET_H