doc/loaders_python.txt

   1 Python Loaders module
   2 ---------------------
   3
   4 The python binding maps mostly to the C API with the 'GP_' prefix stripped.
   5
   6 Loaders adds support for loading and storing contexts into/from various image
   7 fomats.
   8
   9 [source,python]
  10 -------------------------------------------------------------------------------
  11 import gfxprim.loaders as loaders
  12
  13     img = loaders.Load(path, callback=None)
  14
  15     img = loaders.LoadBMP(path, callback=None)
  16     img = loaders.LoadGIF(path, callback=None)
  17     img = loaders.LoadJPG(path, callback=None)
  18     img = loaders.LoadJP2(path, callback=None)
  19     img = loaders.LoadPBM(path, callback=None)
  20     img = loaders.LoadPGM(path, callback=None)
  21     img = loaders.LoadPNG(path, callback=None)
  22     img = loaders.LoadPNM(path, callback=None)
  23     img = loaders.LoadPPM(path, callback=None)
  24     img = loaders.LoadPSP(path, callback=None)
  25     img = loaders.LoadTIFF(path, callback=None)
  26 -------------------------------------------------------------------------------
  27
  28 Loads an image from a file.
  29
  30 First one is general purpose loader function that automatically detects the
  31 file format. The format is detected from file extension first and if this
  32 fails files signature is used.
  33
  34 May raise 'OSError' with errno set to 'EPERM', 'EISDIR', 'ENOENT' or any other
  35 'errno' set by 'open(2)', 'read(2)', 'seek(2)'.
  36
  37 May raise 'OSError' with errno set to 'ENOSYS' on unsupported or not recognized
  38 format.
  39
  40 May raise 'OSError' with errno set to 'EIO' when file is damaged.
  41
  42 May raise 'OSError' with errno set to 'ECANCELED' when action was interrupted
  43 by callback.
  44
  45
  46 [source,python]
  47 -------------------------------------------------------------------------------
  48 import gfxprim.loaders as loaders
  49
  50     img.loaders.Save(path, callback=None)
  51
  52     img.loaders.SaveBMP(path, callback=None)
  53     img.loaders.SaveJPG(path, callback=None)
  54     img.loaders.SavePBM(path, callback=None)
  55     img.loaders.SavePGM(path, callback=None)
  56     img.loaders.SavePNG(path, callback=None)
  57     img.loaders.SavePNM(path, callback=None)
  58     img.loaders.SavePPM(path, callback=None)
  59     img.loaders.SaveTIFF(path, callback=None)
  60 -------------------------------------------------------------------------------
  61
  62 Save image to a file.
  63
  64 For the Save() method the file format is derived from the extension.
  65
  66 May raise 'OSError' with errno set to 'EPERM', 'EISDIR', 'ENOENT' or any other
  67 'errno' set by 'open(2)', 'write(2)', 'seek(2)'.
  68
  69 May raise 'OSError' with errno set to 'ENOSYS' on unsupported pixel type for
  70 a given format.
  71
  72 May raise 'OSError' with errno set to 'EIO' when filesystem is full.
  73
  74 May raise 'OSError' with errno set to 'ECANCELED' when action was interrupted
  75 by callback.
  76
  77 [source,python]
  78 -------------------------------------------------------------------------------
  79 import gfxprim.loaders as loaders
  80
  81     loaders.ListLoaders()
  82
  83 -------------------------------------------------------------------------------
  84
  85 Prints all loaders and their capabilites into the 'stdout'.