Struct MtmdBitmap 

pub struct MtmdBitmap { /* private fields */ }

An image or audio bitmap ready for multimodal encoding.

Image bitmaps

The raw pixel data must be in RGBRGBRGB… (interleaved) format. The total number of bytes must be nx * ny * 3.

Audio bitmaps

The raw sample data must be little-endian f32 PCM samples. The total number of bytes must be n_samples * 4.

Implementations

impl MtmdBitmap

pub fn from_rgb(nx: u32, ny: u32, data: &[u8]) -> Result<Self>

Create a bitmap from raw RGB pixel data.

• nx – image width in pixels
• ny – image height in pixels
• data – raw pixel bytes in RGBRGB… format; must be nx * ny * 3 bytes

Errors

Returns MtmdError::BitmapCreateFailed if the underlying C call returns null.

pub fn from_audio(samples: &[f32]) -> Result<Self>

Create an audio bitmap from PCM f32 samples.

• samples – slice of PCM float samples

Errors

Returns MtmdError::BitmapCreateFailed if the underlying C call returns null.

pub fn from_file(ctx: &MtmdContext, path: impl AsRef<Path>) -> Result<Self>

Load a bitmap from a file (image or audio).

Supported image formats: JPEG, PNG, BMP, GIF, and others handled by stb_image. Supported audio formats: WAV, MP3, FLAC (via miniaudio).

Errors

Returns MtmdError::BitmapCreateFailed if the file cannot be loaded.

pub fn from_buf(ctx: &MtmdContext, buf: &[u8]) -> Result<Self>

Load a bitmap from an in-memory buffer containing a file.

The format is auto-detected (image vs audio via magic bytes).

Errors

Returns MtmdError::BitmapCreateFailed if decoding fails.

pub fn set_mergeable(&mut self, mergeable: bool)

Mark this bitmap as mergeable with an adjacent mergeable bitmap.

Video-capable models such as Qwen-VL merge consecutive frames into one chunk (a temporal merge). MtmdVideo::read_next already sets this on the frames it produces; you only need it when you build frames yourself with Self::from_rgb and expect them to merge. Without it each frame becomes its own chunk, which costs tokens and loses temporal structure.

Wraps mtmd_bitmap_set_mergeable.

pub fn nx(&self) -> u32

Width in pixels (for images) or 0 (for audio).

pub fn ny(&self) -> u32

Height in pixels (for images) or 0 (for audio).

pub fn n_bytes(&self) -> usize

Total number of bytes in the bitmap data.

pub fn is_audio(&self) -> bool

Returns true if this bitmap contains audio (rather than image) data.

pub fn data(&self) -> &[u8]

Return the raw pixel / sample data.

pub fn id(&self) -> Option<&str>

Return the optional ID string attached to this bitmap (used for KV cache tracking), or None if no ID has been set.

pub fn set_id(&mut self, id: &str) -> Result<(), NulError>

Attach an optional ID string to this bitmap (used for KV cache tracking).

Errors

Returns an error if id contains an interior NUL byte.

Trait Implementations

impl Debug for MtmdBitmap

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

Formats the value using the given formatter.

impl Drop for MtmdBitmap

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for MtmdBitmap

impl Sync for MtmdBitmap