diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-10-27 05:59:43 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-10-27 07:55:36 +0300 |
commit | 0d155f274ff2ca2dcf52745e32f17c05a9d1c890 (patch) | |
tree | ee9c9424475e4dfa9ee3e46182958b4684957f78 /source/blender/makesdna | |
parent | a3b785bc083f3d83198c402e00da9d610389ca98 (diff) |
Docs: add docstring for wmWindowManger.winactive
Also justify rounding up font width.
Diffstat (limited to 'source/blender/makesdna')
-rw-r--r-- | source/blender/makesdna/DNA_windowmanager_types.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/source/blender/makesdna/DNA_windowmanager_types.h b/source/blender/makesdna/DNA_windowmanager_types.h index e24d39b61eb..841edaf8724 100644 --- a/source/blender/makesdna/DNA_windowmanager_types.h +++ b/source/blender/makesdna/DNA_windowmanager_types.h @@ -138,7 +138,14 @@ typedef struct wmWindowManager { ID id; /** Separate active from drawable. */ - struct wmWindow *windrawable, *winactive; + struct wmWindow *windrawable; + /** + * \note `CTX_wm_window(C)` is usually preferred. + * Avoid relying on this where possible as this may become NULL during when handling + * events that close or replace windows (opening a file for e.g.). + * While this happens rarely in practice, it can cause difficult to reproduce bugs. + */ + struct wmWindow *winactive; ListBase windows; /** Set on file read. */ |