kmaterial_system.h

Go to the documentation of this file.

 
#pragma once
 
#include "core_render_types.h"
 
#include <defines.h>
#include <strings/kname.h>
 
#define KMATERIAL_STANDARD_NAME_DEFAULT "DefaultMaterial"
#define KMATERIAL_WATER_NAME_DEFAULT "MaterialStandardWater"
#define KMATERIAL_BLENDED_NAME_DEFAULT "MaterialStandardBlended"
 
#define KMATERIAL_MAX_IRRADIANCE_CUBEMAP_COUNT 4
#define KMATERIAL_MAX_SHADOW_CASCADES 4
#define KMATERIAL_MAX_WATER_PLANES 4
// One view for regular camera, plus one reflection view per water plane.
#define KMATERIAL_MAX_POINT_LIGHTS 10
 
#define KMATERIAL_DEFAULT_BASE_COLOUR_VALUE (vec4){1.0f, 1.0f, 1.0f, 1.0f}
#define KMATERIAL_DEFAULT_NORMAL_VALUE (vec3){0.0f, 0.0f, 1.0f}
#define KMATERIAL_DEFAULT_NORMAL_ENABLED true
#define KMATERIAL_DEFAULT_METALLIC_VALUE 0.0f
#define KMATERIAL_DEFAULT_ROUGHNESS_VALUE 0.5f
#define KMATERIAL_DEFAULT_AO_VALUE 1.0f
#define KMATERIAL_DEFAULT_AO_ENABLED true
#define KMATERIAL_DEFAULT_MRA_VALUE (vec3){0.0f, 0.5f, 1.0f}
#define KMATERIAL_DEFAULT_MRA_ENABLED true
#define KMATERIAL_DEFAULT_HAS_TRANSPARENCY false
#define KMATERIAL_DEFAULT_MASKED false
#define KMATERIAL_DEFAULT_DOUBLE_SIDED false
#define KMATERIAL_DEFAULT_RECIEVES_SHADOW true
#define KMATERIAL_DEFAULT_CASTS_SHADOW true
#define KMATERIAL_DEFAULT_USE_VERTEX_COLOUR_AS_BASE_COLOUR false
 
struct kmaterial_system_state;
struct frame_data;
 
typedef struct kmaterial_system_config {
    u32 max_material_count;
 
    u32 max_instance_count;
} kmaterial_system_config;
 
typedef enum kmaterial_texture_input {
    // Forms the base colour of a material. Albedo for PBR, sometimes known as a "diffuse" colour. Specifies per-pixel colour.
    KMATERIAL_TEXTURE_INPUT_BASE_COLOUR,
    // Texture specifying per-pixel normal vector.
    KMATERIAL_TEXTURE_INPUT_NORMAL,
    // Texture specifying per-pixel metallic value.
    KMATERIAL_TEXTURE_INPUT_METALLIC,
    // Texture specifying per-pixel roughness value.
    KMATERIAL_TEXTURE_INPUT_ROUGHNESS,
    // Texture specifying per-pixel ambient occlusion value.
    KMATERIAL_TEXTURE_INPUT_AMBIENT_OCCLUSION,
    // Texture specifying per-pixel emissive value.
    KMATERIAL_TEXTURE_INPUT_EMISSIVE,
    // Texture specifying the reflection (only used for water materials)
    KMATERIAL_TEXTURE_INPUT_REFLECTION,
    // Texture specifying per-pixel refraction strength.
    KMATERIAL_TEXTURE_INPUT_REFRACTION,
    // Texture specifying the reflection depth (only used for water materials)
    KMATERIAL_TEXTURE_INPUT_REFLECTION_DEPTH,
    // Texture specifying the refraction depth.
    KMATERIAL_TEXTURE_INPUT_REFRACTION_DEPTH,
    KMATERIAL_TEXTURE_INPUT_DUDV,
    // Texture holding per-pixel metallic (r), roughness (g) and ambient occlusion (b) value.
    KMATERIAL_TEXTURE_INPUT_MRA,
    // The size of the material_texture_input enumeration.
    KMATERIAL_TEXTURE_INPUT_COUNT
} kmaterial_texture_input;
 
typedef enum kmaterial_state {
    KMATERIAL_STATE_UNINITIALIZED = 0,
    KMATERIAL_STATE_LOADING,
    KMATERIAL_STATE_LOADED,
} kmaterial_state;
 
