|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The HPS.Image.ExportOptionsKit class contains options that will be used to export image files. Calling HPS.Image.ExportOptionsKit.GetDefault() will return an options kit with values found in this table.
◆ ExportOptionsKit() [1/2]
HPS.Image.ExportOptionsKit.ExportOptionsKit |
( |
| ) |
|
|
inline |
◆ ExportOptionsKit() [2/2]
◆ Empty()
override bool HPS.Image.ExportOptionsKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ GetDefault()
Creates a ExportOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A ExportOptionsKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.Image.ExportOptionsKit.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()
◆ SetFormat()
Sets the format of the image. This must be specified when exporting any image.
- Parameters
-
in_format | The format of the image. |
- Returns
- A reference to this ExportOptionsKit.
- See also
- Export format default value
◆ SetSize()
Sets the width and height (in pixels) of the image. If this is not specified , an exception will be thrown on export.
- Parameters
-
in_width | The width (in pixels) of the image. |
in_height | The height (in pixels) of the image. |
- Returns
- A reference to this ExportOptionsKit.
◆ SetTransparentBackground()
Sets whether the image background will be transparent. This setting is only valid when exporting a PNG image.
- Parameters
-
in_state | Whether the image background will be transparent. |
- Returns
- A reference to this ExportOptionsKit.
◆ Show()
◆ 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.ExportOptionsKit.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.
◆ ShowTransparentBackground()
bool HPS.Image.ExportOptionsKit.ShowTransparentBackground |
( |
out bool |
out_state | ) |
|
|
inline |
Shows transparent background setting for this image
- Parameters
-
out_state | The transparent background setting for this image. |
- Returns
- true if a background preference was specified, false otherwise.
◆ UnsetEverything()
◆ UnsetFormat()
◆ UnsetSize()
Removes the width and height of the image.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetTransparentBackground()
Removes the transparent background setting of the image.
- Returns
- A reference to this ExportOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Image.cs