nicegraf.h

 
#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#define NGF_NOEXCEPT noexcept
#else
#define NGF_NOEXCEPT
#endif
 
#define NGF_VER_MAJ 0
#define NGF_VER_MIN 0
 
#ifdef _MSC_VER
#pragma region ngf_type_declarations
#endif
 
typedef enum ngf_diagnostic_log_verbosity {
  NGF_DIAGNOSTICS_VERBOSITY_DEFAULT,
 
  NGF_DIAGNOSTICS_VERBOSITY_DETAILED
} ngf_diagnostic_log_verbosity;
 
typedef enum ngf_diagnostic_message_type {
  NGF_DIAGNOSTIC_INFO,
 
  NGF_DIAGNOSTIC_WARNING,
 
  NGF_DIAGNOSTIC_ERROR
} ngf_diagnostic_message_type;
 
typedef struct ngf_renderdoc_info {
  const char* renderdoc_lib_path;
 
   const char* renderdoc_destination_template;
} ngf_renderdoc_info;
 
typedef void (*ngf_diagnostic_callback)(ngf_diagnostic_message_type, void*, const char*, ...);
 
typedef struct ngf_diagnostic_info {
  ngf_diagnostic_log_verbosity verbosity; 
  void*                        userdata;  
  ngf_diagnostic_callback callback;       
  bool enable_debug_groups; 
} ngf_diagnostic_info;
 
typedef struct ngf_allocation_callbacks {
  void* (*allocate)(size_t obj_size, size_t nobjs, void* userdata);
 
  void (*free)(void* ptr, size_t obj_size, size_t nobjs, void* userdata);
 
  void* userdata;
} ngf_allocation_callbacks;
 
typedef uint32_t ngf_device_handle;
 
typedef enum ngf_device_performance_tier {
  NGF_DEVICE_PERFORMANCE_TIER_HIGH = 0,
 
  NGF_DEVICE_PERFORMANCE_TIER_LOW,
 
  NGF_DEVICE_PERFORMANCE_TIER_UNKNOWN,
 
  NGF_DEVICE_PERFORMANCE_TIER_COUNT
} ngf_device_performance_tier;
 
typedef struct ngf_init_info {
  const ngf_diagnostic_info* diag_info;
 
  const ngf_allocation_callbacks* allocation_callbacks;
 
 
  ngf_device_handle device;
 
  const ngf_renderdoc_info* renderdoc_info;
 
} ngf_init_info;
 
typedef enum ngf_error {
  NGF_ERROR_OK = 0,
 
  NGF_ERROR_OUT_OF_MEM,
 
  NGF_ERROR_OBJECT_CREATION_FAILED,
 
  NGF_ERROR_OUT_OF_BOUNDS,
 
  NGF_ERROR_INVALID_FORMAT,
 
  NGF_ERROR_INVALID_SIZE,
 
  NGF_ERROR_INVALID_ENUM,
 
  NGF_ERROR_INVALID_OPERATION
  /*..add new errors above this line */
} ngf_error;
 
typedef struct ngf_irect2d {
  int32_t  x;      
  int32_t  y;      
  uint32_t width;  
  uint32_t height; 
} ngf_irect2d;
 
typedef struct ngf_extent3d {
  uint32_t width;  
  uint32_t height; 
  uint32_t depth;  
} ngf_extent3d;
 
typedef struct ngf_offset3d {
  int32_t x; 
  int32_t y; 
  int32_t z; 
} ngf_offset3d;
 
typedef enum ngf_stage_type {
  NGF_STAGE_VERTEX = 0,
 
  NGF_STAGE_FRAGMENT,
 
  NGF_STAGE_COMPUTE,
 
  NGF_STAGE_COUNT
} ngf_stage_type;
 
typedef struct ngf_shader_stage_info {
  ngf_stage_type type; 
  const void* content;
 
  uint32_t    content_length;
  const char* debug_name;       
  const char* entry_point_name; 
} ngf_shader_stage_info;
 
typedef struct ngf_shader_stage_t* ngf_shader_stage;
 
typedef enum ngf_polygon_mode {
  NGF_POLYGON_MODE_FILL = 0,
 
  NGF_POLYGON_MODE_LINE,
 
  NGF_POLYGON_MODE_POINT,
  NGF_POLYGON_MODE_COUNT
} ngf_polygon_mode;
 
typedef enum ngf_cull_mode {
  NGF_CULL_MODE_BACK = 0,
 
  NGF_CULL_MODE_FRONT,
 
  NGF_CULL_MODE_FRONT_AND_BACK,
 
  NGF_CULL_MODE_NONE,
  NGF_CULL_MODE_COUNT
} ngf_cull_mode;
 
typedef enum ngf_front_face_mode {
  NGF_FRONT_FACE_COUNTER_CLOCKWISE = 0,
 
  NGF_FRONT_FACE_CLOCKWISE,
 
  NGF_FRONT_FACE_COUNT
} ngf_front_face_mode;
 
typedef struct ngf_rasterization_info {
  bool discard; 
  ngf_polygon_mode    polygon_mode; 
  ngf_cull_mode       cull_mode;    
  ngf_front_face_mode front_face;   
} ngf_rasterization_info;
 
