Tao.Sdl SDK Documentation

SdlImage.IMG_isXPM Method 

Test for valid, supported XPM file.

[Visual Basic]
Public Shared Function IMG_isXPM( _
   ByVal src As IntPtr _
) As IntPtr
[C#]
public static IntPtr IMG_isXPM(
   IntPtr src
);

Parameters

src

Return Value

1 if the image is a XPM and the XPM format support is compiled into SDL_image. 0 is returned otherwise.

Remarks

If the XPM format is supported, then the image data is tested to see if it is readable as a XPM, otherwise it returns false (Zero).

Binds to C-function in SDL_image.h

            int IMG_isXPM(SDL_RWops *src)
            

Example

            // Test sample.xpm to see if it is a XPM
                    SDL_RWops *rwop;
                    rwop=SDL_RWFromFile("sample.xpm", "rb");
                    if(IMG_isXPM(rwop))
                    printf("sample.xpm is a XPM file.\n");
                    else
                    printf("sample.xpm is not a XPM file, or XPM support is not available.\n");
            

See Also

SdlImage Class | Tao.Sdl Namespace | IMG_LoadTyped_RW