Difference between revisions of "Unit uScreenshot"
From Ultibo.org
(Created page with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ---- ''To...") |
|||
| Line 5: | Line 5: | ||
---- | ---- | ||
| − | + | Functions to capture all or part of the Ultibo console screen to a bitmap file. | |
| + | |||
| + | These functions originally appeared in the Ultibo forum and examples of how to use them can be found there: | ||
| + | |||
| + | SaveScreen(Ex): https://ultibo.org/forum/viewtopic.php?f=13&t=313 | ||
=== Constants === | === Constants === | ||
| Line 25: | Line 29: | ||
---- | ---- | ||
| − | |||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function SaveScreen(const Filename:String; X,Y,Width,Height,BPP:LongWord):Boolean; inline;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' A function for saving all or part of the default Ultibo console screen to a standard bitmap file</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! '''Filename''' | ||
| + | | The name of the file to save the bitmap to | ||
| + | |- | ||
| + | ! '''X''' | ||
| + | | The column position for the left edge of the bitmap | ||
| + | |- | ||
| + | ! '''Y''' | ||
| + | | The row position for the top row of the bitmap | ||
| + | |- | ||
| + | ! '''Width''' | ||
| + | | The width (in pixels) of the bitmap | ||
| + | |- | ||
| + | ! '''Height''' | ||
| + | | The height (in pixels) of the bitmap | ||
| + | |- | ||
| + | ! '''BPP''' | ||
| + | | The bits per pixel value for the bitmap (eg 16, 24 or 32) | ||
| + | |- | ||
| + | ! '''Return''' | ||
| + | | True if successful or False is an error occurred | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function SaveScreenEx(Console:PConsoleDevice; const Filename:String; X,Y,Width,Height,BPP:LongWord):Boolean;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' A function for saving all or part of an Ultibo console screen to a standard bitmap file</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! '''Console''' | ||
| + | | The console device to save the bitmap from | ||
| + | |- | ||
| + | ! '''Filename''' | ||
| + | | The name of the file to save the bitmap to | ||
| + | |- | ||
| + | ! '''X''' | ||
| + | | The column position for the left edge of the bitmap | ||
| + | |- | ||
| + | ! '''Y''' | ||
| + | | The row position for the top row of the bitmap | ||
| + | |- | ||
| + | ! '''Width''' | ||
| + | | The width (in pixels) of the bitmap | ||
| + | |- | ||
| + | ! '''Height''' | ||
| + | | The height (in pixels) of the bitmap | ||
| + | |- | ||
| + | ! '''BPP''' | ||
| + | | The bits per pixel value for the bitmap (eg 16, 24 or 32) | ||
| + | |- | ||
| + | ! '''Return''' | ||
| + | | True if successful or False is an error occurred | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
Return to [[Unit_Reference|Unit Reference]] | Return to [[Unit_Reference|Unit Reference]] | ||
Revision as of 02:47, 23 November 2016
Return to Unit Reference
Description
Functions to capture all or part of the Ultibo console screen to a bitmap file.
These functions originally appeared in the Ultibo forum and examples of how to use them can be found there:
SaveScreen(Ex): https://ultibo.org/forum/viewtopic.php?f=13&t=313
Constants
To be documented
Type definitions
To be documented
Public variables
To be documented
Function declarations
function SaveScreen(const Filename:String; X,Y,Width,Height,BPP:LongWord):Boolean; inline;
Description: A function for saving all or part of the default Ultibo console screen to a standard bitmap file
| Filename | The name of the file to save the bitmap to |
|---|---|
| X | The column position for the left edge of the bitmap |
| Y | The row position for the top row of the bitmap |
| Width | The width (in pixels) of the bitmap |
| Height | The height (in pixels) of the bitmap |
| BPP | The bits per pixel value for the bitmap (eg 16, 24 or 32) |
| Return | True if successful or False is an error occurred |
function SaveScreenEx(Console:PConsoleDevice; const Filename:String; X,Y,Width,Height,BPP:LongWord):Boolean;
Description: A function for saving all or part of an Ultibo console screen to a standard bitmap file
| Console | The console device to save the bitmap from |
|---|---|
| Filename | The name of the file to save the bitmap to |
| X | The column position for the left edge of the bitmap |
| Y | The row position for the top row of the bitmap |
| Width | The width (in pixels) of the bitmap |
| Height | The height (in pixels) of the bitmap |
| BPP | The bits per pixel value for the bitmap (eg 16, 24 or 32) |
| Return | True if successful or False is an error occurred |
Return to Unit Reference
