Differential D15817 Diff 55261 source/blender/draw/intern/draw_shader_shared.h

Changeset View

Standalone View

source/blender/draw/intern/draw_shader_shared.h

/* SPDX-License-Identifier: GPL-2.0-or-later */		/* SPDX-License-Identifier: GPL-2.0-or-later */

#ifndef GPU_SHADER		#ifndef GPU_SHADER
# pragma once		# pragma once

# include "GPU_shader.h"		# include "GPU_shader.h"
# include "GPU_shader_shared_utils.h"		# include "GPU_shader_shared_utils.h"
		# include "draw_defines.h"

typedef struct ViewInfos ViewInfos;		typedef struct ViewInfos ViewInfos;
typedef struct ObjectMatrices ObjectMatrices;		typedef struct ObjectMatrices ObjectMatrices;
typedef struct ObjectInfos ObjectInfos;		typedef struct ObjectInfos ObjectInfos;
		typedef struct ObjectBounds ObjectBounds;
typedef struct VolumeInfos VolumeInfos;		typedef struct VolumeInfos VolumeInfos;
typedef struct CurvesInfos CurvesInfos;		typedef struct CurvesInfos CurvesInfos;
typedef struct DrawCommand DrawCommand;		typedef struct DrawCommand DrawCommand;
typedef struct DrawCommandIndexed DrawCommandIndexed;
typedef struct DispatchCommand DispatchCommand;		typedef struct DispatchCommand DispatchCommand;
typedef struct DRWDebugPrintBuffer DRWDebugPrintBuffer;		typedef struct DRWDebugPrintBuffer DRWDebugPrintBuffer;
typedef struct DRWDebugVert DRWDebugVert;		typedef struct DRWDebugVert DRWDebugVert;
typedef struct DRWDebugDrawBuffer DRWDebugDrawBuffer;		typedef struct DRWDebugDrawBuffer DRWDebugDrawBuffer;

		# ifdef __cplusplus
		/* C++ only forward declarations. */
		struct Object;

		namespace blender::draw {

		struct ObjectRef;

		} // namespace blender::draw

		# else /* __cplusplus */
		/* C only forward declarations. */
		typedef enum eObjectInfoFlag eObjectInfoFlag;

		# endif
#endif		#endif

#define DRW_SHADER_SHARED_H		#define DRW_SHADER_SHARED_H

#define DRW_RESOURCE_CHUNK_LEN 512		#define DRW_RESOURCE_CHUNK_LEN 512

/* Define the maximum number of grid we allow in a volume UBO. */		/* Define the maximum number of grid we allow in a volume UBO. */
#define DRW_GRID_PER_VOLUME_MAX 16		#define DRW_GRID_PER_VOLUME_MAX 16
Show All 15 Lines	struct ViewInfos {
float4 viewvecs[2];		float4 viewvecs[2];
/* Should not be here. Not view dependent (only main view). */		/* Should not be here. Not view dependent (only main view). */
float4 viewcamtexcofac;		float4 viewcamtexcofac;

float2 viewport_size;		float2 viewport_size;
float2 viewport_size_inverse;		float2 viewport_size_inverse;

/** Frustum culling data. */		/** Frustum culling data. */
/** NOTE: vec3 arrays are padded to vec4. */		/** \note vec3 array padded to vec4. */
float4 frustum_corners[8];		float4 frustum_corners[8];
		jbakkerUnsubmitted Done Inline Actions I dislike comments on after definition. especially when they are doc comments. jbakker: I dislike comments on after definition. especially when they are doc comments.
float4 frustum_planes[6];		float4 frustum_planes[6];
		float4 frustum_bound_sphere;

/** For debugging purpose */		/** For debugging purpose */
/* Mouse pixel. */		/* Mouse pixel. */
int2 mouse_pixel;		int2 mouse_pixel;

int2 _pad0;		/** True if facing needs to be inverted. */
		bool1 is_inverted;
		int _pad0;
};		};
BLI_STATIC_ASSERT_ALIGN(ViewInfos, 16)		BLI_STATIC_ASSERT_ALIGN(ViewInfos, 16)

