renderer_types.h

Go to the documentation of this file.

#pragma once
 
#include <containers/freelist.h>
#include <core_render_types.h>
#include <defines.h>
#include <math/math_types.h>
#include <strings/kname.h>
 
struct shader_uniform;
struct frame_data;
struct terrain;
struct viewport;
struct camera;
struct material;
struct kwindow_renderer_backend_state;
 
// Max number of point lights that can exist in the renderer at once.
#define KMATERIAL_MAX_GLOBAL_POINT_LIGHTS 64
// Max number of point lights that can be bound in a single draw.
#define KMATERIAL_MAX_BOUND_POINT_LIGHTS 8
 
// The max number of "frames" for which data can exist. This would be 2 if
// only double-buffering was supported, but since triple-buffering is supported
// this must be always taken into account.
#define RENDERER_MAX_FRAME_COUNT 3
 
typedef struct renderbuffer_data {
    u32 element_count;
    u32 element_size;
    void* elements;
    u64 buffer_offset;
} renderbuffer_data;
 
typedef struct geometry_render_data {
    mat4 model;
    kmaterial_instance material;
 
    // The per-draw id to be used when applying this data. Used for draws that don't use materials.
    u32 draw_id;
 
    u64 unique_id;
    b8 winding_inverted;
    vec4 diffuse_colour;
 
    u32 vertex_count;
    u32 vertex_element_size;
    u64 vertex_buffer_offset;
 
    u32 index_count;
    u32 index_element_size;
    u64 index_buffer_offset;
 
    u32 ibl_probe_index;
} geometry_render_data;
 
typedef enum renderer_debug_view_mode {
    RENDERER_VIEW_MODE_DEFAULT = 0,
    RENDERER_VIEW_MODE_LIGHTING = 1,
    RENDERER_VIEW_MODE_NORMALS = 2,
    RENDERER_VIEW_MODE_CASCADES = 3,
    RENDERER_VIEW_MODE_WIREFRAME = 4
} renderer_debug_view_mode;
 
typedef enum renderer_stencil_op {
    RENDERER_STENCIL_OP_KEEP = 0,
    RENDERER_STENCIL_OP_ZERO = 1,
    RENDERER_STENCIL_OP_REPLACE = 2,
    RENDERER_STENCIL_OP_INCREMENT_AND_CLAMP = 3,
    RENDERER_STENCIL_OP_DECREMENT_AND_CLAMP = 4,
    RENDERER_STENCIL_OP_INVERT = 5,
    RENDERER_STENCIL_OP_INCREMENT_AND_WRAP = 6,
    RENDERER_STENCIL_OP_DECREMENT_AND_WRAP = 7
} renderer_stencil_op;
 
typedef enum renderer_compare_op {
    RENDERER_COMPARE_OP_NEVER = 0,
    RENDERER_COMPARE_OP_LESS = 1,
    RENDERER_COMPARE_OP_EQUAL = 2,
    RENDERER_COMPARE_OP_LESS_OR_EQUAL = 3,
    RENDERER_COMPARE_OP_GREATER = 4,
    RENDERER_COMPARE_OP_NOT_EQUAL = 5,
    RENDERER_COMPARE_OP_GREATER_OR_EQUAL = 6,
    RENDERER_COMPARE_OP_ALWAYS = 7
} renderer_compare_op;
 
typedef enum renderer_attachment_type_flag_bits {
    RENDERER_ATTACHMENT_TYPE_FLAG_COLOUR_BIT = 0x1,
    RENDERER_ATTACHMENT_TYPE_FLAG_DEPTH_BIT = 0x2,
    RENDERER_ATTACHMENT_TYPE_FLAG_STENCIL_BIT = 0x4
} renderer_attachment_type_flag_bits;
 
typedef u32 renderer_attachment_type_flags;
 
typedef enum renderer_attachment_load_operation {
    RENDERER_ATTACHMENT_LOAD_OPERATION_DONT_CARE = 0x0,
    RENDERER_ATTACHMENT_LOAD_OPERATION_LOAD = 0x1
} renderer_attachment_load_operation;
 