typedef enum ngf_compare_op {
  NGF_COMPARE_OP_NEVER = 0,
 
  NGF_COMPARE_OP_LESS,
 
  NGF_COMPARE_OP_LEQUAL,
 
  NGF_COMPARE_OP_EQUAL,
 
  NGF_COMPARE_OP_GEQUAL,
 
  NGF_COMPARE_OP_GREATER,
 
  NGF_COMPARE_OP_NEQUAL,
 
  NGF_COMPARE_OP_ALWAYS,
 
  NGF_COMPARE_OP_COUNT
} ngf_compare_op;
 
typedef enum ngf_stencil_op {
  NGF_STENCIL_OP_KEEP = 0,
 
  NGF_STENCIL_OP_ZERO,
 
  NGF_STENCIL_OP_REPLACE,
 
  NGF_STENCIL_OP_INCR_CLAMP,
 
  NGF_STENCIL_OP_INCR_WRAP,
 
  NGF_STENCIL_OP_DECR_CLAMP,
 
  NGF_STENCIL_OP_DECR_WRAP,
 
  NGF_STENCIL_OP_INVERT,
 
  NGF_STENCIL_OP_COUNT
} ngf_stencil_op;
 
typedef struct ngf_stencil_info {
  ngf_stencil_op fail_op;       
  ngf_stencil_op pass_op;       
  ngf_stencil_op depth_fail_op; 
  ngf_compare_op compare_op;    
  uint32_t       compare_mask;  
  uint32_t       write_mask;    
  uint32_t       reference;     
} ngf_stencil_info;
 
typedef struct ngf_depth_stencil_info {
  ngf_stencil_info front_stencil;
 
  ngf_stencil_info back_stencil;
 
  ngf_compare_op depth_compare;
 
  bool stencil_test;
 
  bool depth_test;
 
  bool depth_write;
 
} ngf_depth_stencil_info;
 
typedef enum ngf_blend_factor {
  NGF_BLEND_FACTOR_ZERO = 0,
 
  NGF_BLEND_FACTOR_ONE,
 
  NGF_BLEND_FACTOR_SRC_COLOR,
 
  NGF_BLEND_FACTOR_ONE_MINUS_SRC_COLOR,
 
  NGF_BLEND_FACTOR_DST_COLOR,
 
  NGF_BLEND_FACTOR_ONE_MINUS_DST_COLOR,
 
  NGF_BLEND_FACTOR_SRC_ALPHA,
 
  NGF_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA,
 
  NGF_BLEND_FACTOR_DST_ALPHA,
 
  NGF_BLEND_FACTOR_ONE_MINUS_DST_ALPHA,
 
  NGF_BLEND_FACTOR_CONSTANT_COLOR,
 
  NGF_BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR,
 
  NGF_BLEND_FACTOR_CONSTANT_ALPHA,
 
  NGF_BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA,
 
  NGF_BLEND_FACTOR_COUNT
} ngf_blend_factor;
 
typedef enum ngf_blend_op {
  NGF_BLEND_OP_ADD,
 
  NGF_BLEND_OP_SUB,
 
  NGF_BLEND_OP_REV_SUB,
 
  NGF_BLEND_OP_MIN,
 
  NGF_BLEND_OP_MAX,
 
  NGF_BLEND_OP_COUNT
} ngf_blend_op;
 
typedef enum ngf_color_write_mask_bit {
  NGF_COLOR_MASK_WRITE_BIT_R = 0x01,
  NGF_COLOR_MASK_WRITE_BIT_G = 0x02,
  NGF_COLOR_MASK_WRITE_BIT_B = 0x04,
  NGF_COLOR_MASK_WRITE_BIT_A = 0x08
} ngf_color_write_mask_bit;
 
typedef struct ngf_blend_info {
  ngf_blend_op     blend_op_color;         
  ngf_blend_op     blend_op_alpha;         
  ngf_blend_factor src_color_blend_factor; 
  ngf_blend_factor dst_color_blend_factor; 
  ngf_blend_factor src_alpha_blend_factor; 
  ngf_blend_factor dst_alpha_blend_factor; 
  uint32_t         color_write_mask; 
  bool enable;                       
} ngf_blend_info;
 
typedef enum ngf_type {
  NGF_TYPE_INT8 = 0,
 
  NGF_TYPE_UINT8,
 
  NGF_TYPE_INT16,
 
  NGF_TYPE_UINT16,
 
  NGF_TYPE_INT32,
 
  NGF_TYPE_UINT32,
 
  NGF_TYPE_FLOAT,
 
  NGF_TYPE_HALF_FLOAT,
 
  NGF_TYPE_DOUBLE,
 
  NGF_TYPE_COUNT
} ngf_type;
 
typedef enum ngf_vertex_input_rate {
  NGF_INPUT_RATE_VERTEX = 0,
 
  NGF_INPUT_RATE_INSTANCE,
  NGF_VERTEX_INPUT_RATE_COUNT
} ngf_vertex_input_rate;
 
typedef struct ngf_vertex_buf_binding_desc {
  uint32_t binding; 
  uint32_t stride;
 
  ngf_vertex_input_rate input_rate;
} ngf_vertex_buf_binding_desc;
 
typedef struct ngf_vertex_attrib_desc {
  uint32_t location; 
  uint32_t binding;  
  uint32_t offset;   
  ngf_type type;     
  uint32_t size;     
  bool normalized;
} ngf_vertex_attrib_desc;
 
