Module fipWinImage
Corona wrapper for fipWinImage, a class designed for MS Windows (TM) platforms.
fipWinImage provides methods used to:
- Display a DIB on the screen
- Copy / Paste a DIB to/from Windows devices (HANDLE, HBITMAP, Clipboard)
- Capture a window (HWND) and convert it to an image
fipWinImage derives from fipImage and unless otherwise noted may be treated as one.
Functions
| fipWinImage:assign (image) | Copies one (Win) image to another. |
| fipWinImage:captureWindow (hWndApplicationWindow, hWndSelectedWindow) | Capture a window and convert it to an image. |
| fipWinImage:clear () | Destroy image data. |
| fipWinImage:copyToClipboard (hWndNewOwner) | Clipboard copy. |
| fipWinImage:getToneMappingOperator () | Get the tone mapping algorithm used for drawing, with its parameters. |
| fipWinImage:isValid () | Indicates whether the image is valid for use. |
| fipWinImage:pasteFromClipboard () | Retrieves data from the clipboard. |
| fipWinImage:setToneMappingOperator (tmo[, first=0[, second=0[, third=1[, fourth=0]]]]) | Select a tone mapping algorithm used for drawing and set the image as modified so that the display will be refreshed. |
Functions
- fipWinImage:assign (image)
-
Copies one (Win) image to another.
Parameters:
- image fipWinImage Image to assign.
- fipWinImage:captureWindow (hWndApplicationWindow, hWndSelectedWindow)
-
Capture a window and convert it to an image.
Parameters:
- hWndApplicationWindow userdata Handle to the application main window. (TODO?)
- hWndSelectedWindow userdata Handle to the window to be captured.
Returns:
-
boolean
Operation was successful?
- fipWinImage:clear ()
- Destroy image data.
- fipWinImage:copyToClipboard (hWndNewOwner)
-
Clipboard copy.
Parameters:
- hWndNewOwner userdata Handle to the window to be associated with the open clipboard. (TODO?)
Returns:
-
boolean
Operation was successful?
- fipWinImage:getToneMappingOperator ()
-
Get the tone mapping algorithm used for drawing, with its parameters.
Returns:
- string Tone mapping operator, cf. enums.FREE_IMAGE_TMO.
- number First tone mapping algorithm parameter.
- number Second tone mapping algorithm parameter
- number Third tone mapping algorithm parameter
- number Fourth tone mapping algorithm parameter
- fipWinImage:isValid ()
-
Indicates whether the image is valid for use.
Returns:
-
boolean
The image is allocated?
- fipWinImage:pasteFromClipboard ()
-
Retrieves data from the clipboard.
Returns:
-
boolean
Operation was successful?
- fipWinImage:setToneMappingOperator (tmo[, first=0[, second=0[, third=1[, fourth=0]]]])
-
Select a tone mapping algorithm used for drawing and set the image as modified so that the display will be refreshed.
Parameters:
- tmo string Tone mapping operator, cf. enums.FREE_IMAGE_TMO.
- first number First tone mapping algorithm parameter (algorithm dependant). (default 0)
- second number Second tone mapping algorithm parameter (algorithm dependant). (default 0)
- third number Third tone mapping algorithm parameter (algorithm dependant). (default 1)
- fourth number Fourth tone mapping algorithm parameter (algorithm dependant). (default 0)