PipeWire: spa_meta_bitmap Struct Reference

PipeWire 0.3.37

Data Fields
spa_meta_bitmap Struct Reference
SPA Buffers

Bitmap information. More...

`#include <meta.h>`

Collaboration diagram for spa_meta_bitmap:
[legend]

## Data Fields
uint32_t | format
| bitmap video format, one of enum spa_video_format. More...
struct spa_rectangle | size
| width and height of bitmap More...
int32_t | stride
| stride of bitmap data More...
uint32_t | offset
| offset of bitmap data in this structure. More...

## Detailed Description

Bitmap information.

This metadata contains a bitmap image in the given format and size. It is typically used for cursor images or other small images that are better transferred inline.

## Field Documentation

## ◆ format

uint32_t spa_meta_bitmap::format

bitmap video format, one of enum spa_video_format.

0 is and invalid format and should be handled as if there is no new bitmap information.

## ◆ offset

uint32_t spa_meta_bitmap::offset

offset of bitmap data in this structure.

An offset of 0 means no image data (invisible), an offset >= sizeof(struct spa_meta_bitmap) contains valid bitmap info.

## ◆ size

struct spa_rectangle spa_meta_bitmap::size

width and height of bitmap

## ◆ stride

int32_t spa_meta_bitmap::stride

stride of bitmap data

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

- meta.h