|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The ImageKit class is a user space object. It is used for specifying all data associated with images.
◆ ImageKit() [1/3]
HPS.ImageKit.ImageKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty ImageKit object.
◆ ImageKit() [2/3]
The copy constructor creates a new ImageKit object that contains the same settings as the source ImageKit.
- Parameters
-
◆ ImageKit() [3/3]
This constructor creates a new ImageKit object that contains the same settings as the source ImageKit but converts it to the specified format.
- Parameters
-
in_kit | The source ImageKit to copy and convert. |
in_format | The format to convert the source ImageKit to. |
◆ Convert() [1/2]
Copies the source ImageKit into this ImageKit but converts it to the specified format.
- Parameters
-
in_kit | The source ImageKit to copy and convert. |
in_format | The format to convert the source ImageKit to. |
◆ Convert() [2/2]
Converts this ImageKit to the specified format.
- Parameters
-
in_format | The format to convert the ImageKit to. |
◆ Empty()
override bool HPS.ImageKit.Empty |
( |
| ) |
|
|
inlinevirtual |
Indicates whether this ImageKit has any values set on it.
- Returns
- true if no values are set on this ImageKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
Check if the source ImageKit is equivalent to this ImageKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
override HPS.Type HPS.ImageKit.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
◆ Set()
◆ SetCompressionQuality()
HPS.ImageKit HPS.ImageKit.SetCompressionQuality |
( |
float |
in_quality | ) |
|
|
inline |
Sets the compression quality for the image. Values range from highest compression and poorest quality (0) to no compression and full quality (1).
- Parameters
-
in_quality | The compression quality for the image, a floating point value between 0 and 1. |
- Returns
- A reference to this ImageKit.
◆ SetData()
Sets the data for the image.
- Parameters
-
in_image_data | The array of data for the image. |
- Returns
- A reference to this ImageKit.
◆ SetDownSampling()
Sets the whether to down-sample the image.
- Parameters
-
in_state | Whether to down-sample the image. |
- Returns
- A reference to this ImageKit.
◆ SetFormat()
Sets the format of the image.
- Parameters
-
in_format | The format of the image. |
- Returns
- A reference to this ImageKit.
◆ SetSize()
HPS.ImageKit HPS.ImageKit.SetSize |
( |
uint |
in_width, |
|
|
uint |
in_height |
|
) |
| |
|
inline |
Sets the width and height (in pixels) of the image.
- Parameters
-
in_width | The width (in pixels) of the image. |
in_height | The height (in pixels) of the image. |
- Returns
- A reference to this ImageKit.
◆ Show()
◆ ShowCompressionQuality()
bool HPS.ImageKit.ShowCompressionQuality |
( |
out float |
out_quality | ) |
|
|
inline |
Shows the compression quality for the image.
- Parameters
-
out_quality | The compression quality for the image. |
- Returns
- true if the compression quality is valid, false otherwise.
◆ ShowData()
bool HPS.ImageKit.ShowData |
( |
out byte [] |
out_image_data | ) |
|
|
inline |
Shows the data for the image.
- Parameters
-
out_image_data | The array of data for the image. |
- Returns
- true if the data array is valid, false otherwise.
◆ ShowDownSampling()
bool HPS.ImageKit.ShowDownSampling |
( |
out bool |
out_state | ) |
|
|
inline |
Shows whether to down-sample the image.
- Parameters
-
out_state | whether to down-sample the image. |
- Returns
- true if the flag is valid, false otherwise.
◆ ShowFormat()
Shows the format of the image.
- Parameters
-
out_format | The format of the image. |
- Returns
- true if the format is valid, false otherwise.
◆ ShowSize()
bool HPS.ImageKit.ShowSize |
( |
out uint |
out_width, |
|
|
out uint |
out_height |
|
) |
| |
|
inline |
Shows the width and height (in pixels) of the image.
- Parameters
-
out_width | The width (in pixels) of the image. |
out_height | The height (in pixels) of the image. |
- Returns
- true if the width and height are valid, false otherwise.
◆ UnsetCompressionQuality()
Removes the compression quality for the image.
- Returns
- A reference to this ImageKit.
◆ UnsetData()
Removes the data for the image.
- Returns
- A reference to this ImageKit.
◆ UnsetDownSampling()
Removes whether to down-sample the image.
- Returns
- A reference to this ImageKit.
◆ UnsetEverything()
◆ UnsetFormat()
Removes the format of the image.
- Returns
- A reference to this ImageKit.
◆ UnsetSize()
Removes the width and height of the image.
- Returns
- A reference to this ImageKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ImageKit.cs