/* Do not override old definitions if the shader uses this header but not shader info. */		/* Do not override old definitions if the shader uses this header but not shader info. */
#ifdef USE_GPU_SHADER_CREATE_INFO		#ifdef USE_GPU_SHADER_CREATE_INFO
/* TODO(@fclem): Mass rename. */		/* TODO(@fclem): Mass rename. */
# define ViewProjectionMatrix drw_view.persmat		# define ViewProjectionMatrix drw_view.persmat
# define ViewProjectionMatrixInverse drw_view.persinv		# define ViewProjectionMatrixInverse drw_view.persinv
# define ViewMatrix drw_view.viewmat		# define ViewMatrix drw_view.viewmat
# define ViewMatrixInverse drw_view.viewinv		# define ViewMatrixInverse drw_view.viewinv
# define ProjectionMatrix drw_view.winmat		# define ProjectionMatrix drw_view.winmat
# define ProjectionMatrixInverse drw_view.wininv		# define ProjectionMatrixInverse drw_view.wininv
# define clipPlanes drw_view.clip_planes		# define clipPlanes drw_view.clip_planes
# define ViewVecs drw_view.viewvecs		# define ViewVecs drw_view.viewvecs
# define CameraTexCoFactors drw_view.viewcamtexcofac		# define CameraTexCoFactors drw_view.viewcamtexcofac
#endif		#endif

		/** \} */

		/* -------------------------------------------------------------------- */
		/** \name Debug draw shapes
		* \{ */

struct ObjectMatrices {		struct ObjectMatrices {
float4x4 drw_modelMatrix;		float4x4 model;
float4x4 drw_modelMatrixInverse;		float4x4 model_inverse;

		#if !defined(GPU_SHADER) && defined(__cplusplus)
		void sync(const Object &object);
		void sync(const float4x4 &model_matrix);
		#endif
		};
		BLI_STATIC_ASSERT_ALIGN(ObjectMatrices, 16)

		enum eObjectInfoFlag {
		OBJECT_SELECTED = (1u << 0u),
		OBJECT_FROM_DUPLI = (1u << 1u),
		OBJECT_FROM_SET = (1u << 2u),
		OBJECT_ACTIVE = (1u << 3u),
		OBJECT_NEGATIVE_SCALE = (1u << 4u),
		/* Avoid skipped info to change culling. */
		OBJECT_NO_INFO = ~OBJECT_NEGATIVE_SCALE
};		};
BLI_STATIC_ASSERT_ALIGN(ViewInfos, 16)

struct ObjectInfos {		struct ObjectInfos {
float4 drw_OrcoTexCoFactors[2];		#if defined(GPU_SHADER) && !defined(DRAW_FINALIZE_SHADER)
float4 drw_ObjectColor;		/* TODO Rename to struct member for glsl too. */
float4 drw_Infos;		float4 orco_mul_bias[2];
		float4 color;
		float4 infos;
		#else
		/** Uploaded as center + size. Converted to mul+bias to local coord. */
		float3 orco_add;
		float _pad0;
		float3 orco_mul;
		float _pad1;

		float4 color;
		uint index;
		uint _pad2;
		float random;
		eObjectInfoFlag flag;
		#endif

		#if !defined(GPU_SHADER) && defined(__cplusplus)
		void sync();
		void sync(const blender::draw::ObjectRef ref, bool is_active_object);
		#endif
};		};
BLI_STATIC_ASSERT_ALIGN(ViewInfos, 16)		BLI_STATIC_ASSERT_ALIGN(ObjectInfos, 16)

		struct ObjectBounds {
		/**
		* Uploaded as vertex (0, 4, 3, 1) of the bbox in local space, matching XYZ axis order.
		* Then processed by GPU and stored as (0, 4-0, 3-0, 1-0) in world space for faster culling.
		*/
		float4 bounding_corners[4];
		/** Bounding sphere derived from the bounding corner. Computed on GPU. */
		float4 bounding_sphere;
		/** Radius of the inscribed sphere derived from the bounding corner. Computed on GPU. */
		#define _inner_sphere_radius bounding_corners[3].w

		#if !defined(GPU_SHADER) && defined(__cplusplus)
		void sync();
		void sync(Object &ob);
		void sync(const float3 &center, const float3 &size);
		#endif
		};
		BLI_STATIC_ASSERT_ALIGN(ObjectBounds, 16)

		/** \} */

		/* -------------------------------------------------------------------- */
		/** \name Object attributes
		* \{ */

