Struct pipewire_wrapper::spa::buffers::meta::MetaBitmapRef

#[repr(transparent)]
pub struct MetaBitmapRef { /* private fields */ }

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.

Implementations

impl MetaBitmapRef

pub fn format(&self) -> VideoFormat

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

pub fn set_format(&mut self, format: VideoFormat)

pub fn size(&self) -> &RectangleRef

width and height of bitmap

pub fn size_mut(&mut self) -> &mut RectangleRef

pub fn stride(&self) -> i32

stride of bitmap data

pub fn set_stride(&mut self, stride: i32)

pub fn offset(&self) -> u32

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.

pub fn set_offset(&mut self, offset: u32)

pub unsafe fn bitmap<T: Sized>(&self) -> Option<&mut [T]>

Bitmap data with elements of type T. Returns [Some(&mut T)] or None, when bitmap data is missing.

Safety

There are no guarantees that bitmap has type T.

pub fn is_valid(&self) -> bool

Trait Implementations

impl Debug for MetaBitmapRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<MetaBitmapRef> for spa_meta_bitmap

fn from(value: MetaBitmapRef) -> Self

Converts to this type from the input type.

impl From<spa_meta_bitmap> for MetaBitmapRef

fn from(value: spa_meta_bitmap) -> Self

Converts to this type from the input type.

impl RawWrapper for MetaBitmapRef

type CType = spa_meta_bitmap

External type

fn as_raw_ptr(&self) -> *mut Self::CType

Raw ptr to the external type

fn as_raw(&self) -> &Self::CType

Wrapped external value

fn from_raw(raw: Self::CType) -> Self

Creates wrapper from the external value, can be use when external type has no raw pointers.

unsafe fn mut_from_raw_ptr<'lft>(raw: *mut Self::CType) -> &'lft mut Self

Cast external pointer to the borrowed mutable wrapper. Panic when pointer is null. Lifetime is not reliable and should be guaranteed explicitly.

unsafe fn from_raw_ptr<'a>(raw: *const Self::CType) -> &'a Self

Cast external pointer to the borrowed wrapper. Panic when pointer is null. Lifetime is not reliable and should be guaranteed explicitly.

fn as_ptr(&self) -> *mut Self

Raw mutable pointer to Self