typedef struct ngf_vertex_input_info {
  uint32_t nattribs;           
  uint32_t nvert_buf_bindings; 
  const ngf_vertex_buf_binding_desc* vert_buf_bindings;
 
  const ngf_vertex_attrib_desc* attribs;
} ngf_vertex_input_info;
 
typedef enum ngf_sample_count {
  NGF_SAMPLE_COUNT_1  = 1,
  NGF_SAMPLE_COUNT_2  = 2,
  NGF_SAMPLE_COUNT_4  = 4,
  NGF_SAMPLE_COUNT_8  = 8,
  NGF_SAMPLE_COUNT_16 = 16,
  NGF_SAMPLE_COUNT_32 = 32,
  NGF_SAMPLE_COUNT_64 = 64,
} ngf_sample_count;
 
typedef struct ngf_multisample_info {
  ngf_sample_count sample_count;      
  bool             alpha_to_coverage; 
} ngf_multisample_info;
 
typedef enum ngf_image_format {
  NGF_IMAGE_FORMAT_R8 = 0,
  NGF_IMAGE_FORMAT_RG8,
  NGF_IMAGE_FORMAT_RGB8,
  NGF_IMAGE_FORMAT_RGBA8,
  NGF_IMAGE_FORMAT_SRGB8,
  NGF_IMAGE_FORMAT_SRGBA8,
  NGF_IMAGE_FORMAT_BGR8,
  NGF_IMAGE_FORMAT_BGRA8,
  NGF_IMAGE_FORMAT_BGR8_SRGB,
  NGF_IMAGE_FORMAT_BGRA8_SRGB,
  NGF_IMAGE_FORMAT_RGB10A2,
  NGF_IMAGE_FORMAT_R32F,
  NGF_IMAGE_FORMAT_RG32F,
  NGF_IMAGE_FORMAT_RGB32F,
  NGF_IMAGE_FORMAT_RGBA32F,
  NGF_IMAGE_FORMAT_R16F,
  NGF_IMAGE_FORMAT_RG16F,
  NGF_IMAGE_FORMAT_RGB16F,
  NGF_IMAGE_FORMAT_RGBA16F,
  NGF_IMAGE_FORMAT_RG11B10F,
  NGF_IMAGE_FORMAT_RGB9E5,
  NGF_IMAGE_FORMAT_R16_UNORM,
  NGF_IMAGE_FORMAT_R16_SNORM,
  NGF_IMAGE_FORMAT_RG16_UNORM,
  NGF_IMAGE_FORMAT_RG16_SNORM,
  NGF_IMAGE_FORMAT_RGBA16_UNORM,
  NGF_IMAGE_FORMAT_RGBA16_SNORM,
  NGF_IMAGE_FORMAT_R8U,
  NGF_IMAGE_FORMAT_R8S,
  NGF_IMAGE_FORMAT_R16U,
  NGF_IMAGE_FORMAT_R16S,
  NGF_IMAGE_FORMAT_RG16U,
  NGF_IMAGE_FORMAT_RGB16U,
  NGF_IMAGE_FORMAT_RGBA16U,
  NGF_IMAGE_FORMAT_R32U,
  NGF_IMAGE_FORMAT_RG32U,
  NGF_IMAGE_FORMAT_RGB32U,
  NGF_IMAGE_FORMAT_RGBA32U,
  NGF_IMAGE_FORMAT_BC7,
  NGF_IMAGE_FORMAT_BC7_SRGB,
  NGF_IMAGE_FORMAT_ASTC_4x4,
  NGF_IMAGE_FORMAT_ASTC_4x4_SRGB,
  NGF_IMAGE_FORMAT_ASTC_5x4,
  NGF_IMAGE_FORMAT_ASTC_5x4_SRGB,
  NGF_IMAGE_FORMAT_ASTC_5x5,
  NGF_IMAGE_FORMAT_ASTC_5x5_SRGB,
  NGF_IMAGE_FORMAT_ASTC_6x5,
  NGF_IMAGE_FORMAT_ASTC_6x5_SRGB,
  NGF_IMAGE_FORMAT_ASTC_6x6,
  NGF_IMAGE_FORMAT_ASTC_6x6_SRGB,
  NGF_IMAGE_FORMAT_ASTC_8x5,
  NGF_IMAGE_FORMAT_ASTC_8x5_SRGB,
  NGF_IMAGE_FORMAT_ASTC_8x6,
  NGF_IMAGE_FORMAT_ASTC_8x6_SRGB,
  NGF_IMAGE_FORMAT_ASTC_8x8,
  NGF_IMAGE_FORMAT_ASTC_8x8_SRGB,
  NGF_IMAGE_FORMAT_ASTC_10x5,
  NGF_IMAGE_FORMAT_ASTC_10x5_SRGB,
  NGF_IMAGE_FORMAT_ASTC_10x6,
  NGF_IMAGE_FORMAT_ASTC_10x6_SRGB,
  NGF_IMAGE_FORMAT_ASTC_10x8,
  NGF_IMAGE_FORMAT_ASTC_10x8_SRGB,
  NGF_IMAGE_FORMAT_ASTC_10x10,
  NGF_IMAGE_FORMAT_ASTC_10x10_SRGB,
  NGF_IMAGE_FORMAT_ASTC_12x10,
  NGF_IMAGE_FORMAT_ASTC_12x10_SRGB,
  NGF_IMAGE_FORMAT_ASTC_12x12,
  NGF_IMAGE_FORMAT_ASTC_12x12_SRGB,
  NGF_IMAGE_FORMAT_DEPTH32,
  NGF_IMAGE_FORMAT_DEPTH16,
  NGF_IMAGE_FORMAT_DEPTH24_STENCIL8,
  NGF_IMAGE_FORMAT_UNDEFINED,
  NGF_IMAGE_FORMAT_COUNT
} ngf_image_format;
 
