Difference between revisions of "Unit uScreenshot"

From Ultibo.org
Jump to: navigation, search
(Created page with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ---- ''To...")
 
 
(4 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
----
 
----
  
''To be documented''
+
'''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 ===
 
=== Constants ===
 
----
 
----
  
''To be documented''
+
''None defined''
  
 
=== Type definitions ===
 
=== Type definitions ===
 
----
 
----
  
''To be documented''
+
''None defined''
  
 
=== Public variables ===
 
=== Public variables ===
 
----
 
----
  
''To be documented''
+
''None defined''
  
 
=== Function declarations ===
 
=== Function declarations ===
 
----
 
----
  
''To be documented''
 
  
 +
'''uScreenshot functions'''
 +
 +
<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]]

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

[Expand]
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


[Expand]
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


Return to Unit Reference