icetImageGetColorFormat(3)

✨ NAME ✨

icetImageGetColorFormat, icetImageGetDepthFormat — bestie, these two literally just tell you the format of your image buffers 💅

(Yes it's page icetImageGetColorFormat(3) from the IceT Reference manual, and yes we're getting into it.)

---

🌸 SYNOPSIS 🌸

#include <IceT.h>

IceTEnum   icetImageGetColorFormat(   const IceTImage   image   );
IceTEnum   icetImageGetDepthFormat(   const IceTImage   image   );

---

🎀 DESCRIPTION 🎀

okay so. icetImageGetColorFormat and icetImageGetDepthFormat both hand you back an entry from an enumeration, and that entry says what data format is stored inside the image you passed in. That's it, that's the whole vibe 🦋

And like, this format thing? Not just decorative. It's the ✨main character✨ because it decides which one of icetImageGetColor or icetImageGetDepth you're supposed to use, and it also decides what the resulting data is gonna look like. So you kinda need it. no cap.

---

💖 RETURN VALUE 💖

🌈 color formats

icetImageGetColorFormat returns one of these, and here's what each one means for the format of the stored color data:

• ICET_IMAGE_COLOR_RGBA_UBYTE — every entry is an RGBA color tuple. Each component lives in the range from 0 to 255 and is stored as an 8-bit integer. Also the buffer will always be allocated on memory boundaries such that each color value can be treated as a single 32-bit integer. slay, alignment 💅
• ICET_IMAGE_COLOR_RGBA_FLOAT — every entry is an RGBA color tuple. Each component is in the range from 0.0 to 1.0 and is stored as a 32-bit float.
• ICET_IMAGE_COLOR_RGB_FLOAT — every entry is an RGB color triple. Each component is in the range from 0.0 to 1.0 and is stored as a 32-bit float. ⚠️ heads up bestie: there is no alpha channel, so the color blending composite mode will not work with this color format. it's giving incomplete, honestly 😭
• ICET_IMAGE_COLOR_NONE — no color values are stored in the image. empty. void. nothing. 💀

🦋 depth formats

icetImageGetDepthFormat returns one of these, and here's what each one means for the format of the stored depth data:

• ICET_IMAGE_DEPTH_FLOAT — every entry is in the range from 0.0 (near plane) to 1.0 (far plane) and is stored as a 32-bit float.
• ICET_IMAGE_DEPTH_NONE — no depth values are stored in the image. again: nothing 💀

---

🙈 ERRORS 🙈

None. not a single one. flawless behavior, honestly 👑

---

🫶 WARNINGS 🫶

None. we stay safe out here 🌸

---

💀 BUGS 💀

None known. iconic. no notes.

---

👑 COPYRIGHT 👑

Copyright (C)2010 Sandia Corporation

Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains certain rights in this software.

This source code is released under the New BSD License.

---

⭐ SEE ALSO ⭐

icetImageGetColor(3), icetImageGetDepth(3), icetSetColorFormat(3), icetSetDepthFormat(3)

go read those too bestie, they're the whole friend group 🫶

---

and that's the page!! from the IceT Reference manual, dated September 20, 2010 — yeah she's an older queen but she still ate 💅✨ bye bestie, go format some images 🎀