#include <hps.h>

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 |
ImageKit & | operator= (ImageKit &&in_that) |
ImageKit & | operator= (ImageKit const &in_kit) |
bool | operator== (ImageKit const &in_kit) const |
void | Set (ImageKit const &in_kit) |
ImageKit & | SetCompressionQuality (float in_quality) |
ImageKit & | SetData (ByteArray const &in_image_data) |
ImageKit & | SetData (size_t in_byte_count, byte const in_image_data[]) |
ImageKit & | SetDownSampling (bool in_state) |
ImageKit & | SetFormat (Image::Format in_format) |
ImageKit & | SetSize (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 |
ImageKit & | UnsetCompressionQuality () |
ImageKit & | UnsetData () |
ImageKit & | UnsetDownSampling () |
ImageKit & | UnsetEverything () |
ImageKit & | UnsetFormat () |
ImageKit & | UnsetSize () |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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 | ) |
HPS::ImageKit::ImageKit | ( | ImageKit const & | in_kit, |
HPS::Image::Format | in_format | ||
) |
HPS::ImageKit::ImageKit | ( | ImageKit && | in_that | ) |
Member Function Documentation
void HPS::ImageKit::Convert | ( | ImageKit const & | in_kit, |
HPS::Image::Format | in_format | ||
) |
void HPS::ImageKit::Convert | ( | HPS::Image::Format | in_format | ) |
|
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 |
|
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.
bool HPS::ImageKit::operator!= | ( | ImageKit const & | in_kit | ) | const |
bool HPS::ImageKit::operator== | ( | ImageKit const & | in_kit | ) | const |
void HPS::ImageKit::Set | ( | ImageKit const & | in_kit | ) |
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_quality The 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_data The 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_count The size of the following array. in_image_data The 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_state Whether 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_format The 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_width The width (in pixels) of the image. in_height The height (in pixels) of the image.
- Returns
- A reference to this ImageKit.
void HPS::ImageKit::Show | ( | ImageKit & | out_kit | ) | const |
bool HPS::ImageKit::ShowCompressionQuality | ( | float & | out_quality | ) | const |
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.
bool HPS::ImageKit::ShowData | ( | ByteArray & | out_image_data | ) | const |
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.
bool HPS::ImageKit::ShowDownSampling | ( | bool & | out_state | ) | const |
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.
bool HPS::ImageKit::ShowFormat | ( | Image::Format & | out_format | ) | const |
Shows the format of the image.
- Parameters
-
out_format The 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_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.
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 | ( | ) |
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:
- include/hps.h