
Public Member Functions | |
void | Convert (HPS.ImageKit in_kit, HPS.Image.Format in_format) |
Copies the source ImageKit into this ImageKit but converts it to the specified format. More... | |
void | Convert (HPS.Image.Format in_format) |
Converts this ImageKit to the specified format. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ImageKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ImageKit in_kit) |
Check if the source ImageKit is equivalent to this ImageKit. More... | |
override int | GetHashCode () |
ImageKit () | |
The default constructor creates an empty ImageKit object. More... | |
ImageKit (HPS.ImageKit in_kit) | |
The copy constructor creates a new ImageKit object that contains the same settings as the source ImageKit. More... | |
ImageKit (HPS.ImageKit in_kit, HPS.Image.Format in_format) | |
This constructor creates a new ImageKit object that contains the same settings as the source ImageKit but converts it to the specified format. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.ImageKit in_kit) |
Copies the source ImageKit into this ImageKit. More... | |
HPS.ImageKit | SetCompressionQuality (float in_quality) |
Sets the compression quality for the image. Values range from highest compression and poorest quality (0) to no compression and full quality (1). More... | |
HPS.ImageKit | SetData (byte[] in_image_data) |
Sets the data for the image. More... | |
HPS.ImageKit | SetDownSampling (bool in_state) |
Sets the whether to down-sample the image. More... | |
HPS.ImageKit | SetFormat (HPS.Image.Format in_format) |
Sets the format of the image. More... | |
HPS.ImageKit | SetSize (uint in_width, uint in_height) |
Sets the width and height (in pixels) of the image. More... | |
void | Show (out HPS.ImageKit out_kit) |
Copies this ImageKit into the given ImageKit. More... | |
bool | ShowCompressionQuality (out float out_quality) |
Shows the compression quality for the image. More... | |
bool | ShowData (out byte[] out_image_data) |
Shows the data for the image. More... | |
bool | ShowDownSampling (out bool out_state) |
Shows whether to down-sample the image. More... | |
bool | ShowFormat (out HPS.Image.Format out_format) |
Shows the format of the image. More... | |
bool | ShowSize (out uint out_width, out uint out_height) |
Shows the width and height (in pixels) of the image. More... | |
HPS.ImageKit | UnsetCompressionQuality () |
Removes the compression quality for the image. More... | |
HPS.ImageKit | UnsetData () |
Removes the data for the image. More... | |
HPS.ImageKit | UnsetDownSampling () |
Removes whether to down-sample the image. More... | |
HPS.ImageKit | UnsetEverything () |
Removes all settings from this ImageKit. More... | |
HPS.ImageKit | UnsetFormat () |
Removes the format of the image. More... | |
HPS.ImageKit | UnsetSize () |
Removes the width and height of the image. More... | |
![]() | |
override void | Dispose () |
Kit (HPS.Kit in_that) | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.ImageKit a, HPS.ImageKit b) |
static bool | operator== (HPS.ImageKit a, HPS.ImageKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ImageKit class is a user space object. It is used for specifying all data associated with images.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ImageKit object.
|
inline |
|
inline |
Member Function Documentation
|
inline |
|
inline |
|
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.
|
inline |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
|
inline |
|
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.
|
inline |
Sets the data for the image.
- Parameters
-
in_image_data The array of data for the image.
- Returns
- A reference to this ImageKit.
|
inline |
Sets the whether to down-sample the image.
- Parameters
-
in_state Whether to down-sample the image.
- Returns
- A reference to this ImageKit.
|
inline |
Sets the format of the image.
- Parameters
-
in_format The format of the image.
- Returns
- A reference to this ImageKit.
|
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.
|
inline |
|
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.
|
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.
|
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.
|
inline |
Shows the format of the image.
- Parameters
-
out_format The format of the image.
- Returns
- true if the format is valid, false otherwise.
|
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.
|
inline |
Removes the compression quality for the image.
- Returns
- A reference to this ImageKit.
|
inline |
Removes the data for the image.
- Returns
- A reference to this ImageKit.
|
inline |
Removes whether to down-sample the image.
- Returns
- A reference to this ImageKit.
|
inline |
Removes all settings from this ImageKit.
- Returns
- A reference to this ImageKit.
|
inline |
Removes the format of the image.
- Returns
- A reference to this ImageKit.
|
inline |
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