renderer_frontend.h

Go to the documentation of this file.

 
#pragma once
 
#include <defines.h>
#include <identifiers/khandle.h>
#include <kresources/kresource_types.h>
#include <math/geometry.h>
#include <strings/kname.h>
 
#include "core/frame_data.h"
#include "core_render_types.h"
#include "renderer_types.h"
 
struct shader_uniform;
struct frame_data;
struct viewport;
 
typedef struct renderer_system_config {
    const char* application_name;
    const char* backend_plugin_name;
    b8 vsync;
    b8 enable_validation;
    b8 power_saving;
    b8 triple_buffering_enabled;
 
    // The max number of shaders that can be held. Must match the shader system's count.
    u16 max_shader_count;
} renderer_system_config;
 
struct renderer_system_state;
struct kwindow;
 
b8 renderer_system_deserialize_config(const char* config_str, renderer_system_config* out_config);
 
KAPI b8 renderer_system_initialize(u64* memory_requirement, struct renderer_system_state* state, const renderer_system_config* config);
 
KAPI void renderer_system_shutdown(struct renderer_system_state* state);
 
KAPI u16 renderer_system_frame_number_get(struct renderer_system_state* state);
 
KAPI b8 renderer_on_window_created(struct renderer_system_state* state, struct kwindow* window);
KAPI void renderer_on_window_destroyed(struct renderer_system_state* state, struct kwindow* window);
 
KAPI void renderer_on_window_resized(struct renderer_system_state* state, const struct kwindow* window);
 
KAPI void renderer_begin_debug_label(const char* label_text, vec3 colour);
 
KAPI void renderer_end_debug_label(void);
 
KAPI b8 renderer_frame_prepare(struct renderer_system_state* state, struct frame_data* p_frame_data);
 
KAPI b8 renderer_frame_prepare_window_surface(struct renderer_system_state* state, struct kwindow* window, struct frame_data* p_frame_data);
 
KAPI b8 renderer_frame_command_list_begin(struct renderer_system_state* state, struct frame_data* p_frame_data);
 
KAPI b8 renderer_frame_command_list_end(struct renderer_system_state* state, struct frame_data* p_frame_data);
 
KAPI b8 renderer_frame_submit(struct renderer_system_state* state, struct frame_data* p_frame_data);
 
KAPI b8 renderer_frame_present(struct renderer_system_state* state, struct kwindow* window, struct frame_data* p_frame_data);
 
KAPI void renderer_viewport_set(vec4 rect);
 
KAPI void renderer_viewport_reset(void);
 
KAPI void renderer_scissor_set(vec4 rect);
 
KAPI void renderer_scissor_reset(void);
 
KAPI void renderer_winding_set(renderer_winding winding);
 
KAPI void renderer_cull_mode_set(renderer_cull_mode cull_mode);
 
KAPI void renderer_set_stencil_test_enabled(b8 enabled);
 
KAPI void renderer_set_stencil_reference(u32 reference);
 
KAPI void renderer_set_depth_test_enabled(b8 enabled);
 
KAPI void renderer_set_depth_write_enabled(b8 enabled);
 
KAPI void renderer_set_stencil_op(renderer_stencil_op fail_op, renderer_stencil_op pass_op, renderer_stencil_op depth_fail_op, renderer_compare_op compare_op);
 
KAPI void renderer_begin_rendering(struct renderer_system_state* state, struct frame_data* p_frame_data, rect_2d render_area, u32 colour_target_count, khandle* colour_targets, khandle depth_stencil_target, u32 depth_stencil_layer);
 
KAPI void renderer_end_rendering(struct renderer_system_state* state, struct frame_data* p_frame_data);
 
KAPI void renderer_set_stencil_compare_mask(u32 compare_mask);
 
KAPI void renderer_set_stencil_write_mask(u32 write_mask);
 
KAPI b8 renderer_texture_resources_acquire(struct renderer_system_state* state, kname name, ktexture_type type, u32 width, u32 height, u8 channel_count, u8 mip_levels, u16 array_size, ktexture_flag_bits flags, khandle* out_renderer_texture_handle);
 
