Inheritance diagram for HPS.ImageKit:
HPS.Kit HPS.Object

Public Member Functions

void Convert (HPS.ImageKit in_kit, HPS.Image.Format in_format)
 
void Convert (HPS.Image.Format in_format)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ImageKit in_kit)
 
override int GetHashCode ()
 
 ImageKit ()
 
 ImageKit (HPS.ImageKit in_kit)
 
 ImageKit (HPS.ImageKit in_kit, HPS.Image.Format in_format)
 
override HPS.Type ObjectType ()
 
void Set (HPS.ImageKit in_kit)
 
HPS.ImageKit SetCompressionQuality (float in_quality)
 
HPS.ImageKit SetData (byte[] in_image_data)
 
HPS.ImageKit SetDownSampling (bool in_state)
 
HPS.ImageKit SetFormat (HPS.Image.Format in_format)
 
HPS.ImageKit SetSize (uint in_width, uint in_height)
 
void Show (out HPS.ImageKit out_kit)
 
bool ShowCompressionQuality (out float out_quality)
 
bool ShowData (out byte[] out_image_data)
 
bool ShowDownSampling (out bool out_state)
 
bool ShowFormat (out HPS.Image.Format out_format)
 
bool ShowSize (out uint out_width, out uint out_height)
 
HPS.ImageKit UnsetCompressionQuality ()
 
HPS.ImageKit UnsetData ()
 
HPS.ImageKit UnsetDownSampling ()
 
HPS.ImageKit UnsetEverything ()
 
HPS.ImageKit UnsetFormat ()
 
HPS.ImageKit UnsetSize ()
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

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.Kit
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
 

Detailed Description

The ImageKit class is a user space object. It is used for specifying all data associated with images.

Constructor & Destructor Documentation

◆ ImageKit() [1/3]

HPS.ImageKit.ImageKit ( )
inline

The default constructor creates an empty ImageKit object.

◆ ImageKit() [2/3]

HPS.ImageKit.ImageKit ( HPS.ImageKit  in_kit)
inline

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

Parameters
in_kitThe source ImageKit to copy.

◆ ImageKit() [3/3]

HPS.ImageKit.ImageKit ( HPS.ImageKit  in_kit,
HPS.Image.Format  in_format 
)
inline

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 ImageKit to copy and convert.
in_formatThe format to convert the source ImageKit to.

Member Function Documentation

◆ Convert() [1/2]

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

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

Parameters
in_kitThe source ImageKit to copy and convert.
in_formatThe format to convert the source ImageKit to.

◆ Convert() [2/2]

void HPS.ImageKit.Convert ( HPS.Image.Format  in_format)
inline

Converts this ImageKit to the specified format.

Parameters
in_formatThe format to convert the ImageKit to.

◆ Empty()

override bool HPS.ImageKit.Empty ( )
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.

◆ Equals()

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

Check if the source ImageKit is equivalent to this ImageKit.

Parameters
in_kitThe source ImageKit to compare to this ImageKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.ImageKit.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()

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

Copies the source ImageKit into this ImageKit.

Parameters
in_kitThe source ImageKit to copy.

◆ SetCompressionQuality()

HPS.ImageKit HPS.ImageKit.SetCompressionQuality ( float  in_quality)
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_qualityThe compression quality for the image, a floating point value between 0 and 1.
Returns
A reference to this ImageKit.

◆ SetData()

HPS.ImageKit HPS.ImageKit.SetData ( byte []  in_image_data)
inline

Sets the data for the image.

Parameters
in_image_dataThe array of data for the image.
Returns
A reference to this ImageKit.

◆ SetDownSampling()

HPS.ImageKit HPS.ImageKit.SetDownSampling ( bool  in_state)
inline

Sets the whether to down-sample the image.

Parameters
in_stateWhether to down-sample the image.
Returns
A reference to this ImageKit.

◆ SetFormat()

HPS.ImageKit HPS.ImageKit.SetFormat ( HPS.Image.Format  in_format)
inline

Sets the format of the image.

Parameters
in_formatThe format of the image.
Returns
A reference to this ImageKit.

◆ SetSize()

HPS.ImageKit HPS.ImageKit.SetSize ( uint  in_width,
uint  in_height 
)
inline

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.

◆ Show()

void HPS.ImageKit.Show ( out HPS.ImageKit  out_kit)
inline

Copies this ImageKit into the given ImageKit.

Parameters
out_kitThe ImageKit to populate with the contents of this ImageKit.

◆ ShowCompressionQuality()

bool HPS.ImageKit.ShowCompressionQuality ( out float  out_quality)
inline

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.

◆ ShowData()

bool HPS.ImageKit.ShowData ( out byte []  out_image_data)
inline

Shows the data for the image.

Parameters
out_image_dataThe array of data for the image.
Returns
true if the data array is valid, false otherwise.

◆ ShowDownSampling()

bool HPS.ImageKit.ShowDownSampling ( out bool  out_state)
inline

Shows whether to down-sample the image.

Parameters
out_statewhether to down-sample the image.
Returns
true if the flag is valid, false otherwise.

◆ ShowFormat()

bool HPS.ImageKit.ShowFormat ( out HPS.Image.Format  out_format)
inline

Shows the format of the image.

Parameters
out_formatThe format of the image.
Returns
true if the format is valid, false otherwise.

◆ ShowSize()

bool HPS.ImageKit.ShowSize ( out uint  out_width,
out uint  out_height 
)
inline

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.

◆ UnsetCompressionQuality()

HPS.ImageKit HPS.ImageKit.UnsetCompressionQuality ( )
inline

Removes the compression quality for the image.

Returns
A reference to this ImageKit.

◆ UnsetData()

HPS.ImageKit HPS.ImageKit.UnsetData ( )
inline

Removes the data for the image.

Returns
A reference to this ImageKit.

◆ UnsetDownSampling()

HPS.ImageKit HPS.ImageKit.UnsetDownSampling ( )
inline

Removes whether to down-sample the image.

Returns
A reference to this ImageKit.

◆ UnsetEverything()

HPS.ImageKit HPS.ImageKit.UnsetEverything ( )
inline

Removes all settings from this ImageKit.

Returns
A reference to this ImageKit.

◆ UnsetFormat()

HPS.ImageKit HPS.ImageKit.UnsetFormat ( )
inline

Removes the format of the image.

Returns
A reference to this ImageKit.

◆ UnsetSize()

HPS.ImageKit HPS.ImageKit.UnsetSize ( )
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