Struct MtmdBitmap 

pub struct MtmdBitmap {
    pub bitmap: NonNull<mtmd_bitmap>,
}

Safe wrapper around mtmd_bitmap.

Represents bitmap data for images or audio that can be processed by the multimodal system. For images, data is stored in RGB format. For audio, data is stored as PCM F32 samples.

Fields

bitmap: NonNull<mtmd_bitmap>

Raw pointer to the underlying mtmd_bitmap.

Implementations

impl MtmdBitmap

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

Create a bitmap from image data in RGB format.

Errors

• InvalidDataSize - Data length doesn’t match nx * ny * 3
• NullResult - Underlying C function returned null

Examples

use llama_cpp_bindings::mtmd::MtmdBitmap;

// Create a 2x2 red image
let red_pixel = [255, 0, 0]; // RGB values for red
let image_data = red_pixel.repeat(4); // 2x2 = 4 pixels

let bitmap = MtmdBitmap::from_image_data(2, 2, &image_data);
assert!(bitmap.is_ok());

pub fn from_audio_data(data: &[f32]) -> Result<Self, MtmdBitmapError>

Create a bitmap from audio data in PCM F32 format.

Errors

• NullResult - Underlying C function returned null

Examples

use llama_cpp_bindings::mtmd::MtmdBitmap;

// Create a simple sine wave audio sample
let audio_data: Vec<f32> = (0..100)
    .map(|sample_index| (sample_index as f32 * 0.1).sin())
    .collect();

let bitmap = MtmdBitmap::from_audio_data(&audio_data);
// Note: This will likely fail without proper MTMD context setup

pub fn from_file(ctx: &MtmdContext, path: &str) -> Result<Self, MtmdBitmapError>

Create a bitmap from a file.

Supported formats:

• Images: formats supported by stb_image (jpg, png, bmp, gif, etc.)
• Audio: formats supported by miniaudio (wav, mp3, flac)

Errors

Returns an MtmdBitmapError variant matching the wrapper’s status code.

pub fn from_buffer( ctx: &MtmdContext, data: &[u8], ) -> Result<Self, MtmdBitmapError>

Create a bitmap from a buffer containing file data.

Supported formats:

• Images: formats supported by stb_image (jpg, png, bmp, gif, etc.)
• Audio: formats supported by miniaudio (wav, mp3, flac)

Errors

• NullResult - Buffer could not be processed

pub fn nx(&self) -> u32

Get bitmap width in pixels.

pub fn ny(&self) -> u32

Get bitmap height in pixels.

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

Get bitmap data as a byte slice.

For images: RGB format with length nx * ny * 3 For audio: PCM F32 format with length n_samples * 4

pub fn is_audio(&self) -> bool

Check if this bitmap contains audio data (vs image data).

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

Get the bitmap’s optional ID string.

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

Set the bitmap’s ID string.

Errors

Returns an error if the ID string contains null bytes.

Examples

bitmap.set_id("image_001")?;
assert_eq!(bitmap.id(), Some("image_001".to_string()));

Trait Implementations

impl Clone for MtmdBitmap

fn clone(&self) -> MtmdBitmap

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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