Skip to content

iup_imagegethandle.md

Latest commit

 

History

History
48 lines (34 loc) · 2.58 KB

iup_imagegethandle.md

File metadata and controls

48 lines (34 loc) · 2.58 KB
Raw

IupImageGetHandle

Returns an IupImage handle from a name.

Parameters/Return

Ihandle* IupImageGetHandle(const char* name);

name: name of the image.

Returns: handle of the IupImage or NULL if failed.

Notes

Name can be a global name set with IupSetHandle. In this case, the function just returns the existing element.

Name can also be a file name that will be loaded from disk. The available file formats supported are system-dependent:

  • Windows (Win32): BMP via LoadImage, plus BMP, GIF, JPEG, PNG, TIFF and others via WIC (Windows Imaging Component)
  • Windows (WinUI): BMP, GIF, JPEG, PNG, TIFF and others via WIC
  • GTK 3: formats supported by GDK-PixBuf, such as BMP, GIF, JPEG, PNG, TIFF and many others
  • GTK 4: formats supported by GdkTexture, such as PNG, JPEG, TIFF and others via GdkPixbuf
  • macOS: formats supported by NSImage, such as BMP, GIF, JPEG, PNG, TIFF, PDF, EPS and others
  • iOS: formats supported by UIImage, such as PNG, JPEG, GIF, BMP, TIFF and HEIC; asset-catalog names and SF Symbols are also resolved
  • Qt: formats supported by QPixmap, such as BMP, GIF, JPEG, PNG, PBM, PGM, PPM, XBM, XPM and SVG
  • FLTK: formats supported by Fl_Shared_Image, such as BMP, GIF, JPEG, PNG, XBM and XPM
  • EFL: formats supported by Evas image loaders, such as BMP, GIF, JPEG, PNG, TIFF, WebP and others
  • Motif: XBM and XPM. With Motif 2.4.0+: also JPEG, PNG and SVG via XmGetPixmap
  • Android: formats supported by BitmapFactory, such as PNG, JPEG, GIF, BMP and WebP
  • Haiku: formats supported by the Translation Kit (BTranslatorRoster / BTranslationUtils), such as BMP, GIF, JPEG, PNG, TGA, TIFF and WebP

In this case, the function returns a new image handle and associates the name with that handle, so in the next call it will return the existing handle.

Name can also be a system-specific stock / named image:

  • Win32: names of resources in RC files linked with the application.
  • GTK 3: names of GTK Stock Items.
  • GTK 4: names of icon theme icons.
  • Qt: names of Qt standard pixmaps (QStyle::StandardPixmap).
  • CocoaTouch: asset-catalog names via [UIImage imageNamed:] and SF Symbol names via [UIImage systemImageNamed:].
  • Motif: names of bitmaps installed on the system.

In all cases, the function returns a new image handle and associates the name with that handle, so in the next call it will return the existing handle.

See Also

IupImage, IupImageFromHandle, IupImageSave, IupImageSaveToBuffer