typedef enum kmaterial_instance_state {
    // Instance is available
    KMATERIAL_INSTANCE_STATE_UNINITIALIZED = 0,
    // Instance was issued while base material was loading, and needs initialization.
    KMATERIAL_INSTANCE_STATE_LOADING,
    // Instance is ready to be used.
    KMATERIAL_INSTANCE_STATE_LOADED,
} kmaterial_instance_state;
 
// Represents the data for a single instance of a material.
// This can be thought of as "per-draw" data.
typedef struct kmaterial_instance_data {
    kmaterial_instance_state state;
 
    // A handle to the material to which this instance references.
    kmaterial material;
 
    // Multiplied by albedo/diffuse texture. Overrides the value set in the base material.
    vec4 base_colour;
 
    // Overrides the flags set in the base material.
    kmaterial_flags flags;
 
    // Added to UV coords of vertex data.
    vec3 uv_offset;
    // Multiplied against uv coords of vertex data.
    vec3 uv_scale;
 
} kmaterial_instance_data;
 
// Represents a base material.
// This can be thought of as "per-group" data.
typedef struct kmaterial_data {
    u16 index;
 
    kname name;
    // The state of the material (loaded vs not, etc.)
    kmaterial_state state;
    kmaterial_type type;
    kmaterial_model model;
 
    vec4 base_colour;
    ktexture base_colour_texture;
 
    vec3 normal;
    ktexture normal_texture;
 
    f32 metallic;
    ktexture metallic_texture;
    texture_channel metallic_texture_channel;
 
    f32 roughness;
    ktexture roughness_texture;
    texture_channel roughness_texture_channel;
 
    f32 ao;
    ktexture ao_texture;
    texture_channel ao_texture_channel;
 
    vec4 emissive;
    ktexture emissive_texture;
    f32 emissive_texture_intensity;
 
    ktexture refraction_texture;
    f32 refraction_scale;
 
    ktexture reflection_texture;
    ktexture reflection_depth_texture;
    ktexture dudv_texture;
    ktexture refraction_depth_texture;
 
    vec3 mra;
    ktexture mra_texture;
 
    // Base set of flags for the material. Copied to the material instance when created.
    kmaterial_flags flags;
 
    // Added to UV coords of vertex data. Overridden by instance data.
    vec3 uv_offset;
    // Multiplied against uv coords of vertex data. Overridden by instance data.
    vec3 uv_scale;
 
    // Affects the strength of waves for a water type material.
    f32 wave_strength;
    // Affects wave movement speed for a water material.
    f32 wave_speed;
    f32 tiling;
 
    // Shader binding set id for base material data.
    u32 binding_set_id;
 
} kmaterial_data;
 
b8 kmaterial_system_initialize(u64* memory_requirement, struct kmaterial_system_state* state, const kmaterial_system_config* config);
 
b8 kmaterial_system_setup_defaults(struct kmaterial_system_state* state);
 
void kmaterial_system_shutdown(struct kmaterial_system_state* state);
 
// -------------------------------------------------
// ---------------- MATERIAL -----------------------
// -------------------------------------------------
 
KAPI b8 kmaterial_system_get_handle(struct kmaterial_system_state* state, kname name, kmaterial* out_material);
 
KAPI b8 kmaterial_is_loaded_get(struct kmaterial_system_state* state, kmaterial material);
 
KAPI ktexture kmaterial_texture_get(struct kmaterial_system_state* state, kmaterial material, kmaterial_texture_input tex_input);
KAPI void kmaterial_texture_set(struct kmaterial_system_state* state, kmaterial material, kmaterial_texture_input tex_input, ktexture texture);
 
KAPI texture_channel kmaterial_metallic_texture_channel_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_metallic_texture_channel_set(struct kmaterial_system_state* state, kmaterial material, texture_channel value);
 
KAPI texture_channel kmaterial_roughness_texture_channel_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_roughness_texture_channel_set(struct kmaterial_system_state* state, kmaterial material, texture_channel value);
 
KAPI texture_channel kmaterial_ao_texture_channel_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_ao_texture_channel_set(struct kmaterial_system_state* state, kmaterial material, texture_channel value);
 
KAPI texture_filter kmaterial_texture_filter_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_texture_filter_set(struct kmaterial_system_state* state, kmaterial material, texture_filter value);
 
KAPI texture_repeat kmaterial_texture_mode_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_texture_mode_set(struct kmaterial_system_state* state, kmaterial material, texture_repeat value);
 
