NDEVR
API Documentation
Image

A root class that stores an an array of pixel data that can be displayed as an Image. More...

Inheritance diagram for Image:
[legend]

Public Member Functions

virtual ~Image ()
 Virtual destructor for proper cleanup of derived Image classes.
virtual uint04 pixelSize () const
 Returns the number of bytes per pixel in this image.
virtual uint01 * scanLine (uint04 row)
 Returns a pointer to the raw pixel data for a given scanline (row).
virtual Vector< 2, uint04 > size () const
 Returns the dimensions of the image as a 2D vector (width, height).

Detailed Description

A root class that stores an an array of pixel data that can be displayed as an Image.

Definition at line 39 of file Image.h.

Member Function Documentation

◆ pixelSize()

virtual uint04 Image::pixelSize ( ) const
inlinevirtual

Returns the number of bytes per pixel in this image.

Returns
The pixel size in bytes. Default is 4 (e.g., RGBA).

Definition at line 50 of file Image.h.

◆ scanLine()

virtual uint01 * Image::scanLine ( uint04 row)
inlinevirtual

Returns a pointer to the raw pixel data for a given scanline (row).

Parameters
[in]rowThe zero-based row index of the scanline to retrieve.
Returns
A pointer to the first byte of pixel data for the requested row, or nullptr if not supported.

Reimplemented in QCustomImage.

Definition at line 47 of file Image.h.

◆ size()

virtual Vector< 2, uint04 > Image::size ( ) const
inlinevirtual

Returns the dimensions of the image as a 2D vector (width, height).

Returns
A Vector containing the width and height in pixels, or an invalid vector if not available.

Reimplemented in QCustomImage, and VulkanImageData.

Definition at line 53 of file Image.h.

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