[Bf-blender-cvs] [36ca1312c4b] master: Cleanup: use doxy sections and comments in DNA_scene_types.h
Campbell Barton
noreply at git.blender.org
Thu Dec 15 00:34:58 CET 2022
Commit: 36ca1312c4b2c9cd860f167e3e2fbd12337e9718
Author: Campbell Barton
Date: Thu Dec 15 10:31:18 2022 +1100
Branches: master
https://developer.blender.org/rB36ca1312c4b2c9cd860f167e3e2fbd12337e9718
Cleanup: use doxy sections and comments in DNA_scene_types.h
===================================================================
M source/blender/makesdna/DNA_scene_types.h
===================================================================
diff --git a/source/blender/makesdna/DNA_scene_types.h b/source/blender/makesdna/DNA_scene_types.h
index 8832e044f5e..5f68b2d0c78 100644
--- a/source/blender/makesdna/DNA_scene_types.h
+++ b/source/blender/makesdna/DNA_scene_types.h
@@ -47,11 +47,9 @@ struct World;
struct bGPdata;
struct bNodeTree;
-/* ************************************************************* */
-/* Scene Data */
-
-/* ************************************************************* */
-/* Output Format Data */
+/* -------------------------------------------------------------------- */
+/** \name FFMPEG
+ * \{ */
typedef struct AviCodecData {
/** Save format. */
@@ -100,17 +98,18 @@ typedef enum eFFMpegPreset {
/* Used by WEBM/VP9 and h.264 to control encoding speed vs. file size.
* WEBM/VP9 use these values directly, whereas h.264 map those to
- * respectively the MEDIUM, SLOWER, and SUPERFAST presets.
- */
- /** the default and recommended for most applications */
+ * respectively the MEDIUM, SLOWER, and SUPERFAST presets. */
+
+ /** The default and recommended for most applications. */
FFM_PRESET_GOOD = 10,
- /** recommended if you have lots of time and want the best compression efficiency */
+ /** Recommended if you have lots of time and want the best compression efficiency. */
FFM_PRESET_BEST = 11,
- /** recommended for live / fast encoding */
+ /** Recommended for live / fast encoding. */
FFM_PRESET_REALTIME = 12,
} eFFMpegPreset;
-/* Mapping from easily-understandable descriptions to CRF values.
+/**
+ * Mapping from easily-understandable descriptions to CRF values.
* Assumes we output 8-bit video. Needs to be remapped if 10-bit
* is output.
* We use a slightly wider than "subjectively sane range" according
@@ -160,12 +159,15 @@ typedef struct FFMpegCodecData {
void *_pad1;
} FFMpegCodecData;
-/* ************************************************************* */
-/* Audio */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Audio
+ * \{ */
typedef struct AudioData {
- int mixrate; /* 2.5: now in FFMpegCodecData: audio_mixrate */
- float main; /* 2.5: now in FFMpegCodecData: audio_volume */
+ int mixrate; /* 2.5: now in FFMpegCodecData: audio_mixrate. */
+ float main; /* 2.5: now in FFMpegCodecData: audio_volume. */
float speed_of_sound;
float doppler_factor;
int distance_model;
@@ -175,8 +177,9 @@ typedef struct AudioData {
char _pad2[4];
} AudioData;
-/* *************************************************************** */
-/* Render Layers */
+/* -------------------------------------------------------------------- */
+/** \name Render Layers
+ * \{ */
/** Render Layer. */
typedef struct SceneRenderLayer {
@@ -196,7 +199,7 @@ typedef struct SceneRenderLayer {
/** Converted to ViewLayer layflag and flag. */
int layflag DNA_DEPRECATED;
- /* pass_xor has to be after passflag */
+ /* Pass_xor has to be after passflag. */
/** Pass_xor has to be after passflag. */
int passflag DNA_DEPRECATED;
/** Converted to ViewLayer passflag and flag. */
@@ -227,6 +230,7 @@ typedef struct SceneRenderLayer {
#define SCE_LAY_MOTION_BLUR (1 << 9)
/* Flags between (1 << 9) and (1 << 15) are set to 1 already, for future options. */
+
#define SCE_LAY_FLAG_DEFAULT ((1 << 15) - 1)
#define SCE_LAY_UNUSED_4 (1 << 15)
@@ -310,7 +314,13 @@ typedef enum eScenePassType {
#define RE_PASSNAME_CRYPTOMATTE_ASSET "CryptoAsset"
#define RE_PASSNAME_CRYPTOMATTE_MATERIAL "CryptoMaterial"
-/** View - MultiView. */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Multi-View
+ * \{ */
+
+/** View (Multi-view). */
typedef struct SceneRenderView {
struct SceneRenderView *next, *prev;
@@ -333,7 +343,7 @@ enum {
SCE_VIEWS_FORMAT_MULTIVIEW = 1,
};
-/** #ImageFormatData.views_format (also used for #Sequence.views_format) */
+/** #ImageFormatData.views_format (also used for #Sequence.views_format). */
enum {
R_IMF_VIEWS_INDIVIDUAL = 0,
R_IMF_VIEWS_STEREO_3D = 1,
@@ -381,10 +391,15 @@ typedef enum eStereo3dInterlaceType {
S3D_INTERLACE_CHECKERBOARD = 2,
} eStereo3dInterlaceType;
-/* *************************************************************** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Image Format Data
+ * \{ */
-/* Generic image format settings,
- * this is used for NodeImageFile and IMAGE_OT_save_as operator too.
+/**
+ * Generic image format settings,
+ * this is used for #NodeImageFile and IMAGE_OT_save_as operator too.
*
* NOTE: its a bit strange that even though this is an image format struct
* the imtype can still be used to select video formats.
@@ -413,28 +428,29 @@ typedef struct ImageFormatData {
/* --- format specific --- */
- /* OpenEXR */
+ /** OpenEXR. */
char exr_codec;
- /* Cineon */
+ /** Cineon. */
char cineon_flag;
short cineon_white, cineon_black;
float cineon_gamma;
- /* Jpeg2000 */
+ /** Jpeg2000. */
char jp2_flag;
char jp2_codec;
- /* TIFF */
+ /** TIFF. */
char tiff_codec;
char _pad[4];
- /* Multiview */
+ /** Multi-view. */
char views_format;
Stereo3dFormat stereo3d_format;
- /* color management */
+ /* Color management members. */
+
char color_management;
char _pad1[7];
ColorManagedViewSettings view_settings;
@@ -480,22 +496,27 @@ typedef struct ImageFormatData {
#define R_IMF_FLAG_ZBUF (1 << 0)
#define R_IMF_FLAG_PREVIEW_JPG (1 << 1)
-/* Return values from #BKE_imtype_valid_depths, note this is depths per channel. */
-/** #ImageFormatData.depth */
+/* */
+
+/**
+ * #ImageFormatData.depth
+ *
+ * Return values from #BKE_imtype_valid_depths, note this is depths per channel.
+ */
typedef enum eImageFormatDepth {
- /* 1bits (unused) */
+ /** 1bits (unused). */
R_IMF_CHAN_DEPTH_1 = (1 << 0),
- /* 8bits (default) */
+ /** 8bits (default). */
R_IMF_CHAN_DEPTH_8 = (1 << 1),
- /* 10bits (uncommon, Cineon/DPX support) */
+ /** 10bits (uncommon, Cineon/DPX support). */
R_IMF_CHAN_DEPTH_10 = (1 << 2),
- /* 12bits (uncommon, jp2/DPX support) */
+ /** 12bits (uncommon, jp2/DPX support). */
R_IMF_CHAN_DEPTH_12 = (1 << 3),
- /* 16bits (tiff, half float exr) */
+ /** 16bits (TIFF, half float EXR). */
R_IMF_CHAN_DEPTH_16 = (1 << 4),
- /* 24bits (unused) */
+ /** 24bits (unused). */
R_IMF_CHAN_DEPTH_24 = (1 << 5),
- /* 32bits (full float exr) */
+ /** 32bits (full float EXR). */
R_IMF_CHAN_DEPTH_32 = (1 << 6),
} eImageFormatDepth;
@@ -518,16 +539,16 @@ typedef enum eImageFormatDepth {
#define R_IMF_EXR_CODEC_MAX 10
/** #ImageFormatData.jp2_flag */
-#define R_IMF_JP2_FLAG_YCC (1 << 0) /* when disabled use RGB */ /* was R_JPEG2K_YCC */
-#define R_IMF_JP2_FLAG_CINE_PRESET (1 << 1) /* was R_JPEG2K_CINE_PRESET */
-#define R_IMF_JP2_FLAG_CINE_48 (1 << 2) /* was R_JPEG2K_CINE_48FPS */
+#define R_IMF_JP2_FLAG_YCC (1 << 0) /* When disabled use RGB. */ /* Was `R_JPEG2K_YCC`. */
+#define R_IMF_JP2_FLAG_CINE_PRESET (1 << 1) /* Was `R_JPEG2K_CINE_PRESET`. */
+#define R_IMF_JP2_FLAG_CINE_48 (1 << 2) /* Was `R_JPEG2K_CINE_48FPS`. */
/** #ImageFormatData.jp2_codec */
#define R_IMF_JP2_CODEC_JP2 0
#define R_IMF_JP2_CODEC_J2K 1
/** #ImageFormatData.cineon_flag */
-#define R_IMF_CINEON_FLAG_LOG (1 << 0) /* was R_CINEON_LOG */
+#define R_IMF_CINEON_FLAG_LOG (1 << 0) /* Was `R_CINEON_LOG`. */
/** #ImageFormatData.tiff_codec */
enum {
@@ -537,6 +558,12 @@ enum {
R_IMF_TIFF_CODEC_NONE = 3,
};
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Render Bake
+ * \{ */
+
/** #ImageFormatData.color_management */
#define R_IMF_COLOR_MANAGEMENT_FOLLOW_SCENE 0
#define R_IMF_COLOR_MANAGEMENT_OVERRIDE 1
@@ -566,13 +593,13 @@ typedef struct BakeData {
struct Object *cage_object;
} BakeData;
-/** #BakeData.margin_type (char) */
+/** #BakeData.margin_type (char). */
typedef enum eBakeMarginType {
R_BAKE_ADJACENT_FACES = 0,
R_BAKE_EXTEND = 1,
} eBakeMarginType;
-/** #BakeData.normal_swizzle (char) */
+/** #BakeData.normal_swizzle (char). */
typedef enum eBakeNormalSwizzle {
R_BAKE_POSX = 0,
R_BAKE_POSY = 1,
@@ -582,19 +609,19 @@ typedef enum eBakeNormalSwizzle {
R_BAKE_NEGZ = 5,
} eBakeNormalSwizzle;
-/** #BakeData.target (char) */
+/** #BakeData.target (char). */
typedef enum eBakeTarget {
R_BAKE_TARGET_IMAGE_TEXTURES = 0,
R_BAKE_TARGET_VERTEX_COLORS = 1,
} eBakeTarget;
-/** #BakeData.save_mode (char) */
+/** #BakeData.save_mode (char). */
typedef enum eBakeSaveMode {
R_BAKE_SAVE_INTERNAL = 0,
R_BAKE_SAVE_EXTERNAL = 1,
} eBakeSaveMode;
-/** #BakeData.view_from (char) */
+/** #BakeData.view_from (char). */
typedef enum eBakeViewFrom {
R_BAKE_VIEW_FROM_ABOVE_SURFACE = 0,
R_BAKE_VIEW_FROM_ACTIVE_CAMERA = 1,
@@ -616,8 +643,11 @@ typedef enum eBakePassFilter {
#define R_BAKE_PASS_FILTER_ALL (~0)
-/* *************************************************************** */
-/* Render Data */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Render Data
+ * \{ */
typedef struct RenderData {
struct ImageFormatData im_format;
@@ -640,7 +670,7 @@ typedef struct RenderData {
/** Frames to jump during render/playback. */
int frame_step;
- /** Standalone player stereo settings */ /* XXX deprecated since .2.5 */
+ /** Standalone player stereo settings. */ /* XXX deprecated since .2.5 */
short stereomode DNA_DEPRECATED;
/** For the dimensions presets menu. */
@@ -651,7 +681,7 @@ typedef struct RenderData {
char _pad6[2];
- /* from buttons: */
+ /* From buttons: */
/**
* The desired number of pixels in the x direction
*/
@@ -698,7 +728,7 @@ typedef struct RenderData {
/** Render border to render sub-resions. */
rctf border;
- /* information on different layers to be rendered */
+ /* Information on different layers to be rendered. */
/** Converted to Scene->view_layers. */
ListBase layers DNA_DEPRECATED;
/** Converted to Scen
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list