KAPI b8 kmaterial_has_transparency_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_has_transparency_set(struct kmaterial_system_state* state, kmaterial material, b8 value);
 
KAPI b8 kmaterial_double_sided_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_double_sided_set(struct kmaterial_system_state* state, kmaterial material, b8 value);
 
KAPI b8 kmaterial_recieves_shadow_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_recieves_shadow_set(struct kmaterial_system_state* state, kmaterial material, b8 value);
 
KAPI b8 kmaterial_casts_shadow_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_casts_shadow_set(struct kmaterial_system_state* state, kmaterial material, b8 value);
 
KAPI b8 kmaterial_normal_enabled_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_normal_enabled_set(struct kmaterial_system_state* state, kmaterial material, b8 value);
 
KAPI b8 kmaterial_ao_enabled_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_ao_enabled_set(struct kmaterial_system_state* state, kmaterial material, b8 value);
 
KAPI b8 kmaterial_emissive_enabled_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_emissive_enabled_set(struct kmaterial_system_state* state, kmaterial material, b8 value);
 
KAPI b8 kmaterial_refraction_enabled_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_refraction_enabled_set(struct kmaterial_system_state* state, kmaterial material, b8 value);
 
KAPI f32 kmaterial_refraction_scale_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_refraction_scale_set(struct kmaterial_system_state* state, kmaterial material, f32 value);
 
KAPI b8 kmaterial_use_vertex_colour_as_base_colour_get(struct kmaterial_system_state* state, kmaterial material);
KAPI void kmaterial_use_vertex_colour_as_base_colour_set(struct kmaterial_system_state* state, kmaterial material, b8 value);
 
KAPI b8 kmaterial_flag_set(struct kmaterial_system_state* state, kmaterial material, kmaterial_flag_bits flag, b8 value);
 
KAPI b8 kmaterial_flag_get(struct kmaterial_system_state* state, kmaterial material, kmaterial_flag_bits flag);
 
// -------------------------------------------------
// ------------- MATERIAL INSTANCE -----------------
// -------------------------------------------------
 
KAPI b8 kmaterial_system_acquire(struct kmaterial_system_state* state, kname name, kmaterial_instance* out_instance);
 
KAPI void kmaterial_system_release(struct kmaterial_system_state* state, kmaterial_instance* instance);
 
KAPI const kmaterial_data* kmaterial_get_base_material_data(struct kmaterial_system_state* state, kmaterial base_material);
 
KAPI const kmaterial_data* kmaterial_system_get_all_base_materials(struct kmaterial_system_state* state);
 
KAPI const kmaterial_instance_data* kmaterial_get_material_instance_data(struct kmaterial_system_state* state, kmaterial_instance instance);
 
KAPI b8 kmaterial_instance_flag_set(struct kmaterial_system_state* state, kmaterial_instance instance, kmaterial_flag_bits flag, b8 value);
 
KAPI b8 kmaterial_instance_flag_get(struct kmaterial_system_state* state, kmaterial_instance instance, kmaterial_flag_bits flag);
 
KAPI b8 kmaterial_instance_base_colour_get(struct kmaterial_system_state* state, kmaterial_instance instance, vec4* out_value);
 
KAPI b8 kmaterial_instance_base_colour_set(struct kmaterial_system_state* state, kmaterial_instance instance, vec4 value);
 
KAPI b8 kmaterial_instance_uv_offset_get(struct kmaterial_system_state* state, kmaterial_instance instance, vec3* out_value);
 
KAPI b8 kmaterial_instance_uv_offset_set(struct kmaterial_system_state* state, kmaterial_instance instance, vec3 value);
 
KAPI b8 kmaterial_instance_uv_scale_get(struct kmaterial_system_state* state, kmaterial_instance instance, vec3* out_value);
 
KAPI b8 kmaterial_instance_uv_scale_set(struct kmaterial_system_state* state, kmaterial_instance instance, vec3 value);
 
KAPI kmaterial_instance kmaterial_system_get_default_standard(struct kmaterial_system_state* state);
 
KAPI kmaterial_instance kmaterial_system_get_default_water(struct kmaterial_system_state* state);
 
KAPI kmaterial_instance kmaterial_system_get_default_blended(struct kmaterial_system_state* state);
 
KAPI void kmaterial_system_dump(struct kmaterial_system_state* state);