typedef enum ngf_attachment_type {
  NGF_ATTACHMENT_COLOR = 0,
 
  NGF_ATTACHMENT_DEPTH,
 
  NGF_ATTACHMENT_DEPTH_STENCIL
} ngf_attachment_type;
 
typedef struct ngf_attachment_description {
  ngf_attachment_type type; 
  ngf_image_format format;  
  ngf_sample_count sample_count; 
  bool is_sampled; 
  bool is_resolve; 
} ngf_attachment_description;
 
typedef struct ngf_attachment_descriptions {
  const ngf_attachment_description* descs;
 
  uint32_t ndescs; 
} ngf_attachment_descriptions;
 
typedef enum ngf_primitive_topology {
  NGF_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST = 0,
 
  NGF_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP,
 
  NGF_PRIMITIVE_TOPOLOGY_LINE_LIST,
 
  NGF_PRIMITIVE_TOPOLOGY_LINE_STRIP,
 
  NGF_PRIMITIVE_TOPOLOGY_COUNT
} ngf_primitive_topology;
 
typedef struct ngf_constant_specialization {
  uint32_t constant_id; 
  uint32_t offset;      
  ngf_type type;        
} ngf_constant_specialization;
 
typedef struct ngf_specialization_info {
  const ngf_constant_specialization*  specializations;  
  uint32_t                           nspecializations; 
  const void* value_buffer; 
} ngf_specialization_info;
 
typedef struct ngf_input_assembly_info {
  ngf_primitive_topology primitive_topology;
  bool                   enable_primitive_restart;
} ngf_input_assembly_info;
 
typedef struct ngf_graphics_pipeline_info {
  ngf_shader_stage              shader_stages[5]; 
  uint32_t                      nshader_stages; 
  const ngf_rasterization_info* rasterization;  
  const ngf_multisample_info*   multisample;    
  const ngf_depth_stencil_info* depth_stencil;
 
  const ngf_vertex_input_info* input_info;
 
  const ngf_input_assembly_info* input_assembly_info;
 
  const ngf_specialization_info* spec_info; 
  const ngf_attachment_descriptions* compatible_rt_attachment_descs;
 
  const ngf_blend_info* color_attachment_blend_states;
 
  float blend_consts[4]; 
  const char* debug_name;
} ngf_graphics_pipeline_info;
 
typedef struct ngf_graphics_pipeline_t* ngf_graphics_pipeline;
 
typedef struct ngf_compute_pipeline_info {
  ngf_shader_stage shader_stage; 
  const ngf_specialization_info*
      spec_info; 
      const char* debug_name;
} ngf_compute_pipeline_info;
 
typedef struct ngf_compute_pipeline_t* ngf_compute_pipeline;
 
typedef enum ngf_descriptor_type {
  NGF_DESCRIPTOR_UNIFORM_BUFFER = 0,
 
  NGF_DESCRIPTOR_IMAGE,
 
  NGF_DESCRIPTOR_SAMPLER,
 
  NGF_DESCRIPTOR_IMAGE_AND_SAMPLER,
 
  NGF_DESCRIPTOR_TEXEL_BUFFER,
 
  NGF_DESCRIPTOR_STORAGE_BUFFER,
 
  NGF_DESCRIPTOR_STORAGE_IMAGE,
 
  NGF_DESCRIPTOR_TYPE_COUNT
} ngf_descriptor_type;
 
typedef enum ngf_sampler_filter {
  NGF_FILTER_NEAREST = 0,
 
  NGF_FILTER_LINEAR,
 
  NGF_FILTER_COUNT
} ngf_sampler_filter;
 
typedef enum ngf_sampler_wrap_mode {
  NGF_WRAP_MODE_CLAMP_TO_EDGE = 0,
 
  NGF_WRAP_MODE_REPEAT,
 
  NGF_WRAP_MODE_MIRRORED_REPEAT,
 
  NGF_WRAP_MODE_COUNT
} ngf_sampler_wrap_mode;
 
typedef struct ngf_sampler_info {
  ngf_sampler_filter    min_filter; 
  ngf_sampler_filter    mag_filter; 
  ngf_sampler_filter    mip_filter; 
  ngf_sampler_wrap_mode wrap_u;     
  ngf_sampler_wrap_mode wrap_v;     
  ngf_sampler_wrap_mode wrap_w;     
  float lod_max;  
  float lod_min;  
  float lod_bias; 
  float max_anisotropy;   
  bool enable_anisotropy; 
} ngf_sampler_info;
 
typedef struct ngf_sampler_t* ngf_sampler;
 
