The File class provides a function to import and export image files.
More...
|
static void | Export (string in_file_name, HPS.WindowKey in_window, HPS.Image.ExportOptionsKit in_options) |
| Performs a synchronous export to an image of the specified window. More...
|
|
static void | Export (string in_file_name, HPS.WindowKey in_window, uint in_width, uint in_height, HPS.Image.Format in_format) |
| Performs a synchronous export to an image of the specified window. More...
|
|
static void | Export (string in_file_name, HPS.WindowKey in_window, uint in_width, uint in_height) |
| Performs a synchronous export to an image of the specified window. More...
|
|
static void | Export (string in_file_name, HPS.ImageKit in_image_kit) |
| Performs a synchronous export to an image from the specified ImageKit May throw an exception if a problem occurs during export, or if the image kit provided is incomplete More...
|
|
static HPS.ImageKit | Import (string in_file_name, HPS.Image.ImportOptionsKit in_options) |
| Performs a synchronous import of the specified image file. More...
|
|
The File class provides a function to import and export image files.
Performs a synchronous export to an image of the specified window.
May throw an IOException if a problem occurs during export.
- Parameters
-
in_file_name | Name of image file to which to save the data. |
in_window | The <ref refid="class_h_p_s_1_1_window_key" kindref="compound">WindowKey</ref> where the screen-shot will be taken |
in_options | Options to use during export. If the option does not have size defined the size of in_window is used. |
Performs a synchronous export to an image of the specified window.
May throw an IOException if a problem occurs during export.
- Parameters
-
in_file_name | Name of image file to which to save the data. |
in_window | The <ref refid="class_h_p_s_1_1_window_key" kindref="compound">WindowKey</ref> where the screen-shot will be taken |
in_width | The width of the exported image, in pixels |
in_height | The height of the exported image, in pixels |
in_format | The format of the exported image, defaults to PNG |
static void HPS.Image.File.Export |
( |
string |
in_file_name, |
|
|
HPS.WindowKey |
in_window, |
|
|
uint |
in_width, |
|
|
uint |
in_height |
|
) |
| |
|
static |
Performs a synchronous export to an image of the specified window.
May throw an IOException if a problem occurs during export.
- Parameters
-
in_file_name | Name of image file to which to save the data. |
in_window | The <ref refid="class_h_p_s_1_1_window_key" kindref="compound">WindowKey</ref> where the screen-shot will be taken |
in_width | The width of the exported image, in pixels |
in_height | The height of the exported image, in pixels |
static void HPS.Image.File.Export |
( |
string |
in_file_name, |
|
|
HPS.ImageKit |
in_image_kit |
|
) |
| |
|
static |
Performs a synchronous export to an image from the specified ImageKit May throw an exception if a problem occurs during export, or if the image kit provided is incomplete
- Parameters
-
in_file_name | Name of image file to which to save the data. |
in_image_kit | <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref> containing the data, size and format of the image to be exported |
Performs a synchronous import of the specified image file.
The function returns an ImageKit with the data from the image file and with the specified options. May throw an IOException if a problem occurs during import.
- Parameters
-
in_file_name | Name of image file from which to get the data. |
in_options | Options to use during import and to set on the <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref> returned by this function. |
- Returns
- An ImageKit containing the data from the specified file and with the specified options.
The documentation for this class was generated from the following file: