Skip to content

Commit eb30058

Browse files
committed
document imagedata::swizzleimage()
1 parent 8a54646 commit eb30058

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/engine/render/imagedata.h

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,17 @@ class ImageData final
7070
* for example). Intended for use on grayscale textures.
7171
*/
7272
void forcergbimage();
73+
74+
/**
75+
* @brief Creates a new image that increases the bit depth of the image.
76+
*
77+
* If there is two channels in the original image, replaces it with a four
78+
* channel image where the first channel is copied to the rgb channels, and
79+
* the second channel is copied to the a channel.
80+
*
81+
* If there is one channel in the original image, replaces it with a three
82+
* channel image where all three channels are copies of the original channel.
83+
*/
7384
void swizzleimage();
7485

7586
/**

0 commit comments

Comments
 (0)