Topaz/image_8hpp_source.html

#ifndef TOPAZ_IO_IMAGE_HPP

#define TOPAZ_IO_IMAGE_HPP

#include "tz/core/error.hpp"

#include <cstddef>

#include <span>

#include <expected>


namespace tz::io

{


    struct image_header

    {

        unsigned int width = 0u;

        unsigned int height = 0u;

        std::size_t data_size_bytes = 0u;

    };


    std::expected<image_header, tz::error_code> image_info(std::span<const std::byte> img_file_data);

    tz::error_code parse_image(std::span<const std::byte> img_file_data, std::span<std::byte> buffer);

}


#endif // TOPAZ_IO_IMAGE_HPP

tz::error_code
error_code
Error codes for Topaz.
Definition error.hpp:14

tz::io::image_info
std::expected< image_header, tz::error_code > image_info(std::span< const std::byte > img_file_data)
Retrieve info about an image loaded in memory.

tz::io::parse_image
tz::error_code parse_image(std::span< const std::byte > img_file_data, std::span< std::byte > buffer)
Load an image from file data resident in memory.

tz::io::image_header
Describes basic information about an image.
Definition image.hpp:17

tz::io::image_header::data_size_bytes
std::size_t data_size_bytes
Size of the total image data, in bytes.
Definition image.hpp:23

tz::io::image_header::height
unsigned int height
Height of the image, in pixels.
Definition image.hpp:21

tz::io::image_header::width
unsigned int width
Width of the image, in pixels.
Definition image.hpp:19