|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The ImportOptionsKit class contains options that will be used to import image files and will be set on the ImageKit returned by File.Import.
◆ ImportOptionsKit() [1/2]
HPS.Image.ImportOptionsKit.ImportOptionsKit |
( |
| ) |
|
|
inline |
◆ ImportOptionsKit() [2/2]
◆ Empty()
override bool HPS.Image.ImportOptionsKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ ObjectType()
override HPS.Type HPS.Image.ImportOptionsKit.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()
Sets the compression quality for the image. This setting will be copied over to the ImageKit returned from File.Import. It doesn't need to be set for the import to succeed.
- Parameters
-
in_quality | The compression quality for the image. |
- Returns
- A reference to this ImportOptionsKit.
◆ SetDownSampling()
Sets whether to down-sample the image. This setting will be copied over to the ImageKit returned from File.Import. It doesn't need to be set for the import to succeed.
- Parameters
-
in_state | Whether to down-sample the image. |
- Returns
- A reference to this ImportOptionsKit.
◆ SetFormat()
Sets the format of the image. This must be specified when importing any image.
- Parameters
-
in_format | The format of the image. |
- Returns
- A reference to this ImportOptionsKit.
◆ SetSize()
Sets the width and height (in pixels) of the image. This does not need to be set when importing image files which contain this information (i.e., Image.Jpeg, Image.Png or Image.Targa). If this is not specified for images files which do not contain this information, an exception will be thrown on import.
- Parameters
-
in_width | The width (in pixels) of the image. |
in_height | The height (in pixels) of the image. |
- Returns
- A reference to this ImportOptionsKit.
◆ Show()
◆ ShowCompressionQuality()
bool HPS.Image.ImportOptionsKit.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.
◆ ShowDownSampling()
bool HPS.Image.ImportOptionsKit.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.Image.ImportOptionsKit.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 ImportOptionsKit.
◆ UnsetDownSampling()
Removes whether to down-sample the image.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetEverything()
◆ UnsetFormat()
◆ UnsetSize()
Removes the width and height of the image.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Image.cs