typedef enum ngf_image_usage {
  NGF_IMAGE_USAGE_SAMPLE_FROM = 0x01,
 
  NGF_IMAGE_USAGE_ATTACHMENT = 0x02,
 
  NGF_IMAGE_USAGE_XFER_DST = 0x04,
 
  NGF_IMAGE_USAGE_MIPMAP_GENERATION = 0x08,
 
  NGF_IMAGE_USAGE_STORAGE = 0x10,
 
  NGF_IMAGE_USAGE_XFER_SRC = 0x20
} ngf_image_usage;
 
typedef enum ngf_image_type {
  NGF_IMAGE_TYPE_IMAGE_2D = 0,
 
  NGF_IMAGE_TYPE_IMAGE_3D,
 
  NGF_IMAGE_TYPE_CUBE,
 
  NGF_IMAGE_TYPE_COUNT
} ngf_image_type;
 
typedef struct ngf_image_info {
  ngf_image_type type;    
  ngf_extent3d   extent;  
  uint32_t         nmips; 
  uint32_t         nlayers;      
  ngf_image_format format;       
  ngf_sample_count sample_count; 
  uint32_t         usage_hint;   
} ngf_image_info;
 
typedef struct ngf_image_t* ngf_image;
 
typedef enum ngf_cubemap_face {
  NGF_CUBEMAP_FACE_POSITIVE_X,
  NGF_CUBEMAP_FACE_NEGATIVE_X,
  NGF_CUBEMAP_FACE_POSITIVE_Y,
  NGF_CUBEMAP_FACE_NEGATIVE_Y,
  NGF_CUBEMAP_FACE_POSITIVE_Z,
  NGF_CUBEMAP_FACE_NEGATIVE_Z,
  NGF_CUBEMAP_FACE_COUNT
} ngf_cubemap_face;
 
typedef struct ngf_image_ref {
  ngf_image        image;        
  uint32_t         mip_level;    
  uint32_t         layer;        
  ngf_cubemap_face cubemap_face; 
} ngf_image_ref;
 
typedef struct ngf_render_target_info {
  const ngf_attachment_descriptions* attachment_descriptions;
 
  const ngf_image_ref* attachment_image_refs;
} ngf_render_target_info;
 
typedef struct ngf_render_target_t* ngf_render_target;
 
typedef union ngf_clear_info {
  float clear_color[4];
 
  struct {
    float    clear_depth;   
    uint32_t clear_stencil; 
  } clear_depth_stencil;
} ngf_clear;
 
typedef enum ngf_attachment_load_op {
  NGF_LOAD_OP_DONTCARE = 0,
 
  NGF_LOAD_OP_KEEP,
 
  NGF_LOAD_OP_CLEAR,
  NGF_LOAD_OP_COUNT
} ngf_attachment_load_op;
 
typedef enum ngf_attachment_store_op {
  NGF_STORE_OP_DONTCARE = 0,
 
  NGF_STORE_OP_STORE,
 
  NGF_STORE_OP_RESOLVE,
 
  NGF_STORE_OP_COUNT
} ngf_attachment_store_op;
 
struct ngfi_private_encoder_data {
  uintptr_t d0;
  uintptr_t d1;
};
 
typedef struct ngf_render_encoder {
  struct ngfi_private_encoder_data pvt_data_donotuse;
} ngf_render_encoder;
 
typedef struct ngf_xfer_encoder {
  struct ngfi_private_encoder_data pvt_data_donotuse;
} ngf_xfer_encoder;
 
typedef struct ngf_compute_encoder {
  struct ngfi_private_encoder_data pvt_data_donotuse;
} ngf_compute_encoder;
 
typedef struct ngf_render_pass_info {
  ngf_render_target render_target;
 
  const ngf_attachment_load_op* load_ops;
 
  const ngf_attachment_store_op* store_ops;
 
  const ngf_clear* clears;
} ngf_render_pass_info;
 
typedef struct ngf_xfer_pass_info {
  void* reserved;
} ngf_xfer_pass_info;
 
typedef struct ngf_compute_pass_info {
  void* reserved;
} ngf_compute_pass_info;
 
typedef enum ngf_buffer_storage_type {
  NGF_BUFFER_STORAGE_HOST_READABLE,
 
  NGF_BUFFER_STORAGE_HOST_WRITEABLE,
 
  NGF_BUFFER_STORAGE_HOST_READABLE_WRITEABLE,
 
  NGF_BUFFER_STORAGE_DEVICE_LOCAL,
 
  NGF_BUFFER_STORAGE_DEVICE_LOCAL_HOST_WRITEABLE,
 
  NGF_BUFFER_STORAGE_DEVICE_LOCAL_HOST_READABLE_WRITEABLE
} ngf_buffer_storage_type;
 
typedef enum ngf_buffer_usage {
  NGF_BUFFER_USAGE_XFER_SRC = 0x01,
 
  NGF_BUFFER_USAGE_XFER_DST = 0x02,
 
  NGF_BUFFER_USAGE_UNIFORM_BUFFER = 0x04,
 
  NGF_BUFFER_USAGE_INDEX_BUFFER = 0x08,
 
  NGF_BUFFER_USAGE_VERTEX_BUFFER = 0x10,
 
  NGF_BUFFER_USAGE_TEXEL_BUFFER = 0x20,
 
  NGF_BUFFER_USAGE_STORAGE_BUFFER = 0x40
} ngf_buffer_usage;
 
