Docs: note that "Effect" and related types are deprecated

Also use comments to identify "Effect" members which must be used
by all structs.
This commit is contained in:
Campbell Barton
2023-03-02 14:55:29 +11:00
parent 93508ab2df
commit ae086deaa5

View File

@@ -3,6 +3,8 @@
/** \file
* \ingroup DNA
*
* Types defined in this file are deprecated, converted into modifiers on load.
*/
#pragma once
@@ -57,12 +59,14 @@ typedef struct Effect {
struct Effect *next, *prev;
short type, flag, buttype;
char _pad0[2];
} Effect;
typedef struct BuildEff {
/* NOTE: match #Effect. */
struct BuildEff *next, *prev;
short type, flag, buttype;
/* End header. */
char _pad0[2];
float len, sfra;
@@ -81,8 +85,12 @@ typedef struct Particle {
struct Collection;
typedef struct PartEff {
/* NOTE: match #Effect. */
struct PartEff *next, *prev;
short type, flag, buttype, stype, vertgroup, userjit;
short type, flag, buttype;
/* End header. */
short stype, vertgroup, userjit;
float sta, end, lifetime;
int totpart, totkey, seed;
@@ -111,8 +119,10 @@ typedef struct PartEff {
} PartEff;
typedef struct WaveEff {
/* NOTE: match #Effect. */
struct WaveEff *next, *prev;
short type, flag, buttype, stype;
/* End header. */
float startx, starty, height, width;
float narrow, speed, minfac, damp;