Zephyr API Documentation 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
video_format Struct Reference

Video format structure. More...

#include <zephyr/drivers/video.h>

Data Fields

enum video_buf_type type
 type of the buffer
uint32_t pixelformat
 FourCC pixel format value (Video pixel formats)
uint32_t width
 frame width in pixels.
uint32_t height
 frame height in pixels.
uint32_t pitch
 line stride.
uint32_t size
 size of the buffer in bytes, need to be set by the drivers

Detailed Description

Video format structure.

Used to configure frame format.

Field Documentation

◆ height

uint32_t video_format::height

frame height in pixels.

◆ pitch

uint32_t video_format::pitch

line stride.

This is the number of bytes that needs to be added to the address in the first pixel of a row in order to go to the address of the first pixel of the next row (>=width).

◆ pixelformat

uint32_t video_format::pixelformat

FourCC pixel format value (Video pixel formats)

◆ size

uint32_t video_format::size

size of the buffer in bytes, need to be set by the drivers

For uncompressed formats, this is the size of the raw data buffer in bytes, which could be the whole raw image or a portion of the raw image in cases the receiver / dma supports it.

For compressed formats, this is the maximum number of bytes required to hold a complete compressed frame, estimated for the worst case.

◆ type

enum video_buf_type video_format::type

type of the buffer

◆ width

uint32_t video_format::width

frame width in pixels.


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