diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-09 12:01:44 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-09 12:01:44 +0300 |
commit | 9e365069afe156f33fadfad9705e1325f894cd54 (patch) | |
tree | 78373044d029feb51f987b45208e0c1a36958625 /source/blender/blenlib/BLI_uvproject.h | |
parent | d8b42751625c915113b64f5a2d9c72f19f009fee (diff) |
Cleanup: move public doc-strings into headers for 'blenlib'
- Added space below non doc-string comments to make it clear
these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
- Minor improvements to doc-strings.
Ref T92709
Diffstat (limited to 'source/blender/blenlib/BLI_uvproject.h')
-rw-r--r-- | source/blender/blenlib/BLI_uvproject.h | 24 |
1 files changed, 19 insertions, 5 deletions
diff --git a/source/blender/blenlib/BLI_uvproject.h b/source/blender/blenlib/BLI_uvproject.h index 6028d95bda0..c1cc1cdbb51 100644 --- a/source/blender/blenlib/BLI_uvproject.h +++ b/source/blender/blenlib/BLI_uvproject.h @@ -26,16 +26,26 @@ extern "C" { struct Object; struct ProjCameraInfo; -/* create uv info from the camera, needs to be freed */ +/** + * Create UV info from the camera, needs to be freed. + * + * \param rotmat: can be `obedit->obmat` when uv project is used. + * \param winx, winy: can be from `scene->r.xsch / ysch`. + */ struct ProjCameraInfo *BLI_uvproject_camera_info(struct Object *ob, float rotmat[4][4], float winx, float winy); -/* apply uv from uvinfo (camera) */ +/** + * Apply UV from uvinfo (camera). + */ void BLI_uvproject_from_camera(float target[2], float source[3], struct ProjCameraInfo *uci); -/* apply uv from perspective matrix */ +/** + * Apply uv from perspective matrix. + * \param persmat: Can be `rv3d->persmat`. + */ void BLI_uvproject_from_view(float target[2], float source[3], float persmat[4][4], @@ -43,10 +53,14 @@ void BLI_uvproject_from_view(float target[2], float winx, float winy); -/* apply ortho uv's */ +/** + * Apply orthographic UV's. + */ void BLI_uvproject_from_view_ortho(float target[2], float source[3], const float rotmat[4][4]); -/* so we can adjust scale with keeping the struct private */ +/** + * So we can adjust scale with keeping the struct private. + */ void BLI_uvproject_camera_info_scale(struct ProjCameraInfo *uci, float scale_x, float scale_y); #ifdef __cplusplus |