KAPI void renderer_texture_resources_release(struct renderer_system_state* state, khandle* handle);
 
KAPI b8 renderer_texture_resize(struct renderer_system_state* state, khandle renderer_texture_handle, u32 new_width, u32 new_height);
 
KAPI b8 renderer_texture_write_data(struct renderer_system_state* state, khandle renderer_texture_handle, u32 offset, u32 size, const u8* pixels);
 
KAPI b8 renderer_texture_read_data(struct renderer_system_state* state, khandle renderer_texture_handle, u32 offset, u32 size, u8** out_memory);
 
KAPI b8 renderer_texture_read_pixel(struct renderer_system_state* state, khandle renderer_texture_handle, u32 x, u32 y, u8** out_rgba);
 
KAPI void renderer_default_texture_register(struct renderer_system_state* state, renderer_default_texture default_texture, khandle renderer_texture_handle);
 
KAPI khandle renderer_default_texture_get(struct renderer_system_state* state, renderer_default_texture default_texture);
 
KAPI renderbuffer* renderer_renderbuffer_get(renderbuffer_type type);
 
KAPI b8 renderer_geometry_upload(kgeometry* geometry);
 
KAPI void renderer_geometry_vertex_update(kgeometry* g, u32 offset, u32 vertex_count, void* vertices, b8 include_in_frame_workload);
 
KAPI void renderer_geometry_destroy(kgeometry* geometry);
 
KAPI void renderer_geometry_draw(geometry_render_data* data);
 
KAPI void renderer_clear_colour_set(struct renderer_system_state* state, vec4 colour);
 
KAPI void renderer_clear_depth_set(struct renderer_system_state* state, f32 depth);
 
KAPI void renderer_clear_stencil_set(struct renderer_system_state* state, u32 stencil);
 
KAPI b8 renderer_clear_colour(struct renderer_system_state* state, khandle texture_handle);
 
KAPI b8 renderer_clear_depth_stencil(struct renderer_system_state* state, khandle texture_handle);
 
KAPI void renderer_colour_texture_prepare_for_present(struct renderer_system_state* state, khandle texture_handle);
 
KAPI void renderer_texture_prepare_for_sampling(struct renderer_system_state* state, khandle texture_handle, ktexture_flag_bits flags);
 
KAPI b8 renderer_shader_create(struct renderer_system_state* state, khandle shader, kname name, shader_flags flags, u32 topology_types, face_cull_mode cull_mode, u32 stage_count, shader_stage* stages, kname* stage_names, const char** stage_sources, u32 max_groups, u32 max_draw_ids, u32 attribute_count, const shader_attribute* attributes, u32 uniform_count, const shader_uniform* d_uniforms);
 
KAPI void renderer_shader_destroy(struct renderer_system_state* state, khandle shader);
 
KAPI b8 renderer_shader_reload(struct renderer_system_state* state, khandle shader, u32 stage_count, shader_stage* stages, kname* names, const char** sources);
 
KAPI b8 renderer_shader_use(struct renderer_system_state* state, khandle shader);
 
KAPI b8 renderer_shader_supports_wireframe(struct renderer_system_state* state, khandle shader);
 
KAPI b8 renderer_shader_flag_get(struct renderer_system_state* state, khandle shader, shader_flags flag);
 
KAPI void renderer_shader_flag_set(struct renderer_system_state* state, khandle shader, shader_flags flag, b8 enabled);
 
KAPI b8 renderer_shader_bind_per_frame(struct renderer_system_state* state, khandle shader);
 
KAPI b8 renderer_shader_bind_per_group(struct renderer_system_state* state, khandle shader, u32 group_id);
 
KAPI b8 renderer_shader_bind_per_draw(struct renderer_system_state* state, khandle shader, u32 draw_id);
 
KAPI b8 renderer_shader_apply_per_frame(struct renderer_system_state* state, khandle shader);
 
KAPI b8 renderer_shader_apply_per_group(struct renderer_system_state* state, khandle shader);
 
KAPI b8 renderer_shader_apply_per_draw(struct renderer_system_state* state, khandle shader);
 