typedef enum renderer_attachment_store_operation {
    RENDERER_ATTACHMENT_STORE_OPERATION_DONT_CARE = 0x0,
    RENDERER_ATTACHMENT_STORE_OPERATION_STORE = 0x1
} renderer_attachment_store_operation;
 
typedef enum renderer_attachment_use {
    RENDERER_ATTACHMENT_USE_DONT_CARE,
    RENDERER_ATTACHMENT_USE_COLOUR_ATTACHMENT,
    RENDERER_ATTACHMENT_USE_COLOUR_PRESENT,
    RENDERER_ATTACHMENT_USE_COLOUR_SHADER_READ,
    RENDERER_ATTACHMENT_USE_COLOUR_SHADER_WRITE,
    RENDERER_ATTACHMENT_USE_DEPTH_STENCIL_ATTACHMENT,
    RENDERER_ATTACHMENT_USE_DEPTH_STENCIL_SHADER_READ,
    RENDERER_ATTACHMENT_USE_DEPTH_STENCIL_SHADER_WRITE
} renderer_attachment_use;
 
typedef enum renderbuffer_type {
    RENDERBUFFER_TYPE_UNKNOWN,
    RENDERBUFFER_TYPE_VERTEX,
    RENDERBUFFER_TYPE_INDEX,
    RENDERBUFFER_TYPE_UNIFORM,
    RENDERBUFFER_TYPE_STAGING,
    RENDERBUFFER_TYPE_READ,
    RENDERBUFFER_TYPE_STORAGE
} renderbuffer_type;
 
typedef enum renderbuffer_track_type {
    RENDERBUFFER_TRACK_TYPE_NONE = 0,
    RENDERBUFFER_TRACK_TYPE_FREELIST = 1,
    RENDERBUFFER_TRACK_TYPE_LINEAR = 2
} renderbuffer_track_type;
 
typedef enum renderbuffer_flag_bits {
    RENDERBUFFER_FLAG_NONE = 0,
    // Automatically map the buffer memory on creation. Maps the entire buffer range.
    RENDERBUFFER_FLAG_AUTO_MAP_MEMORY_BIT = 1 << 0,
    // The buffer should be setup to have multiple internal buffers, one per frame buffer (i.e. triple-buffered = 3)
    RENDERBUFFER_FLAG_TRIPLE_BUFFERED_BIT = 1 << 1
} renderbuffer_flag_bits;
 
typedef u32 renderbuffer_flags;
 
typedef u16 krenderbuffer;
#define KRENDERBUFFER_INVALID INVALID_ID_U16
 
#define KRENDERBUFFER_NAME_VERTEX_STANDARD "Kohi.RenderBuffer.VertexStandard"
#define KRENDERBUFFER_NAME_INDEX_STANDARD "Kohi.RenderBuffer.IndexStandard"
 
#define KRENDERBUFFER_BIND_INDEX_VERTEX_STANDARD 0
#define KRENDERBUFFER_BIND_INDEX_VERTEX_EXTENDED 1
#define KRENDERBUFFER_BIND_INDEX_INDEX_STANDARD 0
 
typedef enum renderer_config_flag_bits {
    RENDERER_CONFIG_FLAG_VSYNC_ENABLED_BIT = 0x1,
    RENDERER_CONFIG_FLAG_POWER_SAVING_BIT = 0x2,
    RENDERER_CONFIG_FLAG_ENABLE_VALIDATION = 0x4,
} renderer_config_flag_bits;
 
typedef u32 renderer_config_flags;
 
typedef struct renderer_backend_config {
    const char* application_name;
    renderer_config_flags flags;
    u16 max_shader_count;
    u16 max_texture_count;
    b8 use_triple_buffering;
    b8 require_discrete_gpu;
 
} renderer_backend_config;
 
typedef enum renderer_winding {
    RENDERER_WINDING_COUNTER_CLOCKWISE = 0,
    RENDERER_WINDING_CLOCKWISE = 1
} renderer_winding;
 
