griefith/test
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleanup: minor clarifications for View2D struct members

Browse Source 
Avoid including multiple members in one doc-string.
This commit is contained in:
Campbell Barton
2025-07-24 22:02:00 +10:00
parent 475b20fc5d
commit 21d431d214
1 changed files with 20 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
source/blender/makesdna/DNA_view2d_types.h
View File

@@ -14,27 +14,33 @@
/** View 2D data - stored per region. */
typedef struct View2D {
/** Tot - area that data can be drawn in; cur - region of tot that is visible in viewport. */
rctf tot, cur;
/** Vert - vertical scroll-bar region; hor - horizontal scroll-bar region. */
rcti vert, hor;
/** Total area that data can be drawn in. */
rctf tot;
/** Current region of tot that is visible in viewport. */
rctf cur;
/** Vertical scroll-bar region. */
rcti vert;
/** Horizontal scroll-bar region. */
rcti hor;
/**
* Mask - region (in screen-space) within which 'cur' can be viewed. Note that the coordinates
* are inclusive; to get pixel size you need to use #BLI_rcti_size + 1.
* Mask region (in screen-space) within which `cur` can be viewed.
*
* Note that the coordinates are inclusive; to get pixel size you need to use
* `BLI_rcti_size_x(mask) + 1` (same for the Y axis).
*/
rcti mask;
/** Min/max sizes of 'cur' rect (only when keepzoom not set). */
/** Min/max sizes of `cur` rect (only when keepzoom not set). */
float min[2], max[2];
/** Allowable zoom factor range (only when (keepzoom & V2D_LIMITZOOM)) is set. */
float minzoom, maxzoom;
/** Scroll - scroll-bars to display (bit-flag). */
/** Scroll-bars to display (bit-flag). */
short scroll;
/** Scroll_ui - temp settings used for UI drawing of scrollers. */
/** Temporary settings used for UI drawing of scroll-bars. */
short scroll_ui;
/** Keeptot - 'cur' rect cannot move outside the 'tot' rect? */
/** Keeptot - `cur` rect cannot move outside the `tot` rect? */
short keeptot;
/** Keepzoom - axes that zooming cannot occur on, and also clamp within zoom-limits. */
short keepzoom;
@@ -62,8 +68,10 @@ typedef struct View2D {
char alpha_vert, alpha_hor;
char _pad[2];
/** When set (not 0), determines how many pixels to scroll when scrolling an entire page.
* Otherwise the height of #View2D.mask is used. */
/**
* When set (not 0), determines how many pixels to scroll when scrolling an entire page.
* Otherwise the height of #View2D.mask is used.
*/
float page_size_y;
/* animated smooth view */