KAPI b8 renderer_shader_per_group_resources_acquire(struct renderer_system_state* state, khandle shader, u32* out_group_id);
 
KAPI b8 renderer_shader_per_group_resources_release(struct renderer_system_state* state, khandle shader, u32 group_id);
 
KAPI b8 renderer_shader_per_draw_resources_acquire(struct renderer_system_state* state, khandle shader, u32* out_draw_id);
 
KAPI b8 renderer_shader_per_draw_resources_release(struct renderer_system_state* state, khandle shader, u32 draw_id);
 
KAPI b8 renderer_shader_uniform_set(struct renderer_system_state* state, khandle shader, struct shader_uniform* uniform, u32 array_index, const void* value);
 
KAPI khandle renderer_generic_sampler_get(struct renderer_system_state* state, shader_generic_sampler sampler);
 
KAPI khandle renderer_sampler_acquire(struct renderer_system_state* state, kname name, texture_filter filter, texture_repeat repeat, f32 anisotropy);
 
KAPI void renderer_sampler_release(struct renderer_system_state* state, khandle* sampler);
 
KAPI b8 renderer_sampler_refresh(struct renderer_system_state* state, khandle* sampler, texture_filter filter, texture_repeat repeat, f32 anisotropy, u32 mip_levels);
 
KAPI kname renderer_sampler_name_get(struct renderer_system_state* state, khandle sampler);
 
KAPI b8 renderer_is_multithreaded(void);
 
KAPI b8 renderer_flag_enabled_get(renderer_config_flags flag);
KAPI void renderer_flag_enabled_set(renderer_config_flags flag, b8 enabled);
 
KAPI f32 renderer_max_anisotropy_get(void);
 
KAPI b8 renderer_renderbuffer_create(const char* name, renderbuffer_type type, u64 total_size, renderbuffer_track_type track_type, renderbuffer* out_buffer);
 
KAPI void renderer_renderbuffer_destroy(renderbuffer* buffer);
 
KAPI b8 renderer_renderbuffer_bind(renderbuffer* buffer, u64 offset);
 
KAPI b8 renderer_renderbuffer_unbind(renderbuffer* buffer);
 
KAPI void* renderer_renderbuffer_map_memory(renderbuffer* buffer, u64 offset, u64 size);
 
KAPI void renderer_renderbuffer_unmap_memory(renderbuffer* buffer, u64 offset, u64 size);
 
KAPI b8 renderer_renderbuffer_flush(renderbuffer* buffer, u64 offset, u64 size);
 
KAPI b8 renderer_renderbuffer_read(renderbuffer* buffer, u64 offset, u64 size, void** out_memory);
 
KAPI b8 renderer_renderbuffer_resize(renderbuffer* buffer, u64 new_total_size);
 
KAPI b8 renderer_renderbuffer_allocate(renderbuffer* buffer, u64 size, u64* out_offset);
 
KAPI b8 renderer_renderbuffer_free(renderbuffer* buffer, u64 size, u64 offset);
 
KAPI b8 renderer_renderbuffer_clear(renderbuffer* buffer, b8 zero_memory);
 
KAPI b8 renderer_renderbuffer_load_range(renderbuffer* buffer, u64 offset, u64 size, const void* data, b8 include_in_frame_workload);
 
KAPI b8 renderer_renderbuffer_copy_range(renderbuffer* source, u64 source_offset, renderbuffer* dest, u64 dest_offset, u64 size, b8 include_in_frame_workload);
 
KAPI b8 renderer_renderbuffer_draw(renderbuffer* buffer, u64 offset, u32 element_count, b8 bind_only);
 
KAPI struct viewport* renderer_active_viewport_get(void);
 
KAPI void renderer_active_viewport_set(struct viewport* v);
 
KAPI void renderer_wait_for_idle(void);
 
KAPI b8 renderer_pcf_enabled(struct renderer_system_state* state);
 
KAPI u16 renderer_max_bound_texture_count_get(struct renderer_system_state* state);
 
KAPI u16 renderer_max_bound_sampler_count_get(struct renderer_system_state* state);