typedef enum renderer_cull_mode {
    RENDERER_CULL_MODE_NONE = 0,
    RENDERER_CULL_MODE_FRONT = 1,
    RENDERER_CULL_MODE_BACK = 2,
    RENDERER_CULL_MODE_FRONT_AND_BACK = 3
} renderer_cull_mode;
 
typedef struct kwindow_renderer_state {
    // Pointer back to main window.
    struct kwindow* window;
    // The viewport information for the given window.
    struct viewport* active_viewport;
 
    // This is technically the swapchain images, which should be wrapped into a single texture.
    ktexture colourbuffer;
    // This is technically the per-frame depth image, which should be wrapped into a single texture.
    ktexture depthbuffer;
 
    struct kwindow_renderer_backend_state* backend_state;
} kwindow_renderer_state;
 
// Handle to a renderer backend sampler.
typedef u16 ksampler_backend;
#define KSAMPLER_BACKEND_INVALID INVALID_ID_U16
 
typedef struct renderer_backend_interface {
    // A pointer to the frontend state in case the backend needs to communicate with it.
    struct renderer_system_state* frontend_state;
 
    u64 internal_context_size;
    void* internal_context;
 
    b8 (*initialize)(struct renderer_backend_interface* backend, const renderer_backend_config* config);
 
    void (*shutdown)(struct renderer_backend_interface* backend);
 
    void (*begin_debug_label)(struct renderer_backend_interface* backend, const char* label_text, vec3 colour);
    void (*end_debug_label)(struct renderer_backend_interface* backend);
 
    b8 (*window_create)(struct renderer_backend_interface* backend, struct kwindow* window);
 
    void (*window_destroy)(struct renderer_backend_interface* backend, struct kwindow* window);
 
    void (*window_resized)(struct renderer_backend_interface* backend, const struct kwindow* window);
 
    b8 (*frame_prepare)(struct renderer_backend_interface* backend, struct frame_data* p_frame_data);
 
    b8 (*frame_prepare_window_surface)(struct renderer_backend_interface* backend, struct kwindow* window, struct frame_data* p_frame_data);
 
    b8 (*frame_commands_begin)(struct renderer_backend_interface* backend, struct frame_data* p_frame_data);
 
    b8 (*frame_commands_end)(struct renderer_backend_interface* backend, struct frame_data* p_frame_data);
 
    b8 (*frame_submit)(struct renderer_backend_interface* backend, struct frame_data* p_frame_data);
    b8 (*frame_present)(struct renderer_backend_interface* backend, struct kwindow* window, struct frame_data* p_frame_data);
 
    void (*viewport_set)(struct renderer_backend_interface* backend, rect_2di rect);
 
    void (*viewport_reset)(struct renderer_backend_interface* backend);
 
    void (*scissor_set)(struct renderer_backend_interface* backend, rect_2di rect);
 
    void (*scissor_reset)(struct renderer_backend_interface* backend);
 
    void (*winding_set)(struct renderer_backend_interface* backend, renderer_winding winding);
 
    void (*cull_mode_set)(struct renderer_backend_interface* backend, renderer_cull_mode cull_mode);
 
    void (*set_stencil_test_enabled)(struct renderer_backend_interface* backend, b8 enabled);
 
    void (*set_depth_test_enabled)(struct renderer_backend_interface* backend, b8 enabled);
 
    void (*set_depth_write_enabled)(struct renderer_backend_interface* backend, b8 enabled);
 
    void (*set_depth_bias)(struct renderer_backend_interface* backend, f32 constant_factor, f32 clamp, f32 slope_factor);
 
    void (*set_depth_bias_enabled)(struct renderer_backend_interface* backend, b8 enabled);
 
    void (*set_stencil_reference)(struct renderer_backend_interface* backend, u32 reference);
 
    void (*set_stencil_op)(struct renderer_backend_interface* backend, renderer_stencil_op fail_op, renderer_stencil_op pass_op, renderer_stencil_op depth_fail_op, renderer_compare_op compare_op);
 
    void (*begin_rendering)(struct renderer_backend_interface* backend, struct frame_data* p_frame_data, rect_2di render_area, u32 colour_target_count, ktexture* colour_targets, ktexture depth_stencil_target, u32 depth_stencil_layer);
    void (*end_rendering)(struct renderer_backend_interface* backend, struct frame_data* p_frame_data);
 
    void (*set_stencil_compare_mask)(struct renderer_backend_interface* backend, u32 compare_mask);
 
    void (*set_stencil_write_mask)(struct renderer_backend_interface* backend, u32 write_mask);
 
    void (*clear_colour_set)(struct renderer_backend_interface* backend, vec4 clear_colour);
    void (*clear_depth_set)(struct renderer_backend_interface* backend, f32 depth);
    void (*clear_stencil_set)(struct renderer_backend_interface* backend, u32 stencil);
    void (*clear_colour)(struct renderer_backend_interface* backend, ktexture t);
    void (*clear_depth_stencil)(struct renderer_backend_interface* backend, ktexture t);
    void (*colour_texture_prepare_for_present)(struct renderer_backend_interface* backend, ktexture t);
    void (*texture_prepare_for_sampling)(struct renderer_backend_interface* backend, ktexture t, ktexture_flag_bits flags);
 
    b8 (*texture_resources_acquire)(struct renderer_backend_interface* backend, ktexture t, const char* name, ktexture_type type, u32 width, u32 height, u8 channel_count, u8 mip_levels, u16 array_size, ktexture_flag_bits flags);
    void (*texture_resources_release)(struct renderer_backend_interface* backend, ktexture t);
 
    b8 (*texture_resize)(struct renderer_backend_interface* backend, ktexture t, u32 new_width, u32 new_height);
 
    b8 (*texture_write_data)(struct renderer_backend_interface* backend, ktexture t, u32 offset, u32 size, const u8* pixels, b8 include_in_frame_workload);
 
    b8 (*texture_read_data)(struct renderer_backend_interface* backend, ktexture t, u32 offset, u32 size, u8** out_pixels);
 
    b8 (*texture_read_pixel)(struct renderer_backend_interface* backend, ktexture t, u32 x, u32 y, u8** out_rgba);
 
    b8 (*shader_create)(
        struct renderer_backend_interface* backend,
        kshader shader,
        kname name,
        shader_flags flags,
        primitive_topology_type_bits topology_types,
        primitive_topology_type default_type,
        u8 colour_attachment_count,
        kpixel_format* colour_attachment_formats,
        kpixel_format depth_attachment_format,
        kpixel_format stencil_attachment_format,
        u8 pipeline_count,
        shader_pipeline_config* pipelines,
        u8 binding_set_count,
        const shader_binding_set_config* binding_sets);
 
    void (*shader_destroy)(struct renderer_backend_interface* backend, kshader shader);
 
    b8 (*shader_reload)(
        struct renderer_backend_interface* backend,
        kshader shader,
        u8 pipeline_count,
        shader_pipeline_config* pipelines);
 
    b8 (*shader_use)(struct renderer_backend_interface* backend, kshader shader, u8 vertex_layout_index);
 
    b8 (*shader_use_with_topology)(struct renderer_backend_interface* backend, kshader shader, primitive_topology_type type, u8 vertex_layout_index);
 
    b8 (*shader_supports_wireframe)(const struct renderer_backend_interface* backend, kshader shader);
 
    b8 (*shader_flag_get)(const struct renderer_backend_interface* backend, kshader shader, shader_flags flag);
 
    void (*shader_flag_set)(struct renderer_backend_interface* backend, kshader shader, shader_flags flag, b8 enabled);
 
    b8 (*shader_set_immediate_data)(struct renderer_backend_interface* backend, kshader shader, const void* data, u8 size);
    b8 (*shader_set_binding_data)(struct renderer_backend_interface* backend, kshader shader, u8 binding_set, u32 instance_id, u8 binding_index, u64 offset, void* data, u64 size);
    b8 (*shader_set_binding_texture)(struct renderer_backend_interface* backend, kshader shader, u8 binding_set, u32 instance_id, u8 binding_index, u8 array_index, ktexture texture);
    b8 (*shader_set_binding_sampler)(struct renderer_backend_interface* backend, kshader shader, u8 binding_set, u32 instance_id, u8 binding_index, u8 array_index, ksampler_backend sampler);
 
    u32 (*shader_acquire_binding_set_instance)(struct renderer_backend_interface* backend, kshader shader, u8 binding_set);
    void (*shader_release_binding_set_instance)(struct renderer_backend_interface* backend, kshader shader, u8 binding_set, u32 instance_id);
    u32 (*shader_binding_set_get_max_instance_count)(struct renderer_backend_interface* backend, kshader shader, u8 binding_set);
    b8 (*shader_apply_binding_set)(struct renderer_backend_interface* backend, kshader shader, u8 binding_set, u32 instance_id);
 
    ksampler_backend (*sampler_acquire)(struct renderer_backend_interface* backend, kname name, texture_filter filter, texture_repeat repeat, f32 anisotropy);
    void (*sampler_release)(struct renderer_backend_interface* backend, ksampler_backend* sampler);
    b8 (*sampler_refresh)(struct renderer_backend_interface* backend, ksampler_backend* sampler, texture_filter filter, texture_repeat repeat, f32 anisotropy, u32 mip_levels);
 
    kname (*sampler_name_get)(struct renderer_backend_interface* backend, ksampler_backend sampler);
 
    b8 (*is_multithreaded)(struct renderer_backend_interface* backend);
 
    b8 (*flag_enabled_get)(struct renderer_backend_interface* backend, renderer_config_flags flag);
    void (*flag_enabled_set)(struct renderer_backend_interface* backend, renderer_config_flags flag, b8 enabled);
 
    f32 (*max_anisotropy_get)(struct renderer_backend_interface* backend);
 
    b8 (*renderbuffer_create)(struct renderer_backend_interface* backend, kname name, u64 size, renderbuffer_type type, renderbuffer_flags flags, krenderbuffer buffer);
 
    void (*renderbuffer_destroy)(struct renderer_backend_interface* backend, krenderbuffer buffer);
 
    b8 (*renderbuffer_bind)(struct renderer_backend_interface* backend, krenderbuffer buffer, u64 offset, u32 binding_index);
    b8 (*renderbuffer_unbind)(struct renderer_backend_interface* backend, krenderbuffer buffer);
 
    void (*renderbuffer_map_memory)(struct renderer_backend_interface* backend, krenderbuffer buffer, u64 offset, u64 size);
    void (*renderbuffer_unmap_memory)(struct renderer_backend_interface* backend, krenderbuffer buffer, u64 offset, u64 size);
 
    void* (*renderbuffer_get_mapped_memory)(struct renderer_backend_interface* backend, krenderbuffer handle);
 
    b8 (*renderbuffer_flush)(struct renderer_backend_interface* backend, krenderbuffer buffer, u64 offset, u64 size);
 
    b8 (*renderbuffer_read)(struct renderer_backend_interface* backend, krenderbuffer buffer, u64 offset, u64 size, void** out_memory);
 
    b8 (*renderbuffer_resize)(struct renderer_backend_interface* backend, krenderbuffer buffer, u64 new_total_size);
 
    b8 (*renderbuffer_load_range)(struct renderer_backend_interface* backend, krenderbuffer buffer, u64 offset, u64 size, const void* data, b8 include_in_frame_workload);
 
    b8 (*renderbuffer_copy_range)(struct renderer_backend_interface* backend, krenderbuffer source, u64 source_offset, krenderbuffer dest, u64 dest_offset, u64 size, b8 include_in_frame_workload);
 
    b8 (*renderbuffer_draw)(struct renderer_backend_interface* backend, krenderbuffer buffer, u64 offset, u32 element_count, u32 binding_index, b8 bind_only);
 
    void (*wait_for_idle)(struct renderer_backend_interface* backend);
 
#if KOHI_DEBUG
    void (*debug_pump_brakes)(struct renderer_backend_interface* backend);
#endif
} renderer_backend_interface;