REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
bool | Empty () const |
bool | Equals (ExportOptionsKit const &in_kit) const |
ExportOptionsKit () | |
ExportOptionsKit (ExportOptionsKit const &in_kit) | |
ExportOptionsKit (ExportOptionsKit &&in_that) | |
Type | ObjectType () const |
bool | operator!= (ExportOptionsKit const &in_kit) const |
ExportOptionsKit & | operator= (ExportOptionsKit &&in_that) |
ExportOptionsKit & | operator= (ExportOptionsKit const &in_kit) |
bool | operator== (ExportOptionsKit const &in_kit) const |
void | Set (ExportOptionsKit const &in_kit) |
ExportOptionsKit & | SetFormat (Image::Format in_format) |
ExportOptionsKit & | SetSize (unsigned int in_width, unsigned int in_height) |
void | Show (ExportOptionsKit &out_kit) const |
bool | ShowFormat (Image::Format &out_format) const |
bool | ShowSize (unsigned int &out_width, unsigned int &out_height) const |
ExportOptionsKit & | UnsetEverything () |
ExportOptionsKit & | UnsetFormat () |
ExportOptionsKit & | UnsetSize () |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Static Public Member Functions | |
static ExportOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The Image::ExportOptionsKit class contains options that will be used to export image files. Calling Image::ExportOptionsKit::GetDefault() will return an options kit with values found in this table.
Image::ExportOptionsKit::ExportOptionsKit | ( | ) |
The default constructor creates an empty ExportOptionsKit object.
Image::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
Image::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit && | in_that | ) |
The move constructor creates an ExportOptionsKit by transferring the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to an ExportOptionsKit to take the impl from. |
|
virtual |
Indicates whether this ExportOptionsKit has any values set on it.
Reimplemented from Object.
bool Image::ExportOptionsKit::Equals | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
in_kit | The source ExportOptionsKit to compare to this ExportOptionsKit. |
|
static |
Creates a ExportOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool Image::ExportOptionsKit::operator!= | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit.
in_kit | The source ExportOptionsKit to compare to this ExportOptionsKit. |
ExportOptionsKit& Image::ExportOptionsKit::operator= | ( | ExportOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy.
in_that | An rvalue reference to an ExportOptionsKit to take the impl from. |
ExportOptionsKit& Image::ExportOptionsKit::operator= | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
bool Image::ExportOptionsKit::operator== | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
in_kit | The source ExportOptionsKit to compare to this ExportOptionsKit. |
void Image::ExportOptionsKit::Set | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
ExportOptionsKit& Image::ExportOptionsKit::SetFormat | ( | Image::Format | in_format | ) |
Sets the format of the image. This must be specified when exporting any image.
in_format | The format of the image. |
ExportOptionsKit& Image::ExportOptionsKit::SetSize | ( | unsigned int | in_width, |
unsigned int | in_height | ||
) |
Sets the width and height (in pixels) of the image. If this is not specified , an exception will be thrown on export.
in_width | The width (in pixels) of the image. |
in_height | The height (in pixels) of the image. |
void Image::ExportOptionsKit::Show | ( | ExportOptionsKit & | out_kit | ) | const |
Copies this ExportOptionsKit into the given ExportOptionsKit.
out_kit | The ExportOptionsKit to populate with the contents of this ExportOptionsKit. |
bool Image::ExportOptionsKit::ShowFormat | ( | Image::Format & | out_format | ) | const |
Shows the format of the image.
out_format | The format of the image. |
bool Image::ExportOptionsKit::ShowSize | ( | unsigned int & | out_width, |
unsigned int & | out_height | ||
) | const |
Shows the width and height (in pixels) of the image.
out_width | The width (in pixels) of the image. |
out_height | The height (in pixels) of the image. |
ExportOptionsKit& Image::ExportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportOptionsKit.
ExportOptionsKit& Image::ExportOptionsKit::UnsetFormat | ( | ) |
Removes the format of the image.
ExportOptionsKit& Image::ExportOptionsKit::UnsetSize | ( | ) |
Removes the width and height of the image.