< Home

< Table of Contents

REFERENCE MANUAL

HPS.ImageKit Class Reference

The ImageKit class is a user space object. More...

Inheritance diagram for HPS.ImageKit:
HPS.Object

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. 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. 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...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static bool operator!= (HPS.ImageKit a, HPS.ImageKit b)
 
static bool operator== (HPS.ImageKit a, HPS.ImageKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The ImageKit class is a user space object.

It is used for specifying all data associated with images.

Constructor & Destructor Documentation

HPS.ImageKit.ImageKit ( )

The default constructor creates an empty ImageKit object.

HPS.ImageKit.ImageKit ( HPS.ImageKit  in_kit)

The copy constructor creates a new ImageKit object that contains the same settings as the source ImageKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref> to copy.
HPS.ImageKit.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.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref> to copy and convert.
in_formatThe format to convert the source <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref> to.

Member Function Documentation

void HPS.ImageKit.Convert ( HPS.ImageKit  in_kit,
HPS.Image.Format  in_format 
)

Copies the source ImageKit into this ImageKit but converts it to the specified format.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref> to copy and convert.
in_formatThe format to convert the source <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref> to.
void HPS.ImageKit.Convert ( HPS.Image.Format  in_format)

Converts this ImageKit to the specified format.

Parameters
in_formatThe format to convert the <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref> to.
override bool HPS.ImageKit.Empty ( )
virtual

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.

bool HPS.ImageKit.Equals ( HPS.ImageKit  in_kit)

Check if the source ImageKit is equivalent to this ImageKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref> to compare to this <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.ImageKit.ObjectType ( )
virtual

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.

void HPS.ImageKit.Set ( HPS.ImageKit  in_kit)

Copies the source ImageKit into this ImageKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref> to copy.
HPS.ImageKit 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).

Parameters
in_qualityThe compression quality for the image, a floating point value between 0 and 1.
Returns
A reference to this ImageKit.
HPS.ImageKit HPS.ImageKit.SetData ( byte[]  in_image_data)

Sets the data for the image.

Parameters
in_byte_countThe size of the following array.
in_image_dataThe array of data for the image.
Returns
A reference to this ImageKit.
HPS.ImageKit HPS.ImageKit.SetDownSampling ( bool  in_state)

Sets the whether to down-sample the image.

Parameters
in_stateWhether to down-sample the image.
Returns
A reference to this ImageKit.
HPS.ImageKit HPS.ImageKit.SetFormat ( HPS.Image.Format  in_format)

Sets the format of the image.

Parameters
in_formatThe format of the image.
Returns
A reference to this ImageKit.
HPS.ImageKit HPS.ImageKit.SetSize ( uint  in_width,
uint  in_height 
)

Sets the width and height (in pixels) of the image.

Parameters
in_widthThe width (in pixels) of the image.
in_heightThe height (in pixels) of the image.
Returns
A reference to this ImageKit.
void HPS.ImageKit.Show ( out HPS.ImageKit  out_kit)

Copies this ImageKit into the given ImageKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref>.
bool HPS.ImageKit.ShowCompressionQuality ( out float  out_quality)

Shows the compression quality for the image.

Parameters
out_qualityThe compression quality for the image.
Returns
true if the compression quality is valid, false otherwise.
bool HPS.ImageKit.ShowData ( out byte[]  out_image_data)

Shows the data for the image.

Returns
true if the data array is valid, false otherwise.
bool HPS.ImageKit.ShowDownSampling ( out bool  out_state)

Shows whether to down-sample the image.

Parameters
out_statewhether to down-sample the image.
Returns
true if the flag is valid, false otherwise.
bool HPS.ImageKit.ShowFormat ( out HPS.Image.Format  out_format)

Shows the format of the image.

Parameters
out_formatThe format of the image.
Returns
true if the format is valid, false otherwise.
bool HPS.ImageKit.ShowSize ( out uint  out_width,
out uint  out_height 
)

Shows the width and height (in pixels) of the image.

Parameters
out_widthThe width (in pixels) of the image.
out_heightThe height (in pixels) of the image.
Returns
true if the width and height are valid, false otherwise.
HPS.ImageKit HPS.ImageKit.UnsetCompressionQuality ( )

Removes the compression quality for the image.

Returns
A reference to this ImageKit.
HPS.ImageKit HPS.ImageKit.UnsetData ( )

Removes the data for the image.

Returns
A reference to this ImageKit.
HPS.ImageKit HPS.ImageKit.UnsetDownSampling ( )

Removes whether to down-sample the image.

Returns
A reference to this ImageKit.
HPS.ImageKit HPS.ImageKit.UnsetEverything ( )

Removes all settings from this ImageKit.

Returns
A reference to this ImageKit.
HPS.ImageKit HPS.ImageKit.UnsetFormat ( )

Removes the format of the image.

Returns
A reference to this ImageKit.
HPS.ImageKit HPS.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: