Image(3)

💖 Image(3) — the main character of the library, no cap 💖

Library Functions Manual · Simple Image Loading LibrarY

---

✨ NAME ✨

Image — okay bestie, this is THE main user class of the library. The whole vibe. The one you're actually here for. 👑

---

🌸 SYNOPSIS 🌸

#include <SILLYImage.h>

🎀 Public Member Functions 🎀

• size_t getHeight () const — grabs the height of the image for u 🦋
• const char * getLoaderIdentifierString () const — hands u the Image loader identifier string, iykyk
• PixelFormat getPixelFormat () const — tells u the pixel format of the resulting image ✨
• const byte * getPixelsDataPtr () const — gives u a pointer to the pixels data. the actual pixels. iconic.
• size_t getPixelsDataSize () const — the size of the pixel buffer, periodt 💅
• PixelFormat getSourcePixelFormat () const — the pixel format used for the image storage 🔥
• size_t getWidth () const — the width, obviously 💖
• Image (DataSource &data) — Constructor! hi hello welcome 🫶
• bool isValid () const — returns true if the image is valid after its loading ✅
• bool loadImageData (PixelFormat resultFormat=PF_RGBA, PixelOrigin origin=PO_TOP_LEFT) — loads the image pixels into memory and stores them in resultFormat. the big one. the main event. 💀
• bool loadImageHeader () — retrieves the info concerning the image object 👑
• ~Image () — Destructor. bye bestie 😭

---

💜 Detailed Description 💜

Image is the main user class of the library. that's it. that's the whole thing. main character energy fr fr.

Definition at line 46 of file SILLYImage.h.

---

🧚 Constructor & Destructor Documentation 🧚

🌈 Image (DataSource & data)

Constructor. it's giving "new beginnings" ✨

Parameters

• data — the raw input containing the image

Definition at line 48 of file SILLYImage.cpp.

---

⭐ Member Function Documentation ⭐

💅 bool loadImageData (PixelFormat resultFormat = PF_RGBA, PixelOrigin origin = PO_TOP_LEFT)

Load the image pixels in memory and store them in resultFormat. this is the function u call when u actually want the pixels, bestie.

Parameters

• resultFormat — the pixel format to be used for storing the result
• origin — expected origin position for the pixels

Returns

• true on success, false if an error occured 😭

Note — this function can be called several time if the pixel format are different the format is reloaded. so like, u can hit it more than once, she's flexible 🦋

Definition at line 68 of file SILLYImage.cpp.

🍓 bool loadImageHeader ()

Retrieve the information concerning the image object. the lil sneak peek before u commit to the pixels.

Returns

• true on success ✅

Definition at line 54 of file SILLYImage.cpp.

---

👑 Author 👑

Generated automatically by Doxygen for Simple Image Loading LibrarY from the source code. not me being written by a robot 💀 slay.

---

And that's the whole page, bestie!! Simple Image Loading LibrarY, Version 0.1.0 — that's the source and the version, and we're closing out on Image(3). mwah 💋 🎀🦋✨