IMG_ReadXPMFromArray

sdl3_image_sys::image

Function IMG_ReadXPMFromArray 

Source 
pub unsafe extern "C" fn IMG_ReadXPMFromArray(
    xpm: *mut *mut c_char,
) -> *mut SDL_Surface
Expand description

Load an XPM image from a memory array.

The returned surface will be an 8bpp indexed surface, if possible, otherwise it will be 32bpp. If you always want 32-bit data, use IMG_ReadXPMFromArrayToRGB888() instead.

When done with the returned surface, the app should dispose of it with a call to SDL_DestroySurface().

§Parameters

  • xpm: a null-terminated array of strings that comprise XPM data.

§Return value

Returns a new SDL surface, or NULL on error.

§Availability

This function is available since SDL_image 3.0.0.

§See also