ufo::ImageProperties Struct Reference

Metadata describing the pixel layout of an image file. More...

#include <lib/io/include/ufo/io/image_properties.hpp>

Public Attributes
bool	alpha
	true if the image contains an alpha (transparency) channel.
std::uint32_t	bit_depth
	Bits per channel sample (e.g., 8 for uint8, 16 for uint16).
bool	grayscale
	true if the image is single-channel grayscale (no RGB colour data).
std::uint32_t	height
	Pixel height (number of rows) of the image.
std::uint32_t	width
	Pixel width (number of columns) of the image.

Detailed Description

Metadata describing the pixel layout of an image file.

ImageProperties is returned by image I/O routines to convey the dimensions and channel configuration of the decoded image, letting callers allocate an appropriately sized Image<T> before reading pixel data.

Fields

Field	Description
width	Pixel width of the image (number of columns).
height	Pixel height of the image (number of rows).
bit_depth	Bits per channel sample (e.g., 8 for standard sRGB, 16 for HDR).
alpha	true if the image has a dedicated alpha (transparency) channel.
grayscale	true if the image is single-channel (luminance only, no colour).

Definition at line 66 of file image_properties.hpp.

Member Data Documentation

alpha

bool ufo::ImageProperties::alpha

true if the image contains an alpha (transparency) channel.

Definition at line 74 of file image_properties.hpp.

bit_depth

std::uint32_t ufo::ImageProperties::bit_depth

Bits per channel sample (e.g., 8 for uint8, 16 for uint16).

Definition at line 72 of file image_properties.hpp.

grayscale

bool ufo::ImageProperties::grayscale

true if the image is single-channel grayscale (no RGB colour data).

Definition at line 76 of file image_properties.hpp.

height

std::uint32_t ufo::ImageProperties::height

Pixel height (number of rows) of the image.

Definition at line 70 of file image_properties.hpp.

width

std::uint32_t ufo::ImageProperties::width

Pixel width (number of columns) of the image.

Definition at line 68 of file image_properties.hpp.

---

The documentation for this struct was generated from the following file:

• lib/io/include/ufo/io/image_properties.hpp