func_graphics_pixmaps_createpixmap.rst 807 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .. _func_graphics_pixmaps_createpixmap:
  2. ============
  3. CreatePixmap
  4. ============
  5. CreatePixmap -
  6. Description
  7. ===========
  8. .. code-block:: blitzmax
  9. CreatePixmap:TPixmap( width,height,format,align_bytes=4 )
  10. Create a pixmap
  11. @format should be one of the following:
  12. [ @Format | @Description
  13. * PF_A8 | 8 bit alpha
  14. * PF_I8 | 8 bit intensity
  15. * PF_RGB888 | 24 bit big endian RGB
  16. * PF_BGR888 | 24 bit little endian RGB
  17. * PF_RGBA8888 | 32 bit big endian RGB with alpha
  18. * PF_BGRA8888 | 32 bit little endian RGB with alpha
  19. ]
  20. Note that the newly created pixmap will contain random data. #ClearPixels can
  21. be used to set all pixels to a known value prior to use.
  22. Parameters
  23. ==========
  24. Return Values
  25. =============
  26. A new pixmap object of the specified @width and @height
  27. Examples
  28. ========
  29. See Also
  30. ========