struct VolumeInfos {		struct VolumeInfos {
/* Object to grid-space. */		/** Object to grid-space. */
float4x4 grids_xform[DRW_GRID_PER_VOLUME_MAX];		float4x4 grids_xform[DRW_GRID_PER_VOLUME_MAX];
/* NOTE: vec4 for alignment. Only float3 needed. */		/** \note vec4 for alignment. Only float3 needed. */
float4 color_mul;		float4 color_mul;
float density_scale;		float density_scale;
float temperature_mul;		float temperature_mul;
float temperature_bias;		float temperature_bias;
float _pad;		float _pad;
};		};
BLI_STATIC_ASSERT_ALIGN(VolumeInfos, 16)		BLI_STATIC_ASSERT_ALIGN(VolumeInfos, 16)

struct CurvesInfos {		struct CurvesInfos {
/* Per attribute scope, follows loading order.		/** Per attribute scope, follows loading order.
* NOTE: uint as bool in GLSL is 4 bytes.		* \note uint as bool in GLSL is 4 bytes.
* NOTE: GLSL pad arrays of scalar to 16 bytes (std140). */		* \note GLSL pad arrays of scalar to 16 bytes (std140). */
uint4 is_point_attribute[DRW_ATTRIBUTE_PER_CURVES_MAX];		uint4 is_point_attribute[DRW_ATTRIBUTE_PER_CURVES_MAX];
};		};
BLI_STATIC_ASSERT_ALIGN(CurvesInfos, 16)		BLI_STATIC_ASSERT_ALIGN(CurvesInfos, 16)

#define OrcoTexCoFactors (drw_infos[resource_id].drw_OrcoTexCoFactors)		/** \} */
#define ObjectInfo (drw_infos[resource_id].drw_Infos)
#define ObjectColor (drw_infos[resource_id].drw_ObjectColor)

/* Indirect commands structures. */		/* -------------------------------------------------------------------- */
		/** \name Indirect commands structures.
		* \{ */

struct DrawCommand {		struct DrawCommand {
uint v_count;		/* TODO(fclem): Rename */
uint i_count;		uint vertex_len;
uint v_first;		uint instance_len;
uint i_first;		uint vertex_first;
		#if defined(GPU_SHADER)
		uint base_index;
		/** \note base_index is i_first for non-indexed draw-calls. */
		# define _instance_first_array base_index
		#else
		union {
		uint base_index;
		/* Use this instead of instance_first_indexed for non indexed draw calls. */
		uint instance_first_array;
};		};
BLI_STATIC_ASSERT_ALIGN(DrawCommand, 16)		#endif

struct DrawCommandIndexed {		uint instance_first_indexed;
uint v_count;
uint i_count;		uint _pad0, _pad1, _pad2;
uint v_first;
uint base_index;
uint i_first;
uint _pad0;
uint _pad1;
uint _pad2;
};		};
BLI_STATIC_ASSERT_ALIGN(DrawCommandIndexed, 16)		BLI_STATIC_ASSERT_ALIGN(DrawCommand, 16)

struct DispatchCommand {		struct DispatchCommand {
uint num_groups_x;		uint num_groups_x;
uint num_groups_y;		uint num_groups_y;
uint num_groups_z;		uint num_groups_z;
uint _pad0;		uint _pad0;
};		};
BLI_STATIC_ASSERT_ALIGN(DispatchCommand, 16)		BLI_STATIC_ASSERT_ALIGN(DispatchCommand, 16)

		/** \} */

