#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::ImageKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The ImageKit class is a user space object. It is used for specifying all data associated with images.
◆ ImageKit() [1/4]
HPS::ImageKit::ImageKit |
( |
| ) |
|
The default constructor creates an empty ImageKit object.
◆ ImageKit() [2/4]
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
-
◆ ImageKit() [3/4]
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_kit | The source ImageKit to copy and convert. |
in_format | The format to convert the source ImageKit to. |
◆ ImageKit() [4/4]
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_that | An rvalue reference to an ImageKit to take the impl from. |
◆ Convert() [1/2]
Copies the source ImageKit into this ImageKit but converts it to the specified format.
- Parameters
-
in_kit | The source ImageKit to copy and convert. |
in_format | The format to convert the source ImageKit to. |
◆ Convert() [2/2]
Converts this ImageKit to the specified format.
- Parameters
-
in_format | The format to convert the ImageKit to. |
◆ Empty()
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.
◆ Equals()
bool HPS::ImageKit::Equals |
( |
ImageKit const & |
in_kit | ) |
const |
Check if the source ImageKit is equivalent to this ImageKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
HPS::Type HPS::ImageKit::ObjectType |
( |
| ) |
const |
|
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::Kit.
◆ operator!=()
bool HPS::ImageKit::operator!= |
( |
ImageKit const & |
in_kit | ) |
const |
Check if the source ImageKit is not equivalent to this ImageKit.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this ImageKit thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to an ImageKit to take the impl from. |
- Returns
- A reference to this ImageKit.
◆ operator=() [2/2]
◆ operator==()
bool HPS::ImageKit::operator== |
( |
ImageKit const & |
in_kit | ) |
const |
Check if the source ImageKit is equivalent to this ImageKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::ImageKit::Set |
( |
ImageKit const & |
in_kit | ) |
|
◆ SetCompressionQuality()
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.
◆ SetData() [1/2]
Sets the data for the image.
- Parameters
-
in_image_data | The array of data for the image. |
- Returns
- A reference to this ImageKit.
◆ SetData() [2/2]
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.
◆ SetDownSampling()
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.
◆ SetFormat()
Sets the format of the image.
- Parameters
-
in_format | The format of the image. |
- Returns
- A reference to this ImageKit.
◆ SetSize()
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.
◆ Show()
void HPS::ImageKit::Show |
( |
ImageKit & |
out_kit | ) |
const |
◆ ShowCompressionQuality()
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.
◆ ShowData()
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.
◆ ShowDownSampling()
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.
◆ ShowFormat()
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.
◆ ShowSize()
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.
◆ UnsetCompressionQuality()
ImageKit& HPS::ImageKit::UnsetCompressionQuality |
( |
| ) |
|
Removes the compression quality for the image.
- Returns
- A reference to this ImageKit.
◆ UnsetData()
Removes the data for the image.
- Returns
- A reference to this ImageKit.
◆ UnsetDownSampling()
ImageKit& HPS::ImageKit::UnsetDownSampling |
( |
| ) |
|
Removes whether to down-sample the image.
- Returns
- A reference to this ImageKit.
◆ UnsetEverything()
ImageKit& HPS::ImageKit::UnsetEverything |
( |
| ) |
|
◆ UnsetFormat()
ImageKit& HPS::ImageKit::UnsetFormat |
( |
| ) |
|
Removes the format of the image.
- Returns
- A reference to this 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: