texture.h

Go to the documentation of this file.

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

typedef struct mln_metal_owned_texture_descriptor {
  uint32_t size;
  mln_logical_extent extent;
  mln_metal_context_descriptor context;
  uint64_t pixel_format;
} mln_metal_owned_texture_descriptor;

typedef struct mln_metal_borrowed_texture {
  void* texture;
} mln_metal_borrowed_texture;

typedef struct mln_metal_borrowed_texture_descriptor {
  uint32_t size;
  mln_logical_extent extent;
  uint32_t physical_width;
  uint32_t physical_height;
  const mln_metal_borrowed_texture* textures
    MLN_BINDING("length=texture_count");
  size_t texture_count;
} mln_metal_borrowed_texture_descriptor;

typedef struct mln_metal_texture_frame {
  uint32_t size;
  uint64_t generation;
  uint32_t width;
  uint32_t height;
  double scale_factor;
  uint64_t frame_id;
  uint32_t slot;
  void* texture;
  void* device;
  uint64_t pixel_format;
} mln_metal_texture_frame;

typedef struct mln_vulkan_owned_texture_descriptor {
  uint32_t size;
  mln_logical_extent extent;
  mln_vulkan_context_descriptor context;
} mln_vulkan_owned_texture_descriptor;

typedef struct mln_vulkan_borrowed_texture {
  mln_vulkan_non_dispatchable_handle image;
  mln_vulkan_non_dispatchable_handle image_view;
} mln_vulkan_borrowed_texture;

typedef struct mln_vulkan_borrowed_texture_descriptor {
  uint32_t size;
  mln_logical_extent extent;
  uint32_t physical_width;
  uint32_t physical_height;
  mln_vulkan_context_descriptor context;
  const mln_vulkan_borrowed_texture* textures
    MLN_BINDING("length=texture_count");
  size_t texture_count;
  uint32_t format;
  uint32_t initial_layout;
  uint32_t final_layout;
} mln_vulkan_borrowed_texture_descriptor;

typedef struct mln_vulkan_texture_frame {
  uint32_t size;
  uint64_t generation;
  uint32_t width;
  uint32_t height;
  double scale_factor;
  uint64_t frame_id;
  uint32_t slot;
  mln_vulkan_non_dispatchable_handle image;
  mln_vulkan_non_dispatchable_handle image_view;
  void* device;
  uint32_t format;
  uint32_t layout;
} mln_vulkan_texture_frame;

typedef struct mln_opengl_owned_texture_descriptor {
  uint32_t size;
  mln_logical_extent extent;
  mln_opengl_context_descriptor context;
} mln_opengl_owned_texture_descriptor;

typedef struct mln_opengl_borrowed_texture {
  uint32_t texture;
} mln_opengl_borrowed_texture;

typedef struct mln_opengl_borrowed_texture_descriptor {
  uint32_t size;
  mln_logical_extent extent;
  uint32_t physical_width;
  uint32_t physical_height;
  mln_opengl_context_descriptor context;
  const mln_opengl_borrowed_texture* textures
    MLN_BINDING("length=texture_count");
  size_t texture_count;
  uint32_t target;
} mln_opengl_borrowed_texture_descriptor;

typedef struct mln_webgpu_owned_texture_descriptor {
  uint32_t size;
  mln_logical_extent extent;
  mln_webgpu_context_descriptor context;
} mln_webgpu_owned_texture_descriptor;

typedef struct mln_webgpu_borrowed_texture {
  void* texture;
  void* texture_view;
} mln_webgpu_borrowed_texture;

typedef struct mln_webgpu_borrowed_texture_descriptor {
  uint32_t size;
  mln_logical_extent extent;
  uint32_t physical_width;
  uint32_t physical_height;
  mln_webgpu_context_descriptor context;
  const mln_webgpu_borrowed_texture* textures
    MLN_BINDING("length=texture_count");
  size_t texture_count;
  uint32_t format;
} mln_webgpu_borrowed_texture_descriptor;

typedef struct mln_webgpu_texture_frame {
  uint32_t size;
  uint64_t generation;
  uint32_t width;
  uint32_t height;
  double scale_factor;
  uint64_t frame_id;
  uint32_t slot;
  void* texture;
  void* texture_view;
  void* device;
  uint32_t format;
} mln_webgpu_texture_frame;