/* -------------------------------------------------------------------- */		/* -------------------------------------------------------------------- */
/** \name Debug print		/** \name Debug print
* \{ */		* \{ */

/* Take the header (DrawCommand) into account. */		/* Take the header (DrawCommand) into account. */
#define DRW_DEBUG_PRINT_MAX (8 * 1024) - 4		#define DRW_DEBUG_PRINT_MAX (8 * 1024) - 4
/* NOTE: Cannot be more than 255 (because of column encoding). */		/** \note Cannot be more than 255 (because of column encoding). */
#define DRW_DEBUG_PRINT_WORD_WRAP_COLUMN 120u		#define DRW_DEBUG_PRINT_WORD_WRAP_COLUMN 120u

/* The debug print buffer is laid-out as the following struct.		/* The debug print buffer is laid-out as the following struct.
* But we use plain array in shader code instead because of driver issues. */		* But we use plain array in shader code instead because of driver issues. */
struct DRWDebugPrintBuffer {		struct DRWDebugPrintBuffer {
DrawCommand command;		DrawCommand command;
/** Each character is encoded as 3 `uchar` with char_index, row and column position. */		/** Each character is encoded as 3 `uchar` with char_index, row and column position. */
uint char_array[DRW_DEBUG_PRINT_MAX];		uint char_array[DRW_DEBUG_PRINT_MAX];
};		};
BLI_STATIC_ASSERT_ALIGN(DRWDebugPrintBuffer, 16)		BLI_STATIC_ASSERT_ALIGN(DRWDebugPrintBuffer, 16)

/* Use number of char as vertex count. Equivalent to `DRWDebugPrintBuffer.command.v_count`. */		/* Use number of char as vertex count. Equivalent to `DRWDebugPrintBuffer.command.v_count`. */
#define drw_debug_print_cursor drw_debug_print_buf[0]		#define drw_debug_print_cursor drw_debug_print_buf[0]
/* Reuse first instance as row index as we don't use instancing. Equivalent to		/* Reuse first instance as row index as we don't use instancing. Equivalent to
* `DRWDebugPrintBuffer.command.i_first`. */		* `DRWDebugPrintBuffer.command.i_first`. */
#define drw_debug_print_row_shared drw_debug_print_buf[3]		#define drw_debug_print_row_shared drw_debug_print_buf[3]
		/** Offset to the first data. Equal to: sizeof(DrawCommand) / sizeof(uint).
		* This is needed because we bind the whole buffer as a `uint` array. */
		#define drw_debug_print_offset 8

/** \} */		/** \} */

/* -------------------------------------------------------------------- */		/* -------------------------------------------------------------------- */
/** \name Debug draw shapes		/** \name Debug draw shapes
* \{ */		* \{ */

struct DRWDebugVert {		struct DRWDebugVert {
Show All 14 Lines
struct DRWDebugDrawBuffer {		struct DRWDebugDrawBuffer {
DrawCommand command;		DrawCommand command;
DRWDebugVert verts[DRW_DEBUG_DRAW_VERT_MAX];		DRWDebugVert verts[DRW_DEBUG_DRAW_VERT_MAX];
};		};
BLI_STATIC_ASSERT_ALIGN(DRWDebugPrintBuffer, 16)		BLI_STATIC_ASSERT_ALIGN(DRWDebugPrintBuffer, 16)

/* Equivalent to `DRWDebugDrawBuffer.command.v_count`. */		/* Equivalent to `DRWDebugDrawBuffer.command.v_count`. */
#define drw_debug_draw_v_count drw_debug_verts_buf[0].pos0		#define drw_debug_draw_v_count drw_debug_verts_buf[0].pos0
		/** Offset to the first data. Equal to: sizeof(DrawCommand) / sizeof(DRWDebugVert).
		* This is needed because we bind the whole buffer as a `DRWDebugVert` array. */
		#define drw_debug_draw_offset 2

/** \} */		/** \} */