HPS::Image::File
- class HPS.Image.File : public IDisposable
The File class provides a function to import and export image files.
Public Static Functions
- 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
- Param in_file_name
Name of image file to which to save the data.
- Param in_image_kit
ImageKit containing the data, size and format of the image to be exported
- 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. May throw an IOException if a problem occurs during export.
- Param in_file_name
Name of image file to which to save the data.
- Param in_window
The WindowKey where the screen-shot will be taken
- Param in_options
Options to use during export. If the option does not have size defined the size of in_window is used.
- 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. May throw an IOException if a problem occurs during export.
- Param in_file_name
Name of image file to which to save the data.
- Param in_window
The WindowKey where the screen-shot will be taken
- Param in_width
The width of the exported image, in pixels
- Param in_height
The height of the exported image, in pixels
- 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. May throw an IOException if a problem occurs during export.
- Param in_file_name
Name of image file to which to save the data.
- Param in_window
The WindowKey where the screen-shot will be taken
- Param in_width
The width of the exported image, in pixels
- Param in_height
The height of the exported image, in pixels
- Param in_format
The format of the exported image, defaults to PNG
- void Export (string in_file_name, HPS.WindowKey in_window, uint in_width, uint in_height, HPS.Image.Format in_format, bool in_transparent_background)
Performs a synchronous export to an image of the specified window. May throw an IOException if a problem occurs during export.
- Param in_file_name
Name of image file to which to save the data.
- Param in_window
The WindowKey where the screen-shot will be taken
- Param in_width
The width of the exported image, in pixels
- Param in_height
The height of the exported image, in pixels
- Param in_format
The format of the exported image, defaults to PNG
- Param in_transparent_background
Whether to render the background as transparent. Only valid if in_format is PNG. Defaults to false.
- HPS.ImageKit Import (string in_file_name, HPS.Image.ImportOptionsKit in_options)
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.
