2023-08-15 16:20:26 +02:00
|
|
|
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
2023-05-31 16:19:06 +02:00
|
|
|
*
|
|
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
2017-06-06 22:47:41 +02:00
|
|
|
|
2019-02-17 22:08:12 +01:00
|
|
|
/** \file
|
|
|
|
* \ingroup DNA
|
2017-06-06 22:47:41 +02:00
|
|
|
*/
|
|
|
|
|
2017-06-12 12:59:54 +02:00
|
|
|
#pragma once
|
2017-06-06 22:47:41 +02:00
|
|
|
|
2020-03-19 09:33:03 +01:00
|
|
|
#include "DNA_ID.h"
|
2017-06-06 22:47:41 +02:00
|
|
|
#include "DNA_defs.h"
|
|
|
|
#include "DNA_listBase.h"
|
|
|
|
|
2019-05-29 16:57:09 +02:00
|
|
|
#include "BLI_assert.h"
|
|
|
|
|
2017-06-06 22:47:41 +02:00
|
|
|
struct AnimData;
|
2019-01-28 11:08:24 +01:00
|
|
|
struct Object;
|
2017-06-06 22:47:41 +02:00
|
|
|
|
2017-06-12 12:59:54 +02:00
|
|
|
typedef struct LightProbe {
|
2017-06-06 22:47:41 +02:00
|
|
|
ID id;
|
2019-01-07 12:19:13 +01:00
|
|
|
/** Animation data (must be immediately after id for utilities to use it). */
|
|
|
|
struct AnimData *adt;
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2019-01-07 12:19:13 +01:00
|
|
|
/** For realtime probe objects. */
|
|
|
|
char type;
|
|
|
|
/** General purpose flags for probes. */
|
|
|
|
char flag;
|
|
|
|
/** Attenuation type. */
|
|
|
|
char attenuation_type;
|
|
|
|
/** Parallax type. */
|
|
|
|
char parallax_type;
|
2023-08-06 16:30:12 +02:00
|
|
|
/** Grid specific flags. */
|
|
|
|
char grid_flag;
|
|
|
|
char _pad0[3];
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2019-01-07 12:19:13 +01:00
|
|
|
/** Influence Radius. */
|
|
|
|
float distinf;
|
|
|
|
/** Parallax Radius. */
|
|
|
|
float distpar;
|
|
|
|
/** Influence falloff. */
|
|
|
|
float falloff;
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2017-06-08 23:10:28 +02:00
|
|
|
float clipsta, clipend;
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2019-01-07 12:19:13 +01:00
|
|
|
/** VSM visibility biases. */
|
|
|
|
float vis_bias, vis_bleedbias;
|
2018-01-21 23:15:57 +01:00
|
|
|
float vis_blur;
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2019-01-07 12:19:13 +01:00
|
|
|
/** Intensity multiplier. */
|
|
|
|
float intensity;
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2019-01-07 12:19:13 +01:00
|
|
|
/** Irradiance grid resolution. */
|
|
|
|
int grid_resolution_x;
|
2017-06-13 15:56:04 +02:00
|
|
|
int grid_resolution_y;
|
|
|
|
int grid_resolution_z;
|
2023-06-23 08:39:46 +02:00
|
|
|
/** Irradiance grid: number of directions to evaluate light transfer in. */
|
|
|
|
int grid_bake_samples;
|
2023-08-03 16:47:05 +02:00
|
|
|
/** Irradiance grid: Virtual offset parameters. */
|
|
|
|
float grid_surface_bias;
|
|
|
|
float grid_escape_bias;
|
2023-07-20 19:03:08 +02:00
|
|
|
/** Irradiance grid: Sampling biases. */
|
|
|
|
float grid_normal_bias;
|
|
|
|
float grid_view_bias;
|
|
|
|
float grid_facing_bias;
|
2023-08-06 13:43:17 +02:00
|
|
|
float grid_validity_threshold;
|
2023-08-03 15:48:33 +02:00
|
|
|
/** Irradiance grid: Dilation. */
|
|
|
|
float grid_dilation_threshold;
|
|
|
|
float grid_dilation_radius;
|
2023-10-10 14:50:17 +02:00
|
|
|
|
2023-09-04 23:27:30 +02:00
|
|
|
/** Light intensity clamp. */
|
|
|
|
float grid_clamp_direct;
|
|
|
|
float grid_clamp_indirect;
|
2023-06-23 08:39:46 +02:00
|
|
|
|
|
|
|
/** Surface element density for scene surface cache. In surfel per unit distance. */
|
|
|
|
float surfel_density;
|
|
|
|
|
2019-01-07 12:19:13 +01:00
|
|
|
/** Object visibility group, inclusive or exclusive. */
|
|
|
|
struct Collection *visibility_grp;
|
2023-11-02 17:08:13 +01:00
|
|
|
|
|
|
|
/** LIGHTPROBE_FLAG_SHOW_DATA display size. */
|
|
|
|
float data_display_size;
|
|
|
|
char _pad1[4];
|
2017-06-12 12:59:54 +02:00
|
|
|
} LightProbe;
|
2017-06-06 22:47:41 +02:00
|
|
|
|
|
|
|
/* Probe->type */
|
|
|
|
enum {
|
2023-10-11 19:38:42 +02:00
|
|
|
LIGHTPROBE_TYPE_SPHERE = 0,
|
|
|
|
LIGHTPROBE_TYPE_PLANE = 1,
|
|
|
|
LIGHTPROBE_TYPE_VOLUME = 2,
|
2017-06-06 22:47:41 +02:00
|
|
|
};
|
|
|
|
|
2017-06-09 22:30:49 +02:00
|
|
|
/* Probe->flag */
|
|
|
|
enum {
|
2017-06-12 12:59:54 +02:00
|
|
|
LIGHTPROBE_FLAG_CUSTOM_PARALLAX = (1 << 0),
|
|
|
|
LIGHTPROBE_FLAG_SHOW_INFLUENCE = (1 << 1),
|
|
|
|
LIGHTPROBE_FLAG_SHOW_PARALLAX = (1 << 2),
|
|
|
|
LIGHTPROBE_FLAG_SHOW_CLIP_DIST = (1 << 3),
|
2017-06-15 00:10:34 +02:00
|
|
|
LIGHTPROBE_FLAG_SHOW_DATA = (1 << 4),
|
2018-04-24 12:15:25 +02:00
|
|
|
LIGHTPROBE_FLAG_INVERT_GROUP = (1 << 5),
|
2017-06-09 22:30:49 +02:00
|
|
|
};
|
|
|
|
|
2023-08-06 16:30:12 +02:00
|
|
|
/* Probe->grid_flag */
|
|
|
|
enum {
|
|
|
|
LIGHTPROBE_GRID_CAPTURE_WORLD = (1 << 0),
|
|
|
|
LIGHTPROBE_GRID_CAPTURE_INDIRECT = (1 << 1),
|
|
|
|
LIGHTPROBE_GRID_CAPTURE_EMISSION = (1 << 2),
|
|
|
|
};
|
|
|
|
|
2017-06-06 22:47:41 +02:00
|
|
|
/* Probe->display */
|
|
|
|
enum {
|
2017-06-12 12:59:54 +02:00
|
|
|
LIGHTPROBE_DISP_WIRE = 0,
|
|
|
|
LIGHTPROBE_DISP_SHADED = 1,
|
|
|
|
LIGHTPROBE_DISP_DIFFUSE = 2,
|
|
|
|
LIGHTPROBE_DISP_REFLECTIVE = 3,
|
2017-06-06 22:47:41 +02:00
|
|
|
};
|
|
|
|
|
2021-06-26 13:35:18 +02:00
|
|
|
/* Probe->parallax && Probe->attenuation_type. */
|
2017-06-06 22:47:41 +02:00
|
|
|
enum {
|
2017-06-12 12:59:54 +02:00
|
|
|
LIGHTPROBE_SHAPE_ELIPSOID = 0,
|
|
|
|
LIGHTPROBE_SHAPE_BOX = 1,
|
2017-06-06 22:47:41 +02:00
|
|
|
};
|
|
|
|
|
2018-07-10 15:02:25 +02:00
|
|
|
/* ------- Eevee LightProbes ------- */
|
2019-06-12 01:04:10 +02:00
|
|
|
/* Needs to be there because written to file with the light-cache. */
|
2018-07-10 15:02:25 +02:00
|
|
|
|
2019-02-28 15:10:14 +01:00
|
|
|
/* IMPORTANT Padding in these structs is essential. It must match
|
|
|
|
* GLSL struct definition in lightprobe_lib.glsl. */
|
|
|
|
|
|
|
|
/* Must match CubeData. */
|
2018-07-10 15:02:25 +02:00
|
|
|
typedef struct LightProbeCache {
|
|
|
|
float position[3], parallax_type;
|
|
|
|
float attenuation_fac;
|
|
|
|
float attenuation_type;
|
2019-02-28 15:10:14 +01:00
|
|
|
float _pad3[2];
|
2018-07-10 15:02:25 +02:00
|
|
|
float attenuationmat[4][4];
|
|
|
|
float parallaxmat[4][4];
|
|
|
|
} LightProbeCache;
|
|
|
|
|
2019-02-28 15:10:14 +01:00
|
|
|
/* Must match GridData. */
|
2018-07-10 15:02:25 +02:00
|
|
|
typedef struct LightGridCache {
|
|
|
|
float mat[4][4];
|
2019-01-07 12:19:13 +01:00
|
|
|
/** Offset to the first irradiance sample in the pool. */
|
|
|
|
int resolution[3], offset;
|
2018-07-10 15:02:25 +02:00
|
|
|
float corner[3], attenuation_scale;
|
2019-01-07 12:19:13 +01:00
|
|
|
/** World space vector between 2 opposite cells. */
|
|
|
|
float increment_x[3], attenuation_bias;
|
2018-07-10 15:02:25 +02:00
|
|
|
float increment_y[3], level_bias;
|
2019-02-28 15:10:14 +01:00
|
|
|
float increment_z[3], _pad4;
|
|
|
|
float visibility_bias, visibility_bleed, visibility_range, _pad5;
|
2018-07-10 15:02:25 +02:00
|
|
|
} LightGridCache;
|
|
|
|
|
2021-02-14 10:58:04 +01:00
|
|
|
/* These are used as UBO data. They need to be aligned to size of vec4. */
|
2019-05-29 16:57:09 +02:00
|
|
|
BLI_STATIC_ASSERT_ALIGN(LightProbeCache, 16)
|
|
|
|
BLI_STATIC_ASSERT_ALIGN(LightGridCache, 16)
|
|
|
|
|
2018-07-10 15:02:25 +02:00
|
|
|
/* ------ Eevee Lightcache ------- */
|
|
|
|
|
|
|
|
typedef struct LightCacheTexture {
|
|
|
|
struct GPUTexture *tex;
|
2021-11-19 12:44:27 +01:00
|
|
|
/** Copy of GPU data to create GPUTextures on file read. */
|
2018-07-10 15:02:25 +02:00
|
|
|
char *data;
|
|
|
|
int tex_size[3];
|
|
|
|
char data_type;
|
|
|
|
char components;
|
2019-02-27 05:07:50 +01:00
|
|
|
char _pad[2];
|
2018-07-10 15:02:25 +02:00
|
|
|
} LightCacheTexture;
|
|
|
|
|
|
|
|
typedef struct LightCache {
|
|
|
|
int flag;
|
2020-03-11 17:12:01 +01:00
|
|
|
/** Version number to know if the cache data is compatible with this version of blender. */
|
|
|
|
int version;
|
|
|
|
/** Type of data this cache contains. */
|
|
|
|
int type;
|
2018-07-10 15:02:25 +02:00
|
|
|
/* only a single cache for now */
|
2019-01-07 12:19:13 +01:00
|
|
|
/** Number of probes to use for rendering. */
|
|
|
|
int cube_len, grid_len;
|
|
|
|
/** Number of mipmap level to use. */
|
|
|
|
int mips_len;
|
|
|
|
/** Size of a visibility/reflection sample. */
|
|
|
|
int vis_res, ref_res;
|
2019-02-27 05:07:50 +01:00
|
|
|
char _pad[4][2];
|
2018-07-10 15:02:25 +02:00
|
|
|
/* In the future, we could create a bigger texture containing
|
|
|
|
* multiple caches (for animation) and interpolate between the
|
|
|
|
* caches overtime to another texture. */
|
|
|
|
LightCacheTexture grid_tx;
|
2019-01-07 12:19:13 +01:00
|
|
|
/** Contains data for mipmap level 0. */
|
|
|
|
LightCacheTexture cube_tx;
|
|
|
|
/** Does not contains valid GPUTexture, only data. */
|
|
|
|
LightCacheTexture *cube_mips;
|
2018-07-10 15:02:25 +02:00
|
|
|
/* All lightprobes data contained in the cache. */
|
|
|
|
LightProbeCache *cube_data;
|
|
|
|
LightGridCache *grid_data;
|
|
|
|
} LightCache;
|
|
|
|
|
2020-03-11 17:12:01 +01:00
|
|
|
/* Bump the version number for lightcache data structure changes. */
|
2021-02-13 18:54:54 +01:00
|
|
|
#define LIGHTCACHE_STATIC_VERSION 2
|
2020-03-11 17:12:01 +01:00
|
|
|
|
|
|
|
/* LightCache->type */
|
|
|
|
enum {
|
|
|
|
LIGHTCACHE_TYPE_STATIC = 0,
|
|
|
|
};
|
|
|
|
|
2018-07-10 15:02:25 +02:00
|
|
|
/* LightCache->flag */
|
|
|
|
enum {
|
|
|
|
LIGHTCACHE_BAKED = (1 << 0),
|
|
|
|
LIGHTCACHE_BAKING = (1 << 1),
|
|
|
|
LIGHTCACHE_CUBE_READY = (1 << 2),
|
|
|
|
LIGHTCACHE_GRID_READY = (1 << 3),
|
|
|
|
/* Update tagging */
|
|
|
|
LIGHTCACHE_UPDATE_CUBE = (1 << 4),
|
|
|
|
LIGHTCACHE_UPDATE_GRID = (1 << 5),
|
|
|
|
LIGHTCACHE_UPDATE_WORLD = (1 << 6),
|
2018-07-11 16:54:10 +02:00
|
|
|
LIGHTCACHE_UPDATE_AUTO = (1 << 7),
|
2020-08-04 19:52:18 +02:00
|
|
|
/** Invalid means we tried to alloc it but failed. */
|
|
|
|
LIGHTCACHE_INVALID = (1 << 8),
|
|
|
|
/** The data present in the cache is valid but unusable on this GPU. */
|
|
|
|
LIGHTCACHE_NOT_USABLE = (1 << 9),
|
2018-07-10 15:02:25 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
/* EEVEE_LightCacheTexture->data_type */
|
|
|
|
enum {
|
|
|
|
LIGHTCACHETEX_BYTE = (1 << 0),
|
|
|
|
LIGHTCACHETEX_FLOAT = (1 << 1),
|
|
|
|
LIGHTCACHETEX_UINT = (1 << 2),
|
|
|
|
};
|
|
|
|
|
2023-04-17 17:12:19 +02:00
|
|
|
/* -------------------------------------------------------------------- */
|
|
|
|
/** \name Irradiance grid data storage
|
|
|
|
*
|
|
|
|
* Each spherical harmonic band is stored separately. This allow loading only a specific band.
|
|
|
|
* The layout of each array is set by the #LightProbeGridType.
|
|
|
|
* Any unavailable data is be set to nullptr.
|
|
|
|
* \{ */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Irradiance data (RGB) stored along visibility (A).
|
|
|
|
* This is the format used during baking and is used for visualizing the baking process.
|
|
|
|
*/
|
|
|
|
typedef struct LightProbeBakingData {
|
|
|
|
float (*L0)[4];
|
|
|
|
float (*L1_a)[4];
|
|
|
|
float (*L1_b)[4];
|
|
|
|
float (*L1_c)[4];
|
2023-08-03 15:48:33 +02:00
|
|
|
float *validity;
|
2023-08-03 16:47:05 +02:00
|
|
|
/* Capture offset. Only for debugging. */
|
|
|
|
float (*virtual_offset)[4];
|
2023-04-17 17:12:19 +02:00
|
|
|
} LightProbeBakingData;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Irradiance stored as RGB triple using scene linear color space.
|
|
|
|
*/
|
|
|
|
typedef struct LightProbeIrradianceData {
|
|
|
|
float (*L0)[3];
|
|
|
|
float (*L1_a)[3];
|
|
|
|
float (*L1_b)[3];
|
|
|
|
float (*L1_c)[3];
|
|
|
|
} LightProbeIrradianceData;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Normalized visibility of distant light. Used for compositing grids together.
|
|
|
|
*/
|
|
|
|
typedef struct LightProbeVisibilityData {
|
|
|
|
float *L0;
|
|
|
|
float *L1_a;
|
|
|
|
float *L1_b;
|
|
|
|
float *L1_c;
|
|
|
|
} LightProbeVisibilityData;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Used to avoid light leaks. Validate visibility between each grid sample.
|
|
|
|
*/
|
|
|
|
typedef struct LightProbeConnectivityData {
|
2023-08-03 15:48:33 +02:00
|
|
|
/** Stores validity of the lighting for each grid sample. */
|
|
|
|
uint8_t *validity;
|
2023-04-17 17:12:19 +02:00
|
|
|
} LightProbeConnectivityData;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Defines one block of data inside the grid cache data arrays.
|
|
|
|
* The block size if the same for all the blocks.
|
|
|
|
*/
|
|
|
|
typedef struct LightProbeBlockData {
|
|
|
|
/* Offset inside the level-of-detail this block starts. */
|
|
|
|
int offset[3];
|
|
|
|
/* Level-of-detail this block is from. */
|
|
|
|
int level;
|
|
|
|
} LightProbeBlockData;
|
|
|
|
|
|
|
|
/** \} */
|
|
|
|
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
|
|
/** \name LightProbeGridCacheFrame
|
|
|
|
*
|
|
|
|
* \{ */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* A frame worth of baked lighting data.
|
|
|
|
*/
|
|
|
|
typedef struct LightProbeGridCacheFrame {
|
|
|
|
/** Number of samples in the highest level of detail. */
|
|
|
|
int size[3];
|
|
|
|
/** Spatial layout type of the data stored inside the data arrays. */
|
|
|
|
int data_layout;
|
|
|
|
|
|
|
|
/** Sparse or adaptive layout only: number of blocks inside data arrays. */
|
|
|
|
int block_len;
|
|
|
|
/** Sparse or adaptive layout only: size of a block in samples. All 3 dimensions are equal. */
|
|
|
|
int block_size;
|
|
|
|
/** Sparse or adaptive layout only: specify the blocks positions. */
|
|
|
|
LightProbeBlockData *block_infos;
|
|
|
|
|
|
|
|
/** In-progress baked data. Not stored in file. */
|
|
|
|
LightProbeBakingData baking;
|
|
|
|
/** Baked data. */
|
|
|
|
LightProbeIrradianceData irradiance;
|
|
|
|
LightProbeVisibilityData visibility;
|
|
|
|
LightProbeConnectivityData connectivity;
|
|
|
|
|
|
|
|
char _pad[4];
|
|
|
|
|
|
|
|
/** Number of debug surfels. */
|
|
|
|
int surfels_len;
|
|
|
|
/** Debug surfels used to visualize the baking process. Not stored in file. */
|
|
|
|
void *surfels;
|
|
|
|
} LightProbeGridCacheFrame;
|
|
|
|
|
|
|
|
/** #LightProbeGridCacheFrame.data_layout (int) */
|
|
|
|
enum {
|
|
|
|
/** Simple uniform grid. Raw output from GPU. Used during the baking process. */
|
|
|
|
LIGHTPROBE_CACHE_UNIFORM_GRID = 0,
|
|
|
|
/** Fills the space with different level of resolution. More efficient storage. */
|
|
|
|
LIGHTPROBE_CACHE_ADAPTIVE_RESOLUTION = 1,
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Per object container of baked data.
|
|
|
|
* Should be called #LightProbeCache but name is already taken.
|
|
|
|
*/
|
|
|
|
typedef struct LightProbeObjectCache {
|
|
|
|
/** Allow correct versioning / different types of data for the same layout. */
|
|
|
|
int cache_type;
|
|
|
|
/** True if this cache references the original object's cache. */
|
|
|
|
char shared;
|
|
|
|
/** True if the cache has been tagged for automatic baking. */
|
|
|
|
char dirty;
|
|
|
|
|
|
|
|
char _pad0[2];
|
|
|
|
|
|
|
|
struct LightProbeGridCacheFrame *grid_static_cache;
|
|
|
|
} LightProbeObjectCache;
|
|
|
|
|
|
|
|
/** #LightProbeObjectCache.type (int) */
|
|
|
|
enum {
|
|
|
|
/** Light cache was just created and is not yet baked. Keep as 0 for default value. */
|
|
|
|
LIGHTPROBE_CACHE_TYPE_NONE = 0,
|
|
|
|
/** Light cache is baked for one specific frame and capture all indirect lighting. */
|
|
|
|
LIGHTPROBE_CACHE_TYPE_STATIC = 1,
|
|
|
|
};
|
|
|
|
|
|
|
|
/** \} */
|