typedef struct ngf_buffer_info {
  size_t                  size;         
  ngf_buffer_storage_type storage_type; 
  uint32_t                buffer_usage; 
} ngf_buffer_info;
 
typedef struct ngf_buffer_t* ngf_buffer;
 
typedef struct ngf_buffer_slice {
  ngf_buffer buffer; 
  size_t     offset; 
  size_t     range;  
} ngf_buffer_slice;
 
typedef struct ngf_texel_buffer_view_t* ngf_texel_buffer_view;
 
typedef struct ngf_texel_buffer_view_info {
  ngf_buffer       buffer;       
  size_t           offset;       
  size_t           size;         
  ngf_image_format texel_format; 
} ngf_texel_buffer_view_info;
 
typedef struct ngf_buffer_bind_info {
  ngf_buffer       buffer; 
  size_t           offset; 
  size_t           range;  
} ngf_buffer_bind_info;
 
typedef struct ngf_image_sampler_bind_info {
  ngf_image   image;   
  ngf_sampler sampler; 
} ngf_image_sampler_bind_info;
 
typedef struct ngf_resource_bind_op {
  uint32_t            target_set;     
  uint32_t            target_binding; 
  ngf_descriptor_type type;           
  union {
    ngf_buffer_bind_info        buffer;
    ngf_texel_buffer_view       texel_buffer_view;
    ngf_image_sampler_bind_info image_sampler;
  } info; 
} ngf_resource_bind_op;
 
typedef enum ngf_present_mode {
  NGF_PRESENTATION_MODE_FIFO,
 
  NGF_PRESENTATION_MODE_IMMEDIATE
} ngf_present_mode;
 
typedef enum ngf_colorspace {
    NGF_COLORSPACE_SRGB_NONLINEAR = 0u,
    NGF_COLORSPACE_EXTENDED_SRGB_NONLINEAR,
    NGF_COLORSPACE_EXTENDED_SRGB_LINEAR,
    NGF_COLORSPACE_DISPLAY_P3,
    NGF_COLORSPACE_DISPLAY_P3_LINEAR,
    NGF_COLORSPACE_DCI_P3,
    NGF_COLORSPACE_ITUR_BT2020,
    NGF_COLORSPACE_COUNT
} ngf_colorspace;
 
typedef struct ngf_swapchain_info {
  ngf_image_format color_format;  
  ngf_colorspace   colorspace;    
  ngf_image_format depth_format;  
  ngf_sample_count sample_count;  
  uint32_t         capacity_hint; 
  uint32_t         width;         
  uint32_t         height;        
  uintptr_t        native_handle; 
  ngf_present_mode present_mode;  
} ngf_swapchain_info;
 
typedef struct ngf_context_t* ngf_context;
 
typedef struct ngf_context_info {
  const ngf_swapchain_info* swapchain_info;
 
  const ngf_context shared_context;
} ngf_context_info;
 
typedef struct ngf_cmd_buffer_info {
  uint32_t reserved;
} ngf_cmd_buffer_info;
 
typedef struct ngf_cmd_buffer_t* ngf_cmd_buffer;
 
typedef uintptr_t ngf_frame_token;
 
#define NGF_DEVICE_LIMIT_UNKNOWN (~0u)
 
typedef struct ngf_device_capabilities {
  size_t uniform_buffer_offset_alignment;
 
  size_t storage_buffer_offset_alignment;
 
  size_t max_uniform_buffer_range;
 
  size_t texel_buffer_offset_alignment;
 
  size_t max_vertex_input_attributes_per_pipeline;
 
  size_t max_sampled_images_per_stage;
 
  size_t max_samplers_per_stage;
 
  size_t max_uniform_buffers_per_stage;
 
  size_t max_fragment_input_components;
 
  size_t max_fragment_inputs;
 
  size_t max_1d_image_dimension;
 
  size_t max_2d_image_dimension;
 
  size_t max_3d_image_dimension;
 
  size_t max_cube_image_dimension;
 
  size_t max_image_layers;
 
  size_t max_color_attachments_per_pass;
 
  float max_sampler_anisotropy;
 
  bool clipspace_z_zero_to_one;
 
  bool cubemap_arrays_supported;
 
  size_t framebuffer_color_sample_counts;
 
  ngf_sample_count max_supported_framebuffer_color_sample_count;
 
  size_t framebuffer_depth_sample_counts;
 
  ngf_sample_count max_supported_framebuffer_depth_sample_count;
 
  size_t texture_color_sample_counts;
 
  ngf_sample_count max_supported_texture_color_sample_count;
 
  size_t texture_depth_sample_counts;
 
  ngf_sample_count max_supported_texture_depth_sample_count;
 
  bool device_local_memory_is_host_visible;
} ngf_device_capabilities;
 
#define NGF_DEVICE_NAME_MAX_LENGTH (256u)
 
typedef struct ngf_device {
  ngf_device_performance_tier performance_tier; 
  ngf_device_handle           handle; 
  char name[NGF_DEVICE_NAME_MAX_LENGTH];
 
  ngf_device_capabilities capabilities; 
} ngf_device;
 
