Immutable view of one captured or encoded image. More...

#include <ra8_camera.h>

Data Fields
const uint8_t *	data
	Borrowed immutable image bytes.
uint32_t	bytes
	Valid bytes beginning at data.
uint32_t	stride_bytes
	Bytes between uncompressed rows.
uint16_t	width
	Image width in pixels.
uint16_t	height
	Image height in pixels.
ra8_camera_format_t	format
	Pixel or compressed-image layout.

Detailed Description

Immutable view of one captured or encoded image.

data is borrowed. For source captures it points at the supplied capture buffer. For software encoding it points at the supplied output buffer. A passthrough codec may instead alias its input.

Invariant: Width and height are non-zero for every valid frame.; JPEG frames have stride 0; uncompressed frames cover every row.

Since: 0.1.0

Definition at line 96 of file ra8_camera.h.

Field Documentation

◆ bytes

uint32_t ra8_camera_frame_t::bytes

Valid bytes beginning at data.

Definition at line 98 of file ra8_camera.h.

Referenced by c6_cam_camera_capture_jpeg(), cam_frame_is_plausible(), internal_memory_capture(), internal_memory_get_info(), ra8_camera_codec_encode_to_stream(), ra8_camera_frame_validate(), and ra8_camera_source_capture().

◆ data

const uint8_t* ra8_camera_frame_t::data

Borrowed immutable image bytes.

Definition at line 97 of file ra8_camera.h.

Referenced by c6_cam_camera_capture_jpeg(), cam_frame_is_plausible(), internal_jpeg_sw_read_rgb(), internal_memory_capture(), ra8_camera_codec_encode_to_stream(), ra8_camera_frame_validate(), and ra8_camera_source_capture().

◆ format

ra8_camera_format_t ra8_camera_frame_t::format

Pixel or compressed-image layout.

Definition at line 102 of file ra8_camera.h.

Referenced by cam_frame_is_plausible(), internal_frame_row_bytes(), internal_jpeg_sw_encode(), internal_jpeg_sw_read_rgb(), internal_memory_get_info(), internal_passthrough_encode(), and ra8_camera_frame_validate().

◆ height

uint16_t ra8_camera_frame_t::height

Image height in pixels.

Definition at line 101 of file ra8_camera.h.

Referenced by cam_frame_is_plausible(), internal_jpeg_sw_prepare_rgb(), internal_memory_get_info(), and ra8_camera_frame_validate().

◆ stride_bytes

uint32_t ra8_camera_frame_t::stride_bytes

Bytes between uncompressed rows.

Definition at line 99 of file ra8_camera.h.

Referenced by cam_frame_is_plausible(), internal_jpeg_sw_read_rgb(), internal_memory_get_info(), and ra8_camera_frame_validate().

◆ width

uint16_t ra8_camera_frame_t::width

Image width in pixels.

Definition at line 100 of file ra8_camera.h.

Referenced by cam_frame_is_plausible(), internal_frame_row_bytes(), internal_jpeg_sw_prepare_rgb(), internal_memory_get_info(), and ra8_camera_frame_validate().

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

libs/ra8_camera/inc/ra8_camera.h

Data Fields