typedef struct mln_opengl_texture_frame {
  uint32_t size;
  uint64_t generation;
  uint32_t width;
  uint32_t height;
  double scale_factor;
  uint64_t frame_id;
  uint32_t slot;
  uint32_t texture;
  uint32_t target;
  uint32_t internal_format;
  uint32_t format;
  uint32_t type;
} mln_opengl_texture_frame;

typedef struct mln_texture_image_info {
  uint32_t width;
  uint32_t height;
  uint32_t stride;
  size_t byte_length;
} mln_texture_image_info;

typedef struct mln_texture_readback_result {
  mln_buffer_view data MLN_BINDING("encoding=bytes");
  mln_texture_image_info info;
} mln_texture_readback_result;

MLN_API mln_metal_owned_texture_descriptor
mln_metal_owned_texture_descriptor_default(void) MLN_NOEXCEPT;

MLN_API mln_metal_borrowed_texture_descriptor
mln_metal_borrowed_texture_descriptor_default(void) MLN_NOEXCEPT;

MLN_API mln_vulkan_owned_texture_descriptor
mln_vulkan_owned_texture_descriptor_default(void) MLN_NOEXCEPT;

MLN_API mln_vulkan_borrowed_texture_descriptor
mln_vulkan_borrowed_texture_descriptor_default(void) MLN_NOEXCEPT;

MLN_API mln_opengl_owned_texture_descriptor
mln_opengl_owned_texture_descriptor_default(void) MLN_NOEXCEPT;

MLN_API mln_opengl_borrowed_texture_descriptor
mln_opengl_borrowed_texture_descriptor_default(void) MLN_NOEXCEPT;

MLN_API mln_webgpu_owned_texture_descriptor
mln_webgpu_owned_texture_descriptor_default(void) MLN_NOEXCEPT;

MLN_API mln_webgpu_borrowed_texture_descriptor
mln_webgpu_borrowed_texture_descriptor_default(void) MLN_NOEXCEPT;

MLN_BINDING("execution=lifecycle")
MLN_API mln_status mln_map_attach_metal_owned_texture(
  mln_map map, const mln_metal_owned_texture_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_metal_borrowed_texture(
  mln_map map, const mln_metal_borrowed_texture_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_owned_texture(
  mln_map map, const mln_vulkan_owned_texture_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_borrowed_texture(
  mln_map map, const mln_vulkan_borrowed_texture_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_owned_texture(
  mln_map map, const mln_opengl_owned_texture_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_borrowed_texture(
  mln_map map, const mln_opengl_borrowed_texture_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_owned_texture(
  mln_map map, const mln_webgpu_owned_texture_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_borrowed_texture(
  mln_map map, const mln_webgpu_borrowed_texture_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_borrowed_texture_target(
  mln_render_session session,
  const mln_metal_borrowed_texture_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_borrowed_texture_target(
  mln_render_session session,
  const mln_vulkan_borrowed_texture_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_borrowed_texture_target(
  mln_render_session session,
  const mln_opengl_borrowed_texture_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_borrowed_texture_target(
  mln_render_session session,
  const mln_webgpu_borrowed_texture_descriptor* descriptor,
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=query;result=mln_texture_readback_result")
MLN_API mln_status mln_render_session_read_texture(
  mln_render_session session, const mln_completion* completion,
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("view_owner=frame")
MLN_API mln_status mln_acquired_frame_get_metal_texture(
  mln_acquired_frame frame,
  mln_metal_texture_frame* out_frame MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("view_owner=frame")
MLN_API mln_status mln_acquired_frame_get_vulkan_texture(
  mln_acquired_frame frame,
  mln_vulkan_texture_frame* out_frame MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("view_owner=frame")
MLN_API mln_status mln_acquired_frame_get_opengl_texture(
  mln_acquired_frame frame,
  mln_opengl_texture_frame* out_frame MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("view_owner=frame")
MLN_API mln_status mln_acquired_frame_get_webgpu_texture(
  mln_acquired_frame frame,
  mln_webgpu_texture_frame* out_frame MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_TEXTURE_H