typedef struct ngf_image_write {
  size_t       src_offset;     
  ngf_offset3d dst_offset;     
  ngf_extent3d extent;         
  uint32_t     dst_level;      
  uint32_t     dst_base_layer; 
  uint32_t     nlayers;        
} ngf_image_write;
 
#ifdef _MSC_VER
#pragma endregion
 
#pragma region ngf_function_declarations
#endif
 
ngf_error ngf_get_device_list(const ngf_device** devices, uint32_t* ndevices);
 
ngf_error ngf_initialize(const ngf_init_info* init_info) NGF_NOEXCEPT;
 
 
/*
 * \ingroup ngf
 *
 * De-initializes nicegraf.
 *
 * The client should call this function only once during the
 * entire lifetime of the application. Must be called after
 * \ref ngf_initialize and after \ref ngf_destroy_context has
 * been called on every initialized \ref ngf_context.
 */
void ngf_shutdown() NGF_NOEXCEPT;
 
ngf_error ngf_create_context(const ngf_context_info* info, ngf_context* result) NGF_NOEXCEPT;
 
void ngf_destroy_context(ngf_context ctx) NGF_NOEXCEPT;
 
ngf_error ngf_resize_context(ngf_context ctx, uint32_t new_width, uint32_t new_height) NGF_NOEXCEPT;
 
ngf_error ngf_set_context(ngf_context ctx) NGF_NOEXCEPT;
 
ngf_context ngf_get_context() NGF_NOEXCEPT;
 
ngf_error ngf_begin_frame(ngf_frame_token* token) NGF_NOEXCEPT;
 
ngf_error ngf_end_frame(ngf_frame_token token) NGF_NOEXCEPT;
 
const ngf_device_capabilities* ngf_get_device_capabilities(void) NGF_NOEXCEPT;
 
ngf_error
ngf_create_shader_stage(const ngf_shader_stage_info* info, ngf_shader_stage* result) NGF_NOEXCEPT;
 
void ngf_destroy_shader_stage(ngf_shader_stage stage) NGF_NOEXCEPT;
 
ngf_error ngf_create_graphics_pipeline(
    const ngf_graphics_pipeline_info* info,
    ngf_graphics_pipeline*            result) NGF_NOEXCEPT;
 
void ngf_destroy_graphics_pipeline(ngf_graphics_pipeline pipeline) NGF_NOEXCEPT;
 
ngf_error ngf_create_compute_pipeline(
    const ngf_compute_pipeline_info* info,
    ngf_compute_pipeline*            result) NGF_NOEXCEPT;
 
void ngf_destroy_compute_pipeline(ngf_compute_pipeline pipeline) NGF_NOEXCEPT;
 
ngf_error ngf_create_image(const ngf_image_info* info, ngf_image* result) NGF_NOEXCEPT;
 
void ngf_destroy_image(ngf_image image) NGF_NOEXCEPT;
 
ngf_error ngf_create_sampler(const ngf_sampler_info* info, ngf_sampler* result) NGF_NOEXCEPT;
 
void ngf_destroy_sampler(ngf_sampler sampler) NGF_NOEXCEPT;
 
ngf_error ngf_create_render_target(const ngf_render_target_info* info, ngf_render_target* result)
    NGF_NOEXCEPT;
 
void ngf_destroy_render_target(ngf_render_target rendertarget) NGF_NOEXCEPT;
 
ngf_render_target ngf_default_render_target() NGF_NOEXCEPT;
 
const ngf_attachment_descriptions* ngf_default_render_target_attachment_descs() NGF_NOEXCEPT;
 
ngf_error ngf_create_buffer(const ngf_buffer_info* info, ngf_buffer* result) NGF_NOEXCEPT;
 
void ngf_destroy_buffer(ngf_buffer buffer) NGF_NOEXCEPT;
 
void* ngf_buffer_map_range(ngf_buffer buf, size_t offset, size_t size) NGF_NOEXCEPT;
 
void ngf_buffer_flush_range(ngf_buffer buf, size_t offset, size_t size) NGF_NOEXCEPT;
 
void ngf_buffer_unmap(ngf_buffer buf) NGF_NOEXCEPT;
 
ngf_error ngf_create_texel_buffer_view(
    const ngf_texel_buffer_view_info* info,
    ngf_texel_buffer_view*            result) NGF_NOEXCEPT;
 
void ngf_destroy_texel_buffer_view(ngf_texel_buffer_view buf_view) NGF_NOEXCEPT;
 
void ngf_finish(void) NGF_NOEXCEPT;
 
ngf_error
ngf_create_cmd_buffer(const ngf_cmd_buffer_info* info, ngf_cmd_buffer* result) NGF_NOEXCEPT;
 
void ngf_destroy_cmd_buffer(ngf_cmd_buffer buffer) NGF_NOEXCEPT;
 
ngf_error ngf_start_cmd_buffer(ngf_cmd_buffer buf, ngf_frame_token token) NGF_NOEXCEPT;
 
ngf_error ngf_submit_cmd_buffers(uint32_t nbuffers, ngf_cmd_buffer* bufs) NGF_NOEXCEPT;
 
ngf_error ngf_cmd_begin_render_pass(
    ngf_cmd_buffer       buf,
    const ngf_render_pass_info* pass_info,
    ngf_render_encoder*  enc) NGF_NOEXCEPT;
 
