#include <hps.h>
|
template<typename T > |
static intptr_t | ClassID () |
|
The ImportOptionsKit class contains options that will be used to import image files and will be set on the ImageKit returned by File::Import.
Image::ImportOptionsKit::ImportOptionsKit |
( |
| ) |
|
The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
bool Image::ImportOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
Type Image::ImportOptionsKit::ObjectType |
( |
| ) |
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 Object.
bool Image::ImportOptionsKit::operator!= |
( |
ImportOptionsKit const & |
in_kit | ) |
const |
The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this ImportOptionsKit.
bool Image::ImportOptionsKit::operator== |
( |
ImportOptionsKit const & |
in_kit | ) |
const |
ImportOptionsKit& Image::ImportOptionsKit::SetCompressionQuality |
( |
float |
in_quality | ) |
|
Sets the compression quality for the image. This setting will be copied over to the ImageKit returned from File::Import. It doesn't need to be set for the import to succeed.
- Parameters
-
in_quality | The compression quality for the image. |
- Returns
- A reference to this ImportOptionsKit.
Sets whether to down-sample the image. This setting will be copied over to the ImageKit returned from File::Import. It doesn't need to be set for the import to succeed.
- Parameters
-
in_state | Whether to down-sample the image. |
- Returns
- A reference to this ImportOptionsKit.
Sets the format of the image. This must be specified when importing any image.
- Parameters
-
in_format | The format of the image. |
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& Image::ImportOptionsKit::SetSize |
( |
unsigned int |
in_width, |
|
|
unsigned int |
in_height |
|
) |
| |
Sets the width and height (in pixels) of the image. This does not need to be set when importing image files which contain this information (i.e., Image::Jpeg, Image::Png or Image::Targa). If this is not specified for images files which do not contain this information, an exception will be thrown on import.
- Parameters
-
in_width | The width (in pixels) of the image. |
in_height | The height (in pixels) of the image. |
- Returns
- A reference to this ImportOptionsKit.
bool Image::ImportOptionsKit::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 Image::ImportOptionsKit::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 Image::ImportOptionsKit::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 Image::ImportOptionsKit::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.
Removes the compression quality for the image.
- Returns
- A reference to this ImportOptionsKit.
Removes whether to down-sample the image.
- Returns
- A reference to this ImportOptionsKit.
Removes the width and height of the image.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file: