mxvk_png.hpp

Go to the documentation of this file.

/**
 * @file mxvk_png.hpp
 * @brief PNG image loading and saving utilities via SDL3.
 */
#pragma once
 
#include <SDL3/SDL.h>
#include <cstddef>
 
/** @namespace mxvk
 *  @brief Utilities for loading and saving PNG images. */
namespace mxvk {
 
    /**
     * @brief Load a PNG file into an SDL_Surface.
     * @param file Path to the PNG file.
     * @return Newly allocated SDL_Surface, or nullptr on failure.
     */
    SDL_Surface *LoadPNG(const char *file);
 
    /**
     * @brief Save an SDL_Texture to a PNG file.
     * @param texture  Source texture.
     * @param renderer Renderer used to read back the texture pixels.
     * @param filename Destination file path.
     * @param compression_level PNG compression level passed to libpng; 0 favors
     *                          speed and 9 favors smaller files. Defaults to 6.
     * @return @c true on success, @c false on failure.
     */
    bool SavePNG(SDL_Texture *texture, SDL_Renderer *renderer, const char *filename, int compression_level = 6);
 
    /**
     * @brief Save raw data to a file.
     * @param filename Output file path
     * @param buffer   Pointer to the source data (read-only)
     * @param w        Width of the image in pixels
     * @param h        Height of the image in pixels
     * @param bpp      Bytes per pixel (e.g., 2 for YUYV, 4 for RGBA)
     * @return @c true on success, @c false on failure.
     */
    bool SaveRawBytes(const char *filename, const void *buffer, size_t w, size_t h, size_t bpp);
    /**
     * @brief Save a raw RGBA pixel buffer to a PNG file.
     * @param filename Destination file path.
     * @param buffer   Pointer to the raw RGBA pixel data.
     * @param w        Image width in pixels.
     * @param h        Image height in pixels.
     * @param compression_level PNG compression level passed to libpng; 0 favors
     *                          speed and 9 favors smaller files. Defaults to 6.
     * @return @c true on success, @c false on failure.
     */
    bool SavePNG_RGBA(const char *filename, void *buffer, int w, int h, int compression_level = 6);
 
    /**
     * @brief Save a raw 16-bit RGBA pixel buffer to a PNG file.
     * @param filename Destination file path.
     * @param buffer   Pointer to the raw 16-bit RGBA pixel data.
     * @param w        Image width in pixels.
     * @param h        Image height in pixels.
     * @param compression_level PNG compression level passed to libpng; 0 favors
     *                          speed and 9 favors smaller files. Defaults to 6.
     * @return @c true on success, @c false on failure.
     */
    bool SavePNG_RGBA16(const char *filename, const void *buffer, int w, int h, int compression_level = 6);
} // namespace mxvk