PNGImageLoader(3)

📦
version 0.1.0 · 2 versions
, in fedora 43

💖 PNGImageLoader(3) — like, the manual page bestie 💖

Library Functions Manual · PNGImageLoader(3)

okay so bestie, gather round, because we're about to talk about PNGImageLoader from the Simple Image Loading LibrarY — yes it's a manual page for the C++ class, yes it's giving very much "library functions manual", and yes I'm gonna explain every single bit of it to you. no skipping. we don't skip here. 💅

✨ NAME ✨

PNGImageLoader — the Loader for PNG Image. that's it, that's the whole vibe. it loads PNGs. iconic behavior honestly. 🦋

🌸 SYNOPSIS 🌸

#include <SILLYPNGImageLoader.h>

Inherits ImageLoader.

🎀 Public Member Functions 🎀

  • void destroyContext(ImageContext *context) — Destroy the image context. 💀
  • const char * getIdentifierString() const — Return the name of the loader.
  • ImageContext * loadHeader(PixelFormat &formatSource, DataSource *data) — Parse the header of the image and fill the header struct.
  • bool loadImageData(PixelOrigin origin, DataSource *data, ImageContext *context) — Parse the pixels data of the image and fill the header struct.

🌈 Detailed Description 🌈

Loader for PNG Image. that's the whole deal, bestie — this class is the thing that knows how to take a PNG and turn it into pixels you can actually use. 🫶

Definition at line 42 of file SILLYPNGImageLoader.h. (yes, they really do tell you exactly where to find it, we love transparency ✨)

💜 Constructor & Destructor Documentation 💜

🧚 PNGImageLoader()

the constructor. it exists. it makes a PNGImageLoader. lowkey the most normal thing about this whole page. 😭

Definition at line 71 of file SILLYPNGImageLoader.cpp.

🧚 ~PNGImageLoader()

the destructor. it cleans up after you, like the true main character it is. 👑

Definition at line 75 of file SILLYPNGImageLoader.cpp.

🦋 Member Function Documentation 🦋

💅 void destroyContext(ImageContext *context) [inherited]

Destroy the image context. girl, we're tearing it down, no survivors, periodt. 🔥

Parameters

  • context — a pointer to the context
Definition at line 47 of file SILLYImageLoader.cpp.

💅 ImageContext * loadHeader(PixelFormat &formatSource, DataSource *data) [virtual]

Parse the header of the image and fill the header struct. this is the "okay bestie, let's peek at what this file actually is" step. 👀

Parameters

  • formatSource — this var should contains the pixel format used to store the image initialy (their spelling, not mine, and we respect the original fr fr 💖)
  • data — the input of the image data

Returns

Context for the rest of the parsing or 0 if an error occured. so like, if it's a 0, that's a red flag, wrap it up. 🚩

Implements ImageLoader.

Definition at line 80 of file SILLYPNGImageLoader.cpp.

💅 bool loadImageData(PixelOrigin origin, DataSource *data, ImageContext *context) [virtual]

Parse the pixels data of the image and fill the header struct. this is the part where the actual pixel vibes get read in. the main event. the moment. ✨

Parameters

  • origin — the layout of the pixel in the resulting pixel array
  • data — the input of the image data
  • context — the data associated to the image parsing

Returns

true on success false on error. binary queen — either it ate or it flopped, no in-between. 💅

Implements ImageLoader.

Definition at line 146 of file SILLYPNGImageLoader.cpp.

👑 Author 👑

Generated automatically by Doxygen for Simple Image Loading LibrarY from the source code. so nobody hand-wrote this, a robot did, and honestly? the robot ate. 🤖💖

and that's the whole page bestie, every single flag, param, return value and file path accounted for, no cap. 🎀

Sign-off szn: this lil masterpiece comes to you from the Simple Image Loading LibrarY, Version 0.1.0, and it's the PNGImageLoader(3) page. go forth and load those PNGs, you absolute icon. 🦋✨💜

📦 where this page comes from