Difference between revisions of "Unit uScreenshot"
From Ultibo.org
| (3 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
=== Description === | === Description === | ||
---- | ---- | ||
| + | |||
| + | '''Ultibo Screenshot Utility unit''' | ||
Functions to capture all or part of the Ultibo console screen to a bitmap file. | Functions to capture all or part of the Ultibo console screen to a bitmap file. | ||
| Line 14: | Line 16: | ||
---- | ---- | ||
| − | '' | + | ''None defined'' |
=== Type definitions === | === Type definitions === | ||
---- | ---- | ||
| − | '' | + | ''None defined'' |
=== Public variables === | === Public variables === | ||
---- | ---- | ||
| − | '' | + | ''None defined'' |
=== Function declarations === | === Function declarations === | ||
---- | ---- | ||
| + | |||
| + | '''uScreenshot functions''' | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| Line 36: | Line 40: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Filename |
| The name of the file to save the bitmap to | | The name of the file to save the bitmap to | ||
|- | |- | ||
| − | ! | + | ! X |
| The column position for the left edge of the bitmap | | The column position for the left edge of the bitmap | ||
|- | |- | ||
| − | ! | + | ! Y |
| The row position for the top row of the bitmap | | The row position for the top row of the bitmap | ||
|- | |- | ||
| − | ! | + | ! Width |
| The width (in pixels) of the bitmap | | The width (in pixels) of the bitmap | ||
|- | |- | ||
| − | ! | + | ! Height |
| The height (in pixels) of the bitmap | | The height (in pixels) of the bitmap | ||
|- | |- | ||
| − | ! | + | ! BPP |
| The bits per pixel value for the bitmap (eg 16, 24 or 32) | | The bits per pixel value for the bitmap (eg 16, 24 or 32) | ||
|- | |- | ||
| − | ! | + | ! Return |
| True if successful or False is an error occurred | | True if successful or False is an error occurred | ||
|- | |- | ||
| Line 66: | Line 70: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Console |
| The console device to save the bitmap from | | The console device to save the bitmap from | ||
|- | |- | ||
| − | ! | + | ! Filename |
| The name of the file to save the bitmap to | | The name of the file to save the bitmap to | ||
|- | |- | ||
| − | ! | + | ! X |
| The column position for the left edge of the bitmap | | The column position for the left edge of the bitmap | ||
|- | |- | ||
| − | ! | + | ! Y |
| The row position for the top row of the bitmap | | The row position for the top row of the bitmap | ||
|- | |- | ||
| − | ! | + | ! Width |
| The width (in pixels) of the bitmap | | The width (in pixels) of the bitmap | ||
|- | |- | ||
| − | ! | + | ! Height |
| The height (in pixels) of the bitmap | | The height (in pixels) of the bitmap | ||
|- | |- | ||
| − | ! | + | ! BPP |
| The bits per pixel value for the bitmap (eg 16, 24 or 32) | | The bits per pixel value for the bitmap (eg 16, 24 or 32) | ||
|- | |- | ||
| − | ! | + | ! Return |
| True if successful or False is an error occurred | | True if successful or False is an error occurred | ||
|- | |- | ||
Latest revision as of 06:19, 31 August 2021
Return to Unit Reference
Description
Ultibo Screenshot Utility unit
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
None defined
Type definitions
None defined
Public variables
None defined
Function declarations
uScreenshot functions
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