ngf_error ngf_cmd_begin_render_pass_simple(
    ngf_cmd_buffer      buf,
    ngf_render_target   rt,
    float               clear_color_r,
    float               clear_color_g,
    float               clear_color_b,
    float               clear_color_a,
    float               clear_depth,
    uint32_t            clear_stencil,
    ngf_render_encoder* enc) NGF_NOEXCEPT;
 
ngf_error ngf_cmd_end_render_pass(ngf_render_encoder enc) NGF_NOEXCEPT;
 
ngf_error
ngf_cmd_begin_xfer_pass(ngf_cmd_buffer buf, const ngf_xfer_pass_info* pass_info, ngf_xfer_encoder* enc)
    NGF_NOEXCEPT;
 
ngf_error ngf_cmd_end_xfer_pass(ngf_xfer_encoder enc) NGF_NOEXCEPT;
 
ngf_error
ngf_cmd_begin_compute_pass(ngf_cmd_buffer buf, const ngf_compute_pass_info* pass_info, ngf_compute_encoder* enc)
    NGF_NOEXCEPT;
 
ngf_error ngf_cmd_end_compute_pass(ngf_compute_encoder enc) NGF_NOEXCEPT;
 
void ngf_cmd_bind_gfx_pipeline(ngf_render_encoder buf, ngf_graphics_pipeline pipeline)
    NGF_NOEXCEPT;
 
void ngf_cmd_bind_compute_pipeline(ngf_compute_encoder buf, ngf_compute_pipeline pipeline)
    NGF_NOEXCEPT;
 
void ngf_cmd_viewport(ngf_render_encoder buf, const ngf_irect2d* r) NGF_NOEXCEPT;
 
void ngf_cmd_scissor(ngf_render_encoder enc, const ngf_irect2d* r) NGF_NOEXCEPT;
 
void ngf_cmd_stencil_reference(ngf_render_encoder enc, uint32_t front, uint32_t back) NGF_NOEXCEPT;
 
void ngf_cmd_stencil_compare_mask(ngf_render_encoder enc, uint32_t front, uint32_t back)
    NGF_NOEXCEPT;
 
void ngf_cmd_stencil_write_mask(ngf_render_encoder enc, uint32_t front, uint32_t back) NGF_NOEXCEPT;
 
void ngf_cmd_bind_resources(
    ngf_render_encoder          enc,
    const ngf_resource_bind_op* bind_operations,
    uint32_t                    nbind_operations) NGF_NOEXCEPT;
 
void ngf_cmd_bind_compute_resources(
    ngf_compute_encoder         enc,
    const ngf_resource_bind_op* bind_operations,
    uint32_t                    nbind_operations) NGF_NOEXCEPT;
 
void ngf_cmd_bind_attrib_buffer(
    ngf_render_encoder enc,
    ngf_buffer         vbuf,
    uint32_t           binding,
    size_t             offset) NGF_NOEXCEPT;
 
void ngf_cmd_bind_index_buffer(
    ngf_render_encoder enc,
    ngf_buffer         idxbuf,
    size_t             offset,
    ngf_type           index_type) NGF_NOEXCEPT;
 
void ngf_cmd_draw(
    ngf_render_encoder enc,
    bool               indexed,
    uint32_t           first_element,
    uint32_t           nelements,
    uint32_t           ninstances) NGF_NOEXCEPT;
 
void ngf_cmd_dispatch(
    ngf_compute_encoder enc,
    uint32_t            x_threadgroups,
    uint32_t            y_threadgroups,
    uint32_t            z_threadgroups) NGF_NOEXCEPT;
 
void ngf_cmd_copy_buffer(
    ngf_xfer_encoder enc,
    ngf_buffer       src,
    ngf_buffer       dst,
    size_t           size,
    size_t           src_offset,
    size_t           dst_offset) NGF_NOEXCEPT;
 
void ngf_cmd_write_image(
    ngf_xfer_encoder       enc,
    ngf_buffer             src,
    ngf_image              dst,
    const ngf_image_write* writes,
    uint32_t               nwrites) NGF_NOEXCEPT;
 
void ngf_cmd_copy_image_to_buffer(
    ngf_xfer_encoder    enc,
    const ngf_image_ref src,
    ngf_offset3d        src_offset,
    ngf_extent3d        src_extent,
    uint32_t            nlayers,
    ngf_buffer          dst,
    size_t              dst_offset) NGF_NOEXCEPT;
 
ngf_error ngf_cmd_generate_mipmaps(ngf_xfer_encoder xfenc, ngf_image img) NGF_NOEXCEPT;
 
void ngf_cmd_begin_debug_group(ngf_cmd_buffer cmd_buffer, const char* name) NGF_NOEXCEPT;
 
void ngf_cmd_end_current_debug_group(ngf_cmd_buffer cmd_buffer) NGF_NOEXCEPT;
 
void ngf_renderdoc_capture_next_frame() NGF_NOEXCEPT;
 
void ngf_renderdoc_capture_begin() NGF_NOEXCEPT;
 
void ngf_renderdoc_capture_end() NGF_NOEXCEPT;
 
 
#ifdef _MSC_VER
#pragma endregion
#endif
 
#ifdef __cplusplus
}
#endif