Inheritance diagram for HPS.Image.File:

Public Member Functions

virtual void Dispose ()
 
File (HPS.Image.File in_that)
 

Static Public Member Functions

static void Export (string in_file_name, HPS.WindowKey in_window, HPS.Image.ExportOptionsKit in_options)
 
static 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)
 
static void Export (string in_file_name, HPS.WindowKey in_window, uint in_width, uint in_height, HPS.Image.Format in_format)
 
static void Export (string in_file_name, HPS.WindowKey in_window, uint in_width, uint in_height)
 
static void Export (string in_file_name, HPS.ImageKit in_image_kit)
 
static HPS.ImageKit Import (string in_file_name, HPS.Image.ImportOptionsKit in_options)
 

Protected Member Functions

virtual void deleteCptr ()
 

Protected Attributes

bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The File class provides a function to import and export image files.

Member Function Documentation

◆ Export() [1/5]

static void HPS.Image.File.Export ( string  in_file_name,
HPS.WindowKey  in_window,
HPS.Image.ExportOptionsKit  in_options 
)
inlinestatic

Performs a synchronous export to an image of the specified window. May throw an IOException if a problem occurs during export.

Parameters
in_file_nameName of image file to which to save the data.
in_windowThe WindowKey where the screen-shot will be taken
in_optionsOptions to use during export. If the option does not have size defined the size of in_window is used.

◆ Export() [2/5]

static void HPS.Image.File.Export ( string  in_file_name,
HPS.WindowKey  in_window,
uint  in_width,
uint  in_height,
HPS.Image.Format  in_format,
bool  in_transparent_background 
)
inlinestatic

Performs a synchronous export to an image of the specified window. May throw an IOException if a problem occurs during export.

Parameters
in_file_nameName of image file to which to save the data.
in_windowThe WindowKey where the screen-shot will be taken
in_widthThe width of the exported image, in pixels
in_heightThe height of the exported image, in pixels
in_formatThe format of the exported image, defaults to PNG
in_transparent_backgroundWhether to render the background as transparent. Only valid if in_format is PNG. Defaults to false.

◆ Export() [3/5]

static void HPS.Image.File.Export ( string  in_file_name,
HPS.WindowKey  in_window,
uint  in_width,
uint  in_height,
HPS.Image.Format  in_format 
)
inlinestatic

Performs a synchronous export to an image of the specified window. May throw an IOException if a problem occurs during export.

Parameters
in_file_nameName of image file to which to save the data.
in_windowThe WindowKey where the screen-shot will be taken
in_widthThe width of the exported image, in pixels
in_heightThe height of the exported image, in pixels
in_formatThe format of the exported image, defaults to PNG

◆ Export() [4/5]

static void HPS.Image.File.Export ( string  in_file_name,
HPS.WindowKey  in_window,
uint  in_width,
uint  in_height 
)
inlinestatic

Performs a synchronous export to an image of the specified window. May throw an IOException if a problem occurs during export.

Parameters
in_file_nameName of image file to which to save the data.
in_windowThe WindowKey where the screen-shot will be taken
in_widthThe width of the exported image, in pixels
in_heightThe height of the exported image, in pixels

◆ Export() [5/5]

static void HPS.Image.File.Export ( string  in_file_name,
HPS.ImageKit  in_image_kit 
)
inlinestatic

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_nameName of image file to which to save the data.
in_image_kitImageKit containing the data, size and format of the image to be exported

◆ Import()

static HPS.ImageKit HPS.Image.File.Import ( string  in_file_name,
HPS.Image.ImportOptionsKit  in_options 
)
inlinestatic

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_nameName of image file from which to get the data.
in_optionsOptions to use during import and to set on the ImageKit 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:
  • internals/hps_core/source/cs/HPS.Image.cs