The ImageKit class is a user space object. It is used for specifying all data associated with images. More...
Public Member Functions | |
override void | Dispose () |
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... | |
void | Show (out HPS.ImageKit out_kit) |
Copies this ImageKit into the given ImageKit. More... | |
override bool | Empty () |
Indicates whether this ImageKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.ImageKit in_kit) |
Check if the source ImageKit is equivalent to this ImageKit. More... | |
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... | |
HPS.ImageKit | SetSize (uint in_width, uint in_height) |
Sets the width and height (in pixels) of the image. More... | |
HPS.ImageKit | SetData (byte[] in_image_data) |
Sets the data for the image. More... | |
HPS.ImageKit | SetFormat (HPS.Image.Format in_format) |
Sets the format of the image. More... | |
HPS.ImageKit | SetDownSampling (bool in_state) |
Sets the whether to down-sample the image. 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 | UnsetSize () |
Removes the width and height of the image. More... | |
HPS.ImageKit | UnsetData () |
Removes the data for the image. More... | |
HPS.ImageKit | UnsetFormat () |
Removes the format of the image. More... | |
HPS.ImageKit | UnsetDownSampling () |
Removes whether to down-sample the image. More... | |
HPS.ImageKit | UnsetCompressionQuality () |
Removes the compression quality for the image. More... | |
HPS.ImageKit | UnsetEverything () |
Removes all settings from this ImageKit. More... | |
bool | ShowSize (out uint out_width, out uint out_height) |
Shows the width and height (in pixels) of the image. More... | |
bool | ShowData (out byte[] out_image_data) |
Shows the data for the image. More... | |
bool | ShowFormat (out HPS.Image.Format out_format) |
Shows the format of the image. More... | |
bool | ShowDownSampling (out bool out_state) |
Shows whether to down-sample the image. More... | |
bool | ShowCompressionQuality (out float out_quality) |
Shows the compression quality for the image. More... | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
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 () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The ImageKit class is a user space object. It is used for specifying all data associated with images.
|
inline |
The default constructor creates an empty ImageKit object.
|
inline |
|
inline |
|
inline |
|
inline |
|
inlinevirtual |
Indicates whether this ImageKit has any values set on it.
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.
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).
in_quality | The compression quality for the image, a floating point value between 0 and 1. |
|
inline |
Sets the data for the image.
in_image_data | The array of data for the image. |
|
inline |
Sets the whether to down-sample the image.
in_state | Whether to down-sample the image. |
|
inline |
Sets the format of the image.
in_format | The format of the image. |
|
inline |
Sets the width and height (in pixels) of the image.
in_width | The width (in pixels) of the image. |
in_height | The height (in pixels) of the image. |
|
inline |
|
inline |
Shows the compression quality for the image.
out_quality | The compression quality for the image. |
|
inline |
Shows the data for the image.
out_image_data | The array of data for the image. |
|
inline |
Shows whether to down-sample the image.
out_state | whether to down-sample the image. |
|
inline |
Shows the format of the image.
out_format | The format of the image. |
|
inline |
Shows the width and height (in pixels) of the image.
out_width | The width (in pixels) of the image. |
out_height | The height (in pixels) of the image. |
|
inline |
Removes the compression quality for the image.
|
inline |
Removes the data for the image.
|
inline |
Removes whether to down-sample the image.
|
inline |
|
inline |
Removes the format of the image.
|
inline |
Removes the width and height of the image.