API Search || Global Search

#include <hps.h>

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

Public Member Functions

void Convert (ImageKit const &in_kit, HPS::Image::Format in_format)
 
void Convert (HPS::Image::Format in_format)
 
bool Empty () const
 
bool Equals (ImageKit const &in_kit) const
 
 ImageKit ()
 
 ImageKit (ImageKit const &in_kit)
 
 ImageKit (ImageKit const &in_kit, HPS::Image::Format in_format)
 
 ImageKit (ImageKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (ImageKit const &in_kit) const
 
ImageKitoperator= (ImageKit &&in_that)
 
ImageKitoperator= (ImageKit const &in_kit)
 
bool operator== (ImageKit const &in_kit) const
 
void Set (ImageKit const &in_kit)
 
ImageKitSetCompressionQuality (float in_quality)
 
ImageKitSetData (ByteArray const &in_image_data)
 
ImageKitSetData (size_t in_byte_count, byte const in_image_data[])
 
ImageKitSetDownSampling (bool in_state)
 
ImageKitSetFormat (Image::Format in_format)
 
ImageKitSetSize (unsigned int in_width, unsigned int in_height)
 
void Show (ImageKit &out_kit) const
 
bool ShowCompressionQuality (float &out_quality) const
 
bool ShowData (ByteArray &out_image_data) const
 
bool ShowDownSampling (bool &out_state) const
 
bool ShowFormat (Image::Format &out_format) const
 
bool ShowSize (unsigned int &out_width, unsigned int &out_height) const
 
ImageKitUnsetCompressionQuality ()
 
ImageKitUnsetData ()
 
ImageKitUnsetDownSampling ()
 
ImageKitUnsetEverything ()
 
ImageKitUnsetFormat ()
 
ImageKitUnsetSize ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ImageKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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 ( ImageKit const &  in_kit)

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

Parameters
in_kitThe source ImageKit to copy.
HPS::ImageKit::ImageKit ( ImageKit const &  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 ImageKit to copy and convert.
in_formatThe format to convert the source ImageKit to.
HPS::ImageKit::ImageKit ( ImageKit &&  in_that)

The move constructor creates an ImageKit by transferring the underlying impl of the rvalue reference to this ImageKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to an ImageKit to take the impl from.

Member Function Documentation

void HPS::ImageKit::Convert ( ImageKit const &  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 ImageKit to copy and convert.
in_formatThe format to convert the source ImageKit to.
void HPS::ImageKit::Convert ( HPS::Image::Format  in_format)

Converts this ImageKit to the specified format.

Parameters
in_formatThe format to convert the ImageKit to.
bool HPS::ImageKit::Empty ( ) const
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 ( ImageKit const &  in_kit) const

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.
bool HPS::ImageKit::operator!= ( ImageKit const &  in_kit) const

Check if the source ImageKit is not equivalent to this ImageKit.

Parameters
in_kitThe source ImageKit to compare to this ImageKit.
Returns
true if the objects are not equivalent, false otherwise.
ImageKit& HPS::ImageKit::operator= ( ImageKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ImageKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an ImageKit to take the impl from.
Returns
A reference to this ImageKit.
ImageKit& HPS::ImageKit::operator= ( ImageKit const &  in_kit)

Copies the source ImageKit into this ImageKit.

Parameters
in_kitThe source ImageKit to copy.
Returns
A reference to this ImageKit.
bool HPS::ImageKit::operator== ( ImageKit const &  in_kit) const

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.
void HPS::ImageKit::Set ( ImageKit const &  in_kit)

Copies the source ImageKit into this ImageKit.

Parameters
in_kitThe source ImageKit to copy.
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.
ImageKit& HPS::ImageKit::SetData ( ByteArray const &  in_image_data)

Sets the data for the image.

Parameters
in_image_dataThe array of data for the image.
Returns
A reference to this ImageKit.
ImageKit& HPS::ImageKit::SetData ( size_t  in_byte_count,
byte const  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.
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.
ImageKit& HPS::ImageKit::SetFormat ( Image::Format  in_format)

Sets the format of the image.

Parameters
in_formatThe format of the image.
Returns
A reference to this ImageKit.
ImageKit& HPS::ImageKit::SetSize ( unsigned int  in_width,
unsigned int  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 ( ImageKit out_kit) const

Copies this ImageKit into the given ImageKit.

Parameters
out_kitThe ImageKit to populate with the contents of this ImageKit.
bool HPS::ImageKit::ShowCompressionQuality ( float &  out_quality) const

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 ( ByteArray out_image_data) const

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.
bool HPS::ImageKit::ShowDownSampling ( bool &  out_state) const

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 ( Image::Format out_format) const

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 ( unsigned int &  out_width,
unsigned int &  out_height 
) const

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.
ImageKit& HPS::ImageKit::UnsetCompressionQuality ( )

Removes the compression quality for the image.

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

Removes the data for the image.

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

Removes whether to down-sample the image.

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

Removes all settings from this ImageKit.

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

Removes the format of the image.

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